xref: /plugin/combo/ComboStrap/Slug.php (revision 4cadd4f8c541149bdda95f080e38a6d4e3a640ca)

<?php


use ComboStrap\DokuPath;
use ComboStrap\MetaManagerForm;
use ComboStrap\Metadata;
use ComboStrap\MetadataWikiPath;
use ComboStrap\PageTitle;
use ComboStrap\ResourceCombo;
use ComboStrap\StringUtility;

class Slug extends MetadataWikiPath
{

    public const PROPERTY_NAME = "slug";


    public static function createForPage(ResourceCombo $resource)
    {
        return (new Slug())
            ->setResource($resource);
    }

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


    /**
     * The goal is to get only words that can be interpreted
     * We could also encode it
     * @param $string
     * @return string|null
     */
    public static function toSlugPath($string): ?string
    {
        if (empty($string)) return null;
        $excludedCharacters = array_merge(DokuPath::getReservedWords(), StringUtility::SEPARATORS_CHARACTERS);
        $excludedCharacters[] = DokuPath::SLUG_SEPARATOR;
        $parts = explode(DokuPath::PATH_SEPARATOR, $string);
        $parts = array_map(function ($e) use ($excludedCharacters) {
            $wordsPart = StringUtility::getWords(
                $e,
                $excludedCharacters
            );
            // Implode and Lower case
            return strtolower(implode(DokuPath::SLUG_SEPARATOR, $wordsPart));
        }, $parts);

        $slug = implode(DokuPath::PATH_SEPARATOR, $parts);
        // Space to separator
        //$slugWithoutSpace = str_replace(" ", DokuPath::SLUG_SEPARATOR, $slugWithoutSpaceAroundParts);
        // No double separator
        //$slugWithoutDoubleSeparator = preg_replace("/" . DokuPath::SLUG_SEPARATOR . "{2,}/", DokuPath::SLUG_SEPARATOR, $slugWithoutSpace);
        DokuPath::addRootSeparatorIfNotPresent($slug);
        return $slug;
    }

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

    public function getDescription(): string
    {
        return "The slug is used in the url of the page (if chosen)";
    }

    public function getLabel(): string
    {
        return "Slug Path";
    }

    public function setFromStoreValue($value): Metadata
    {
        return $this->buildFromStoreValue($value);
    }

    public function setValue($value): Metadata
    {
        return $this->buildFromStoreValue($value);
    }

    public function buildFromStoreValue($value): Metadata
    {
        return parent::buildFromStoreValue(self::toSlugPath($value));
    }


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

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

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

    public function getDefaultValue(): ?string
    {
        $title = PageTitle::createForPage($this->getResource())
            ->getValueOrDefault();
        if ($title === null) {
            return null;
        }
        return self::toSlugPath($title);
    }
}