Inheritance diagram for ilADTMultiEnum:

Collaboration diagram for ilADTMultiEnum:

Public Member Functions
	getType ()
	Get type (from class/instance) More...

	reset ()
	Init property defaults. More...

	setSelections (array $a_values=null)

	getSelections ()

	isValidOption ($a_value)

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

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

	handleSelectionValue ($a_value)

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

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

Member Function Documentation

◆ equals()

ilADTMultiEnum::equals ( ilADT $a_adt )

Check if given ADT equals self.

Parameters

ilADT $a_adt

Returns: bool

Reimplemented from ilADT.

Definition at line 66 of file class.ilADTMultiEnum.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()

ilADTMultiEnum::getCheckSum ( )

Get unique checksum.

Returns: string

Reimplemented from ilADT.

Definition at line 95 of file class.ilADTMultiEnum.php.

        {
                if(!$this->isNull())
                {
                        $current = $this->getSelections();
                        sort($current);                 
                        return md5(implode(",", $current));
                }
        }       

References getSelections(), and isNull().

Referenced by equals().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSelections()

ilADTMultiEnum::getSelections ( )

Definition at line 52 of file class.ilADTMultiEnum.php.

        {
                return $this->values;
        }

References $values.

Referenced by getCheckSum(), ilADTEnumSearchBridgeMulti\isInCondition(), and isNull().

Here is the caller graph for this function:

◆ getType()

ilADTMultiEnum::getType ( )

Get type (from class/instance)

Returns: string

Reimplemented from ilADT.

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

        {
                return "MultiEnum";
        }

◆ handleSelectionValue()

ilADTMultiEnum::handleSelectionValue ( $a_value )

abstractprotected

Reimplemented in ilADTMultiEnumNumeric, and ilADTMultiEnumText.

Referenced by isValidOption(), and setSelections().

Here is the caller graph for this function:

◆ isLarger()

ilADTMultiEnum::isLarger ( ilADT $a_adt )

Check if given ADT is larger than self.

Parameters

ilADT $a_adt

Returns: bool

Reimplemented from ilADT.

Definition at line 74 of file class.ilADTMultiEnum.php.

        {
                // return null?
        }

◆ isNull()

ilADTMultiEnum::isNull ( )

Is currently null.

Returns: bool

Reimplemented from ilADT.

Definition at line 87 of file class.ilADTMultiEnum.php.

        {               
                return ($this->getSelections() === null);
        }

References getSelections().

Referenced by getCheckSum().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isSmaller()

ilADTMultiEnum::isSmaller ( ilADT $a_adt )

Check if given ADT is smaller than self.

Parameters

ilADT $a_adt

Returns: bool

Reimplemented from ilADT.

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

        {
                // return null?
        }

◆ isValidDefinition()

ilADTMultiEnum::isValidDefinition ( ilADTDefinition $a_def )

protected

Check if definition is valid for ADT.

Returns: bool;

Reimplemented from ilADT.

Definition at line 15 of file class.ilADTMultiEnum.php.

        {
                return ($a_def instanceof ilADTMultiEnumDefinition);
        }

◆ isValidOption()

ilADTMultiEnum::isValidOption ( $a_value )

Definition at line 57 of file class.ilADTMultiEnum.php.

        {               
                $a_value = $this->handleSelectionValue($a_value);
                return array_key_exists($a_value, $this->getDefinition()->getOptions());
        }

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

Referenced by setSelections().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reset()

ilADTMultiEnum::reset ( )

Init property defaults.

Reimplemented from ilADT.

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

        {
                parent::reset();
                
                $this->values = null;
        }

◆ setSelections()

ilADTMultiEnum::setSelections ( array $a_values = null )

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

        {
                if($a_values !== null)
                {
                        foreach($a_values as $idx => $value)
                        {
                                $value = $this->handleSelectionValue($value);
                                if(!$this->isValidOption($value))
                                {
                                        unset($a_values[$idx]);
                                }
                        }
                        if(!sizeof($a_values))
                        {
                                $a_values = null;
                        }
                }
                $this->values = $a_values;
        }

References handleSelectionValue(), and isValidOption().

Here is the call graph for this function:

Field Documentation

◆ $values

ilADTMultiEnum::$values

protected

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

Referenced by getSelections().

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

Services/ADT/classes/Types/MultiEnum/class.ilADTMultiEnum.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ equals()

◆ getCheckSum()

◆ getSelections()

◆ getType()

◆ handleSelectionValue()

◆ isLarger()

◆ isNull()

◆ isSmaller()

◆ isValidDefinition()

◆ isValidOption()

◆ reset()

◆ setSelections()

Field Documentation

◆ $values