Inheritance diagram for ilADTMultiText:

Collaboration diagram for ilADTMultiText:

Public Member Functions
	reset ()

	setTextElements (?array $a_values=null)

	getTextElements ()

	equals (ilADT $a_adt)

	isLarger (ilADT $a_adt)

	isSmaller (ilADT $a_adt)

	isNull ()

	isValid ()

	getCheckSum ()

	exportStdClass ()

	importStdClass (?stdClass $a_std)

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)

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 )

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

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

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

Here is the call graph for this function:

◆ exportStdClass()

ilADTMultiText::exportStdClass ( )

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

References getTextElements(), and isNull().

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

Here is the call graph for this function:

◆ getCheckSum()

ilADTMultiText::getCheckSum ( )

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

References getTextElements(), and isNull().

Referenced by equals().

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

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.

References $values.

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

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

Here is the caller graph for this function:

◆ importStdClass()

ilADTMultiText::importStdClass ( ?stdClass $a_std )

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

References setTextElements().

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

Here is the call graph for this function:

◆ isLarger()

ilADTMultiText::isLarger ( ilADT $a_adt )

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

                                           : ?bool
     {
         return null;
     }

◆ isNull()

ilADTMultiText::isNull ( )

Returns: bool

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

References getTextElements().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isSmaller()

ilADTMultiText::isSmaller ( ilADT $a_adt )

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

                                            : ?bool
     {
         return null;
     }

◆ isValid()

ilADTMultiText::isValid ( )

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

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

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

Here is the call graph for this function:

◆ isValidDefinition()

ilADTMultiText::isValidDefinition ( ilADTDefinition $a_def )

protected

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

                                                                 : bool
     {
         return $a_def instanceof ilADTMultiTextDefinition;
     }

◆ reset()

ilADTMultiText::reset ( )

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.

Referenced by importStdClass().

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

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