ilADTEnum Class Reference

Inheritance diagram for ilADTEnum:

Collaboration diagram for ilADTEnum:

Public Member Functions
	reset ()
	setSelection ($a_value=null)
	getSelection ()
	isValidOption ($a_value)
	equals (ilADT $a_adt)
	isLarger (ilADT $a_adt)
	isSmaller (ilADT $a_adt)
	isNull ()
	getCheckSum ()
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)
	handleSelectionValue ($a_value)
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.ilADTEnum.php.

Member Function Documentation

equals()

ilADTEnum::equals

(

ilADT

$a_adt

)

Definition at line 52 of file class.ilADTEnum.php.

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

    {
        if ($this->getDefinition()->isComparableTo($a_adt)) {
            return ($this->getSelection() === $a_adt->getSelection());
        }
    }

Here is the call graph for this function:

getCheckSum()

ilADTEnum::getCheckSum

(

)

Definition at line 80 of file class.ilADTEnum.php.

References getSelection(), and isNull().

    {
        if (!$this->isNull()) {
            return (string) $this->getSelection();
        }
    }

Here is the call graph for this function:

getSelection()

ilADTEnum::getSelection

(

)

Definition at line 38 of file class.ilADTEnum.php.

References $value.

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

    {
        return $this->value;
    }

Here is the caller graph for this function:

handleSelectionValue()

ilADTEnum::handleSelectionValue (   $a_value )

abstractprotected

Referenced by isValidOption(), reset(), and setSelection().

Here is the caller graph for this function:

isLarger()

ilADTEnum::isLarger

(

ilADT

$a_adt

)

Definition at line 59 of file class.ilADTEnum.php.

    {
        // return null?
    }

isNull()

ilADTEnum::isNull

(

)

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

References getSelection().

Referenced by getCheckSum().

    {
        return ($this->getSelection() === null);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isSmaller()

ilADTEnum::isSmaller

(

ilADT

$a_adt

)

Definition at line 64 of file class.ilADTEnum.php.

    {
        // return null?
    }

isValidDefinition()

ilADTEnum::isValidDefinition ( ilADTDefinition  $a_def )

protected

Definition at line 10 of file class.ilADTEnum.php.

    {
        return ($a_def instanceof ilADTEnumDefinition);
    }

isValidOption()

ilADTEnum::isValidOption

(

$a_value

)

Definition at line 43 of file class.ilADTEnum.php.

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

Referenced by setSelection().

    {
        $a_value = $this->handleSelectionValue($a_value);
        return array_key_exists($a_value, $this->getDefinition()->getOptions());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

reset()

ilADTEnum::reset

(

)

Definition at line 15 of file class.ilADTEnum.php.

References handleSelectionValue().

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

Here is the call graph for this function:

setSelection()

ilADTEnum::setSelection

(

$a_value = null

)

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

References handleSelectionValue(), and isValidOption().

    {
        if ($a_value !== null) {
            $a_value = $this->handleSelectionValue($a_value);
            if (!$this->isValidOption($a_value)) {
                $a_value = null;
            }
        }
        $this->value = $a_value;
    }

Here is the call graph for this function:

Field Documentation

$value

ilADTEnum::$value

protected

Definition at line 5 of file class.ilADTEnum.php.

Referenced by getSelection().

---

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

• Services/ADT/classes/Types/Enum/class.ilADTEnum.php