Inheritance diagram for ilADTEnum:

Collaboration diagram for ilADTEnum:

Public Member Functions
	reset ()
	Init property defaults. More...

	setSelection ($a_value=null)

	getSelection ()

	isValidOption ($a_value)

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

	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 currently null. More...

	getCheckSum ()
	Get unique checksum. More...

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

	importStdClass (?stdClass $a_std)
	Import value from stdClass. 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)
	Check if definition is valid for ADT. More...

	handleSelectionValue ($a_value)

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

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

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

Member Function Documentation

◆ equals()

ilADTEnum::equals ( ilADT $a_adt )

Check if given ADT equals self.

Parameters

ilADT $a_adt

Returns: bool|null

Reimplemented from ilADT.

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

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

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

Here is the call graph for this function:

◆ exportStdClass()

ilADTEnum::exportStdClass ( )

Export value as stdClass.

Returns: stdClass | null

Reimplemented from ilADT.

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

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

References getSelection(), and isNull().

Here is the call graph for this function:

◆ getCheckSum()

ilADTEnum::getCheckSum ( )

Get unique checksum.

Returns: string | null

Reimplemented from ilADT.

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

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

References getSelection(), and isNull().

Here is the call graph for this function:

◆ getSelection()

ilADTEnum::getSelection ( )

Returns: mixed

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

    {
        return $this->value;
    }

References $value.

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

Here is the caller graph for this function:

◆ handleSelectionValue()

ilADTEnum::handleSelectionValue ( $a_value )

abstractprotected

Parameters

string | int $a_value

Returns: string|int

Reimplemented in ilADTEnumNumeric, and ilADTEnumText.

Referenced by isValidOption(), and setSelection().

Here is the caller graph for this function:

◆ importStdClass()

ilADTEnum::importStdClass ( ?stdClass $a_std )

Import value from stdClass.

Parameters

stdClass | null $a_std

Reimplemented from ilADT.

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

                                                    : void
    {
        if (is_object($a_std)) {
            $this->setSelection($a_std->value);
        }
    }

References setSelection().

Here is the call graph for this function:

◆ isLarger()

ilADTEnum::isLarger ( ilADT $a_adt )

Check if given ADT is larger than self.

Parameters

ilADT $a_adt

Returns: bool

Reimplemented from ilADT.

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

                                          : ?bool
    {
        return null;
    }

◆ isNull()

ilADTEnum::isNull ( )

Is currently null.

Returns: bool | null

Reimplemented from ilADT.

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

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

References getSelection().

Referenced by exportStdClass(), and getCheckSum().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isSmaller()

ilADTEnum::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 71 of file class.ilADTEnum.php.

                                           : ?bool
    {
        return null;
    }

◆ isValidDefinition()

ilADTEnum::isValidDefinition ( ilADTDefinition $a_def )

protected

Check if definition is valid for ADT.

Parameters

ilADTDefinition $a_def

Returns: bool

Reimplemented from ilADT.

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

                                                                : bool
    {
        return ($a_def instanceof ilADTEnumDefinition);
    }

◆ isValidOption()

ilADTEnum::isValidOption ( $a_value )

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

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

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

Referenced by setSelection().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reset()

ilADTEnum::reset ( )

Init property defaults.

Reimplemented from ilADT.

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

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

◆ setSelection()

ilADTEnum::setSelection ( $a_value = null )

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

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

References handleSelectionValue(), and isValidOption().

Referenced by importStdClass().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $value

ilADTEnum::$value

protected

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ equals()

◆ exportStdClass()

◆ getCheckSum()

◆ getSelection()

◆ handleSelectionValue()

◆ importStdClass()

◆ isLarger()

◆ isNull()

◆ isSmaller()

◆ isValidDefinition()

◆ isValidOption()

◆ reset()

◆ setSelection()

Field Documentation

◆ $value