ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
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 ()
 
 getCheckSum ()
 Get unique checksum. More...
 
 exportStdClass ()
 Export value as stdClass. More...
 
 importStdClass (?stdClass $a_std)
 Import value from stdClass. More...
 
- 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)
 Check if definition is valid for ADT. More...
 
- 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

Definition at line 20 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|null

Reimplemented from ilADT.

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

56 : ?bool
57 {
58 if ($this->getDefinition()->isComparableTo($a_adt)) {
59 return ($this->getNumber() == $a_adt->getNumber());
60 }
61 return null;
62 }
getDefinition()
Get definition.

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

+ Here is the call graph for this function:

◆ exportStdClass()

ilADTInteger::exportStdClass ( )

Export value as stdClass.

Returns
stdClass | null

Reimplemented from ilADT.

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

117 : ?stdClass
118 {
119 if (!$this->isNull()) {
120 $obj = new stdClass();
121 $obj->value = $this->getNumber();
122 return $obj;
123 }
124 return null;
125 }
isNull()
Is currently null.

References getNumber(), and isNull().

+ Here is the call graph for this function:

◆ getCheckSum()

ilADTInteger::getCheckSum ( )

Get unique checksum.

Returns
string | null

Reimplemented from ilADT.

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

107 : ?string
108 {
109 if (!$this->isNull()) {
110 return (string) $this->getNumber();
111 }
112 return null;
113 }

References getNumber(), and isNull().

+ Here is the call graph for this function:

◆ getNumber()

ilADTInteger::getNumber ( )

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

49 : ?int
50 {
51 return $this->value;
52 }

References $value.

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

+ Here is the caller graph for this function:

◆ importStdClass()

ilADTInteger::importStdClass ( ?stdClass  $a_std)

Import value from stdClass.

Parameters
stdClass  |  null$a_std

Reimplemented from ilADT.

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

127 : void
128 {
129 if (is_object($a_std)) {
130 $this->setNumber($a_std->value);
131 }
132 }
setNumber($a_value=null)

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

64 : ?bool
65 {
66 if ($this->getDefinition()->isComparableTo($a_adt)) {
67 return ($this->getNumber() > $a_adt->getNumber());
68 }
69 return null;
70 }

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

+ Here is the call graph for this function:

◆ isNull()

ilADTInteger::isNull ( )

Is currently null.

Returns
bool | null

Reimplemented from ilADT.

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

82 : bool
83 {
84 return $this->getNumber() === null;
85 }

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

Reimplemented from ilADT.

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

72 : ?bool
73 {
74 if ($this->getDefinition()->isComparableTo($a_adt)) {
75 return ($this->getNumber() < $a_adt->getNumber());
76 }
77 return null;
78 }

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

+ Here is the call graph for this function:

◆ isValid()

ilADTInteger::isValid ( )

Reimplemented from ilADT.

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

87 : bool
88 {
89 $valid = parent::isValid();
90 $num = $this->getNumber();
91 if ($num !== null) {
92 $min = $this->getDefinition()->getMin();
93 if ($min !== null && $num < $min) {
94 $this->addValidationError(self::ADT_VALIDATION_ERROR_MIN);
95 $valid = false;
96 }
97
98 $max = $this->getDefinition()->getMax();
99 if ($max !== null && $num > $max) {
100 $this->addValidationError(self::ADT_VALIDATION_ERROR_MAX);
101 $valid = false;
102 }
103 }
104 return $valid;
105 }
addValidationError(string $a_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.

Parameters
ilADTDefinition$a_def
Returns
bool

Reimplemented from ilADT.

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

26 : bool
27 {
28 return $a_def instanceof ilADTIntegerDefinition;
29 }

◆ reset()

ilADTInteger::reset ( )

Init property defaults.

Reimplemented from ilADT.

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

31 : void
32 {
33 parent::reset();
34
35 $this->value = null;
36 }

◆ setNumber()

ilADTInteger::setNumber (   $a_value = null)

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

41 {
42 if ($a_value !== null) {
43 $this->value = $this->getDefinition()->handleNumber((int) $a_value);
44 } else {
45 $this->value = null;
46 }
47 }

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

int ilADTInteger::$value
protected

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

Referenced by getNumber().


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