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 ($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 ()
	Constructor. More...
	getType ()
	Get type (from class/instance) More...
	setAllowNull ($a_value)
	Toggle null allowed status. More...
	isNullAllowed ()
	Is null currently allowed. More...
	isComparableTo (ilADT $a_adt)
	Check if given ADT is comparable to self. More...

Protected Attributes
	$options
	$numeric
Protected Attributes inherited from ilADTDefinition
	$allow_null

Additional Inherited Members
	reset ()
	Init property defaults. More...

Detailed Description

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

Member Function Documentation

getADTInstance()

ilADTEnumDefinition::getADTInstance

(

)

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

        {
                if($this->isNumeric())
                {
                        $class = "ilADTEnumNumeric";
                }
                else
                {
                        $class = "ilADTEnumText";
                }
                include_once "Services/ADT/classes/Types/Enum/class.ilADTEnum.php";
                include_once "Services/ADT/classes/Types/Enum/class.".$class.".php";
                return new $class($this);
        }

References isNumeric().

Here is the call graph for this function:

getOptions()

ilADTEnumDefinition::getOptions

(

)

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

        {
                return $this->options;
        }

References $options.

getType()

ilADTEnumDefinition::getType

(

)

Get type (from class/instance)

Returns

string

Reimplemented from ilADTDefinition.

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

        {
                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 61 of file class.ilADTEnumDefinition.php.

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

isNumeric()

ilADTEnumDefinition::isNumeric

(

)

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

        {
                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 16 of file class.ilADTEnumDefinition.php.

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

References setNumeric().

Here is the call graph for this function:

setNumeric()

ilADTEnumDefinition::setNumeric

(

$a_value

)

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

        {
                $this->numeric = $a_value;              
        }

Referenced by reset().

Here is the caller graph for this function:

setOptions()

ilADTEnumDefinition::setOptions

(

array

$a_values

)

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

ilADTEnumDefinition::$numeric

protected

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

Referenced by isNumeric().

$options

ilADTEnumDefinition::$options

protected

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

Referenced by getOptions().

---

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

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