ADT base class. More...

Inheritance diagram for ilADT:

Collaboration diagram for ilADT:

Public Member Functions
	__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...

Data Fields
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'

Protected Member Functions
	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
ilADTDefinition	$definition

ilLanguage	$lng

array	$validation_errors = []

Detailed Description

ADT base class.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 11 of file class.ilADT.php.

Constructor & Destructor Documentation

◆ __construct()

ilADT::__construct ( ilADTDefinition $a_def )

Definition at line 37 of file class.ilADT.php.

References $DIC, ILIAS\Repository\lng(), reset(), and setDefinition().

     {
         global $DIC;
         $this->setDefinition($a_def);
         $this->reset();
 
         $this->lng = $DIC->language();
     }

Here is the call graph for this function:

Member Function Documentation

◆ addValidationError()

ilADT::addValidationError ( string $a_error_code )

protected

Definition at line 223 of file class.ilADT.php.

Referenced by ilADTText\isValid(), ilADTMultiText\isValid(), ilADTFloat\isValid(), ilADTInteger\isValid(), ilADTLocation\isValid(), ilADTInternalLink\isValid(), ilADTExternalLink\isValid(), and isValid().

                                                                : void
     {
         $this->validation_errors[] = $a_error_code;
     }

Here is the caller graph for this function:

◆ equals()

ilADT::equals ( ilADT $a_adt )

abstract

Check if given ADT equals self.

Parameters

ilADT $a_adt

Returns: bool|null

Referenced by getCopyOfDefinition(), isInbetweenOrEqual(), isLargerOrEqual(), and isSmallerOrEqual().

Here is the caller graph for this function:

◆ exportStdClass()

ilADT::exportStdClass ( )

abstract

Export value as stdClass.

Returns: stdClass | null

Referenced by ilAdvancedMDFieldDefinitionGroupBased\importComplexOptionFromForm(), and translateErrorCode().

Here is the caller graph for this function:

◆ getCheckSum()

ilADT::getCheckSum ( )

abstract

Get unique checksum.

Returns: string | null

Referenced by ilADTMultiText\equals(), ilADTGroup\equals(), ilADTInternalLink\equals(), ilADTMultiEnum\equals(), ilADTExternalLink\equals(), and translateErrorCode().

Here is the caller graph for this function:

◆ getCopyOfDefinition()

ilADT::getCopyOfDefinition ( )

Get copy of definition.

Returns: ilADTDefinition $a_def

Definition at line 101 of file class.ilADT.php.

References equals(), and isLarger().

Referenced by ilADTLocationFormBridge\addToForm().

                                          : ilADTDefinition
     {
         return (clone $this->definition);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefinition()

ilADT::getDefinition ( )

protected

Get definition.

Returns: ilADTDefinition $a_def

Definition at line 92 of file class.ilADT.php.

References $definition.

Referenced by ilADTBoolean\equals(), ilADTDate\equals(), ilADTDateTime\equals(), ilADTMultiText\equals(), ilADTText\equals(), ilADTFloat\equals(), ilADTInteger\equals(), ilADTEnum\equals(), ilADTLocalizedText\equals(), ilADTLocation\equals(), ilADTGroup\equals(), ilADTInternalLink\equals(), ilADTMultiEnum\equals(), ilADTExternalLink\equals(), getType(), isInbetween(), isInbetweenOrEqual(), ilADTDate\isLarger(), ilADTDateTime\isLarger(), ilADTFloat\isLarger(), ilADTInteger\isLarger(), isLargerOrEqual(), ilADTDate\isSmaller(), ilADTDateTime\isSmaller(), ilADTFloat\isSmaller(), ilADTInteger\isSmaller(), isSmallerOrEqual(), ilADTText\isValid(), ilADTMultiText\isValid(), ilADTFloat\isValid(), ilADTInteger\isValid(), isValid(), ilADTEnum\isValidOption(), ilADTMultiEnum\isValidOption(), ilADTGroup\setDefinition(), ilADTInteger\setNumber(), and ilADTFloat\setNumber().

                                       : ilADTDefinition
     {
         return $this->definition;
     }

Here is the caller graph for this function:

◆ getType()

ilADT::getType ( )

Get type (from class/instance)

Returns: string

Definition at line 50 of file class.ilADT.php.

References getDefinition().

Referenced by ilAdvancedMDValues\_deleteByFieldId(), ilADTFactory\getActiveRecordBridgeForInstance(), ilADTFactory\getDBBridgeForInstance(), ilADTFactory\getFormBridgeForInstance(), and ilADTFactory\getPresentationBridgeForInstance().

                              : string
     {
         return $this->getDefinition()->getType();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getValidationErrors()

ilADT::getValidationErrors ( )

Get all validation error codes.

Returns: string[]

See also: isValid()

Definition at line 233 of file class.ilADT.php.

                                          : array
     {
         if (
             is_array($this->validation_errors) &&
             count($this->validation_errors)) {
             return array_unique($this->validation_errors);
         }
         return [];
     }

◆ importStdClass()

ilADT::importStdClass ( ?stdClass $a_std )

abstract

Import value from stdClass.

Parameters

stdClass | null $a_std

Referenced by ilAdvancedMDFieldDefinitionGroupBased\getADTForOption(), and translateErrorCode().

Here is the caller graph for this function:

◆ isInbetween()

ilADT::isInbetween	(	ilADT	$a_adt_from,
		ilADT	$a_adt_to
	)

Check if self is inbetween given ADTs (exclusive)

Parameters

ilADT	$a_adt_from
ilADT	$a_adt_to

Returns: bool | null

Definition at line 165 of file class.ilADT.php.

References getDefinition(), isLarger(), and isSmaller().

Referenced by isInbetweenOrEqual().

                                                                    : ?bool
     {
         if (
             !$this->getDefinition()->isComparableTo($a_adt_from) ||
             !$this->getDefinition()->isComparableTo($a_adt_to)
         ) {
             return null;
         }
         if ($this->isLarger($a_adt_from) === null || $this->isSmaller($a_adt_to) === null) {
             return null;
         }
         return $this->isLarger($a_adt_from) && $this->isSmaller($a_adt_to);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isInbetweenOrEqual()

ilADT::isInbetweenOrEqual	(	ilADT	$a_adt_from,
		ilADT	$a_adt_to
	)

Check if self is inbetween given ADTs (inclusive)

Parameters

ilADT	$a_adt_from
ilADT	$a_adt_to

Returns: bool

Definition at line 185 of file class.ilADT.php.

References equals(), getDefinition(), isInbetween(), and isNull().

Referenced by ilADTDateSearchBridgeRange\isInCondition(), and ilADTDateTimeSearchBridgeRange\isInCondition().

                                                                           : ?bool
     {
         if (
             !$this->getDefinition()->isComparableTo($a_adt_from) ||
             !$this->getDefinition()->isComparableTo($a_adt_to)
         ) {
             return null;
         }
         if (
             $this->equals($a_adt_from) === null ||
             $this->equals($a_adt_to) === null ||
             $this->isInbetween($a_adt_from, $a_adt_to) === null
         ) {
             return null;
         }
         return
             $this->equals($a_adt_from) ||
             $this->equals($a_adt_to) ||
             $this->isInbetween($a_adt_from, $a_adt_to);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isLarger()

ilADT::isLarger ( ilADT $a_adt )

abstract

Check if given ADT is larger than self.

Parameters

ilADT $a_adt

Returns: bool

Referenced by getCopyOfDefinition(), isInbetween(), and isLargerOrEqual().

Here is the caller graph for this function:

◆ isLargerOrEqual()

ilADT::isLargerOrEqual ( ilADT $a_adt )

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

References equals(), getDefinition(), isLarger(), and isSmaller().

Referenced by ilADTDateSearchBridgeRange\isInCondition(), and ilADTDateTimeSearchBridgeRange\isInCondition().

                                                  : ?bool
     {
         if (!$this->getDefinition()->isComparableTo($a_adt)) {
             return null;
         }
         if ($this->equals($a_adt) === null || $this->isLarger($a_adt) === null) {
             return null;
         }
         return $this->equals($a_adt) || $this->isLarger($a_adt);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isNull()

ilADT::isNull ( )

abstract

Is currently null.

Returns: bool | null

Referenced by ilADTLocationFormBridge\addToForm(), ilADTLocationSearchBridgeSingle\addToForm(), ilADTDate\equals(), ilADTDateTime\equals(), isInbetweenOrEqual(), ilADTDate\isLarger(), ilADTDateTime\isLarger(), ilADTDate\isSmaller(), ilADTDateTime\isSmaller(), and isValid().

Here is the caller graph for this function:

◆ isSmaller()

ilADT::isSmaller ( ilADT $a_adt )

abstract

Check if given ADT is smaller than self.

Parameters

ilADT $a_adt

Returns: bool | null

Referenced by isInbetween(), isLargerOrEqual(), and isSmallerOrEqual().

Here is the caller graph for this function:

◆ isSmallerOrEqual()

ilADT::isSmallerOrEqual ( ilADT $a_adt )

Check if given ADT is smaller or equal than self.

Parameters

ilADT $a_adt

Returns: bool | null

Definition at line 148 of file class.ilADT.php.

References equals(), getDefinition(), and isSmaller().

Referenced by ilADTDateSearchBridgeRange\isInCondition(), and ilADTDateTimeSearchBridgeRange\isInCondition().

                                                   : ?bool
     {
         if (!$this->getDefinition()->isComparableTo($a_adt)) {
             return null;
         }
         if ($this->equals($a_adt) === null || $this->isSmaller($a_adt) === null) {
             return null;
         }
         return $this->equals($a_adt) || $this->isSmaller($a_adt);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isValid()

ilADT::isValid ( )

Definition at line 212 of file class.ilADT.php.

References addValidationError(), getDefinition(), and isNull().

                              : bool
     {
         $this->validation_errors = [];
 
         if (!$this->getDefinition()->isNullAllowed() && $this->isNull()) {
             $this->addValidationError(self::ADT_VALIDATION_ERROR_NULL_NOT_ALLOWED);
             return false;
         }
         return true;
     }

Here is the call graph for this function:

◆ isValidDefinition()

ilADT::isValidDefinition ( ilADTDefinition $a_def )

abstractprotected

Check if definition is valid for ADT.

Parameters

ilADTDefinition $a_def

Returns: bool

Referenced by reset(), and setDefinition().

Here is the caller graph for this function:

◆ reset()

ilADT::reset ( )

Init property defaults.

Definition at line 58 of file class.ilADT.php.

References isValidDefinition().

Referenced by __construct().

                            : void
     {
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDefinition()

ilADT::setDefinition ( ilADTDefinition $a_def )

protected

Set definition.

Parameters

ilADTDefinition $a_def

Exceptions

ilException

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

References isValidDefinition().

Referenced by __construct().

                                                             : void
     {
         if ($this->isValidDefinition($a_def)) {
             $this->definition = clone $a_def;
         } else {
             throw new ilException("ilADT invalid definition");
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ translateErrorCode()

ilADT::translateErrorCode ( string $a_code )

Translate error-code to human-readable message.

Parameters

string $a_code

Returns: string

Exceptions

Exception

Definition at line 249 of file class.ilADT.php.

References exportStdClass(), getCheckSum(), importStdClass(), and ILIAS\Repository\lng().

                                                       : string
     {
         switch ($a_code) {
             case self::ADT_VALIDATION_ERROR_NULL_NOT_ALLOWED:
                 return $this->lng->txt("msg_input_is_required");
 
             case self::ADT_VALIDATION_ERROR_MAX_LENGTH:
                 return $this->lng->txt("adt_error_max_length");
 
             case self::ADT_VALIDATION_ERROR_MAX_SIZE:
                 return $this->lng->txt("adt_error_max_size");
 
             case self::ADT_VALIDATION_ERROR_MIN:
                 return $this->lng->txt("form_msg_value_too_low");
 
             case self::ADT_VALIDATION_ERROR_MAX:
                 return $this->lng->txt("form_msg_value_too_high");
 
             // :TODO: currently not used - see ilDateTimeInputGUI
             case self::ADT_VALIDATION_DATE:
                 return $this->lng->txt("exc_date_not_valid");
 
         }
         throw new Exception("ADT unknown error code");
     }

Here is the call graph for this function:

Field Documentation

◆ $definition

ilADTDefinition ilADT::$definition

protected

Definition at line 13 of file class.ilADT.php.

Referenced by getDefinition().

◆ $lng

ilLanguage ilADT::$lng

protected

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

◆ $validation_errors

array ilADT::$validation_errors = []

protected

Definition at line 17 of file class.ilADT.php.

Referenced by ilADTGroup\getValidationErrorsByElements().

◆ ADT_VALIDATION_DATE

const ilADT::ADT_VALIDATION_DATE = "adt6"

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

◆ ADT_VALIDATION_ERROR_INVALID_NODE

const ilADT::ADT_VALIDATION_ERROR_INVALID_NODE = 'adt7'

Definition at line 35 of file class.ilADT.php.

◆ ADT_VALIDATION_ERROR_MAX

const ilADT::ADT_VALIDATION_ERROR_MAX = "adt5"

Definition at line 29 of file class.ilADT.php.

◆ ADT_VALIDATION_ERROR_MAX_LENGTH

const ilADT::ADT_VALIDATION_ERROR_MAX_LENGTH = "adt2"

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

◆ ADT_VALIDATION_ERROR_MAX_SIZE

const ilADT::ADT_VALIDATION_ERROR_MAX_SIZE = "adt3"

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

◆ ADT_VALIDATION_ERROR_MIN

const ilADT::ADT_VALIDATION_ERROR_MIN = "adt4"

Definition at line 28 of file class.ilADT.php.

◆ ADT_VALIDATION_ERROR_NULL_NOT_ALLOWED

const ilADT::ADT_VALIDATION_ERROR_NULL_NOT_ALLOWED = "adt1"

Definition at line 19 of file class.ilADT.php.

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

Services/ADT/classes/class.ilADT.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addValidationError()

◆ equals()

◆ exportStdClass()

◆ getCheckSum()

◆ getCopyOfDefinition()

◆ getDefinition()

◆ getType()

◆ getValidationErrors()

◆ importStdClass()

◆ isInbetween()

◆ isInbetweenOrEqual()

◆ isLarger()

◆ isLargerOrEqual()

◆ isNull()

◆ isSmaller()

◆ isSmallerOrEqual()

◆ isValid()

◆ isValidDefinition()

◆ reset()

◆ setDefinition()

◆ translateErrorCode()

Field Documentation

◆ $definition

◆ $lng

◆ $validation_errors

◆ ADT_VALIDATION_DATE

◆ ADT_VALIDATION_ERROR_INVALID_NODE

◆ ADT_VALIDATION_ERROR_MAX

◆ ADT_VALIDATION_ERROR_MAX_LENGTH

◆ ADT_VALIDATION_ERROR_MAX_SIZE

◆ ADT_VALIDATION_ERROR_MIN

◆ ADT_VALIDATION_ERROR_NULL_NOT_ALLOWED