ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
ilADTDate Class Reference
+ Inheritance diagram for ilADTDate:
+ Collaboration diagram for ilADTDate:

Public Member Functions

 reset ()
 Init property defaults. More...
 
 setDate (?ilDateTime $a_value=null)
 
 getDate ()
 
 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...
 
 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

ilDateTime $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 21 of file class.ilADTDate.php.

Member Function Documentation

◆ equals()

ilADTDate::equals ( ilADT  $a_adt)

Check if given ADT equals self.

Parameters
ilADT$a_adt
Returns
bool|null

Reimplemented from ilADT.

Definition at line 54 of file class.ilADTDate.php.

54 : ?bool
55 {
56 if ($this->getDefinition()->isComparableTo($a_adt)) {
57 if (!$this->isNull() && !$a_adt->isNull()) {
58 // could use checksum...
59 $value = $this->getDate()->get(IL_CAL_UNIX);
60 $other = $a_adt->getDate()->get(IL_CAL_UNIX);
61 return ($value == $other);
62 }
63 }
64 return null;
65 }
const IL_CAL_UNIX
isNull()
Is currently null.
ilDateTime $value
isNull()
Is currently null.
getDefinition()
Get definition.

References $value, getDate(), ilADT\getDefinition(), IL_CAL_UNIX, ilADT\isNull(), and isNull().

+ Here is the call graph for this function:

◆ exportStdClass()

ilADTDate::exportStdClass ( )

Export value as stdClass.

Returns
stdClass | null

Reimplemented from ilADT.

Definition at line 108 of file class.ilADTDate.php.

108 : ?stdClass
109 {
110 if (!$this->isNull()) {
111 $obj = new stdClass();
112 $obj->value = $this->getDate()->get(IL_CAL_UNIX);
113 return $obj;
114 }
115 return null;
116 }

References getDate(), IL_CAL_UNIX, and isNull().

+ Here is the call graph for this function:

◆ getCheckSum()

ilADTDate::getCheckSum ( )

Get unique checksum.

Returns
string | null

Reimplemented from ilADT.

Definition at line 98 of file class.ilADTDate.php.

98 : ?string
99 {
100 if (!$this->isNull()) {
101 return (string) $this->getDate()->get(IL_CAL_UNIX);
102 }
103 return null;
104 }

References getDate(), IL_CAL_UNIX, and isNull().

+ Here is the call graph for this function:

◆ getDate()

ilADTDate::getDate ( )

Definition at line 47 of file class.ilADTDate.php.

47 : ?ilDateTime
48 {
49 return $this->value;
50 }
@classDescription Date and time handling

References $value.

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

+ Here is the caller graph for this function:

◆ importStdClass()

ilADTDate::importStdClass ( ?stdClass  $a_std)

Import value from stdClass.

Parameters
stdClass  |  null$a_std

Reimplemented from ilADT.

Definition at line 118 of file class.ilADTDate.php.

118 : void
119 {
120 if (is_object($a_std)) {
121 $this->setDate(new ilDate($a_std->value, IL_CAL_UNIX));
122 }
123 }
setDate(?ilDateTime $a_value=null)
Class for single dates.

References IL_CAL_UNIX, and setDate().

+ Here is the call graph for this function:

◆ isLarger()

ilADTDate::isLarger ( ilADT  $a_adt)

Check if given ADT is larger than self.

Parameters
ilADT$a_adt
Returns
bool

Reimplemented from ilADT.

Definition at line 67 of file class.ilADTDate.php.

67 : ?bool
68 {
69 if ($this->getDefinition()->isComparableTo($a_adt)) {
70 if (!$this->isNull() && !$a_adt->isNull()) {
71 $value = $this->getDate()->get(IL_CAL_UNIX);
72 $other = $a_adt->getDate()->get(IL_CAL_UNIX);
73 return ($value > $other);
74 }
75 }
76 return null;
77 }

References $value, getDate(), ilADT\getDefinition(), IL_CAL_UNIX, ilADT\isNull(), and isNull().

+ Here is the call graph for this function:

◆ isNull()

ilADTDate::isNull ( )

Is currently null.

Returns
bool | null

Reimplemented from ilADT.

Definition at line 93 of file class.ilADTDate.php.

93 : bool
94 {
95 return !$this->value instanceof ilDate || $this->value->isNull();
96 }
isNull()
Check if a date is null (Datetime == '0000-00-00 00:00:00', unixtime == 0,...)

References ilDateTime\isNull().

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

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

◆ isSmaller()

ilADTDate::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 79 of file class.ilADTDate.php.

79 : ?bool
80 {
81 if ($this->getDefinition()->isComparableTo($a_adt)) {
82 if (!$this->isNull() && !$a_adt->isNull()) {
83 $value = $this->getDate()->get(IL_CAL_UNIX);
84 $other = $a_adt->getDate()->get(IL_CAL_UNIX);
85 return ($value < $other);
86 }
87 }
88 return null;
89 }

References $value, getDate(), ilADT\getDefinition(), IL_CAL_UNIX, ilADT\isNull(), and isNull().

+ Here is the call graph for this function:

◆ isValidDefinition()

ilADTDate::isValidDefinition ( ilADTDefinition  $a_def)
protected

Check if definition is valid for ADT.

Parameters
ilADTDefinition$a_def
Returns
bool

Reimplemented from ilADT.

Definition at line 27 of file class.ilADTDate.php.

27 : bool
28 {
29 return ($a_def instanceof ilADTDateDefinition);
30 }

◆ reset()

ilADTDate::reset ( )

Init property defaults.

Reimplemented from ilADT.

Definition at line 32 of file class.ilADTDate.php.

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

◆ setDate()

ilADTDate::setDate ( ?ilDateTime  $a_value = null)

Definition at line 39 of file class.ilADTDate.php.

39 : void
40 {
41 if ($a_value && $a_value->isNull()) {
42 $a_value = null;
43 }
44 $this->value = $a_value;
45 }

Referenced by importStdClass().

+ Here is the caller graph for this function:

Field Documentation

◆ $value

ilDateTime ilADTDate::$value
protected

Definition at line 23 of file class.ilADTDate.php.

Referenced by equals(), getDate(), isLarger(), and isSmaller().


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