ilADTInteger Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilADTInteger:

Collaboration diagram for ilADTInteger:

Public Member Functions
	reset ()
	setNumber ($a_value=null)
	getNumber ()
	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
int	$value
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

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

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

Member Function Documentation

equals()

ilADTInteger::equals

(

ilADT

$a_adt

)

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

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

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

Here is the call graph for this function:

exportStdClass()

ilADTInteger::exportStdClass

(

)

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

References getNumber(), and isNull().

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

Here is the call graph for this function:

getCheckSum()

ilADTInteger::getCheckSum

(

)

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

References getNumber(), and isNull().

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

Here is the call graph for this function:

getNumber()

ilADTInteger::getNumber

(

)

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

References $value.

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

                               : ?int
    {
        return $this->value;
    }

Here is the caller graph for this function:

importStdClass()

ilADTInteger::importStdClass

(

?stdClass

$a_std

)

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

References setNumber().

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

Here is the call graph for this function:

isLarger()

ilADTInteger::isLarger

(

ilADT

$a_adt

)

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

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

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

Here is the call graph for this function:

isNull()

ilADTInteger::isNull

(

)

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

References getNumber().

Referenced by exportStdClass(), and getCheckSum().

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

Here is the call graph for this function:

Here is the caller graph for this function:

isSmaller()

ilADTInteger::isSmaller

(

ilADT

$a_adt

)

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

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

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

Here is the call graph for this function:

isValid()

ilADTInteger::isValid

(

)

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

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

                             : bool
    {
        $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;
    }

Here is the call graph for this function:

isValidDefinition()

ilADTInteger::isValidDefinition ( ilADTDefinition  $a_def )

protected

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

                                                                : bool
    {
        return $a_def instanceof ilADTIntegerDefinition;
    }

reset()

ilADTInteger::reset

(

)

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

                           : void
    {
        parent::reset();

        $this->value = null;
    }

setNumber()

ilADTInteger::setNumber

(

$a_value = null

)

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

References ilADT\getDefinition().

Referenced by importStdClass().

    {
        if ($a_value !== null) {
            $this->value = $this->getDefinition()->handleNumber((int) $a_value);
        } else {
            $this->value = null;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$value

int ilADTInteger::$value

protected

Definition at line 23 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