This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilADTDateTimeSearchBridgeRange:

Collaboration diagram for ilADTDateTimeSearchBridgeRange:

Public Member Functions
	loadFilter ()

	addToForm ()

	importFromPost (array $a_post=null)

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

	isInCondition (ilADT $a_adt)

	getSerializedValue ()

	setSerializedValue (string $a_value)

Public Member Functions inherited from ilADTSearchBridgeRange
	getLowerADT ()
	Get lower ADT. More...

	getUpperADT ()
	Get upper ADT. More...

	isNull ()

	isValid ()

	validate ()

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...

	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)

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

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilADTDateTimeSearchBridgeRange

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

Member Function Documentation

◆ addToForm()

ilADTDateTimeSearchBridgeRange::addToForm ( )

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

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

                                : void
     {
         if ($this->getForm() instanceof ilPropertyFormGUI) {
             // :TODO: use DateDurationInputGUI ?!
 
             $check = new ilCustomInputGUI($this->getTitle());
 
             $date_from = new ilDateTimeInputGUI($this->lng->txt('from'), $this->addToElementId("lower"));
             $date_from->setShowTime(true);
             $check->addSubItem($date_from);
 
             if ($this->getLowerADT()->getDate() && !$this->getLowerADT()->isNull()) {
                 $date_from->setDate($this->getLowerADT()->getDate());
                 $checked = true;
             }
 
             $date_until = new ilDateTimeInputGUI($this->lng->txt('until'), $this->addToElementId("upper"));
             $date_until->setShowTime(true);
             $check->addSubItem($date_until);
 
             if ($this->getUpperADT()->getDate() && !$this->getUpperADT()->isNull()) {
                 $date_until->setDate($this->getUpperADT()->getDate());
                 $checked = true;
             }
 
             $this->addToParentElement($check);
         } else {
             // see ilTable2GUI::addFilterItemByMetaType()
             $item = new ilCombinationInputGUI($this->getTitle(), $this->getElementId());
 
             $lower = new ilDateTimeInputGUI("", $this->addToElementId("lower"));
             $lower->setShowTime(true);
             $item->addCombinationItem("lower", $lower, $this->lng->txt("from"));
 
             if ($this->getLowerADT()->getDate() && !$this->getLowerADT()->isNull()) {
                 $lower->setDate($this->getLowerADT()->getDate());
             }
 
             $upper = new ilDateTimeInputGUI("", $this->addToElementId("upper"));
             $upper->setShowTime(true);
             $item->addCombinationItem("upper", $upper, $this->lng->txt("to"));
 
             if ($this->getUpperADT()->getDate() && !$this->getUpperADT()->isNull()) {
                 $upper->setDate($this->getUpperADT()->getDate());
             }
 
             $item->setComparisonMode(ilCombinationInputGUI::COMPARISON_ASCENDING);
 
             $this->addToParentElement($item);
         }
     }

Here is the call graph for this function:

◆ getSerializedValue()

ilADTDateTimeSearchBridgeRange::getSerializedValue ( )

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

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

                                         : string
     {
         if (!$this->isNull() && $this->isValid()) {
             $res = array();
             if (!$this->getLowerADT()->isNull()) {
                 $res["lower"] = $this->getLowerADT()->getDate()->get(IL_CAL_DATETIME);
             }
             if (!$this->getUpperADT()->isNull()) {
                 $res["upper"] = $this->getUpperADT()->getDate()->get(IL_CAL_DATETIME);
             }
             return serialize($res);
         }
         return '';
     }

Here is the call graph for this function:

◆ getSQLCondition()

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

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

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

                                                                                                             : string
     {
         if (!$this->isNull() && $this->isValid()) {
             $sql = array();
             if (!$this->getLowerADT()->isNull()) {
                 $sql[] = $a_element_id . " >= " . $this->db->quote(
                     $this->getLowerADT()->getDate()->get(IL_CAL_DATETIME),
                     "timestamp"
                 );
             }
             if (!$this->getUpperADT()->isNull()) {
                 $sql[] = $a_element_id . " <= " . $this->db->quote(
                     $this->getUpperADT()->getDate()->get(IL_CAL_DATETIME),
                     "timestamp"
                 );
             }
             return "(" . implode(" AND ", $sql) . ")";
         }
         return '';
     }

Here is the call graph for this function:

◆ importFromPost()

ilADTDateTimeSearchBridgeRange::importFromPost ( array $a_post = null )

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

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

                                                         : bool
     {
         $post = $this->extractPostValues($a_post);
 
         if ($post && $this->shouldBeImportedFromPost($post)) {
             $start = ilCalendarUtil::parseIncomingDate($post["lower"], true);
             $end = ilCalendarUtil::parseIncomingDate($post["upper"], true);
             if ($start && $end && $start->get(IL_CAL_UNIX) > $end->get(IL_CAL_UNIX)) {
                 $tmp = $start;
                 $start = $end;
                 $end = $tmp;
             }
 
             if ($this->getForm() instanceof ilPropertyFormGUI) {
                 $item = $this->getForm()->getItemByPostVar($this->getElementId() . "[lower]");
                 $item->setDate($start);
 
                 $item = $this->getForm()->getItemByPostVar($this->getElementId() . "[upper]");
                 $item->setDate($end);
             } elseif (array_key_exists($this->getElementId(), $this->table_filter_fields)) {
                 $this->table_filter_fields[$this->getElementId()]->getCombinationItem("lower")->setDate($start);
                 $this->table_filter_fields[$this->getElementId()]->getCombinationItem("upper")->setDate($end);
                 $this->writeFilter(array(
                     "lower" => (!$start || $start->isNull()) ? null : $start->get(IL_CAL_DATETIME),
                     "upper" => (!$end || $end->isNull()) ? null : $end->get(IL_CAL_DATETIME)
                 ));
             }
 
             $this->getLowerADT()->setDate($start);
             $this->getUpperADT()->setDate($end);
         } else {
             $this->getLowerADT()->setDate();
             $this->getUpperADT()->setDate();
         }
         return true;
     }

Here is the call graph for this function:

◆ isInCondition()

ilADTDateTimeSearchBridgeRange::isInCondition ( ilADT $a_adt )

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

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

                                                : bool
     {
         assert($a_adt instanceof ilADTDateTime);
 
         if (!$this->getLowerADT()->isNull() && !$this->getUpperADT()->isNull()) {
             return (bool) $a_adt->isInbetweenOrEqual($this->getLowerADT(), $this->getUpperADT());
         } elseif (!$this->getLowerADT()->isNull()) {
             return (bool) $a_adt->isLargerOrEqual($this->getLowerADT());
         } else {
             return (bool) $a_adt->isSmallerOrEqual($this->getUpperADT());
         }
     }

Here is the call graph for this function:

◆ isValidADTDefinition()

ilADTDateTimeSearchBridgeRange::isValidADTDefinition ( ilADTDefinition $a_adt_def )

protected

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

                                                                        : bool
     {
         return ($a_adt_def instanceof ilADTDateTimeDefinition);
     }

◆ loadFilter()

ilADTDateTimeSearchBridgeRange::loadFilter ( )

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

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

                                 : void
     {
         $value = $this->readFilter();
         if (isset($value) && is_array($value)) {
             if ($value["lower"] ?? false) {
                 $this->getLowerADT()->setDate(new ilDateTime($value["lower"], IL_CAL_DATETIME));
             }
             if ($value["upper"] ?? false) {
                 $this->getUpperADT()->setDate(new ilDateTime($value["upper"], IL_CAL_DATETIME));
             }
         }
     }

Here is the call graph for this function:

◆ setSerializedValue()

ilADTDateTimeSearchBridgeRange::setSerializedValue ( string $a_value )

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

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

                                                        : void
     {
         $a_value = unserialize($a_value);
         if (is_array($a_value)) {
             if (isset($a_value["lower"])) {
                 $this->getLowerADT()->setDate(new ilDateTime($a_value["lower"], IL_CAL_DATETIME));
             }
             if (isset($a_value["upper"])) {
                 $this->getUpperADT()->setDate(new ilDateTime($a_value["upper"], IL_CAL_DATETIME));
             }
         }
     }

Here is the call graph for this function:

◆ shouldBeImportedFromPost()

ilADTDateTimeSearchBridgeRange::shouldBeImportedFromPost ( $a_post )

protected

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

References ilADTSearchBridge\getForm().

Referenced by importFromPost().

                                                         : bool
     {
         if ($this->getForm() instanceof ilPropertyFormGUI) {
             return ($a_post['lower'] ?? false) || ($a_post['upper'] ?? false);
         }
         return parent::shouldBeImportedFromPost($a_post);
     }