ilADTMultiEnum Class Reference

Inheritance diagram for ilADTMultiEnum:

Collaboration diagram for ilADTMultiEnum:

Public Member Functions
	getType ()
	reset ()
	addSelection (int $value_index)
	setSelections (array $a_values=null)
	getSelections ()
	isValidOption ($a_value)
	equals (ilADT $a_adt)
	isLarger (ilADT $a_adt)
	isSmaller (ilADT $a_adt)
	isNull ()
	getCheckSum ()
	exportStdClass ()
	importStdClass ($a_std)
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...
	exportStdClass ()
	Export value as stdClass. More...
	importStdClass ($a_std)
	Import value from stdClass. More...

Protected Member Functions
	isValidDefinition (ilADTDefinition $a_def)
	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"
const	ADT_VALIDATION_ERROR_INVALID_NODE = 'adt7'

Detailed Description

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

Member Function Documentation

addSelection()

ilADTMultiEnum::addSelection

(

int

$value_index

)

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

References isValidOption().

    {
        if (!$this->isValidOption($value_index)) {
            return;
        }
        $this->values[] = $value_index;
    }

Here is the call graph for this function:

equals()

ilADTMultiEnum::equals

(

ilADT

$a_adt

)

Definition at line 70 of file class.ilADTMultiEnum.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:

exportStdClass()

ilADTMultiEnum::exportStdClass

(

)

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

References getSelections(), and isNull().

    {
        if (!$this->isNull()) {
            $obj = new stdClass();
            $obj->value = $this->getSelections();
            return $obj;
        }
    }

Here is the call graph for this function:

getCheckSum()

ilADTMultiEnum::getCheckSum

(

)

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

References getSelections(), and isNull().

Referenced by equals().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getSelections()

ilADTMultiEnum::getSelections

(

)

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

References $values.

Referenced by exportStdClass(), getCheckSum(), and isNull().

    {
        return $this->values;
    }

Here is the caller graph for this function:

getType()

ilADTMultiEnum::getType

(

)

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

    {
        return "MultiEnum";
    }

handleSelectionValue()

ilADTMultiEnum::handleSelectionValue (   $a_value )

abstractprotected

Referenced by isValidOption(), reset(), and setSelections().

Here is the caller graph for this function:

importStdClass()

ilADTMultiEnum::importStdClass

(

$a_std

)

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

References setSelections().

    {
        if (is_object($a_std)) {
            $this->setSelections($a_std->value);
        }
    }

Here is the call graph for this function:

isLarger()

ilADTMultiEnum::isLarger

(

ilADT

$a_adt

)

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

    {
        // return null?
    }

isNull()

ilADTMultiEnum::isNull

(

)

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

References getSelections().

Referenced by exportStdClass(), and getCheckSum().

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

Here is the call graph for this function:

Here is the caller graph for this function:

isSmaller()

ilADTMultiEnum::isSmaller

(

ilADT

$a_adt

)

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

    {
        // return null?
    }

isValidDefinition()

ilADTMultiEnum::isValidDefinition ( ilADTDefinition  $a_def )

protected

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

    {
        return ($a_def instanceof ilADTMultiEnumDefinition);
    }

isValidOption()

ilADTMultiEnum::isValidOption

(

$a_value

)

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

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

Referenced by addSelection(), and setSelections().

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

Here is the call graph for this function:

Here is the caller graph for this function:

reset()

ilADTMultiEnum::reset

(

)

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

References handleSelectionValue().

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

Here is the call graph for this function:

setSelections()

ilADTMultiEnum::setSelections

(

array

$a_values = null

)

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

References handleSelectionValue(), and isValidOption().

Referenced by importStdClass().

    {
        if ($a_values === null) {
            return;
        }
        $checked_values = [];
        foreach ($a_values as $value_index) {
            $clean_value = $this->handleSelectionValue($value_index);
            if ($this->isValidOption($clean_value)) {
                $checked_values[] = (int) $clean_value;
            }
        }
        $this->values = count($checked_values) ? $checked_values : null;
    }

Here is the call graph for this function:

Here is the caller 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