ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
ilADTDateTimeSearchBridgeSingle Class Reference
+ Inheritance diagram for ilADTDateTimeSearchBridgeSingle:
+ Collaboration diagram for ilADTDateTimeSearchBridgeSingle:

Public Member Functions

 loadFilter ()
 Load filter value(s) into ADT. More...
 
 addToForm ()
 Add ADT-specific fields to form. More...
 
 importFromPost (array $a_post=null)
 Import values from (search) form request POST data. More...
 
 getSQLCondition ($a_element_id)
 Get SQL condition for current value(s) More...
 
 isInCondition (ilADT $a_adt)
 Compare directly against ADT. More...
 
 getSerializedValue ()
 Get current value(s) in serialized form (for easy persisting) More...
 
 setSerializedValue ($a_value)
 Set current value(s) in serialized form (for easy persisting) More...
 
- Public Member Functions inherited from ilADTSearchBridgeSingle
 getADT ()
 Get ADT. More...
 
 isNull ()
 Is null ? More...
 
 isValid ()
 
 validate ()
 Validate current data. More...
 
- Public Member Functions inherited from ilADTSearchBridge
 __construct (ilADTDefinition $a_adt_def)
 Constructor. More...
 
 isNull ()
 Is null ? More...
 
 setForm (ilPropertyFormGUI $a_form)
 Set form. More...
 
 getForm ()
 Get form. More...
 
 setElementId ($a_value)
 Set element id (aka form field) More...
 
 getElementId ()
 Get element id. More...
 
 setTitle ($a_value)
 Set title (aka form field caption) More...
 
 getTitle ()
 Get title. More...
 
 setTableGUI (ilTable2GUI $a_table)
 Set table gui (for filter mode) More...
 
 getTableGUI ()
 Get table gui. More...
 
 loadFilter ()
 Load filter value(s) into ADT. More...
 
 addToForm ()
 Add ADT-specific fields to form. More...
 
 importFromPost (array $a_post=null)
 Import values from (search) form request POST data. More...
 
 validate ()
 Validate current data. More...
 
 getSQLCondition ($a_element_id)
 Get SQL condition for current value(s) More...
 
 isInCondition (ilADT $a_adt)
 Compare directly against ADT. More...
 
 getSerializedValue ()
 Get current value(s) in serialized form (for easy persisting) More...
 
 setSerializedValue ($a_value)
 Set current value(s) in serialized form (for easy persisting) More...
 

Protected Member Functions

 isValidADTDefinition (ilADTDefinition $a_adt_def)
 Check if given ADT definition is valid. More...
 
 shouldBeImportedFromPost ($a_post)
 Check if incoming values should be imported at all. More...
 
- Protected Member Functions inherited from ilADTSearchBridgeSingle
 setDefinition (ilADTDefinition $a_adt_def)
 Set ADT definition. More...
 
- Protected Member Functions inherited from ilADTSearchBridge
 isValidADTDefinition (ilADTDefinition $a_adt_def)
 Check if given ADT definition is valid. More...
 
 setDefinition (ilADTDefinition $a_adt_def)
 Set ADT definition. More...
 
 writeFilter ($a_value=null)
 Write value(s) to filter store (in session) More...
 
 readFilter ()
 Load value(s) from filter store (in session) More...
 
 addToParentElement (ilFormPropertyGUI $a_field)
 Add form field to parent element. More...
 
 addToElementId ($a_add)
 Add sub-element. More...
 
 shouldBeImportedFromPost ($a_post)
 Check if incoming values should be imported at all. More...
 
 extractPostValues (array $a_post=null)
 Extract data from (post) values. More...
 

Additional Inherited Members

- Protected Attributes inherited from ilADTSearchBridgeSingle
 $adt
 
- Protected Attributes inherited from ilADTSearchBridge
 $form
 
 $table_gui
 
 $table_filter_fields = []
 
 $id
 
 $title
 
 $info
 

Detailed Description

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

Member Function Documentation

◆ addToForm()

ilADTDateTimeSearchBridgeSingle::addToForm ( )

Add ADT-specific fields to form.

Reimplemented from ilADTSearchBridge.

Definition at line 26 of file class.ilADTDateTimeSearchBridgeSingle.php.

27 {
28 global $lng;
29
30 $adt_date = $this->getADT()->getDate();
31
32 $date = new ilDateTimeInputGUI($this->getTitle(), $this->getElementId());
33 $date->setShowTime(true);
34
35 $date->setDate($adt_date);
36
37 $this->addToParentElement($date);
38 }
addToParentElement(ilFormPropertyGUI $a_field)
Add form field to parent element.
getElementId()
Get element id.
This class represents a date/time property in a property form.
global $lng
Definition: privfeed.php:17

References $lng, ilADTSearchBridge\addToParentElement(), ilADTSearchBridgeSingle\getADT(), ilADTSearchBridge\getElementId(), and ilADTSearchBridge\getTitle().

+ Here is the call graph for this function:

◆ getSerializedValue()

ilADTDateTimeSearchBridgeSingle::getSerializedValue ( )

Get current value(s) in serialized form (for easy persisting)

Returns
string

Reimplemented from ilADTSearchBridge.

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

94 {
95 if (!$this->isNull() && $this->isValid()) {
96 return serialize(array($this->getADT()->getDate()->get(IL_CAL_DATETIME)));
97 }
98 }
const IL_CAL_DATETIME

References ilADTSearchBridgeSingle\getADT(), IL_CAL_DATETIME, ilADTSearchBridgeSingle\isNull(), and ilADTSearchBridgeSingle\isValid().

+ Here is the call graph for this function:

◆ getSQLCondition()

ilADTDateTimeSearchBridgeSingle::getSQLCondition (   $a_element_id)

Get SQL condition for current value(s)

Parameters
string$a_element_id
Returns
string

Reimplemented from ilADTSearchBridge.

Definition at line 74 of file class.ilADTDateTimeSearchBridgeSingle.php.

75 {
76 global $ilDB;
77
78 if (!$this->isNull() && $this->isValid()) {
79 return $a_element_id . " = " . $ilDB->quote($this->getADT()->getDate()->get(IL_CAL_DATETIME), "timestamp");
80 }
81 }
global $ilDB

References $ilDB, ilADTSearchBridgeSingle\getADT(), IL_CAL_DATETIME, ilADTSearchBridgeSingle\isNull(), and ilADTSearchBridgeSingle\isValid().

+ Here is the call graph for this function:

◆ importFromPost()

ilADTDateTimeSearchBridgeSingle::importFromPost ( array  $a_post = null)

Import values from (search) form request POST data.

Returns
bool

Reimplemented from ilADTSearchBridge.

Definition at line 48 of file class.ilADTDateTimeSearchBridgeSingle.php.

49 {
50 $post = $this->extractPostValues($a_post);
51
52 if ($post && $this->shouldBeImportedFromPost($post)) {
53 include_once "Services/Calendar/classes/class.ilCalendarUtil.php";
55
56 if ($this->getForm() instanceof ilPropertyFormGUI) {
57 $item = $this->getForm()->getItemByPostVar($this->getElementId());
58 $item->setDate($date);
59 } elseif (array_key_exists($this->getElementId(), $this->table_filter_fields)) {
60 $this->table_filter_fields[$this->getElementId()]->setDate($date);
61 $this->writeFilter($date->get(IL_CAL_DATETIME));
62 }
63
64 $this->getADT()->setDate($date);
65 } else {
66 $this->writeFilter();
67 $this->getADT()->setDate();
68 }
69 }
shouldBeImportedFromPost($a_post)
Check if incoming values should be imported at all.
extractPostValues(array $a_post=null)
Extract data from (post) values.
writeFilter($a_value=null)
Write value(s) to filter store (in session)
static parseIncomingDate($a_value, $a_add_time=null)
Try to parse incoming value to date object.
This class represents a property form user interface.
$post
Definition: post.php:34

References $post, ilADTSearchBridge\extractPostValues(), ilADTSearchBridgeSingle\getADT(), ilADTSearchBridge\getElementId(), ilADTSearchBridge\getForm(), IL_CAL_DATETIME, ilCalendarUtil\parseIncomingDate(), shouldBeImportedFromPost(), and ilADTSearchBridge\writeFilter().

+ Here is the call graph for this function:

◆ isInCondition()

ilADTDateTimeSearchBridgeSingle::isInCondition ( ilADT  $a_adt)

Compare directly against ADT.

Parameters
ilADT$a_adt
Returns
boolean

Reimplemented from ilADTSearchBridge.

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

84 {
85 assert($a_adt instanceof ilADTDateTime);
86
87 return $this->getADT()->equals($a_adt);
88 }

References ilADTSearchBridgeSingle\getADT().

+ Here is the call graph for this function:

◆ isValidADTDefinition()

ilADTDateTimeSearchBridgeSingle::isValidADTDefinition ( ilADTDefinition  $a_adt_def)
protected

Check if given ADT definition is valid.

:TODO: This could be avoided with type-specifc constructors :TODO: bridge base class?

Parameters
ilADTDefinition$a_adt_def

Reimplemented from ilADTSearchBridge.

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

8 {
9 return ($a_adt_def instanceof ilADTDateTimeDefinition);
10 }

◆ loadFilter()

ilADTDateTimeSearchBridgeSingle::loadFilter ( )

Load filter value(s) into ADT.

Reimplemented from ilADTSearchBridge.

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

16 {
17 $value = $this->readFilter();
18 if ($value !== null) {
19 $this->getADT()->setDate(new ilDateTime($value, IL_CAL_DATETIME));
20 }
21 }
readFilter()
Load value(s) from filter store (in session)
@classDescription Date and time handling

References ilADTSearchBridgeSingle\getADT(), IL_CAL_DATETIME, and ilADTSearchBridge\readFilter().

+ Here is the call graph for this function:

◆ setSerializedValue()

ilADTDateTimeSearchBridgeSingle::setSerializedValue (   $a_value)

Set current value(s) in serialized form (for easy persisting)

Parameters
string

Reimplemented from ilADTSearchBridge.

Definition at line 100 of file class.ilADTDateTimeSearchBridgeSingle.php.

101 {
102 $a_value = unserialize($a_value);
103 if (is_array($a_value)) {
104 $this->getADT()->setDate(new ilDateTime($a_value[0], IL_CAL_DATETIME));
105 }
106 }

References ilADTSearchBridgeSingle\getADT(), and IL_CAL_DATETIME.

+ Here is the call graph for this function:

◆ shouldBeImportedFromPost()

ilADTDateTimeSearchBridgeSingle::shouldBeImportedFromPost (   $a_post)
protected

Check if incoming values should be imported at all.

Parameters
mixed$a_post
Returns
bool

Reimplemented from ilADTSearchBridge.

Definition at line 40 of file class.ilADTDateTimeSearchBridgeSingle.php.

41 {
42 if (!(bool) $this->text_input) {
43 return (bool) $a_post["tgl"];
44 }
45 return parent::shouldBeImportedFromPost($a_post);
46 }

Referenced by importFromPost().

+ Here is the caller graph for this function:

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