xref: /template/strap/ComboStrap/DokuwikiId.php (revision c3437056399326d621a01da73b649707fbb0ae69)

<?php


namespace ComboStrap;


use DateTime;

/**

 * @package ComboStrap
 * Represents the wiki id of a resource
 */
class DokuwikiId extends MetadataText
{


    public const DOKUWIKI_ID_ATTRIBUTE = "id";

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

    public function getDefaultValue(): ?DateTime
    {
        return null;
    }

    public function getValue(): ?string
    {
        return $this->getResource()->getPath()->getDokuwikiId();
    }


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


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


    public function getTab(): ?string
    {
        return null;
    }

    public function getDescription(): string
    {
        return "The id of a resource represents the path of a resource from its root directory";
    }

    public function getLabel(): string
    {
        return "Wiki Id";
    }

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