ILIAS  release_5-2 Revision v5.2.25-18-g3f80b82851
ilADTDateTime Class Reference
+ Inheritance diagram for ilADTDateTime:
+ Collaboration diagram for ilADTDateTime:

Public Member Functions

 reset ()
 
 setDate (ilDateTime $a_value=null)
 
 getDate ()
 
 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.ilADTDateTime.php.

Member Function Documentation

◆ equals()

ilADTDateTime::equals ( ilADT  $a_adt)

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

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

43  {
44  if($this->getDefinition()->isComparableTo($a_adt))
45  {
46  if(!$this->isNull() && !$a_adt->isNull())
47  {
48  // could use checksum...
49  $value = $this->getDate()->get(IL_CAL_UNIX);
50  $other = $a_adt->getDate()->get(IL_CAL_UNIX);
51  return ($value == $other);
52  }
53  }
54  // null?
55  }
const IL_CAL_UNIX
isNull()
Is currently null.
getDefinition()
Get definition.
Definition: class.ilADT.php:99
+ Here is the call graph for this function:

◆ getCheckSum()

ilADTDateTime::getCheckSum ( )

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

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

117  {
118  if(!$this->isNull())
119  {
120  return (string)$this->getDate()->get(IL_CAL_UNIX);
121  }
122  }
const IL_CAL_UNIX
+ Here is the call graph for this function:

◆ getDate()

ilADTDateTime::getDate ( )

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

References $value.

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

35  {
36  return $this->value;
37  }
+ Here is the caller graph for this function:

◆ isLarger()

ilADTDateTime::isLarger ( ilADT  $a_adt)

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

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

58  {
59  if($this->getDefinition()->isComparableTo($a_adt))
60  {
61  if(!$this->isNull() && !$a_adt->isNull())
62  {
63  $value = $this->getDate()->get(IL_CAL_UNIX);
64  $other = $a_adt->getDate()->get(IL_CAL_UNIX);
65  return ($value > $other);
66  }
67  }
68  }
const IL_CAL_UNIX
isNull()
Is currently null.
getDefinition()
Get definition.
Definition: class.ilADT.php:99
+ Here is the call graph for this function:

◆ isNull()

ilADTDateTime::isNull ( )

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

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

87  {
88  return (!($this->value instanceof ilDateTime) || $this->value->isNull());
89  }
Date and time handling
+ Here is the caller graph for this function:

◆ isSmaller()

ilADTDateTime::isSmaller ( ilADT  $a_adt)

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

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

71  {
72  if($this->getDefinition()->isComparableTo($a_adt))
73  {
74  if(!$this->isNull() && !$a_adt->isNull())
75  {
76  $value = $this->getDate()->get(IL_CAL_UNIX);
77  $other = $a_adt->getDate()->get(IL_CAL_UNIX);
78  return ($value < $other);
79  }
80  }
81  }
const IL_CAL_UNIX
isNull()
Is currently null.
getDefinition()
Get definition.
Definition: class.ilADT.php:99
+ Here is the call graph for this function:

◆ isValid()

ilADTDateTime::isValid ( )

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

References $valid.

95  {
96  $valid = parent::isValid();
97 
98  /* timestamp is "always" valid
99  if(!$this->isNull())
100  {
101  $value = getdate($this->getDate()->get(IL_CAL_UNIX));
102  if(!checkdate($value["mon"], $value["mday"], $value["year"]))
103  {
104  $valid = false;
105  $this->addValidationError(self::ADT_VALIDATION_DATE);
106  }
107  }
108  */
109 
110  return $valid;
111  }
$valid

◆ isValidDefinition()

ilADTDateTime::isValidDefinition ( ilADTDefinition  $a_def)
protected

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

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

◆ reset()

ilADTDateTime::reset ( )

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

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

◆ setDate()

ilADTDateTime::setDate ( ilDateTime  $a_value = null)

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

26  {
27  if($a_value && $a_value->isNull())
28  {
29  $a_value = null;
30  }
31  $this->value = $a_value;
32  }
isNull()
Check if a date is null (Datetime == &#39;0000-00-00 00:00:00&#39;, unixtime == 0,...)

Field Documentation

◆ $value

ilADTDateTime::$value
protected

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

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


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