xref: /plugin/combo/ComboStrap/ModificationDate.php (revision c3437056399326d621a01da73b649707fbb0ae69)

<?php


use ComboStrap\ExceptionCombo;
use ComboStrap\FileSystems;
use ComboStrap\MetaManagerForm;
use ComboStrap\LogUtility;
use ComboStrap\Metadata;
use ComboStrap\MetadataDateTime;
use ComboStrap\MetadataDokuWikiStore;
use ComboStrap\Page;
use ComboStrap\PageCreationDate;

class ModificationDate extends MetadataDateTime
{

    public const PROPERTY_NAME = 'date_modified';

    public static function createForPage(Page $page)
    {
        return (new ModificationDate())
            ->setResource($page);
    }

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

    public function buildFromReadStore(): MetadataDateTime
    {
        $store = $this->getReadStore();
        if (!($store instanceof MetadataDokuWikiStore)) {
            return parent::buildFromReadStore();
        }

        $modificationTime = FileSystems::getModifiedTime($this->getResource()->getPath());
        if ($modificationTime !== null) {
            $this->setValue($modificationTime);
            return $this;
        }

        /**
         * Dokuwiki
         * Why do they store the date of the file while it's in the file system ?
         */
        $createdMeta = $store->getCurrentFromName('date')['modified'];
        if (empty($createdMeta)) {
            $createdMeta = $store->getFromPersistentName('date')['modified'];
            if (empty($createdMeta)) {
                return $this;
            }
        }
        // the data in dokuwiki is saved as timestamp
        $datetime = new DateTime();
        if(!is_int($createdMeta)){
            LogUtility::msg("The modification time in the dokuwiki meta is not an integer");
            return $this;
        }
        $datetime->setTimestamp($createdMeta);
        $this->setValue($datetime);
        return $this;
    }


    public function getDescription(): string
    {
        return "The last modification date of the page"; // resource
    }

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

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

    public function getPersistenceType(): string
    {
        return Metadata::DERIVED_METADATA;
    }

    public function getMutable(): bool
    {
        return false;
    }

    public function getDefaultValue(): ?DateTime
    {

        $modificationTime = FileSystems::getModifiedTime($this->getResource()->getPath());
        if ($modificationTime !== null) {
            return $modificationTime;
        }
        return PageCreationDate::createForPage($this->getResource())->getValue();

    }

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


}