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

Inheritance diagram for ilADTInternalLink:

Collaboration diagram for ilADTInternalLink:

Public Member Functions
	__construct (ilADTDefinition $a_def)

	reset ()
	Reset. More...

	setTargetRefId (?int $a_value)

	getTargetRefId ()

	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...

	isValid ()

	getCheckSum ()
	Get unique 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...

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
int	$value

ilTree	$tree

Protected Attributes inherited from ilADT
ilADTDefinition	$definition

ilLanguage	$lng

array	$validation_errors = []

Additional Inherited Members
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'

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.ilADTInternalLink.php.

Constructor & Destructor Documentation

◆ __construct()

ilADTInternalLink::__construct ( ilADTDefinition $a_def )

Reimplemented from ilADT.

Definition at line 27 of file class.ilADTInternalLink.php.

    {
        global $DIC;
        parent::__construct($a_def);
 
        $this->tree = $DIC->repositoryTree();
    }

References $DIC, and ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

◆ equals()

ilADTInternalLink::equals ( ilADT $a_adt )

Parameters

ilADT $a_adt

Returns: bool

Reimplemented from ilADT.

Definition at line 70 of file class.ilADTInternalLink.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()

ilADTInternalLink::exportStdClass ( )

@inheritDoc

Reimplemented from ilADT.

Definition at line 123 of file class.ilADTInternalLink.php.

                                    : ?stdClass
    {
        if (!$this->isNull()) {
            $obj = new stdClass();
            $obj->target_ref_id = $this->getTargetRefId();
 
            return $obj;
        }
        return null;
    }

References getTargetRefId(), and isNull().

Here is the call graph for this function:

◆ getCheckSum()

ilADTInternalLink::getCheckSum ( )

Get unique checksum.

Returns: string | null

Reimplemented from ilADT.

Definition at line 112 of file class.ilADTInternalLink.php.

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

References getTargetRefId(), and isNull().

Referenced by equals().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTargetRefId()

ilADTInternalLink::getTargetRefId ( )

Returns: int|null get target ref_id

Definition at line 61 of file class.ilADTInternalLink.php.

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

References $value.

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

Here is the caller graph for this function:

◆ importStdClass()

ilADTInternalLink::importStdClass ( ?stdClass $a_std )

@inheritDoc

Reimplemented from ilADT.

Definition at line 137 of file class.ilADTInternalLink.php.

                                                    : void
    {
        if (is_object($a_std)) {
            $this->setTargetRefId($a_std->target_ref_id);
        }
    }

References setTargetRefId().

Here is the call graph for this function:

◆ isLarger()

ilADTInternalLink::isLarger ( ilADT $a_adt )

Check if given ADT is larger than self.

Parameters

ilADT $a_adt

Returns: bool

Reimplemented from ilADT.

Definition at line 78 of file class.ilADTInternalLink.php.

                                          : ?bool
    {
        return null;
    }

◆ isNull()

ilADTInternalLink::isNull ( )

is null

Returns: bool

Reimplemented from ilADT.

Definition at line 92 of file class.ilADTInternalLink.php.

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

References getTargetRefId().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isSmaller()

ilADTInternalLink::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 83 of file class.ilADTInternalLink.php.

                                           : ?bool
    {
        return null;
    }

◆ isValid()

ilADTInternalLink::isValid ( )

Reimplemented from ilADT.

Definition at line 97 of file class.ilADTInternalLink.php.

                             : bool
    {
        $valid = parent::isValid();
        if (!$this->isNull()) {
            if (
                !$this->tree->isInTree($this->getTargetRefId()) ||
                $this->tree->isDeleted($this->getTargetRefId())
            ) {
                $valid = false;
                $this->addValidationError(self::ADT_VALIDATION_ERROR_INVALID_NODE);
            }
        }
        return $valid;
    }

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

Here is the call graph for this function:

◆ isValidDefinition()

ilADTInternalLink::isValidDefinition ( ilADTDefinition $a_def )

protected

Parameters

ilADTDefinition $a_def

Returns: bool

Reimplemented from ilADT.

Definition at line 39 of file class.ilADTInternalLink.php.

                                                                : bool
    {
        return $a_def instanceof ilADTInternalLinkDefinition;
    }

◆ reset()

ilADTInternalLink::reset ( )

Reset.

Reimplemented from ilADT.

Definition at line 47 of file class.ilADTInternalLink.php.

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

◆ setTargetRefId()

ilADTInternalLink::setTargetRefId ( ?int $a_value )

Definition at line 53 of file class.ilADTInternalLink.php.

                                                 : void
    {
        $this->value = $a_value;
    }

Referenced by importStdClass().

Here is the caller graph for this function:

Field Documentation

◆ $tree

ilTree ilADTInternalLink::$tree

protected

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

◆ $value

int ilADTInternalLink::$value

protected

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

Referenced by getTargetRefId().

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

Services/ADT/classes/Types/InternalLink/class.ilADTInternalLink.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ equals()

◆ exportStdClass()

◆ getCheckSum()

◆ getTargetRefId()

◆ importStdClass()

◆ isLarger()

◆ isNull()

◆ isSmaller()

◆ isValid()

◆ isValidDefinition()

◆ reset()

◆ setTargetRefId()

Field Documentation

◆ $tree

◆ $value