ILIAS  release_9 Revision v9.13-25-g2c18ec4c24f
Public Member Functions | Protected Member Functions | Protected Attributes
ilADTDate Class Reference
+ Inheritance diagram for ilADTDate:
+ Collaboration diagram for ilADTDate:

Public Member Functions

 reset ()
 
 setDate (?ilDateTime $a_value=null)
 
 getDate ()
 
 equals (ilADT $a_adt)
 
 isLarger (ilADT $a_adt)
 
 isSmaller (ilADT $a_adt)
 
 isNull ()
 
 getCheckSum ()
 
 exportStdClass ()
 
 importStdClass (?stdClass $a_std)
 
- 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)
 
- 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.ilADTDate.php.

Member Function Documentation

◆ equals()

ilADTDate::equals ( ilADT  $a_adt)

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

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

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

◆ exportStdClass()

ilADTDate::exportStdClass ( )

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

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

92  : ?stdClass
93  {
94  if (!$this->isNull()) {
95  $obj = new stdClass();
96  $obj->value = $this->getDate()->get(IL_CAL_UNIX);
97  return $obj;
98  }
99  return null;
100  }
IL_CAL_UNIX
const IL_CAL_UNIX
Definition: class.ilDateTime.php:9
+ Here is the call graph for this function:

◆ getCheckSum()

ilADTDate::getCheckSum ( )

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

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

82  : ?string
83  {
84  if (!$this->isNull()) {
85  return (string) $this->getDate()->get(IL_CAL_UNIX);
86  }
87  return null;
88  }
IL_CAL_UNIX
const IL_CAL_UNIX
Definition: class.ilDateTime.php:9
+ Here is the call graph for this function:

◆ getDate()

ilADTDate::getDate ( )

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

References $value.

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

31  : ?ilDateTime
32  {
33  return $this->value;
34  }
ilADTDate\$value
ilDateTime $value
Definition: class.ilADTDate.php:7
+ Here is the caller graph for this function:

◆ importStdClass()

ilADTDate::importStdClass ( ?stdClass  $a_std)

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

References IL_CAL_UNIX, and setDate().

102  : void
103  {
104  if (is_object($a_std)) {
105  $this->setDate(new ilDate($a_std->value, IL_CAL_UNIX));
106  }
107  }
ilADTDate\setDate
setDate(?ilDateTime $a_value=null)
Definition: class.ilADTDate.php:23
IL_CAL_UNIX
const IL_CAL_UNIX
Definition: class.ilDateTime.php:9
+ Here is the call graph for this function:

◆ isLarger()

ilADTDate::isLarger ( ilADT  $a_adt)

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

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

51  : ?bool
52  {
53  if ($this->getDefinition()->isComparableTo($a_adt)) {
54  if (!$this->isNull() && !$a_adt->isNull()) {
55  $value = $this->getDate()->get(IL_CAL_UNIX);
56  $other = $a_adt->getDate()->get(IL_CAL_UNIX);
57  return ($value > $other);
58  }
59  }
60  return null;
61  }
IL_CAL_UNIX
const IL_CAL_UNIX
Definition: class.ilDateTime.php:9
ilADTDate\$value
ilDateTime $value
Definition: class.ilADTDate.php:7
ilADT\isNull
isNull()
Is currently null.
ilADT\getDefinition
getDefinition()
Get definition.
Definition: class.ilADT.php:92
+ Here is the call graph for this function:

◆ isNull()

ilADTDate::isNull ( )

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

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

77  : bool
78  {
79  return !$this->value instanceof ilDate || $this->value->isNull();
80  }
+ Here is the caller graph for this function:

◆ isSmaller()

ilADTDate::isSmaller ( ilADT  $a_adt)

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

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

63  : ?bool
64  {
65  if ($this->getDefinition()->isComparableTo($a_adt)) {
66  if (!$this->isNull() && !$a_adt->isNull()) {
67  $value = $this->getDate()->get(IL_CAL_UNIX);
68  $other = $a_adt->getDate()->get(IL_CAL_UNIX);
69  return ($value < $other);
70  }
71  }
72  return null;
73  }
IL_CAL_UNIX
const IL_CAL_UNIX
Definition: class.ilDateTime.php:9
ilADTDate\$value
ilDateTime $value
Definition: class.ilADTDate.php:7
ilADT\isNull
isNull()
Is currently null.
ilADT\getDefinition
getDefinition()
Get definition.
Definition: class.ilADT.php:92
+ Here is the call graph for this function:

◆ isValidDefinition()

ilADTDate::isValidDefinition ( ilADTDefinition  $a_def)
protected

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

11  : bool
12  {
13  return ($a_def instanceof ilADTDateDefinition);
14  }

◆ reset()

ilADTDate::reset ( )

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

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

◆ setDate()

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

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

Referenced by importStdClass().

23  : void
24  {
25  if ($a_value && $a_value->isNull()) {
26  $a_value = null;
27  }
28  $this->value = $a_value;
29  }
+ Here is the caller graph for this function:

Field Documentation

◆ $value

ilDateTime ilADTDate::$value
protected

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

Referenced by getDate().

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