ilADTEnumDefinition Class Reference

Inheritance diagram for ilADTEnumDefinition:

Collaboration diagram for ilADTEnumDefinition:

Public Member Functions
	getType ()
	Get type (from class/instance) More...
	reset ()
	Init property defaults. More...
	isNumeric ()
	setNumeric (bool $a_value)
	getOptions ()
	setOptions (array $a_values)
	isComparableTo (ilADT $a_adt)
	Check if given ADT is comparable to self. More...
	getADTInstance ()
Public Member Functions inherited from ilADTDefinition
	__construct ()
	getType ()
	Get type (from class/instance) More...
	reset ()
	Init property defaults. More...
	setAllowNull (bool $a_value)
	Toggle null allowed status. More...
	isNullAllowed ()
	isComparableTo (ilADT $a_adt)
	Check if given ADT is comparable to self. More...

Protected Attributes
array	$options = []
bool	$numeric
Protected Attributes inherited from ilADTDefinition
bool	$allow_null

Detailed Description

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

Member Function Documentation

getADTInstance()

ilADTEnumDefinition::getADTInstance

(

)

Definition at line 79 of file class.ilADTEnumDefinition.php.

                                    : ilADTEnum
    {
        if ($this->isNumeric()) {
            $class = "ilADTEnumNumeric";
        } else {
            $class = "ilADTEnumText";
        }
        return new $class($this);
    }

References isNumeric().

Here is the call graph for this function:

getOptions()

ilADTEnumDefinition::getOptions

(

)

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

                                : array
    {
        return $this->options;
    }

References $options.

getType()

ilADTEnumDefinition::getType

(

)

Get type (from class/instance)

Returns

string

Reimplemented from ilADTDefinition.

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

                             : string
    {
        return "Enum";
    }

isComparableTo()

ilADTEnumDefinition::isComparableTo

(

ilADT

$a_adt

)

Check if given ADT is comparable to self.

Parameters

ilADT

$a_adt

Returns

bool

Reimplemented from ilADTDefinition.

Definition at line 73 of file class.ilADTEnumDefinition.php.

                                                : bool
    {
        // has to be enum-based
        return ($a_adt instanceof ilADTEnum);
    }

isNumeric()

ilADTEnumDefinition::isNumeric

(

)

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

                               : bool
    {
        return $this->numeric;
    }

References $numeric.

Referenced by getADTInstance(), and setOptions().

Here is the caller graph for this function:

reset()

ilADTEnumDefinition::reset

(

)

Init property defaults.

Reimplemented from ilADTDefinition.

Definition at line 33 of file class.ilADTEnumDefinition.php.

                           : void
    {
        parent::reset();
 
        $this->options = array();
        $this->setNumeric(true);
    }

References setNumeric().

Here is the call graph for this function:

setNumeric()

ilADTEnumDefinition::setNumeric

(

bool

$a_value

)

Definition at line 48 of file class.ilADTEnumDefinition.php.

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

Referenced by reset().

Here is the caller graph for this function:

setOptions()

ilADTEnumDefinition::setOptions

(

array

$a_values

)

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

    {
        if ($this->isNumeric()) {
            foreach (array_keys($a_values) as $key) {
                if (!is_numeric($key)) {
                    throw new Exception("ilADTEnum was expecting numeric option keys");
                }
            }
        }
 
        $this->options = $a_values;
    }

References isNumeric().

Here is the call graph for this function:

Field Documentation

$numeric

bool ilADTEnumDefinition::$numeric

protected

Definition at line 24 of file class.ilADTEnumDefinition.php.

Referenced by isNumeric().

$options

array ilADTEnumDefinition::$options = []

protected

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

Referenced by getOptions().

---

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

• components/ILIAS/ADT/classes/Types/Enum/class.ilADTEnumDefinition.php