Inheritance diagram for ilADTGroup:

Collaboration diagram for ilADTGroup:

Public Member Functions
	__clone ()
	reset ()
	Init property defaults.
	hasElement ($a_name)
	getElement ($a_name)
	getElements ()
	equals (ilADT $a_adt)
	Check if given ADT equals self.
	isLarger (ilADT $a_adt)
	Check if given ADT is larger than self.
	isSmaller (ilADT $a_adt)
	Check if given ADT is smaller than self.
	isNull ()
	Is currently null.
	getValidationErrorsByElements ()
	getValidationErrors ()
	Get all validation error codes.
	isValid ()
	Is currently valid.
	translateErrorCode ($a_code)
	Translate error-code to human-readable message.
	getCheckSum ()
	Get unique checksum.
Public Member Functions inherited from ilADT
	__construct (ilADTDefinition $a_def)
	Constructor.
	getType ()
	Get type (from class/instance)
	getCopyOfDefinition ()
	Get copy of definition.
	isLargerOrEqual (ilADT $a_adt)
	Check if given ADT is larger or equal than self.
	isSmallerOrEqual (ilADT $a_adt)
	Check if given ADT is smaller or equal than self.
	isInbetween (ilADT $a_adt_from, ilADT $a_adt_to)
	Check if self is inbetween given ADTs (exclusive)
	isInbetweenOrEqual (ilADT $a_adt_from, ilADT $a_adt_to)
	Check if self is inbetween given ADTs (inclusive)

Protected Member Functions
	isValidDefinition (ilADTDefinition $a_def)
	Check if definition is valid for ADT.
	setDefinition (ilADTDefinition $a_def)
	Set definition.
	addElement ($a_name, ilADTDefinition $a_def)
	addValidationError ($a_element_id, $a_error_code)
Protected Member Functions inherited from ilADT
	getDefinition ()
	Get definition.
	addValidationError ($a_error_code)
	Add validation error code.

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"

Detailed Description

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

Member Function Documentation

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;                          
                        }
                }
        }

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

protected

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

References ilADTFactory\getInstance().

Referenced by setDefinition().

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

Here is the call graph for this function:

Here is the caller graph for this function:

ilADTGroup::addValidationError	(	$a_element_id,
		$a_error_code
	)

protected

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

Referenced by isValid().

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

Here is the caller graph for this function:

ilADTGroup::equals ( ilADT $a_adt )

Check if given ADT equals self.

Parameters

ilADT $a_adt

Returns: bool

Reimplemented from ilADT.

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

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

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

Here is the call graph for this function:

ilADTGroup::getCheckSum ( )

Get unique checksum.

Returns: string

Reimplemented from ilADT.

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

References getElements(), and isNull().

Referenced by equals().

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

Here is the call graph for this function:

Here is the caller graph for this function:

ilADTGroup::getElement ( $a_name )

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

References hasElement().

Referenced by translateErrorCode().

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

Here is the call graph for this function:

Here is the caller graph for this function:

ilADTGroup::getElements ( )

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

References $elements.

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

        {
                return $this->elements;
        }

Here is the caller graph for this function:

ilADTGroup::getValidationErrors ( )

Get all validation error codes.

See Also: isValid()

Returns: array

Reimplemented from ilADT.

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

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

ilADTGroup::getValidationErrorsByElements ( )

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

References ilADT\$validation_errors.

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

ilADTGroup::hasElement ( $a_name )

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

Referenced by getElement().

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

Here is the caller graph for this function:

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

        {
                // return null?
        }

ilADTGroup::isNull ( )

Is currently null.

Returns: bool

Reimplemented from ilADT.

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

References getElements().

Referenced by getCheckSum(), and isValid().

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

        {
                // return null?
        }

ilADTGroup::isValid ( )

Is currently valid.

Returns: boolean

Reimplemented from ilADT.

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

References $valid, addValidationError(), getElements(), and isNull().

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

Here is the call graph for this function:

ilADTGroup::isValidDefinition ( ilADTDefinition $a_def )

protected

Check if definition is valid for ADT.

Returns: bool;

Reimplemented from ilADT.

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

        {
                return ($a_def instanceof ilADTGroupDefinition);
        }

ilADTGroup::reset ( )

Init property defaults.

Reimplemented from ilADT.

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

References $elements, and getElements().

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

Here is the call graph for this function:

ilADTGroup::setDefinition ( ilADTDefinition $a_def )

protected

Set definition.

Exceptions

ilException

Parameters

ilADTDefinition $a_def

Reimplemented from ilADT.

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

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

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

Here is the call graph for this function:

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

References getElement().

        {
                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);
                        }
                }
        }

Here is the call graph for this function:

Field Documentation

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

Field Documentation