xref: /template/strap/ComboStrap/PageUrlType.php (revision 04fd306c7c155fa133ebb3669986875d65988276)

<?php


namespace ComboStrap;


use ComboStrap\Meta\Api\Metadata;
use ComboStrap\Meta\Api\MetadataText;

class PageUrlType extends MetadataText
{

    public const CONF_CANONICAL_URL_TYPE = "pageUrlType";
    public const CONF_CANONICAL_URL_TYPE_DEFAULT = self::CONF_VALUE_PAGE_PATH;
    public const CONF_VALUE_PAGE_PATH = "page path";
    public const CONF_VALUE_SLUG = "slug";
    public const CONF_VALUE_CANONICAL_PATH = "canonical path";
    public const CONF_VALUE_HIERARCHICAL_SLUG = "hierarchical slug";
    public const CONF_VALUE_PERMANENT_PAGE_PATH = "permanent page path";
    public const CONF_VALUE_PERMANENT_CANONICAL_PATH = "permanent canonical path";
    public const CONF_VALUE_HOMED_SLUG = "homed slug";
    public const CONF_VALUES = [
        PageUrlType::CONF_VALUE_PAGE_PATH,
        PageUrlType::CONF_VALUE_PERMANENT_PAGE_PATH,
        PageUrlType::CONF_VALUE_CANONICAL_PATH,
        PageUrlType::CONF_VALUE_PERMANENT_CANONICAL_PATH,
        PageUrlType::CONF_VALUE_SLUG,
        PageUrlType::CONF_VALUE_HOMED_SLUG,
        PageUrlType::CONF_VALUE_HIERARCHICAL_SLUG
    ];


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

    public function getValue(): string
    {

        $resourceCombo = $this->getResource();
        if (!$resourceCombo->exists()) {
            return PageUrlType::CONF_VALUE_PAGE_PATH;
        }
        if (!($resourceCombo instanceof MarkupPath)) {
            LogUtility::msg("The page type is only for page");
            return PageUrlType::CONF_VALUE_PAGE_PATH;
        }

        $confCanonicalType = $this->getName();
        $confDefaultValue = $this->getDefaultValue();
        $urlType = SiteConfig::getConfValue($confCanonicalType, $confDefaultValue);
        if (!in_array($urlType, self::CONF_VALUES)) {
            LogUtility::msg("The canonical configuration ($confCanonicalType) value ($urlType) is unknown and was set to the default one", LogUtility::LVL_MSG_ERROR, PageUrlPath::PROPERTY_NAME);
            return $confDefaultValue;
        }

        return $urlType;


    }


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

    static public function getDescription(): string
    {
        return "The type of Url for pages";
    }

    static public function getLabel(): string
    {
        return "Page Url";
    }

    static public function getName(): string
    {
        return PageUrlType::CONF_CANONICAL_URL_TYPE;
    }

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

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

    /**
     * @return string
     */
    public function getDefaultValue(): string
    {
        return PageUrlType::CONF_CANONICAL_URL_TYPE_DEFAULT;
    }
}