ilADTFloatDefinition Class Reference

Inheritance diagram for ilADTFloatDefinition:

Collaboration diagram for ilADTFloatDefinition:

Public Member Functions
	handleNumber ($a_value)
	getMin ()
	setMin (?float $a_value)
	getMax ()
	setMax (?float $a_value)
	getSuffix ()
	setSuffix (?string $a_value)
	isComparableTo (ilADT $a_adt)
	Check if given ADT is comparable to self. More...
	reset ()
	Init property defaults. More...
	getDecimals ()
	setDecimals (int $a_value)
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	$decimals
float	$min_value
float	$max_value
string	$suffix = ''
Protected Attributes inherited from ilADTDefinition
bool	$allow_null

Detailed Description

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

Member Function Documentation

getDecimals()

ilADTFloatDefinition::getDecimals

(

)

Definition at line 68 of file class.ilADTFloatDefinition.php.

                                 : int
    {
        return $this->decimals;
    }

References $decimals.

getMax()

ilADTFloatDefinition::getMax

(

)

Definition at line 36 of file class.ilADTFloatDefinition.php.

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

References $max_value.

getMin()

ilADTFloatDefinition::getMin

(

)

Definition at line 26 of file class.ilADTFloatDefinition.php.

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

References $min_value.

getSuffix()

ilADTFloatDefinition::getSuffix

(

)

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

                               : string
    {
        return $this->suffix;
    }

References $suffix.

handleNumber()

ilADTFloatDefinition::handleNumber

(

$a_value

)

Definition at line 14 of file class.ilADTFloatDefinition.php.

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

Referenced by setMax(), and setMin().

Here is the caller graph for this function:

isComparableTo()

ilADTFloatDefinition::isComparableTo

(

ilADT

$a_adt

)

Check if given ADT is comparable to self.

Parameters

ilADT

$a_adt

Returns

bool

Reimplemented from ilADTDefinition.

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

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

reset()

ilADTFloatDefinition::reset

(

)

Init property defaults.

Reimplemented from ilADTDefinition.

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

                           : void
    {
        parent::reset();
        $this->setDecimals(1);
    }

References setDecimals().

Here is the call graph for this function:

setDecimals()

ilADTFloatDefinition::setDecimals

(

int

$a_value

)

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

                                             : void
    {
        // max precision ?!
        $this->decimals = max(1, abs($a_value));
    }

Referenced by reset().

Here is the caller graph for this function:

setMax()

ilADTFloatDefinition::setMax

(

?float

$a_value

)

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

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

References handleNumber().

Here is the call graph for this function:

setMin()

ilADTFloatDefinition::setMin

(

?float

$a_value

)

Definition at line 31 of file class.ilADTFloatDefinition.php.

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

References handleNumber().

Here is the call graph for this function:

setSuffix()

ilADTFloatDefinition::setSuffix

(

?string

$a_value

)

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

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

Field Documentation

$decimals

int ilADTFloatDefinition::$decimals

protected

Definition at line 7 of file class.ilADTFloatDefinition.php.

Referenced by getDecimals().

$max_value

float ilADTFloatDefinition::$max_value

protected

Definition at line 9 of file class.ilADTFloatDefinition.php.

Referenced by getMax().

$min_value

float ilADTFloatDefinition::$min_value

protected

Definition at line 8 of file class.ilADTFloatDefinition.php.

Referenced by getMin().

$suffix

string ilADTFloatDefinition::$suffix = ''

protected

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

Referenced by getSuffix().

---

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

• Services/ADT/classes/Types/Float/class.ilADTFloatDefinition.php