xref: /plugin/combo/ComboStrap/CreationDate.php (revision 70bbd7f1f72440223cc13f3495efdcb2b0a11514)

<?php


namespace ComboStrap;


use ComboStrap\Meta\Api\Metadata;
use ComboStrap\Meta\Api\MetadataDateTime;
use ComboStrap\Meta\Store\MetadataDokuWikiStore;
use DateTime;

/**
 * Class CacheExpirationFrequencyMeta
 * @package ComboStrap
 * Represents the creation date of a resource
 */
class CreationDate extends MetadataDateTime
{


    public const PROPERTY_NAME = 'date_created';
    const DATE_DOKUWIKI_PROPERTY_NAME = 'date';
    const DOKUWIKI_SUB_KEY = 'created';


    public static function createForPage(ResourceCombo $page): CreationDate
    {
        return (new CreationDate())
            ->setResource($page);
    }

    public static function create(): CreationDate
    {
        return new CreationDate();
    }

    public function getDefaultValue(): DateTime
    {
        $path = $this->getResource()->getPathObject();
        return FileSystems::getCreationTime($path);
    }

    /**
     */
    public function buildFromReadStore(): MetadataDateTime
    {

        $store = $this->getReadStore();

        if (!($store instanceof MetadataDokuWikiStore)) {
            return parent::buildFromReadStore();
        }

        $fromName = $store->getFromName(self::DATE_DOKUWIKI_PROPERTY_NAME);
        if ($fromName === null) {
            return $this;
        }
        $createdMeta = $fromName[self::DOKUWIKI_SUB_KEY] ?? null;
        if (empty($createdMeta)) {
            return $this;
        }
        // the data in dokuwiki is saved as timestamp
        $datetime = new DateTime();
        $datetime->setTimestamp($createdMeta);
        $this->setValue($datetime);
        return $this;
    }

    public function toStoreValue()
    {
        $store = $this->getWriteStore();
        if (!($store instanceof MetadataDokuWikiStore)) {
            return parent::toStoreValue();
        }
        $value = $this->getValue();

        return array(
            self::DATE_DOKUWIKI_PROPERTY_NAME => [self::DOKUWIKI_SUB_KEY => $value->getTimestamp()]
        );
    }


    static public function getName(): string
    {
        return CreationDate::PROPERTY_NAME;
    }


    public static function getPersistenceType(): string
    {
        /**
         * On windows, the creation time is not preserved when you copy
         * a file
         *
         * If you copy a file from C:\fat16 to D:\NTFS,
         * it keeps the same modified date and time but changes the created date
         * and time to the current date and time.
         * If you move a file from C:\fat16 to D:\NTFS,
         * it keeps the same modified date and time
         * and keeps the same created date and time
         */
        return Metadata::PERSISTENT_METADATA;
    }


    public static function getTab(): string
    {
        return MetaManagerForm::TAB_PAGE_VALUE;
    }

    static public function getDescription(): string
    {
        return "The creation date of the page";
    }

    static public function getLabel(): string
    {
        return "Creation Date";
    }

    static public function isMutable(): bool
    {
        /**
         * Not sure, It should not be really mutable by the user
         * but the date should be found in the frontmatter for instance
         */
        return false;
    }

    public static function getCanonical(): string
    {
        return Metadata::CANONICAL;
    }

    public static function isOnForm(): bool
    {
        return true;
    }
}