Inheritance diagram for ilADTGroup:

Collaboration diagram for ilADTGroup:

Public Member Functions
	__clone ()

	reset ()
	Init property defaults. More...

	hasElement ($a_name)

	getElement ($a_name)

	getElements ()

	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...

	getValidationErrorsByElements ()

	getValidationErrors ()
	Get all validation error codes. More...

	isValid ()
	Is currently valid. More...

	translateErrorCode ($a_code)
	Translate error-code to human-readable message. More...

	getCheckSum ()
	Get unique checksum. More...

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)
	Check if definition is valid for ADT. More...

	setDefinition (ilADTDefinition $a_def)
	Set definition. More...

	addElement ($a_name, ilADTDefinition $a_def)

	addElementValidationError ($a_element_id, $a_error_code)

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

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.ilADTGroup.php.

Member Function Documentation

◆ __clone()

ilADTGroup::__clone ( )

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

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

References $id.

◆ addElement()

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

protected

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

    {
        $this->elements[$a_name] = ilADTFactory::getInstance()->getInstanceByDefinition($a_def);
    }

References ilADTFactory\getInstance().

Referenced by setDefinition().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addElementValidationError()

ilADTGroup::addElementValidationError	(	$a_element_id,
		$a_error_code
	)

protected

Definition at line 117 of file class.ilADTGroup.php.

    {
        $this->validation_errors[(string) $a_error_code] = $a_element_id;
    }

Referenced by isValid().

Here is the caller graph for this function:

◆ equals()

ilADTGroup::equals ( ilADT $a_adt )

Check if given ADT equals self.

Parameters

ilADT $a_adt

Returns: bool

Reimplemented from ilADT.

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

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

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

Here is the call graph for this function:

◆ getCheckSum()

ilADTGroup::getCheckSum ( )

Get unique checksum.

Returns: string

Reimplemented from ilADT.

Definition at line 154 of file class.ilADTGroup.php.

    {
        if (!$this->isNull()) {
            $tmp = array();
            foreach ($this->getElements() as $element) {
                $tmp[] = $element->getCheckSum();
            }
            return md5(implode(",", $tmp));
        }
    }

References getElements(), and isNull().

Referenced by equals().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getElement()

ilADTGroup::getElement ( $a_name )

Definition at line 63 of file class.ilADTGroup.php.

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

References hasElement().

Referenced by translateErrorCode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getElements()

ilADTGroup::getElements ( )

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

    {
        return $this->elements;
    }

References $elements.

Referenced by getCheckSum(), isNull(), isValid(), reset(), and setDefinition().

Here is the caller graph for this function:

◆ getValidationErrors()

ilADTGroup::getValidationErrors ( )

Get all validation error codes.

See also: isValid()

Returns: array

Reimplemented from ilADT.

Definition at line 112 of file class.ilADTGroup.php.

    {
        return array_keys((array) $this->validation_errors);
    }

◆ getValidationErrorsByElements()

ilADTGroup::getValidationErrorsByElements ( )

Definition at line 107 of file class.ilADTGroup.php.

    {
        return (array) $this->validation_errors;
    }

References ilADT\$validation_errors.

◆ hasElement()

ilADTGroup::hasElement ( $a_name )

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

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

Referenced by getElement().

Here is the caller graph for this function:

◆ isLarger()

ilADTGroup::isLarger ( ilADT $a_adt )

Check if given ADT is larger than self.

Parameters

ilADT $a_adt

Returns: bool

Reimplemented from ilADT.

Definition at line 86 of file class.ilADTGroup.php.

    {
        // return null?
    }

◆ isNull()

ilADTGroup::isNull ( )

Is currently null.

Returns: bool

Reimplemented from ilADT.

Definition at line 99 of file class.ilADTGroup.php.

    {
        return !sizeof($this->getElements());
    }

References getElements().

Referenced by getCheckSum(), and isValid().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isSmaller()

ilADTGroup::isSmaller ( ilADT $a_adt )

Check if given ADT is smaller than self.

Parameters

ilADT $a_adt

Returns: bool

Reimplemented from ilADT.

Definition at line 91 of file class.ilADTGroup.php.

    {
        // return null?
    }

◆ isValid()

ilADTGroup::isValid ( )

Is currently valid.

Returns: boolean

Reimplemented from ilADT.

Definition at line 122 of file class.ilADTGroup.php.

    {
        $valid = parent::isValid();
        
        if (!$this->isNull()) {
            foreach ($this->getElements() as $element_id => $element) {
                if (!$element->isValid()) {
                    foreach ($element->getValidationErrors() as $error) {
                        $this->addElementValidationError($element_id, $error);
                    }
                    $valid = false;
                }
            }
        }
            
        return $valid;
    }

References $error, $valid, addElementValidationError(), getElements(), and isNull().

Here is the call graph for this function:

◆ isValidDefinition()

ilADTGroup::isValidDefinition ( ilADTDefinition $a_def )

protected

Check if definition is valid for ADT.

Returns: bool;

Reimplemented from ilADT.

Definition at line 19 of file class.ilADTGroup.php.

    {
        return ($a_def instanceof ilADTGroupDefinition);
    }

◆ reset()

ilADTGroup::reset ( )

Init property defaults.

Reimplemented from ilADT.

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

    {
        parent::reset();
        
        $elements = $this->getElements();
        if (is_array($elements)) {
            foreach ($elements as $element) {
                $element->reset();
            }
        }
    }

References $elements, and getElements().

Here is the call graph for this function:

◆ setDefinition()

ilADTGroup::setDefinition ( ilADTDefinition $a_def )

protected

Set definition.

Exceptions

ilException

Parameters

ilADTDefinition $a_def

Reimplemented from ilADT.

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

    {
        parent::setDefinition($a_def);
        
        $this->elements = array();
        
        foreach ($this->getDefinition()->getElements() as $name => $def) {
            $this->addElement($name, $def);
        }
    }

References $def, $name, addElement(), ilADT\getDefinition(), and getElements().

Here is the call graph for this function:

◆ translateErrorCode()

ilADTGroup::translateErrorCode ( $a_code )

Translate error-code to human-readable message.

Exceptions

Exception

Parameters

int $a_code

Returns: string

Reimplemented from ilADT.

Definition at line 140 of file class.ilADTGroup.php.

    {
        if (isset($this->validation_errors[$a_code])) {
            $element_id = $this->validation_errors[$a_code];
            $element = $this->getElement($element_id);
            if ($element) {
                return $element->translateErrorCode($a_code);
            }
        }
    }

References getElement().

Here is the call graph for this function:

Field Documentation

◆ $elements

ilADTGroup::$elements

protected

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

Referenced by getElements(), and reset().

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

Services/ADT/classes/Types/Group/class.ilADTGroup.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ __clone()

◆ addElement()

◆ addElementValidationError()

◆ equals()

◆ getCheckSum()

◆ getElement()

◆ getElements()

◆ getValidationErrors()

◆ getValidationErrorsByElements()

◆ hasElement()

◆ isLarger()

◆ isNull()

◆ isSmaller()

◆ isValid()

◆ isValidDefinition()

◆ reset()

◆ setDefinition()

◆ translateErrorCode()

Field Documentation

◆ $elements