ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilADTBoolean Class Reference
+ Inheritance diagram for ilADTBoolean:
+ Collaboration diagram for ilADTBoolean:

Public Member Functions

 reset ()
 Init property defaults. More...
 
 setStatus ($a_value=null)
 
 getStatus ()
 
 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.ilADTBoolean.php.

Member Function Documentation

◆ equals()

ilADTBoolean::equals ( ilADT  $a_adt)

Check if given ADT equals self.

Parameters
ilADT$a_adt
Returns
bool

Reimplemented from ilADT.

Definition at line 42 of file class.ilADTBoolean.php.

43 {
44 if($this->isComparableTo($a_adt))
45 {
46 return ($this->getStatus() === $a_adt->getStatus());
47 }
48 }

References getStatus().

+ Here is the call graph for this function:

◆ getCheckSum()

ilADTBoolean::getCheckSum ( )

Get unique checksum.

Returns
string

Reimplemented from ilADT.

Definition at line 79 of file class.ilADTBoolean.php.

80 {
81 if(!$this->isNull())
82 {
83 return (string)$this->getStatus();
84 }
85 }
isNull()
Is currently null.

References getStatus(), and isNull().

+ Here is the call graph for this function:

◆ getStatus()

ilADTBoolean::getStatus ( )

Definition at line 34 of file class.ilADTBoolean.php.

35 {
36 return $this->value;
37 }

References $value.

Referenced by equals(), getCheckSum(), and isNull().

+ Here is the caller graph for this function:

◆ isLarger()

ilADTBoolean::isLarger ( ilADT  $a_adt)

Check if given ADT is larger than self.

Parameters
ilADT$a_adt
Returns
bool

Reimplemented from ilADT.

Definition at line 50 of file class.ilADTBoolean.php.

51 {
52 // return null?
53 }

◆ isNull()

ilADTBoolean::isNull ( )

Is currently null.

Returns
bool

Reimplemented from ilADT.

Definition at line 63 of file class.ilADTBoolean.php.

64 {
65 return ($this->getStatus() === null);
66 }

References getStatus().

Referenced by getCheckSum().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ isSmaller()

ilADTBoolean::isSmaller ( ilADT  $a_adt)

Check if given ADT is smaller than self.

Parameters
ilADT$a_adt
Returns
bool

Reimplemented from ilADT.

Definition at line 55 of file class.ilADTBoolean.php.

56 {
57 // return null?
58 }

◆ isValid()

ilADTBoolean::isValid ( )

Is currently valid.

Returns
boolean

Reimplemented from ilADT.

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

72 {
73 return true;
74 }

◆ isValidDefinition()

ilADTBoolean::isValidDefinition ( ilADTDefinition  $a_def)
protected

Check if definition is valid for ADT.

Returns
bool;

Reimplemented from ilADT.

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

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

◆ reset()

ilADTBoolean::reset ( )

Init property defaults.

Reimplemented from ilADT.

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

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

◆ setStatus()

ilADTBoolean::setStatus (   $a_value = null)

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

26 {
27 if($a_value !== null)
28 {
29 $a_value = (bool)$a_value;
30 }
31 $this->value = $a_value;
32 }

Field Documentation

◆ $value

ilADTBoolean::$value
protected

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

Referenced by getStatus().


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