Inheritance diagram for ilADTInteger:

Collaboration diagram for ilADTInteger:

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

	setNumber ($a_value=null)

	getNumber ()

	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 ()
	Is currently null. More...

	isValid ()
	Is currently valid. More...

	getCheckSum ()
	Get unique checksum. More...

	exportStdClass ()
	Export value as stdClass. More...

	importStdClass ($a_std)
	Import value from stdClass. More...

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

	exportStdClass ()
	Export value as stdClass. More...

	importStdClass ($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
	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
	$value

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"

const	ADT_VALIDATION_ERROR_INVALID_NODE = 'adt7'

Detailed Description

Definition at line 3 of file class.ilADTInteger.php.

Member Function Documentation

◆ equals()

ilADTInteger::equals ( ilADT $a_adt )

Check if given ADT equals self.

Parameters

ilADT $a_adt

Returns: bool

Reimplemented from ilADT.

Definition at line 38 of file class.ilADTInteger.php.

    {
        if ($this->getDefinition()->isComparableTo($a_adt)) {
            return ($this->getNumber() == $a_adt->getNumber());
        }
    }

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

Here is the call graph for this function:

◆ exportStdClass()

ilADTInteger::exportStdClass ( )

Export value as stdClass.

Returns: stdClass

Reimplemented from ilADT.

Definition at line 105 of file class.ilADTInteger.php.

    {
        if (!$this->isNull()) {
            $obj = new stdClass();
            $obj->value = $this->getNumber();
            return $obj;
        }
    }

References getNumber(), and isNull().

Here is the call graph for this function:

◆ getCheckSum()

ilADTInteger::getCheckSum ( )

Get unique checksum.

Returns: string

Reimplemented from ilADT.

Definition at line 95 of file class.ilADTInteger.php.

    {
        if (!$this->isNull()) {
            return (string) $this->getNumber();
        }
    }

References getNumber(), and isNull().

Here is the call graph for this function:

◆ getNumber()

ilADTInteger::getNumber ( )

Definition at line 30 of file class.ilADTInteger.php.

    {
        return $this->value;
    }

References $value.

Referenced by equals(), exportStdClass(), getCheckSum(), isLarger(), isNull(), isSmaller(), and isValid().

Here is the caller graph for this function:

◆ importStdClass()

ilADTInteger::importStdClass ( $a_std )

Import value from stdClass.

Parameters

stdClass $a_std

Reimplemented from ilADT.

Definition at line 114 of file class.ilADTInteger.php.

    {
        if (is_object($a_std)) {
            $this->setNumber($a_std->value);
        }
    }

References setNumber().

Here is the call graph for this function:

◆ isLarger()

ilADTInteger::isLarger ( ilADT $a_adt )

Check if given ADT is larger than self.

Parameters

ilADT $a_adt

Returns: bool

Reimplemented from ilADT.

Definition at line 45 of file class.ilADTInteger.php.

    {
        if ($this->getDefinition()->isComparableTo($a_adt)) {
            return ($this->getNumber() > $a_adt->getNumber());
        }
    }

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

Here is the call graph for this function:

◆ isNull()

ilADTInteger::isNull ( )

Is currently null.

Returns: bool

Reimplemented from ilADT.

Definition at line 62 of file class.ilADTInteger.php.

    {
        return ($this->getNumber() === null);
    }

References getNumber().

Referenced by exportStdClass(), and getCheckSum().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isSmaller()

ilADTInteger::isSmaller ( ilADT $a_adt )

Check if given ADT is smaller than self.

Parameters

ilADT $a_adt

Returns: bool

Reimplemented from ilADT.

Definition at line 52 of file class.ilADTInteger.php.

    {
        if ($this->getDefinition()->isComparableTo($a_adt)) {
            return ($this->getNumber() < $a_adt->getNumber());
        }
    }

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

Here is the call graph for this function:

◆ isValid()

ilADTInteger::isValid ( )

Is currently valid.

Returns: boolean

Reimplemented from ilADT.

Definition at line 70 of file class.ilADTInteger.php.

    {
        $valid = parent::isValid();
        
        $num = $this->getNumber();
        if ($num !== null) {
            $min = $this->getDefinition()->getMin();
            if ($min !== null && $num < $min) {
                $this->addValidationError(self::ADT_VALIDATION_ERROR_MIN);
                $valid = false;
            }
 
            $max = $this->getDefinition()->getMax();
            if ($max !== null && $num > $max) {
                $this->addValidationError(self::ADT_VALIDATION_ERROR_MAX);
                $valid = false;
            }
        }
        
        return $valid;
    }

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

Here is the call graph for this function:

◆ isValidDefinition()

ilADTInteger::isValidDefinition ( ilADTDefinition $a_def )

protected

Check if definition is valid for ADT.

Returns: bool;

Reimplemented from ilADT.

Reimplemented in ilADTFloat.

Definition at line 10 of file class.ilADTInteger.php.

    {
        return ($a_def instanceof ilADTIntegerDefinition);
    }

◆ reset()

ilADTInteger::reset ( )

Init property defaults.

Reimplemented from ilADT.

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

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

◆ setNumber()

ilADTInteger::setNumber ( $a_value = null )

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

    {
        $this->value = $this->getDefinition()->handleNumber($a_value);
    }

References ilADT\getDefinition().

Referenced by importStdClass().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $value

ilADTInteger::$value

protected

Definition at line 5 of file class.ilADTInteger.php.

Referenced by getNumber().

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

Services/ADT/classes/Types/Integer/class.ilADTInteger.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ equals()

◆ exportStdClass()

◆ getCheckSum()

◆ getNumber()

◆ importStdClass()

◆ isLarger()

◆ isNull()

◆ isSmaller()

◆ isValid()

◆ isValidDefinition()

◆ reset()

◆ setNumber()

Field Documentation

◆ $value