ILIAS  release_8 Revision v8.24
Public Member Functions | Protected Member Functions | Protected Attributes
ilADTDateTime Class Reference
+ Inheritance diagram for ilADTDateTime:
+ Collaboration diagram for ilADTDateTime:

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 5 of file class.ilADTDateTime.php.

Member Function Documentation

◆ equals()

ilADTDateTime::equals ( ilADT  $a_adt)

Check if given ADT equals self.

Parameters
ilADT$a_adt
Returns
bool|null

Reimplemented from ilADT.

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

39 : ?bool
40 {
41 if ($this->getDefinition()->isComparableTo($a_adt)) {
42 if (!$this->isNull() && !$a_adt->isNull()) {
43 // could use checksum...
44 $value = $this->getDate()->get(IL_CAL_UNIX);
45 $other = $a_adt->getDate()->get(IL_CAL_UNIX);
46 return ($value == $other);
47 }
48 }
49 return null;
50 }
IL_CAL_UNIX
const IL_CAL_UNIX
Definition: class.ilDateTime.php:9
ilADTDateTime\isNull
isNull()
Is currently null.
Definition: class.ilADTDateTime.php:78
ilADT\isNull
isNull()
Is currently null.
ilADT\getDefinition
getDefinition()
Get definition.
Definition: class.ilADT.php:92

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

+ Here is the call graph for this function:

◆ exportStdClass()

ilADTDateTime::exportStdClass ( )

Export value as stdClass.

Returns
stdClass | null

Reimplemented from ilADT.

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

93 : ?stdClass
94 {
95 if (!$this->isNull()) {
96 $obj = new stdClass();
97 $obj->value = $this->getDate()->get(IL_CAL_UNIX);
98 return $obj;
99 }
100 return null;
101 }

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

+ Here is the call graph for this function:

◆ getCheckSum()

ilADTDateTime::getCheckSum ( )

Get unique checksum.

Returns
string | null

Reimplemented from ilADT.

Definition at line 83 of file class.ilADTDateTime.php.

83 : ?string
84 {
85 if (!$this->isNull()) {
86 return (string) $this->getDate()->get(IL_CAL_UNIX);
87 }
88 return null;
89 }

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

+ Here is the call graph for this function:

◆ getDate()

ilADTDateTime::getDate ( )

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

32 : ?ilDateTime
33 {
34 return $this->value;
35 }
ilDateTime
@classDescription Date and time handling
Definition: class.ilDateTime.php:29

References $value.

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

+ Here is the caller graph for this function:

◆ importStdClass()

ilADTDateTime::importStdClass ( ?stdClass  $a_std)

Import value from stdClass.

Parameters
stdClass  |  null$a_std

Reimplemented from ilADT.

Definition at line 103 of file class.ilADTDateTime.php.

103 : void
104 {
105 if (is_object($a_std)) {
106 $this->setDate(new ilDateTime($a_std->value, IL_CAL_UNIX));
107 }
108 }
ilADTDateTime\setDate
setDate(ilDateTime $a_value=null)
Definition: class.ilADTDateTime.php:24

References IL_CAL_UNIX, and setDate().

+ Here is the call graph for this function:

◆ isLarger()

ilADTDateTime::isLarger ( ilADT  $a_adt)

Check if given ADT is larger than self.

Parameters
ilADT$a_adt
Returns
bool

Reimplemented from ilADT.

Definition at line 52 of file class.ilADTDateTime.php.

52 : ?bool
53 {
54 if ($this->getDefinition()->isComparableTo($a_adt)) {
55 if (!$this->isNull() && !$a_adt->isNull()) {
56 $value = $this->getDate()->get(IL_CAL_UNIX);
57 $other = $a_adt->getDate()->get(IL_CAL_UNIX);
58 return ($value > $other);
59 }
60 }
61 return null;
62 }

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

+ Here is the call graph for this function:

◆ isNull()

ilADTDateTime::isNull ( )

Is currently null.

Returns
bool | null

Reimplemented from ilADT.

Definition at line 78 of file class.ilADTDateTime.php.

78 : bool
79 {
80 return !$this->value instanceof ilDateTime || $this->value->isNull();
81 }
ilDateTime\isNull
isNull()
Check if a date is null (Datetime == '0000-00-00 00:00:00', unixtime == 0,...)
Definition: class.ilDateTime.php:88

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()

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

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

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

+ Here is the call graph for this function:

◆ isValidDefinition()

ilADTDateTime::isValidDefinition ( ilADTDefinition  $a_def)
protected

Check if definition is valid for ADT.

Parameters
ilADTDefinition$a_def
Returns
bool

Reimplemented from ilADT.

Definition at line 11 of file class.ilADTDateTime.php.

11 : bool
12 {
13 return $a_def instanceof ilADTDateTimeDefinition;
14 }

◆ reset()

ilADTDateTime::reset ( )

Init property defaults.

Reimplemented from ilADT.

Definition at line 16 of file class.ilADTDateTime.php.

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

◆ setDate()

ilADTDateTime::setDate ( ilDateTime  $a_value = null)

Definition at line 24 of file class.ilADTDateTime.php.

25 {
26 if ($a_value && $a_value->isNull()) {
27 $a_value = null;
28 }
29 $this->value = $a_value;
30 }

Referenced by importStdClass().

+ Here is the caller graph for this function:

Field Documentation

◆ $value

ilDateTime ilADTDateTime::$value
protected

Definition at line 7 of file class.ilADTDateTime.php.

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

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