ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
Public Member Functions | Protected Member Functions | Protected Attributes
ilADTInteger Class Reference
+ 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 ()
 
- 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)
 
- 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)

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

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

39  {
40  if($this->getDefinition()->isComparableTo($a_adt))
41  {
42  return ($this->getNumber() == $a_adt->getNumber());
43  }
44  }
ilADT\getDefinition
getDefinition()
Get definition.
Definition: class.ilADT.php:99
+ Here is the call graph for this function:

◆ getCheckSum()

ilADTInteger::getCheckSum ( )

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

References getNumber(), and isNull().

102  {
103  if(!$this->isNull())
104  {
105  return (string)$this->getNumber();
106  }
107  }
+ Here is the call graph for this function:

◆ getNumber()

ilADTInteger::getNumber ( )

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

References $value.

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

31  {
32  return $this->value;
33  }
+ Here is the caller graph for this function:

◆ isLarger()

ilADTInteger::isLarger ( ilADT  $a_adt)

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

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

47  {
48  if($this->getDefinition()->isComparableTo($a_adt))
49  {
50  return ($this->getNumber() > $a_adt->getNumber());
51  }
52  }
ilADT\getDefinition
getDefinition()
Get definition.
Definition: class.ilADT.php:99
+ Here is the call graph for this function:

◆ isNull()

ilADTInteger::isNull ( )

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

References getNumber().

Referenced by getCheckSum().

66  {
67  return ($this->getNumber() === null);
68  }
+ 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 54 of file class.ilADTInteger.php.

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

55  {
56  if($this->getDefinition()->isComparableTo($a_adt))
57  {
58  return ($this->getNumber() < $a_adt->getNumber());
59  }
60  }
ilADT\getDefinition
getDefinition()
Get definition.
Definition: class.ilADT.php:99
+ Here is the call graph for this function:

◆ isValid()

ilADTInteger::isValid ( )

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

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

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  }
$valid
$valid
Definition: dummy_client.php:53
ilADT\addValidationError
addValidationError($a_error_code)
Add validation error code.
Definition: class.ilADT.php:233
ilADT\getDefinition
getDefinition()
Get definition.
Definition: class.ilADT.php:99
+ Here is the call graph for this function:

◆ isValidDefinition()

ilADTInteger::isValidDefinition ( ilADTDefinition  $a_def)
protected

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

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

◆ reset()

ilADTInteger::reset ( )

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.

References ilADT\getDefinition().

26  {
27  $this->value = $this->getDefinition()->handleNumber($a_value);
28  }
ilADT\getDefinition
getDefinition()
Get definition.
Definition: class.ilADT.php:99
+ 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: