class.ilADTExternalLink.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilADTExternalLink extends ilADT
{
    public const MAX_LENGTH = 2000;

    protected ?string $value;
    protected ?string $title;

    protected function isValidDefinition(ilADTDefinition $a_def): bool
    {
        return $a_def instanceof ilADTExternalLinkDefinition;
    }

    public function reset(): void
    {
        parent::reset();
        $this->value = null;
        $this->title = null;
    }

    public function setTitle(?string $a_title = null): void
    {
        if ($a_title !== null) {
            $a_title = trim($a_title);
        }
        $this->title = $a_title;
    }

    public function getTitle(): ?string
    {
        return $this->title;
    }

    public function setUrl(?string $a_value = null): void
    {
        if ($a_value !== null) {
            $a_value = trim($a_value);
        }
        $this->value = $a_value;
    }

    public function getUrl(): ?string
    {
        return $this->value;
    }

    public function equals(ilADT $a_adt): ?bool
    {
        if ($this->getDefinition()->isComparableTo($a_adt)) {
            return strcmp($this->getCheckSum() ?? '', $a_adt->getCheckSum() ?? '') === 0;
        }
        return null;
    }

    public function isLarger(ilADT $a_adt): ?bool
    {
        return null;
    }

    public function isSmaller(ilADT $a_adt): ?bool
    {
        return null;
    }

    public function isNull(): bool
    {
        return !$this->getLength();
    }

    public function getLength(): int
    {
        if (function_exists("mb_strlen")) {
            return mb_strlen($this->getUrl() . $this->getTitle(), "UTF-8");
        } else {
            return strlen($this->getUrl() . $this->getTitle());
        }
    }

    public function isValid(): bool
    {
        $valid = parent::isValid();
        if (!$this->isNull()) {
            if (self::MAX_LENGTH < $this->getLength()) {
                $valid = false;
                $this->addValidationError(self::ADT_VALIDATION_ERROR_MAX_LENGTH);
            }
        }
        return $valid;
    }

    public function getCheckSum(): ?string
    {
        if (!$this->isNull()) {
            return md5($this->getUrl() . $this->getTitle());
        }
        return null;
    }

    public function exportStdClass(): ?stdClass
    {
        if (!$this->isNull()) {
            $obj = new stdClass();
            $obj->url = $this->getUrl();
            $obj->title = $this->getTitle();
            return $obj;
        }
        return null;
    }

    public function importStdClass(?stdClass $a_std): void
    {
        if (is_object($a_std)) {
            $this->setTitle($a_std->title);
            $this->setUrl($a_std->url);
        }
    }
}