ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
Public Member Functions | Protected Member Functions
ilADTDateSearchBridgeRange Class Reference
+ Inheritance diagram for ilADTDateSearchBridgeRange:
+ Collaboration diagram for ilADTDateSearchBridgeRange:

Public Member Functions

 loadFilter ()
 
 addToForm ()
 
 importFromPost (array $a_post=null)
 
 getSQLCondition ($a_element_id)
 
 isInCondition (ilADT $a_adt)
 
 getSerializedValue ()
 
 setSerializedValue ($a_value)
 
- Public Member Functions inherited from ilADTSearchBridgeRange
 getLowerADT ()
 Get lower ADT. More...
 
 getUpperADT ()
 Get lower ADT. More...
 
 isNull ()
 
 isValid ()
 
 validate ()
 
- 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)
 
 shouldBeImportedFromPost ($a_post)
 
- Protected Member Functions inherited from ilADTSearchBridgeRange
 setDefinition (ilADTDefinition $a_adt_def)
 
- 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 ilADTSearchBridgeRange
 $adt_lower
 
 $adt_upper
 
- Protected Attributes inherited from ilADTSearchBridge
 $form
 
 $table_gui
 
 $table_filter_fields = []
 
 $id
 
 $title
 
 $info
 

Detailed Description

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

Member Function Documentation

◆ addToForm()

ilADTDateSearchBridgeRange::addToForm ( )

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

References $lng, ilADTSearchBridge\addToElementId(), ilADTSearchBridge\addToParentElement(), ilCombinationInputGUI\COMPARISON_ASCENDING, ilADTSearchBridge\getElementId(), ilADTSearchBridge\getForm(), ilADTSearchBridgeRange\getLowerADT(), ilADTSearchBridge\getTitle(), ilADTSearchBridgeRange\getUpperADT(), ilADTSearchBridgeRange\isNull(), and ilDateTimeInputGUI\setShowTime().

32  {
33  global $lng;
34 
35  if ($this->getForm() instanceof ilPropertyFormGUI) {
36  $check = new ilCustomInputGUI($this->getTitle());
37 
38  $date_from = new ilDateTimeInputGUI($lng->txt('from'), $this->addToElementId("lower"));
39  $date_from->setShowTime(false);
40  $check->addSubItem($date_from);
41 
42  if ($this->getLowerADT()->getDate() && !$this->getLowerADT()->isNull()) {
43  $date_from->setDate($this->getLowerADT()->getDate());
44  $checked = true;
45  }
46 
47  $date_until = new ilDateTimeInputGUI($lng->txt('until'), $this->addToElementId("upper"));
48  $date_until->setShowTime(false);
49  $check->addSubItem($date_until);
50 
51  if ($this->getUpperADT()->getDate() && !$this->getUpperADT()->isNull()) {
52  $date_until->setDate($this->getUpperADT()->getDate());
53  $checked = true;
54  }
55 
56  $this->addToParentElement($check);
57  } else {
58  include_once("./Services/Form/classes/class.ilCombinationInputGUI.php");
59  include_once("./Services/Form/classes/class.ilDateTimeInputGUI.php");
60 
61  $item = new ilCombinationInputGUI($this->getTitle(), $this->getElementId());
62 
63  $lower = new ilDateTimeInputGUI("", $this->addToElementId("lower"));
64  $item->addCombinationItem("lower", $lower, $lng->txt("from"));
65 
66  if ($this->getLowerADT()->getDate() && !$this->getLowerADT()->isNull()) {
67  $lower->setDate($this->getLowerADT()->getDate());
68  }
69 
70  $upper = new ilDateTimeInputGUI("", $this->addToElementId("upper"));
71  $item->addCombinationItem("upper", $upper, $lng->txt("to"));
72 
73  if ($this->getUpperADT()->getDate() && !$this->getUpperADT()->isNull()) {
74  $upper->setDate($this->getUpperADT()->getDate());
75  }
76 
77  $item->setComparisonMode(ilCombinationInputGUI::COMPARISON_ASCENDING);
78 
79  $this->addToParentElement($item);
80  }
81  }
ilPropertyFormGUI
This class represents a property form user interface.
Definition: class.ilPropertyFormGUI.php:47
ilDateTimeInputGUI
This class represents a date/time property in a property form.
Definition: class.ilDateTimeInputGUI.php:14
ilCombinationInputGUI
This class represents a number property in a property form.
Definition: class.ilCombinationInputGUI.php:31
ilCustomInputGUI
This class represents a custom property in a property form.
Definition: class.ilCustomInputGUI.php:34
$lng
global $lng
Definition: privfeed.php:17
ilADTSearchBridge\getElementId
getElementId()
Get element id.
Definition: class.ilADTSearchBridge.php:97
ilDateTimeInputGUI\setShowTime
setShowTime($a_showtime)
Set Show Time Information.
Definition: class.ilDateTimeInputGUI.php:81
ilADTSearchBridge\addToParentElement
addToParentElement(ilFormPropertyGUI $a_field)
Add form field to parent element.
Definition: class.ilADTSearchBridge.php:195
ilADTSearchBridge\addToElementId
addToElementId($a_add)
Add sub-element.
Definition: class.ilADTSearchBridge.php:215
+ Here is the call graph for this function:

◆ getSerializedValue()

ilADTDateSearchBridgeRange::getSerializedValue ( )

Definition at line 165 of file class.ilADTDateSearchBridgeRange.php.

References $res, array, ilADTSearchBridgeRange\getLowerADT(), ilADTSearchBridgeRange\getUpperADT(), IL_CAL_DATE, ilADTSearchBridgeRange\isNull(), and ilADTSearchBridgeRange\isValid().

166  {
167  if (!$this->isNull() && $this->isValid()) {
168  $res = array();
169  if (!$this->getLowerADT()->isNull()) {
170  $res["lower"] = $this->getLowerADT()->getDate()->get(IL_CAL_DATE);
171  }
172  if (!$this->getUpperADT()->isNull()) {
173  $res["upper"] = $this->getUpperADT()->getDate()->get(IL_CAL_DATE);
174  }
175  return serialize($res);
176  }
177  }
$res
foreach($_POST as $key=> $value) $res
Definition: save_question_post_data.php:15
array
Create styles array
The data for the language used.
Definition: 40duplicateStyle.php:19
IL_CAL_DATE
const IL_CAL_DATE
Definition: class.ilDateTime.php:10
+ Here is the call graph for this function:

◆ getSQLCondition()

ilADTDateSearchBridgeRange::getSQLCondition (   $a_element_id)

Definition at line 133 of file class.ilADTDateSearchBridgeRange.php.

References $ilDB, array, ilADTSearchBridgeRange\getLowerADT(), ilADTSearchBridgeRange\getUpperADT(), IL_CAL_DATE, ilADTSearchBridgeRange\isNull(), and ilADTSearchBridgeRange\isValid().

134  {
135  global $ilDB;
136 
137  if (!$this->isNull() && $this->isValid()) {
138  $sql = array();
139  if (!$this->getLowerADT()->isNull()) {
140  $sql[] = $a_element_id . " >= " . $ilDB->quote($this->getLowerADT()->getDate()->get(IL_CAL_DATE), "date");
141  }
142  if (!$this->getUpperADT()->isNull()) {
143  $sql[] = $a_element_id . " <= " . $ilDB->quote($this->getUpperADT()->getDate()->get(IL_CAL_DATE), "date");
144  }
145  return "(" . implode(" AND ", $sql) . ")";
146  }
147  }
array
Create styles array
The data for the language used.
Definition: 40duplicateStyle.php:19
IL_CAL_DATE
const IL_CAL_DATE
Definition: class.ilDateTime.php:10
$ilDB
global $ilDB
Definition: storeScorm2004.php:16
+ Here is the call graph for this function:

◆ importFromPost()

ilADTDateSearchBridgeRange::importFromPost ( array  $a_post = null)

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

References $end, $post, array, ilADTSearchBridge\extractPostValues(), ilADTSearchBridge\getElementId(), ilADTSearchBridge\getForm(), ilADTSearchBridgeRange\getLowerADT(), ilADTSearchBridgeRange\getUpperADT(), IL_CAL_DATE, IL_CAL_UNIX, ilCalendarUtil\parseIncomingDate(), shouldBeImportedFromPost(), and ilADTSearchBridge\writeFilter().

93  {
94  $post = $this->extractPostValues($a_post);
95 
96  if ($post && $this->shouldBeImportedFromPost($post)) {
97  include_once "Services/Calendar/classes/class.ilCalendarUtil.php";
98  $start = ilCalendarUtil::parseIncomingDate($post["lower"]);
99  $end = ilCalendarUtil::parseIncomingDate($post["upper"]);
100 
101  if ($start && $end && $start->get(IL_CAL_UNIX) > $end->get(IL_CAL_UNIX)) {
102  $tmp = $start;
103  $start = $end;
104  $end = $tmp;
105  }
106 
107  if ($this->getForm() instanceof ilPropertyFormGUI) {
108  $item = $this->getForm()->getItemByPostVar($this->getElementId() . "[lower]");
109  $item->setDate($start);
110 
111  $item = $this->getForm()->getItemByPostVar($this->getElementId() . "[upper]");
112  $item->setDate($end);
113  } elseif (array_key_exists($this->getElementId(), $this->table_filter_fields)) {
114  $this->table_filter_fields[$this->getElementId()]->getCombinationItem("lower")->setDate($start);
115  $this->table_filter_fields[$this->getElementId()]->getCombinationItem("upper")->setDate($end);
116  $this->writeFilter(array(
117  "lower" => (!$start || $start->isNull()) ? null: $start->get(IL_CAL_DATE),
118  "upper" => (!$end || $end->isNull()) ? null : $end->get(IL_CAL_DATE)
119  ));
120  }
121 
122  $this->getLowerADT()->setDate($start);
123  $this->getUpperADT()->setDate($end);
124  } else {
125  $this->getLowerADT()->setDate();
126  $this->getUpperADT()->setDate();
127  }
128  }
ilPropertyFormGUI
This class represents a property form user interface.
Definition: class.ilPropertyFormGUI.php:47
$end
$end
Definition: saml1-acs.php:18
IL_CAL_UNIX
const IL_CAL_UNIX
Definition: class.ilDateTime.php:11
ilADTSearchBridge\extractPostValues
extractPostValues(array $a_post=null)
Extract data from (post) values.
Definition: class.ilADTSearchBridge.php:247
$post
$post
Definition: post.php:34
array
Create styles array
The data for the language used.
Definition: 40duplicateStyle.php:19
IL_CAL_DATE
const IL_CAL_DATE
Definition: class.ilDateTime.php:10
ilADTSearchBridge\writeFilter
writeFilter($a_value=null)
Write value(s) to filter store (in session)
Definition: class.ilADTSearchBridge.php:152
ilADTSearchBridge\getElementId
getElementId()
Get element id.
Definition: class.ilADTSearchBridge.php:97
ilCalendarUtil\parseIncomingDate
static parseIncomingDate($a_value, $a_add_time=null)
Try to parse incoming value to date object.
Definition: class.ilCalendarUtil.php:712
+ Here is the call graph for this function:

◆ isInCondition()

ilADTDateSearchBridgeRange::isInCondition ( ilADT  $a_adt)

Definition at line 149 of file class.ilADTDateSearchBridgeRange.php.

References ilADTSearchBridgeRange\getLowerADT(), ilADTSearchBridgeRange\getUpperADT(), ilADT\isInbetweenOrEqual(), ilADT\isLargerOrEqual(), ilADTSearchBridgeRange\isNull(), and ilADT\isSmallerOrEqual().

150  {
151  assert($a_adt instanceof ilADTDate);
152 
153  if (!$this->getLowerADT()->isNull() && !$this->getUpperADT()->isNull()) {
154  return $a_adt->isInbetweenOrEqual($this->getLowerADT(), $this->getUpperADT());
155  } elseif (!$this->getLowerADT()->isNull()) {
156  return $a_adt->isLargerOrEqual($this->getLowerADT());
157  } else {
158  return $a_adt->isSmallerOrEqual($this->getUpperADT());
159  }
160  }
ilADT\isLargerOrEqual
isLargerOrEqual(ilADT $a_adt)
Check if given ADT is larger or equal than self.
Definition: class.ilADT.php:139
ilADT\isInbetweenOrEqual
isInbetweenOrEqual(ilADT $a_adt_from, ilADT $a_adt_to)
Check if self is inbetween given ADTs (inclusive)
Definition: class.ilADT.php:185
ilADT\isSmallerOrEqual
isSmallerOrEqual(ilADT $a_adt)
Check if given ADT is smaller or equal than self.
Definition: class.ilADT.php:159
+ Here is the call graph for this function:

◆ isValidADTDefinition()

ilADTDateSearchBridgeRange::isValidADTDefinition ( ilADTDefinition  $a_adt_def)
protected

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

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

◆ loadFilter()

ilADTDateSearchBridgeRange::loadFilter ( )

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

References ilADTSearchBridgeRange\getLowerADT(), ilADTSearchBridgeRange\getUpperADT(), IL_CAL_DATE, and ilADTSearchBridge\readFilter().

16  {
17  $value = $this->readFilter();
18  if ($value !== null) {
19  if ($value["lower"]) {
20  $this->getLowerADT()->setDate(new ilDate($value["lower"], IL_CAL_DATE));
21  }
22  if ($value["upper"]) {
23  $this->getUpperADT()->setDate(new ilDate($value["upper"], IL_CAL_DATE));
24  }
25  }
26  }
ilDate
Class for single dates.
Definition: class.ilDate.php:36
ilADTSearchBridge\readFilter
readFilter()
Load value(s) from filter store (in session)
Definition: class.ilADTSearchBridge.php:169
IL_CAL_DATE
const IL_CAL_DATE
Definition: class.ilDateTime.php:10
+ Here is the call graph for this function:

◆ setSerializedValue()

ilADTDateSearchBridgeRange::setSerializedValue (   $a_value)

Definition at line 179 of file class.ilADTDateSearchBridgeRange.php.

References ilADTSearchBridgeRange\getLowerADT(), ilADTSearchBridgeRange\getUpperADT(), and IL_CAL_DATE.

180  {
181  $a_value = unserialize($a_value);
182  if (is_array($a_value)) {
183  if (isset($a_value["lower"])) {
184  $this->getLowerADT()->setDate(new ilDate($a_value["lower"], IL_CAL_DATE));
185  }
186  if (isset($a_value["upper"])) {
187  $this->getUpperADT()->setDate(new ilDate($a_value["upper"], IL_CAL_DATE));
188  }
189  }
190  }
ilDate
Class for single dates.
Definition: class.ilDate.php:36
IL_CAL_DATE
const IL_CAL_DATE
Definition: class.ilDateTime.php:10
+ Here is the call graph for this function:

◆ shouldBeImportedFromPost()

ilADTDateSearchBridgeRange::shouldBeImportedFromPost (   $a_post)
protected

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

References ilADTSearchBridge\getForm().

Referenced by importFromPost().

84  {
85  if ($this->getForm() instanceof ilPropertyFormGUI &&
86  !(bool) $this->text_input) {
87  return (bool) $a_post["tgl"];
88  }
89  return parent::shouldBeImportedFromPost($a_post);
90  }
ilPropertyFormGUI
This class represents a property form user interface.
Definition: class.ilPropertyFormGUI.php:47
+ Here is the call graph for this function:
+ Here is the caller graph for this function:
The documentation for this class was generated from the following file: