ilADTInternalLink Class Reference

Inheritance diagram for ilADTInternalLink:

Collaboration diagram for ilADTInternalLink:

Public Member Functions
	reset ()
	Reset. More...
	setTargetRefId ($a_value)
	Set id of target object. More...
	getTargetRefId ()
	equals (ilADT $a_adt)
	isLarger (ilADT $a_adt)
	Is larger. More...
	isSmaller (ilADT $a_adt)
	Is smaller. More...
	isNull ()
	is null More...
	isValid ()
	is valid More...
	getCheckSum ()
	get checksum More...
Public Member Functions inherited from ilADT
	__construct (ilADTDefinition $a_def)
	Constructor. More...
	getType ()
	Get type (from class/instance) 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)
	Check if given ADT is larger or equal than self. More...
	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 ()
	Is currently valid. More...
	getValidationErrors ()
	Get all validation error codes. More...
	translateErrorCode ($a_code)
	Translate error-code to human-readable message. More...
	getCheckSum ()
	Get unique checksum. More...

Protected Member Functions
	isValidDefinition (ilADTDefinition $a_def)
Protected Member Functions inherited from ilADT
	reset ()
	Init property defaults. More...
	isValidDefinition (ilADTDefinition $a_def)
	Check if definition is valid for ADT. More...
	setDefinition (ilADTDefinition $a_def)
	Set definition. More...
	getDefinition ()
	Get definition. More...
	addValidationError ($a_error_code)
	Add validation error code. More...

Protected Attributes
	$value
Protected Attributes inherited from ilADT
	$definition
	$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

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

Member Function Documentation

equals()

ilADTInternalLink::equals

(

ilADT

$a_adt

)

Parameters

ilADT

$a_adt

Returns

type

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

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

    {
        if ($this->getDefinition()->isComparableTo($a_adt)) {
            return strcmp($this->getCheckSum(), $a_adt->getCheckSum()) === 0;
        }
    }

Here is the call graph for this function:

getCheckSum()

ilADTInternalLink::getCheckSum

(

)

get checksum

Returns

string

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

References getTargetRefId(), and isNull().

Referenced by equals().

    {
        if (!$this->isNull()) {
            return md5($this->getTargetRefId());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTargetRefId()

ilADTInternalLink::getTargetRefId

(

)

Returns

int get target ref_id

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

References $value.

Referenced by getCheckSum(), and isNull().

    {
        return $this->value;
    }

Here is the caller graph for this function:

isLarger()

ilADTInternalLink::isLarger

(

ilADT

$a_adt

)

Is larger.

Parameters

ilADT

$a_adt

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

    {
    }

isNull()

ilADTInternalLink::isNull

(

)

is null

Returns

bool

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

References getTargetRefId().

Referenced by getCheckSum(), and isValid().

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

Here is the call graph for this function:

Here is the caller graph for this function:

isSmaller()

ilADTInternalLink::isSmaller

(

ilADT

$a_adt

)

Is smaller.

Parameters

ilADT

$a_adt

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

    {
    }

isValid()

ilADTInternalLink::isValid

(

)

is valid

Returns

boolean

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

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

    {
        $valid = parent::isValid();
        if (!$this->isNull()) {
            $tree = $GLOBALS['DIC']->repositoryTree();
            if (
                !$tree->isInTree($this->getTargetRefId()) ||
                $tree->isDeleted($this->getTargetRefId())
            ) {
                $this->valid = false;
                $this->addValidationError(self::ADT_VALIDATION_ERROR_INVALID_NODE);
            }
        }
        return $valid;
    }

Here is the call graph for this function:

isValidDefinition()

ilADTInternalLink::isValidDefinition ( ilADTDefinition  $a_def )

protected

Parameters

ilADTDefinition

$a_def

Returns

bool

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

    {
        return $a_def instanceof ilADTInternalLinkDefinition;
    }

reset()

ilADTInternalLink::reset

(

)

Reset.

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

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

setTargetRefId()

ilADTInternalLink::setTargetRefId

(

$a_value

)

Set id of target object.

Parameters

type

$a_value

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

    {
        $this->value = $a_value;
    }

Field Documentation

$value

ilADTInternalLink::$value

protected

Definition at line 8 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