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

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)

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

Member Function Documentation

◆ equals()

ilADTMultiText::equals ( ilADT $a_adt )

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

◆ getCheckSum()

ilADTMultiText::getCheckSum ( )

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

References getTextElements(), and isNull().

Referenced by equals().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTextElements()

ilADTMultiText::getTextElements ( )

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

References $values.

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

         {
                 return $this->values;
         }

Here is the caller graph for this function:

◆ isLarger()

ilADTMultiText::isLarger ( ilADT $a_adt )

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

         {
                 // return null?
         }

◆ isNull()

ilADTMultiText::isNull ( )

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

References getTextElements().

Referenced by getCheckSum(), and isValid().

         {               
                 $all = $this->getTextElements();
                 return (!is_array($all) || !sizeof($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 70 of file class.ilADTMultiText.php.

         {
                 // return null?
         }

◆ isValid()

ilADTMultiText::isValid ( )

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

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

         {
                 $valid = parent::isValid();
                 
                 if(!$this->isNull())
                 {
                         $max_size = $this->getDefinition()->getMaxSize();
                         if($max_size && $max_size < sizeof($this->getTextElements()))
                         {
                                 $valid = false;
                                 $this->addValidationError(self::ADT_VALIDATION_ERROR_MAX_SIZE);
                         }
 
                         $max_len = $this->getDefinition()->getMaxLength();
                         if($max_len)
                         {
                                 foreach($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 10 of file class.ilADTMultiText.php.

         {
                 return ($a_def instanceof ilADTMultiTextDefinition);
         }

◆ reset()

ilADTMultiText::reset ( )

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

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

◆ setTextElements()

ilADTMultiText::setTextElements ( array $a_values = null )

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

         {               
                 if(is_array($a_values))
                 {
                         if(sizeof($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(!sizeof($a_values))
                         {
                                 $a_values = null;
                         }
                 }
                 $this->values = $a_values;
         }

Field Documentation

◆ $values

ilADTMultiText::$values

protected

Definition at line 5 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()

◆ getCheckSum()

◆ getTextElements()

◆ isLarger()

◆ isNull()

◆ isSmaller()

◆ isValid()

◆ isValidDefinition()

◆ reset()

◆ setTextElements()

Field Documentation

◆ $values