ADT base class. More...

Inheritance diagram for ilADT:

Collaboration diagram for ilADT:

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

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

	$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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilADT::__construct ( ilADTDefinition $a_def )

Constructor.

Returns: self

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

    {
        $this->setDefinition($a_def);
        $this->reset();
    }

References reset(), and setDefinition().

Here is the call graph for this function:

Member Function Documentation

◆ addValidationError()

ilADT::addValidationError ( $a_error_code )

protected

Add validation error code.

Parameters

int $a_error_code

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

    {
        $this->validation_errors[] = (string) $a_error_code;
    }

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

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

Reimplemented in ilADTBoolean, ilADTDate, ilADTDateTime, ilADTEnum, ilADTExternalLink, ilADTGroup, ilADTInteger, ilADTInternalLink, ilADTLocation, ilADTMultiEnum, ilADTMultiText, and ilADTText.

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

Here is the caller graph for this function:

◆ getCheckSum()

ilADT::getCheckSum ( )

abstract

Get unique checksum.

Returns: string

Reimplemented in ilADTBoolean, ilADTDate, ilADTDateTime, ilADTEnum, ilADTExternalLink, ilADTGroup, ilADTInteger, ilADTInternalLink, ilADTLocation, ilADTMultiEnum, ilADTMultiText, and ilADTText.

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

Here is the caller graph for this function:

◆ getCopyOfDefinition()

ilADT::getCopyOfDefinition ( )

Get copy of definition.

Returns: ilADTDefinition $a_def

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

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

◆ getDefinition()

ilADT::getDefinition ( )

protected

Get definition.

Returns: ilADTDefinition $a_def

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

    {
        return $this->definition;
    }

References $definition.

Referenced by ilADTDate\equals(), ilADTDateTime\equals(), ilADTEnum\equals(), ilADTExternalLink\equals(), ilADTGroup\equals(), ilADTInteger\equals(), ilADTInternalLink\equals(), ilADTLocation\equals(), ilADTMultiEnum\equals(), ilADTMultiText\equals(), ilADTText\equals(), getType(), ilADTDate\isLarger(), ilADTDateTime\isLarger(), ilADTInteger\isLarger(), ilADTDate\isSmaller(), ilADTDateTime\isSmaller(), ilADTInteger\isSmaller(), isValid(), ilADTInteger\isValid(), ilADTMultiText\isValid(), ilADTText\isValid(), ilADTEnum\isValidOption(), ilADTMultiEnum\isValidOption(), ilADTGroup\setDefinition(), and ilADTInteger\setNumber().

Here is the caller graph for this function:

◆ getType()

ilADT::getType ( )

Get type (from class/instance)

Returns: string

Reimplemented in ilADTMultiEnum.

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

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

References getDefinition().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getValidationErrors()

ilADT::getValidationErrors ( )

Get all validation error codes.

See also: isValid()

Returns: array

Reimplemented in ilADTGroup.

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

    {
        if (is_array($this->validation_errors) &&
            sizeof($this->validation_errors)) {
            return array_unique($this->validation_errors);
        }
        return array();
    }

◆ 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

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

    {
        return ($this->isLarger($a_adt_from) &&
            $this->isSmaller($a_adt_to));
    }

References isLarger(), and isSmaller().

Referenced by isInbetweenOrEqual().

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.

    {
        return ($this->equals($a_adt_from) ||
            $this->equals($a_adt_to) ||
            $this->isInbetween($a_adt_from, $a_adt_to));
    }

References equals(), and isInbetween().

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

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

Reimplemented in ilADTBoolean, ilADTDate, ilADTDateTime, ilADTEnum, ilADTExternalLink, ilADTGroup, ilADTInteger, ilADTInternalLink, ilADTLocation, ilADTMultiEnum, ilADTMultiText, and ilADTText.

Referenced by isInbetween(), and isLargerOrEqual().

Here is the caller graph for this function:

◆ isLargerOrEqual()

ilADT::isLargerOrEqual ( ilADT $a_adt )

Check if given ADT is larger or equal than self.

Parameters

ilADT $a_adt

Returns: bool

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

    {
        return ($this->equals($a_adt) ||
            $this->isLarger($a_adt));
    }

References equals(), and isLarger().

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

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

Reimplemented in ilADTBoolean, ilADTDate, ilADTDateTime, ilADTEnum, ilADTExternalLink, ilADTGroup, ilADTInteger, ilADTInternalLink, ilADTLocation, ilADTMultiEnum, ilADTMultiText, and ilADTText.

Referenced by ilADTDate\equals(), ilADTDateTime\equals(), 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

Reimplemented in ilADTBoolean, ilADTDate, ilADTDateTime, ilADTEnum, ilADTExternalLink, ilADTGroup, ilADTInteger, ilADTInternalLink, ilADTLocation, ilADTMultiEnum, ilADTMultiText, and ilADTText.

Referenced by isInbetween(), 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

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

    {
        return ($this->equals($a_adt) ||
            $this->isSmaller($a_adt));
    }

References equals(), and isSmaller().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isValid()

ilADT::isValid ( )

Is currently valid.

Returns: boolean

Reimplemented in ilADTBoolean, ilADTDate, ilADTDateTime, ilADTExternalLink, ilADTGroup, ilADTInteger, ilADTInternalLink, ilADTLocation, ilADTMultiText, and ilADTText.

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

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

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

Here is the call graph for this function:

◆ isValidDefinition()

ilADT::isValidDefinition ( ilADTDefinition $a_def )

abstractprotected

Check if definition is valid for ADT.

Returns: bool;

Reimplemented in ilADTBoolean, ilADTDate, ilADTDateTime, ilADTEnum, ilADTExternalLink, ilADTFloat, ilADTGroup, ilADTInteger, ilADTInternalLink, ilADTLocation, ilADTMultiEnum, ilADTMultiText, and ilADTText.

Referenced by setDefinition().

Here is the caller graph for this function:

◆ reset()

ilADT::reset ( )

protected

Init property defaults.

Reimplemented in ilADTBoolean, ilADTDate, ilADTDateTime, ilADTEnum, ilADTExternalLink, ilADTGroup, ilADTInteger, ilADTInternalLink, ilADTLocation, ilADTMultiEnum, ilADTMultiText, and ilADTText.

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

62 {

63 }

Referenced by __construct().

Here is the caller graph for this function:

◆ setDefinition()

ilADT::setDefinition ( ilADTDefinition $a_def )

protected

Set definition.

Exceptions

ilException

Parameters

ilADTDefinition $a_def

Reimplemented in ilADTGroup.

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

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

References isValidDefinition().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ translateErrorCode()

ilADT::translateErrorCode ( $a_code )

Translate error-code to human-readable message.

Exceptions

Exception

Parameters

int $a_code

Returns: string

Reimplemented in ilADTGroup, and ilADTLocation.

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

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

References $DIC, $lng, ADT_VALIDATION_DATE, ADT_VALIDATION_ERROR_MAX, ADT_VALIDATION_ERROR_MAX_LENGTH, ADT_VALIDATION_ERROR_MAX_SIZE, ADT_VALIDATION_ERROR_MIN, and ADT_VALIDATION_ERROR_NULL_NOT_ALLOWED.

Field Documentation

◆ $definition

ilADT::$definition

protected

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

Referenced by getDefinition().

◆ $validation_errors

ilADT::$validation_errors = []

protected

Definition at line 14 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.

Referenced by translateErrorCode().

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

Referenced by translateErrorCode().

◆ ADT_VALIDATION_ERROR_MAX_LENGTH

const ilADT::ADT_VALIDATION_ERROR_MAX_LENGTH = "adt2"

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

Referenced by translateErrorCode().

◆ ADT_VALIDATION_ERROR_MAX_SIZE

const ilADT::ADT_VALIDATION_ERROR_MAX_SIZE = "adt3"

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

Referenced by translateErrorCode().

◆ ADT_VALIDATION_ERROR_MIN

const ilADT::ADT_VALIDATION_ERROR_MIN = "adt4"

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

Referenced by translateErrorCode().

◆ ADT_VALIDATION_ERROR_NULL_NOT_ALLOWED

const ilADT::ADT_VALIDATION_ERROR_NULL_NOT_ALLOWED = "adt1"

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

Referenced by translateErrorCode().

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

◆ getCheckSum()

◆ getCopyOfDefinition()

◆ getDefinition()

◆ getType()

◆ getValidationErrors()

◆ isInbetween()

◆ isInbetweenOrEqual()

◆ isLarger()

◆ isLargerOrEqual()

◆ isNull()

◆ isSmaller()

◆ isSmallerOrEqual()

◆ isValid()

◆ isValidDefinition()

◆ reset()

◆ setDefinition()

◆ translateErrorCode()

Field Documentation

◆ $definition

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