ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilADTInteger Class Reference
+ 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...
 
- 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...
 

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"
 

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.

39 {
40 if($this->getDefinition()->isComparableTo($a_adt))
41 {
42 return ($this->getNumber() == $a_adt->getNumber());
43 }
44 }
getDefinition()
Get definition.
Definition: class.ilADT.php:99

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

+ Here is the call graph for this function:

◆ getCheckSum()

ilADTInteger::getCheckSum ( )

Get unique checksum.

Returns
string

Reimplemented from ilADT.

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

102 {
103 if(!$this->isNull())
104 {
105 return (string)$this->getNumber();
106 }
107 }
isNull()
Is currently null.

References getNumber(), and isNull().

+ Here is the call graph for this function:

◆ getNumber()

ilADTInteger::getNumber ( )

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

31 {
32 return $this->value;
33 }

References $value.

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

+ Here is the caller 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 46 of file class.ilADTInteger.php.

47 {
48 if($this->getDefinition()->isComparableTo($a_adt))
49 {
50 return ($this->getNumber() > $a_adt->getNumber());
51 }
52 }

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 65 of file class.ilADTInteger.php.

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

References getNumber().

Referenced by 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 54 of file class.ilADTInteger.php.

55 {
56 if($this->getDefinition()->isComparableTo($a_adt))
57 {
58 return ($this->getNumber() < $a_adt->getNumber());
59 }
60 }

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 73 of file class.ilADTInteger.php.

74 {
75 $valid = parent::isValid();
76
77 $num = $this->getNumber();
78 if($num !== null)
79 {
80 $min = $this->getDefinition()->getMin();
81 if($min !== null && $num < $min)
82 {
83 $this->addValidationError(self::ADT_VALIDATION_ERROR_MIN);
84 $valid = false;
85 }
86
87 $max = $this->getDefinition()->getMax();
88 if($max !== null && $num > $max)
89 {
90 $this->addValidationError(self::ADT_VALIDATION_ERROR_MAX);
91 $valid = false;
92 }
93 }
94
95 return $valid;
96 }
addValidationError($a_error_code)
Add validation error code.
$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.

11 {
12 return ($a_def instanceof ilADTIntegerDefinition);
13 }

◆ reset()

ilADTInteger::reset ( )

Init property defaults.

Reimplemented from ilADT.

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

16 {
17 parent::reset();
18
19 $this->value = null;
20 }

◆ setNumber()

ilADTInteger::setNumber (   $a_value = null)

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

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

References ilADT\getDefinition().

+ Here is the call 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: