Description.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Data\Description;

use ILIAS\Data\Text;

abstract class Description
{
    public function __construct(
        protected ?Text\SimpleDocumentMarkdown $description,
    ) {
    }

    public function getDescription(): ?Text\SimpleDocumentMarkdown
    {
        return $this->description;
    }

    abstract public function getPrimitiveRepresentation(mixed $data): mixed;

    public function matches(mixed $data): bool
    {
        if ($this->getPrimitiveRepresentation($data) instanceof \Generator) {
            return false;
        }

        return true;
    }
}