ilADTGroupDefinition Class Reference

Inheritance diagram for ilADTGroupDefinition:

Collaboration diagram for ilADTGroupDefinition:

Public Member Functions
	__clone ()
	reset ()
	Init property defaults. More...
	addElement ($a_name, ilADTDefinition $a_def)
	hasElement ($a_name)
	getElement (string $a_name)
	getElements ()
	isComparableTo (ilADT $a_adt)
	Check if given ADT is comparable to self. More...
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	$elements = []
Protected Attributes inherited from ilADTDefinition
bool	$allow_null

Detailed Description

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

Member Function Documentation

__clone()

ilADTGroupDefinition::__clone

(

)

Definition at line 9 of file class.ilADTGroupDefinition.php.

    {
        if (is_array($this->elements)) {
            foreach ($this->elements as $id => $element) {
                $this->elements[$id] = clone $element;
            }
        }
    }

References $id.

addElement()

ilADTGroupDefinition::addElement	(		$a_name,
		ilADTDefinition	$a_def
	)

Definition at line 28 of file class.ilADTGroupDefinition.php.

                                                               : void
    {
        $this->elements[$a_name] = $a_def;
    }

getElement()

ilADTGroupDefinition::getElement

(

string

$a_name

)

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

                                              : ?ilADTDefinition
    {
        if ($this->hasElement($a_name)) {
            return $this->elements[$a_name];
        }
        return null;
    }

References hasElement().

Here is the call graph for this function:

getElements()

ilADTGroupDefinition::getElements

(

)

Definition at line 46 of file class.ilADTGroupDefinition.php.

                                 : array
    {
        return $this->elements;
    }

References $elements.

hasElement()

ilADTGroupDefinition::hasElement

(

$a_name

)

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

                                       : bool
    {
        return array_key_exists($a_name, $this->elements);
    }

Referenced by getElement().

Here is the caller graph for this function:

isComparableTo()

ilADTGroupDefinition::isComparableTo

(

ilADT

$a_adt

)

Check if given ADT is comparable to self.

Parameters

ilADT

$a_adt

Returns

bool

Reimplemented from ilADTDefinition.

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

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

reset()

ilADTGroupDefinition::reset

(

)

Init property defaults.

Reimplemented from ilADTDefinition.

Definition at line 20 of file class.ilADTGroupDefinition.php.

                           : void
    {
        parent::reset();
        $this->elements = array();
    }

Field Documentation

$elements

array ilADTGroupDefinition::$elements = []

protected

Definition at line 7 of file class.ilADTGroupDefinition.php.

Referenced by getElements().

---

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

• Services/ADT/classes/Types/Group/class.ilADTGroupDefinition.php