This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilADTExternalLink:

Collaboration diagram for ilADTExternalLink:

Public Member Functions
	reset ()
	Reset. More...

	setTitle (?string $a_title=null)
	Set title. More...

	getTitle ()
	Get title. More...

	setUrl (?string $a_value=null)
	Set url. More...

	getUrl ()
	Get url. More...

	equals (ilADT $a_adt)

	isLarger (ilADT $a_adt)
	Check if given ADT is larger than self. More...

	isSmaller (ilADT $a_adt)
	Check if given ADT is smaller than self. More...

	isNull ()
	is null More...

	getLength ()
	Get length. More...

	isValid ()

	getCheckSum ()
	get checksum More...

	exportStdClass ()
	@inheritDoc More...

	importStdClass (?stdClass $a_std)
	@inheritDoc More...

Public Member Functions inherited from ilADT
	__construct (ilADTDefinition $a_def)

	getType ()
	Get type (from class/instance) More...

	reset ()
	Init property defaults. More...

	getCopyOfDefinition ()
	Get copy of definition. More...

	equals (ilADT $a_adt)
	Check if given ADT equals self. More...

	isLarger (ilADT $a_adt)
	Check if given ADT is larger than self. More...

	isLargerOrEqual (ilADT $a_adt)

	isSmaller (ilADT $a_adt)
	Check if given ADT is smaller than self. More...

	isSmallerOrEqual (ilADT $a_adt)
	Check if given ADT is smaller or equal than self. More...

	isInbetween (ilADT $a_adt_from, ilADT $a_adt_to)
	Check if self is inbetween given ADTs (exclusive) More...

	isInbetweenOrEqual (ilADT $a_adt_from, ilADT $a_adt_to)
	Check if self is inbetween given ADTs (inclusive) More...

	isNull ()
	Is currently null. More...

	isValid ()

	getValidationErrors ()
	Get all validation error codes. More...

	translateErrorCode (string $a_code)
	Translate error-code to human-readable message. More...

	getCheckSum ()
	Get unique checksum. More...

	exportStdClass ()
	Export value as stdClass. More...

	importStdClass (?stdClass $a_std)
	Import value from stdClass. More...

Data Fields
const	MAX_LENGTH = 2000

Data Fields inherited from ilADT
const	ADT_VALIDATION_ERROR_NULL_NOT_ALLOWED = "adt1"

const	ADT_VALIDATION_ERROR_MAX_LENGTH = "adt2"

const	ADT_VALIDATION_ERROR_MAX_SIZE = "adt3"

const	ADT_VALIDATION_ERROR_MIN = "adt4"

const	ADT_VALIDATION_ERROR_MAX = "adt5"

const	ADT_VALIDATION_DATE = "adt6"

const	ADT_VALIDATION_ERROR_INVALID_NODE = 'adt7'

Protected Member Functions
	isValidDefinition (ilADTDefinition $a_def)

Protected Member Functions inherited from ilADT
	isValidDefinition (ilADTDefinition $a_def)
	Check if definition is valid for ADT. More...

	setDefinition (ilADTDefinition $a_def)
	Set definition. More...

	getDefinition ()
	Get definition. More...

	addValidationError (string $a_error_code)

Protected Attributes
string	$value

string	$title

Protected Attributes inherited from ilADT
ilADTDefinition	$definition

ilLanguage	$lng

array	$validation_errors = []

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Definition at line 21 of file class.ilADTExternalLink.php.

Member Function Documentation

◆ equals()

ilADTExternalLink::equals ( ilADT $a_adt )

Parameters

ilADT $a_adt

Returns: bool

Reimplemented from ilADT.

Definition at line 93 of file class.ilADTExternalLink.php.

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

References ilADT\getCheckSum(), getCheckSum(), and ilADT\getDefinition().

Here is the call graph for this function:

◆ exportStdClass()

ilADTExternalLink::exportStdClass ( )

@inheritDoc

Reimplemented from ilADT.

Definition at line 160 of file class.ilADTExternalLink.php.

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

References getTitle(), getUrl(), and isNull().

Here is the call graph for this function:

◆ getCheckSum()

ilADTExternalLink::getCheckSum ( )

get checksum

Returns: string

Reimplemented from ilADT.

Definition at line 149 of file class.ilADTExternalLink.php.

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

References getTitle(), getUrl(), and isNull().

Referenced by equals().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLength()

ilADTExternalLink::getLength ( )

Get length.

Returns: int

Definition at line 124 of file class.ilADTExternalLink.php.

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

References getTitle(), and getUrl().

Referenced by isNull(), and isValid().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTitle()

ilADTExternalLink::getTitle ( )

Get title.

Returns: string|null

Definition at line 63 of file class.ilADTExternalLink.php.

                              : ?string
    {
        return $this->title;
    }

References $title.

Referenced by exportStdClass(), getCheckSum(), and getLength().

Here is the caller graph for this function:

◆ getUrl()

ilADTExternalLink::getUrl ( )

Get url.

Returns: string|null

Definition at line 84 of file class.ilADTExternalLink.php.

                            : ?string
    {
        return $this->value;
    }

References $value.

Referenced by exportStdClass(), getCheckSum(), and getLength().

Here is the caller graph for this function:

◆ importStdClass()

ilADTExternalLink::importStdClass ( ?stdClass $a_std )

@inheritDoc

Reimplemented from ilADT.

Definition at line 174 of file class.ilADTExternalLink.php.

                                                    : void
    {
        if (is_object($a_std)) {
            $this->setTitle($a_std->title);
            $this->setUrl($a_std->url);
        }
    }

References setTitle(), and setUrl().

Here is the call graph for this function:

◆ isLarger()

ilADTExternalLink::isLarger ( ilADT $a_adt )

Check if given ADT is larger than self.

Parameters

ilADT $a_adt

Returns: bool

Reimplemented from ilADT.

Definition at line 101 of file class.ilADTExternalLink.php.

                                          : ?bool
    {
        return null;
    }

◆ isNull()

ilADTExternalLink::isNull ( )

is null

Returns: bool

Reimplemented from ilADT.

Definition at line 115 of file class.ilADTExternalLink.php.

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

References getLength().

Referenced by exportStdClass(), getCheckSum(), and isValid().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isSmaller()

ilADTExternalLink::isSmaller ( ilADT $a_adt )

Check if given ADT is smaller than self.

Parameters

ilADT $a_adt

Returns: bool | null

Reimplemented from ilADT.

Definition at line 106 of file class.ilADTExternalLink.php.

                                           : ?bool
    {
        return null;
    }

◆ isValid()

ilADTExternalLink::isValid ( )

Reimplemented from ilADT.

Definition at line 133 of file class.ilADTExternalLink.php.

                             : 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;
    }

References $valid, ilADT\addValidationError(), getLength(), and isNull().

Here is the call graph for this function:

◆ isValidDefinition()

ilADTExternalLink::isValidDefinition ( ilADTDefinition $a_def )

protected

Parameters

ilADTDefinition $a_def

Returns: bool

Reimplemented from ilADT.

Definition at line 32 of file class.ilADTExternalLink.php.

                                                                : bool
    {
        return $a_def instanceof ilADTExternalLinkDefinition;
    }

◆ reset()

ilADTExternalLink::reset ( )

Reset.

Reimplemented from ilADT.

Definition at line 40 of file class.ilADTExternalLink.php.

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

◆ setTitle()

ilADTExternalLink::setTitle ( ?string $a_title = null )

Set title.

Parameters

string | null $a_title

Definition at line 51 of file class.ilADTExternalLink.php.

                                                     : void
    {
        if ($a_title !== null) {
            $a_title = trim($a_title);
        }
        $this->title = $a_title;
    }

Referenced by importStdClass().

Here is the caller graph for this function:

◆ setUrl()

ilADTExternalLink::setUrl ( ?string $a_value = null )

Set url.

Parameters

string | null $a_value

Definition at line 72 of file class.ilADTExternalLink.php.

                                                   : void
    {
        if ($a_value !== null) {
            $a_value = trim($a_value);
        }
        $this->value = $a_value;
    }

Referenced by importStdClass().

Here is the caller graph for this function:

Field Documentation

◆ $title

string ilADTExternalLink::$title

protected

Definition at line 26 of file class.ilADTExternalLink.php.

Referenced by getTitle().

◆ $value

string ilADTExternalLink::$value

protected

Definition at line 25 of file class.ilADTExternalLink.php.

Referenced by getUrl().

◆ MAX_LENGTH

const ilADTExternalLink::MAX_LENGTH = 2000

Definition at line 23 of file class.ilADTExternalLink.php.

The documentation for this class was generated from the following file:

Services/ADT/classes/Types/ExternalLink/class.ilADTExternalLink.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ equals()

◆ exportStdClass()

◆ getCheckSum()

◆ getLength()

◆ getTitle()

◆ getUrl()

◆ importStdClass()

◆ isLarger()

◆ isNull()

◆ isSmaller()

◆ isValid()

◆ isValidDefinition()

◆ reset()

◆ setTitle()

◆ setUrl()

Field Documentation

◆ $title

◆ $value

◆ MAX_LENGTH