ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
Public Member Functions | Protected Member Functions
ilADTDateTimeSearchBridgeRange Class Reference

Class ilADTDateTimeSearchBridgeRange. More...

+ Inheritance diagram for ilADTDateTimeSearchBridgeRange:
+ Collaboration diagram for ilADTDateTimeSearchBridgeRange:

Public Member Functions

 loadFilter ()
 Load filter value(s) into ADT. More...
 
 addToForm ()
 Add ADT-specific fields to form. More...
 
 importFromPost (?array $a_post=null)
 
 getSQLCondition (string $a_element_id, int $mode=self::SQL_LIKE, array $quotedWords=[])
 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 (string $a_value)
 Set current value(s) in serialized form (for easy persisting) More...
 
- Public Member Functions inherited from ilADTSearchBridgeRange
 getLowerADT ()
 Get lower ADT. More...
 
 getUpperADT ()
 Get upper ADT. More...
 
 isNull ()
 
 isValid ()
 
 validate ()
 Validate current data. More...
 
- Public Member Functions inherited from ilADTSearchBridge
 __construct (ilADTDefinition $a_adt_def)
 
 isNull ()
 
 setForm (ilPropertyFormGUI $a_form)
 
 getForm ()
 
 setElementId (string $a_value)
 
 getElementId ()
 
 setTitle (string $a_value)
 
 getTitle ()
 
 getSearchColumn ()
 
 setTableGUI (ilTable2GUI $a_table)
 
 getTableGUI ()
 Get table gui. More...
 
 loadFilter ()
 Load filter value(s) into ADT. More...
 
 addToForm ()
 Add ADT-specific fields to form. More...
 
 addToFilterForm ()
 Add ADT-specific fields to filter. More...
 
 importFromPost (?array $a_post=null)
 
 validate ()
 Validate current data. More...
 
 getSQLCondition (string $a_element_id, int $mode=self::SQL_LIKE, array $quotedWords=[])
 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 (string $a_value)
 Set current value(s) in serialized form (for easy persisting) More...
 

Protected Member Functions

 isValidADTDefinition (ilADTDefinition $a_adt_def)
 
 shouldBeImportedFromPost ($a_post)
 Check if incoming values should be imported at all. More...
 
- Protected Member Functions inherited from ilADTSearchBridgeRange
 setDefinition (ilADTDefinition $a_adt_def)
 
- Protected Member Functions inherited from ilADTSearchBridge
 isValidADTDefinition (ilADTDefinition $a_adt_def)
 
 setDefinition (ilADTDefinition $a_adt_def)
 
 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 (string $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

- Data Fields inherited from ilADTSearchBridge
const SQL_STRICT = 1
 
const SQL_LIKE = 2
 
const SQL_LIKE_END = 3
 
const SQL_LIKE_START = 4
 
const DEFAULT_SEARCH_COLUMN = 'value'
 
- Protected Attributes inherited from ilADTSearchBridgeRange
ilADT $adt_lower
 
ilADT $adt_upper
 
- Protected Attributes inherited from ilADTSearchBridge
ilPropertyFormGUI $form = null
 
ilTable2GUI $table_gui = null
 
array $table_filter_fields = []
 
string $id = ''
 
string $title = ''
 
string $info = ''
 
ilLanguage $lng
 
ilDBInterface $db
 
HttpServices $http
 

Detailed Description

Class ilADTDateTimeSearchBridgeRange.

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

Member Function Documentation

◆ addToForm()

ilADTDateTimeSearchBridgeRange::addToForm ( )

Add ADT-specific fields to form.

Reimplemented from ilADTSearchBridge.

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

48 : void
49 {
50 if ($this->getForm() instanceof ilPropertyFormGUI) {
51 // :TODO: use DateDurationInputGUI ?!
52
53 $check = new ilCustomInputGUI($this->getTitle());
54
55 $date_from = new ilDateTimeInputGUI($this->lng->txt('from'), $this->addToElementId("lower"));
56 $date_from->setShowTime(true);
57 $check->addSubItem($date_from);
58
59 if ($this->getLowerADT()->getDate() && !$this->getLowerADT()->isNull()) {
60 $date_from->setDate($this->getLowerADT()->getDate());
61 $checked = true;
62 }
63
64 $date_until = new ilDateTimeInputGUI($this->lng->txt('until'), $this->addToElementId("upper"));
65 $date_until->setShowTime(true);
66 $check->addSubItem($date_until);
67
68 if ($this->getUpperADT()->getDate() && !$this->getUpperADT()->isNull()) {
69 $date_until->setDate($this->getUpperADT()->getDate());
70 $checked = true;
71 }
72
73 $this->addToParentElement($check);
74 } else {
75 // see ilTable2GUI::addFilterItemByMetaType()
76 $item = new ilCombinationInputGUI($this->getTitle(), $this->getElementId());
77
78 $lower = new ilDateTimeInputGUI("", $this->addToElementId("lower"));
79 $lower->setShowTime(true);
80 $item->addCombinationItem("lower", $lower, $this->lng->txt("from"));
81
82 if ($this->getLowerADT()->getDate() && !$this->getLowerADT()->isNull()) {
83 $lower->setDate($this->getLowerADT()->getDate());
84 }
85
86 $upper = new ilDateTimeInputGUI("", $this->addToElementId("upper"));
87 $upper->setShowTime(true);
88 $item->addCombinationItem("upper", $upper, $this->lng->txt("to"));
89
90 if ($this->getUpperADT()->getDate() && !$this->getUpperADT()->isNull()) {
91 $upper->setDate($this->getUpperADT()->getDate());
92 }
93
94 $item->setComparisonMode(ilCombinationInputGUI::COMPARISON_ASCENDING);
95
96 $this->addToParentElement($item);
97 }
98 }
$check
$check
Definition: buildRTE.php:81
ilADTSearchBridge\addToElementId
addToElementId(string $a_add)
Add sub-element.
Definition: class.ilADTSearchBridge.php:185
ilADTSearchBridge\addToParentElement
addToParentElement(ilFormPropertyGUI $a_field)
Add form field to parent element.
Definition: class.ilADTSearchBridge.php:167
ilCombinationInputGUI
This class represents a number property in a property form.
Definition: class.ilCombinationInputGUI.php:28
ilCustomInputGUI
This class represents a custom property in a property form.
Definition: class.ilCustomInputGUI.php:29
ilDateTimeInputGUI
This class represents a date/time property in a property form.
Definition: class.ilDateTimeInputGUI.php:28
ilPropertyFormGUI
This class represents a property form user interface.
Definition: class.ilPropertyFormGUI.php:32

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

+ Here is the call graph for this function:

◆ getSerializedValue()

ilADTDateTimeSearchBridgeRange::getSerializedValue ( )

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

Reimplemented from ilADTSearchBridge.

Definition at line 183 of file class.ilADTDateTimeSearchBridgeRange.php.

183 : string
184 {
185 if (!$this->isNull() && $this->isValid()) {
186 $res = array();
187 if (!$this->getLowerADT()->isNull()) {
188 $res["lower"] = $this->getLowerADT()->getDate()->get(IL_CAL_DATETIME);
189 }
190 if (!$this->getUpperADT()->isNull()) {
191 $res["upper"] = $this->getUpperADT()->getDate()->get(IL_CAL_DATETIME);
192 }
193 return serialize($res);
194 }
195 return '';
196 }
IL_CAL_DATETIME
const IL_CAL_DATETIME
Definition: class.ilDateTime.php:21
$res
$res
Definition: ltiservices.php:69

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

+ Here is the call graph for this function:

◆ getSQLCondition()

ilADTDateTimeSearchBridgeRange::getSQLCondition ( string  $a_element_id,
int  $mode = self::SQL_LIKE,
array  $quotedWords = [] 
)

Get SQL condition for current value(s)

Reimplemented from ilADTSearchBridge.

Definition at line 147 of file class.ilADTDateTimeSearchBridgeRange.php.

147 : string
148 {
149 if (!$this->isNull() && $this->isValid()) {
150 $sql = array();
151 if (!$this->getLowerADT()->isNull()) {
152 $sql[] = $a_element_id . " >= " . $this->db->quote(
153 $this->getLowerADT()->getDate()->get(IL_CAL_DATETIME),
154 "timestamp"
155 );
156 }
157 if (!$this->getUpperADT()->isNull()) {
158 $sql[] = $a_element_id . " <= " . $this->db->quote(
159 $this->getUpperADT()->getDate()->get(IL_CAL_DATETIME),
160 "timestamp"
161 );
162 }
163 return "(" . implode(" AND ", $sql) . ")";
164 }
165 return '';
166 }

References ilADTSearchBridgeRange\getLowerADT(), ilADTSearchBridgeRange\getUpperADT(), IL_CAL_DATETIME, ilADTSearchBridgeRange\isNull(), and ilADTSearchBridgeRange\isValid().

+ Here is the call graph for this function:

◆ importFromPost()

ilADTDateTimeSearchBridgeRange::importFromPost ( ?array  $a_post = null)
Todo:
make post required

Reimplemented from ilADTSearchBridge.

Definition at line 108 of file class.ilADTDateTimeSearchBridgeRange.php.

108 : bool
109 {
110 $post = $this->extractPostValues($a_post);
111
112 if ($post && $this->shouldBeImportedFromPost($post)) {
113 $start = ilCalendarUtil::parseIncomingDate($post["lower"], true);
114 $end = ilCalendarUtil::parseIncomingDate($post["upper"], true);
115 if ($start && $end && $start->get(IL_CAL_UNIX) > $end->get(IL_CAL_UNIX)) {
116 $tmp = $start;
117 $start = $end;
118 $end = $tmp;
119 }
120
121 if ($this->getForm() instanceof ilPropertyFormGUI) {
122 $item = $this->getForm()->getItemByPostVar($this->getElementId() . "[lower]");
123 $item->setDate($start);
124
125 $item = $this->getForm()->getItemByPostVar($this->getElementId() . "[upper]");
126 $item->setDate($end);
127 } elseif (array_key_exists($this->getElementId(), $this->table_filter_fields)) {
128 $this->table_filter_fields[$this->getElementId()]->getCombinationItem("lower")->setDate($start);
129 $this->table_filter_fields[$this->getElementId()]->getCombinationItem("upper")->setDate($end);
130 $this->writeFilter(array(
131 "lower" => (!$start || $start->isNull()) ? null : $start->get(IL_CAL_DATETIME),
132 "upper" => (!$end || $end->isNull()) ? null : $end->get(IL_CAL_DATETIME)
133 ));
134 }
135
136 $this->getLowerADT()->setDate($start);
137 $this->getUpperADT()->setDate($end);
138 } else {
139 $this->getLowerADT()->setDate();
140 $this->getUpperADT()->setDate();
141 }
142 return true;
143 }
IL_CAL_UNIX
const IL_CAL_UNIX
Definition: class.ilDateTime.php:23
ilADTDateTimeSearchBridgeRange\shouldBeImportedFromPost
shouldBeImportedFromPost($a_post)
Check if incoming values should be imported at all.
Definition: class.ilADTDateTimeSearchBridgeRange.php:100
ilADTSearchBridge\extractPostValues
extractPostValues(?array $a_post=null)
Extract data from (post) values.
Definition: class.ilADTSearchBridge.php:220
ilADTSearchBridge\writeFilter
writeFilter($a_value=null)
Write value(s) to filter store (in session)
Definition: class.ilADTSearchBridge.php:115
ilCalendarUtil\parseIncomingDate
static parseIncomingDate($value, bool $add_time=false)
Try to parse incoming value to date object.
Definition: class.ilCalendarUtil.php:583
$post
$post
Definition: ltitoken.php:46

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

+ Here is the call graph for this function:

◆ isInCondition()

ilADTDateTimeSearchBridgeRange::isInCondition ( ilADT  $a_adt)

Compare directly against ADT.

This is currently only used in ilAdvancedMDValues::queryForRecords, e.g. in the filter of mediapools. Other filter/search use cases use instead getSQLCondition.

Reimplemented from ilADTSearchBridge.

Definition at line 168 of file class.ilADTDateTimeSearchBridgeRange.php.

168 : bool
169 {
170 assert($a_adt instanceof ilADTDateTime);
171
172 if (!$this->getLowerADT()->isNull() && !$this->getUpperADT()->isNull()) {
173 return (bool) $a_adt->isInbetweenOrEqual($this->getLowerADT(), $this->getUpperADT());
174 } elseif (!$this->getLowerADT()->isNull()) {
175 return (bool) $a_adt->isLargerOrEqual($this->getLowerADT());
176 } else {
177 return (bool) $a_adt->isSmallerOrEqual($this->getUpperADT());
178 }
179 }
ilADT\isSmallerOrEqual
isSmallerOrEqual(ilADT $a_adt)
Check if given ADT is smaller or equal than self.
Definition: class.ilADT.php:162
ilADT\isLargerOrEqual
isLargerOrEqual(ilADT $a_adt)
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:199

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

+ Here is the call graph for this function:

◆ isValidADTDefinition()

ilADTDateTimeSearchBridgeRange::isValidADTDefinition ( ilADTDefinition  $a_adt_def)
protected

Reimplemented from ilADTSearchBridge.

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

26 : bool
27 {
28 return ($a_adt_def instanceof ilADTDateTimeDefinition);
29 }

◆ loadFilter()

ilADTDateTimeSearchBridgeRange::loadFilter ( )

Load filter value(s) into ADT.

Reimplemented from ilADTSearchBridge.

Definition at line 33 of file class.ilADTDateTimeSearchBridgeRange.php.

33 : void
34 {
35 $value = $this->readFilter();
36 if (isset($value) && is_array($value)) {
37 if ($value["lower"] ?? false) {
38 $this->getLowerADT()->setDate(new ilDateTime($value["lower"], IL_CAL_DATETIME));
39 }
40 if ($value["upper"] ?? false) {
41 $this->getUpperADT()->setDate(new ilDateTime($value["upper"], IL_CAL_DATETIME));
42 }
43 }
44 }
ilADTSearchBridge\readFilter
readFilter()
Load value(s) from filter store (in session)
Definition: class.ilADTSearchBridge.php:140
ilDateTime
@classDescription Date and time handling
Definition: class.ilDateTime.php:43

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

+ Here is the call graph for this function:

◆ setSerializedValue()

ilADTDateTimeSearchBridgeRange::setSerializedValue ( string  $a_value)

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

Reimplemented from ilADTSearchBridge.

Definition at line 198 of file class.ilADTDateTimeSearchBridgeRange.php.

198 : void
199 {
200 $a_value = unserialize($a_value);
201 if (is_array($a_value)) {
202 if (isset($a_value["lower"])) {
203 $this->getLowerADT()->setDate(new ilDateTime($a_value["lower"], IL_CAL_DATETIME));
204 }
205 if (isset($a_value["upper"])) {
206 $this->getUpperADT()->setDate(new ilDateTime($a_value["upper"], IL_CAL_DATETIME));
207 }
208 }
209 }

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

+ Here is the call graph for this function:

◆ shouldBeImportedFromPost()

ilADTDateTimeSearchBridgeRange::shouldBeImportedFromPost (   $a_post)
protected

Check if incoming values should be imported at all.

Parameters
string | int$a_post
Returns
bool

Reimplemented from ilADTSearchBridge.

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

100 : bool
101 {
102 if ($this->getForm() instanceof ilPropertyFormGUI) {
103 return ($a_post['lower'] ?? false) || ($a_post['upper'] ?? false);
104 }
105 return parent::shouldBeImportedFromPost($a_post);
106 }

References ilADTSearchBridge\getForm().

Referenced by importFromPost().

+ 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: