Inheritance diagram for ilADTGroup:

Collaboration diagram for ilADTGroup:

Public Member Functions
	__clone ()

	reset ()
	Init property defaults. More...

	hasElement (string $a_name)

	getElement (string $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 ()
	@inheritcoc More...

	isValid ()

	translateErrorCode (string $a_code)
	@inheritcoc 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...

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

	addElement (string $a_name, ilADTDefinition $a_def)

	addElementValidationError (string $a_element_id, string $a_error_code)

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
array	$elements = []

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

Member Function Documentation

◆ __clone()

ilADTGroup::__clone ( )

Definition at line 9 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	(	string	$a_name,
		ilADTDefinition	$a_def
	)

protected

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

                                                                         : void
    {
        $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	(	string	$a_element_id,
		string	$a_error_code
	)

protected

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

                                                                                            : void
    {
        $this->validation_errors[$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|null

Reimplemented from ilADT.

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

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

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

Here is the call graph for this function:

◆ exportStdClass()

ilADTGroup::exportStdClass ( )

Export value as stdClass.

Returns: stdClass | null

Reimplemented from ilADT.

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

                                    : ?stdClass
    {
        $obj = new stdClass();
        foreach ($this->getElements() as $id => $element) {
            $obj->$id = $element->exportStdClass();
        }
        return $obj;
    }

References $id, and getElements().

Here is the call graph for this function:

◆ getCheckSum()

ilADTGroup::getCheckSum ( )

Get unique checksum.

Returns: string | null

Reimplemented from ilADT.

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

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

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 ( string $a_name )

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

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

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 64 of file class.ilADTGroup.php.

                                 : array
    {
        return $this->elements;
    }

References $elements.

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

Here is the caller graph for this function:

◆ getValidationErrors()

ilADTGroup::getValidationErrors ( )

@inheritcoc

Reimplemented from ilADT.

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

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

◆ getValidationErrorsByElements()

ilADTGroup::getValidationErrorsByElements ( )

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

                                                   : array
    {
        return $this->validation_errors;
    }

References ilADT\$validation_errors.

◆ hasElement()

ilADTGroup::hasElement ( string $a_name )

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

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

Referenced by getElement().

Here is the caller graph for this function:

◆ importStdClass()

ilADTGroup::importStdClass ( ?stdClass $a_std )

Import value from stdClass.

Parameters

stdClass | null $a_std

Reimplemented from ilADT.

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

                                                    : void
    {
        if (is_object($a_std)) {
            foreach ($this->getElements() as $id => $element) {
                $element->importStdClass($a_std->$id);
            }
        }
    }

References $id, and getElements().

Here is the call 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 77 of file class.ilADTGroup.php.

                                          : ?bool
    {
        return null;
    }

◆ isNull()

ilADTGroup::isNull ( )

Is currently null.

Returns: bool | null

Reimplemented from ilADT.

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

                            : bool
    {
        return !count($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 | null

Reimplemented from ilADT.

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

                                           : ?bool
    {
        return null;
    }

◆ isValid()

ilADTGroup::isValid ( )

Reimplemented from ilADT.

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

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

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

Parameters

ilADTDefinition $a_def

Returns: bool

Reimplemented from ilADT.

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

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

◆ reset()

ilADTGroup::reset ( )

Init property defaults.

Reimplemented from ilADT.

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

                           : void
    {
        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.

Parameters

ilADTDefinition $a_def

Exceptions

ilException

Reimplemented from ilADT.

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

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

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

Here is the call graph for this function:

◆ translateErrorCode()

ilADTGroup::translateErrorCode ( string $a_code )

@inheritcoc

Reimplemented from ilADT.

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

                                                      : string
    {
        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);
            }
        }
        return parent::translateErrorCode($a_code);
    }

References getElement().

Here is the call graph for this function:

Field Documentation

◆ $elements

array ilADTGroup::$elements = []

protected

Definition at line 7 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()

◆ exportStdClass()

◆ getCheckSum()

◆ getElement()

◆ getElements()

◆ getValidationErrors()

◆ getValidationErrorsByElements()

◆ hasElement()

◆ importStdClass()

◆ isLarger()

◆ isNull()

◆ isSmaller()

◆ isValid()

◆ isValidDefinition()

◆ reset()

◆ setDefinition()

◆ translateErrorCode()

Field Documentation

◆ $elements