Inheritance diagram for ilADTMultiText:

Collaboration diagram for ilADTMultiText:

Public Member Functions
	reset ()
	Init property defaults. More...

	setTextElements (?array $a_values=null)

	getTextElements ()

	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 ()

	isValid ()

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

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

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

Member Function Documentation

◆ equals()

ilADTMultiText::equals ( ilADT $a_adt )

Check if given ADT equals self.

Parameters

ilADT $a_adt

Returns: bool|null

Reimplemented from ilADT.

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

ilADTMultiText::exportStdClass ( )

Export value as stdClass.

Returns: stdClass | null

Reimplemented from ilADT.

Definition at line 115 of file class.ilADTMultiText.php.

                                    : ?stdClass
    {
        if (!$this->isNull()) {
            $obj = new stdClass();
            $obj->value = $this->getTextElements();
            return $obj;
        }
        return null;
    }

References getTextElements(), and isNull().

Here is the call graph for this function:

◆ getCheckSum()

ilADTMultiText::getCheckSum ( )

Get unique checksum.

Returns: string | null

Reimplemented from ilADT.

Definition at line 103 of file class.ilADTMultiText.php.

                                 : ?string
    {
        if (!$this->isNull()) {
            $elements = $this->getTextElements();
            sort($elements);
            return md5(implode("", $elements));
        }
        return null;
    }

References getTextElements(), and isNull().

Referenced by equals().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTextElements()

ilADTMultiText::getTextElements ( )

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

                                     : ?array
    {
        return $this->values;
    }

References $values.

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

Here is the caller graph for this function:

◆ importStdClass()

ilADTMultiText::importStdClass ( ?stdClass $a_std )

Import value from stdClass.

Parameters

stdClass | null $a_std

Reimplemented from ilADT.

Definition at line 125 of file class.ilADTMultiText.php.

                                                    : void
    {
        if (is_object($a_std)) {
            $this->setTextElements($a_std->value);
        }
    }

References setTextElements().

Here is the call graph for this function:

◆ isLarger()

ilADTMultiText::isLarger ( ilADT $a_adt )

Check if given ADT is larger than self.

Parameters

ilADT $a_adt

Returns: bool

Reimplemented from ilADT.

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

                                          : ?bool
    {
        return null;
    }

◆ isNull()

ilADTMultiText::isNull ( )

Returns: bool

Reimplemented from ilADT.

Definition at line 72 of file class.ilADTMultiText.php.

                            : bool
    {
        $all = $this->getTextElements();
        return (!is_array($all) || !count($all));
    }

References getTextElements().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isSmaller()

ilADTMultiText::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 61 of file class.ilADTMultiText.php.

                                           : ?bool
    {
        return null;
    }

◆ isValid()

ilADTMultiText::isValid ( )

Reimplemented from ilADT.

Definition at line 80 of file class.ilADTMultiText.php.

                             : bool
    {
        $valid = parent::isValid();
        if (!$this->isNull()) {
            $max_size = $this->getDefinition()->getMaxSize();
            if ($max_size && $max_size < count((array) $this->getTextElements())) {
                $valid = false;
                $this->addValidationError(self::ADT_VALIDATION_ERROR_MAX_SIZE);
            }
 
            $max_len = $this->getDefinition()->getMaxLength();
            if ($max_len) {
                foreach ((array) $this->getTextElements() as $element) {
                    if ($max_len < strlen($element)) {
                        $valid = false;
                        $this->addValidationError(self::ADT_VALIDATION_ERROR_MAX_LENGTH);
                    }
                }
            }
        }
        return $valid;
    }

References $valid, ilADT\addValidationError(), ilADT\getDefinition(), getTextElements(), and isNull().

Here is the call graph for this function:

◆ isValidDefinition()

ilADTMultiText::isValidDefinition ( ilADTDefinition $a_def )

protected

Check if definition is valid for ADT.

Parameters

ilADTDefinition $a_def

Returns: bool

Reimplemented from ilADT.

Definition at line 9 of file class.ilADTMultiText.php.

                                                                : bool
    {
        return $a_def instanceof ilADTMultiTextDefinition;
    }

◆ reset()

ilADTMultiText::reset ( )

Init property defaults.

Reimplemented from ilADT.

Definition at line 14 of file class.ilADTMultiText.php.

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

◆ setTextElements()

ilADTMultiText::setTextElements ( ?array $a_values = null )

Definition at line 22 of file class.ilADTMultiText.php.

                                                            : void
    {
        if (is_array($a_values)) {
            if (count($a_values)) {
                foreach ($a_values as $idx => $element) {
                    $a_values[$idx] = trim($element);
                    if (!$a_values[$idx]) {
                        unset($a_values[$idx]);
                    }
                }
                $a_values = array_unique($a_values);
            }
            if (!count($a_values)) {
                $a_values = null;
            }
        }
        $this->values = $a_values;
    }

Referenced by importStdClass().

Here is the caller graph for this function:

Field Documentation

◆ $values

array ilADTMultiText::$values

protected

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

Referenced by getTextElements().

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

Services/ADT/classes/Types/MultiText/class.ilADTMultiText.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ equals()

◆ exportStdClass()

◆ getCheckSum()

◆ getTextElements()

◆ importStdClass()

◆ isLarger()

◆ isNull()

◆ isSmaller()

◆ isValid()

◆ isValidDefinition()

◆ reset()

◆ setTextElements()

Field Documentation

◆ $values