ilADTIntegerDefinition Class Reference

Inheritance diagram for ilADTIntegerDefinition:

Collaboration diagram for ilADTIntegerDefinition:

Public Member Functions
	handleNumber (?int $a_value)
	getMin ()
	setMin (?int $a_value)
	getMax ()
	setMax (?int $a_value)
	getSuffix ()
	setSuffix (?string $a_value)
	isComparableTo (ilADT $a_adt)
	Check if given ADT is comparable to self. More...
Public Member Functions inherited from ilADTDefinition
	__construct ()
	getType ()
	Get type (from class/instance) More...
	reset ()
	Init property defaults. More...
	setAllowNull (bool $a_value)
	Toggle null allowed status. More...
	isNullAllowed ()
	isComparableTo (ilADT $a_adt)
	Check if given ADT is comparable to self. More...

Protected Attributes
int	$min_value
int	$max_value
string	$suffix = ''
Protected Attributes inherited from ilADTDefinition
bool	$allow_null

Detailed Description

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

Member Function Documentation

getMax()

ilADTIntegerDefinition::getMax

(

)

Definition at line 51 of file class.ilADTIntegerDefinition.php.

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

References $max_value.

getMin()

ilADTIntegerDefinition::getMin

(

)

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

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

References $min_value.

getSuffix()

ilADTIntegerDefinition::getSuffix

(

)

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

                               : string
    {
        return $this->suffix;
    }

References $suffix.

handleNumber()

ilADTIntegerDefinition::handleNumber

(

?int

$a_value

)

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

                                               : ?int
    {
        if (!is_numeric($a_value)) {
            $a_value = null;
        }
        if ($a_value !== null) {
            // round?
            $a_value = (int) $a_value;
        }
        return $a_value;
    }

References ILIAS\Repository\int().

Referenced by setMax(), and setMin().

Here is the call graph for this function:

Here is the caller graph for this function:

isComparableTo()

ilADTIntegerDefinition::isComparableTo

(

ilADT

$a_adt

)

Check if given ADT is comparable to self.

Parameters

ilADT

$a_adt

Returns

bool

Reimplemented from ilADTDefinition.

Definition at line 71 of file class.ilADTIntegerDefinition.php.

                                                : bool
    {
        // has to be number-based
        return ($a_adt instanceof ilADTInteger);
    }

setMax()

ilADTIntegerDefinition::setMax

(

?int

$a_value

)

Definition at line 56 of file class.ilADTIntegerDefinition.php.

                                         : void
    {
        $this->max_value = $this->handleNumber($a_value);
    }

References handleNumber().

Here is the call graph for this function:

setMin()

ilADTIntegerDefinition::setMin

(

?int

$a_value

)

Definition at line 46 of file class.ilADTIntegerDefinition.php.

                                         : void
    {
        $this->min_value = $this->handleNumber($a_value);
    }

References handleNumber().

Here is the call graph for this function:

setSuffix()

ilADTIntegerDefinition::setSuffix

(

?string

$a_value

)

Definition at line 66 of file class.ilADTIntegerDefinition.php.

                                               : void
    {
        $this->suffix = $a_value === null ? '' : trim($a_value);
    }

Field Documentation

$max_value

int ilADTIntegerDefinition::$max_value

protected

Definition at line 24 of file class.ilADTIntegerDefinition.php.

Referenced by getMax().

$min_value

int ilADTIntegerDefinition::$min_value

protected

Definition at line 23 of file class.ilADTIntegerDefinition.php.

Referenced by getMin().

$suffix

string ilADTIntegerDefinition::$suffix = ''

protected

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

Referenced by getSuffix().

---

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

• components/ILIAS/ADT/classes/Types/Integer/class.ilADTIntegerDefinition.php