xref: /template/strap/ComboStrap/Meta/Field/PageImage.php (revision 04fd306c7c155fa133ebb3669986875d65988276)

<?php


namespace ComboStrap\Meta\Field;


use ComboStrap\ExceptionCompile;
use ComboStrap\MarkupPath;
use ComboStrap\PageImageUsage;
use ComboStrap\ResourceCombo;
use ComboStrap\WikiPath;

/**
 * Represents the image of a page in a {@link PageImages}
 * @deprecated
 */
class PageImage
{

    const PAGE_IMAGE = "page-image";


    /**
     * A path and not a {@link FetcherImage}
     * because:
     *   * it's basically a path (no processing information are needed)
     *   * it's easier to manipulate a path
     *   * in syntax component, we pass attribute to the fetcher that it should delete if used (Way to check the attribute usage)
     * @var WikiPath
     */
    private WikiPath $image;
    private $usages;
    /**
     * @var MarkupPath
     */
    private $page;

    /**
     * PageImage constructor.
     */
    public function __construct(WikiPath $image, MarkupPath $page)
    {
        $this->image = $image;
        $this->page = $page;
    }

    /**
     * @param WikiPath $image
     * @param MarkupPath $page
     * @return PageImage
     */
    public static function create(WikiPath $image, ResourceCombo $page): PageImage
    {
        return new PageImage($image, $page);
    }

    /**
     * @param array $usages
     * @return $this
     * @throws ExceptionCompile
     */
    public function setUsages(array $usages): PageImage
    {
        foreach ($usages as $usage) {
            $value = trim($usage);
            if ($value === "") {
                continue;
            }
            if (!in_array($value, PageImageUsage::getUsageValues())) {
                throw new ExceptionCompile("The page image usage value ($value) is not valid.");
            }
            $this->usages[$value] = $value;
        }
        return $this;
    }

    public function getImagePath(): WikiPath
    {
        return $this->image;
    }

    public function getUsages(): array
    {
        if ($this->usages === null) {
            return $this->getDefaultUsage();
        }
        return array_values($this->usages);
    }

    public function getDefaultUsage(): array
    {
        return [PageImageUsage::DEFAULT];
    }

    /**
     * @return MarkupPath
     */
    public function getPage(): MarkupPath
    {
        return $this->page;
    }


}