ilADTDateTimeSearchBridgeSingle Class Reference

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

Inheritance diagram for ilADTDateTimeSearchBridgeSingle:

Collaboration diagram for ilADTDateTimeSearchBridgeSingle:

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 ilADTSearchBridgeSingle
	getADT ()
	Get 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 ilADTSearchBridgeSingle
	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 ilADTSearchBridgeSingle
ilADT	$adt
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

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

Member Function Documentation

addToForm()

ilADTDateTimeSearchBridgeSingle::addToForm

(

)

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

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

                               : void
    {
        $adt_date = $this->getADT()->getDate();

        $date = new ilDateTimeInputGUI($this->getTitle(), $this->getElementId());
        $date->setShowTime(true);

        $date->setDate($adt_date);

        $this->addToParentElement($date);
    }

Here is the call graph for this function:

getSerializedValue()

ilADTDateTimeSearchBridgeSingle::getSerializedValue

(

)

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

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

                                        : string
    {
        if (!$this->isNull() && $this->isValid()) {
            return serialize(array($this->getADT()->getDate()->get(IL_CAL_DATETIME)));
        }
        return '';
    }

Here is the call graph for this function:

getSQLCondition()

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

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

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

                                                                                                            : string
    {
        if (!$this->isNull() && $this->isValid()) {
            return $a_element_id . " = " . $this->db->quote($this->getADT()->getDate()->get(IL_CAL_DATETIME), "timestamp");
        }
        return '';
    }

Here is the call graph for this function:

importFromPost()

ilADTDateTimeSearchBridgeSingle::importFromPost

(

array

$a_post = null

)

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

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

                                                        : bool
    {
        $post = $this->extractPostValues($a_post);

        if ($post && $this->shouldBeImportedFromPost($post)) {
            $date = ilCalendarUtil::parseIncomingDate($post, true);

            if ($this->getForm() instanceof ilPropertyFormGUI) {
                $item = $this->getForm()->getItemByPostVar($this->getElementId());
                $item->setDate($date);
            } elseif (array_key_exists($this->getElementId(), $this->table_filter_fields)) {
                $this->table_filter_fields[$this->getElementId()]->setDate($date);
                $this->writeFilter($date->get(IL_CAL_DATETIME));
            }

            $this->getADT()->setDate($date);
        } else {
            $this->writeFilter();
            $this->getADT()->setDate();
        }
        return true;
    }

Here is the call graph for this function:

isInCondition()

ilADTDateTimeSearchBridgeSingle::isInCondition

(

ilADT

$a_adt

)

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

References ilADTSearchBridgeSingle\getADT().

                                               : bool
    {
        assert($a_adt instanceof ilADTDateTime);

        return $this->getADT()->equals($a_adt);
    }

Here is the call graph for this function:

isValidADTDefinition()

ilADTDateTimeSearchBridgeSingle::isValidADTDefinition ( ilADTDefinition  $a_adt_def )

protected

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

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

loadFilter()

ilADTDateTimeSearchBridgeSingle::loadFilter

(

)

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

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

                                : void
    {
        $value = $this->readFilter();
        if ($value !== null) {
            $this->getADT()->setDate(new ilDateTime($value, IL_CAL_DATETIME));
        }
    }

Here is the call graph for this function:

setSerializedValue()

ilADTDateTimeSearchBridgeSingle::setSerializedValue

(

string

$a_value

)

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

References ilADTSearchBridgeSingle\getADT(), and IL_CAL_DATETIME.

                                                       : void
    {
        $a_value = unserialize($a_value);
        if (is_array($a_value)) {
            $this->getADT()->setDate(new ilDateTime($a_value[0], IL_CAL_DATETIME));
        }
    }

Here is the call graph for this function:

shouldBeImportedFromPost()

ilADTDateTimeSearchBridgeSingle::shouldBeImportedFromPost (   $a_post )

protected

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

Referenced by importFromPost().

                                                        : bool
    {
        return ($a_post['lower'] ?? false) || ($a_post['upper'] ?? false);
    }

Here is the caller graph for this function:

---

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

• Services/ADT/classes/Types/DateTime/class.ilADTDateTimeSearchBridgeSingle.php