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

Inheritance diagram for ilADTSearchBridge:

Collaboration diagram for ilADTSearchBridge:

Public Member Functions
	__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...

Data Fields
const	SQL_STRICT = 1

const	SQL_LIKE = 2

const	SQL_LIKE_END = 3

const	SQL_LIKE_START = 4

const	DEFAULT_SEARCH_COLUMN = 'value'

Protected Member Functions
	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...

Protected Attributes
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 ADT search bridge base class

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 28 of file class.ilADTSearchBridge.php.

Constructor & Destructor Documentation

◆ __construct()

ilADTSearchBridge::__construct ( ilADTDefinition $a_adt_def )

Reimplemented in ilADTLocationSearchBridgeSingle.

Definition at line 47 of file class.ilADTSearchBridge.php.

    {
        global $DIC;
        $this->setDefinition($a_adt_def);
 
        $this->lng = $DIC->language();
        $this->db = $DIC->database();
        $this->http = $DIC->http();
    }

References $DIC, ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and setDefinition().

Here is the call graph for this function:

Member Function Documentation

◆ addToElementId()

ilADTSearchBridge::addToElementId ( string $a_add )

protected

Add sub-element.

Parameters

string $a_add

Returns: string

Definition at line 185 of file class.ilADTSearchBridge.php.

                                                    : string
    {
        return $this->getElementId() . "[" . $a_add . "]";
    }

References getElementId().

Referenced by ilADTDateSearchBridgeRange\addToForm(), ilADTDateTimeSearchBridgeRange\addToForm(), ilADTLocationSearchBridgeSingle\addToForm(), ilADTLocationSearchBridgeSingle\importFromPost(), and ilADTSearchBridgeRange\validate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addToForm()

ilADTSearchBridge::addToForm ( )

abstract

Add ADT-specific fields to form.

Reimplemented in ilADTDateSearchBridgeRange, ilADTDateSearchBridgeSingle, ilADTDateTimeSearchBridgeRange, ilADTDateTimeSearchBridgeSingle, ilADTEnumSearchBridgeMulti, ilADTEnumSearchBridgeSingle, ilADTExternalLinkSearchBridgeSingle, ilADTFloatSearchBridgeSingle, ilADTIntegerSearchBridgeSingle, ilADTInternalLinkSearchBridgeSingle, ilADTLocalizedTextSearchBridgeSingle, ilADTLocationSearchBridgeSingle, and ilADTTextSearchBridgeSingle.

◆ addToParentElement()

ilADTSearchBridge::addToParentElement ( ilFormPropertyGUI $a_field )

protected

Add form field to parent element.

Parameters

ilFormPropertyGUI $a_field

Definition at line 167 of file class.ilADTSearchBridge.php.

                                                                     : void
    {
        if ($this->getForm() instanceof ilPropertyFormGUI) {
            $this->getForm()->addItem($a_field);
        } elseif (
            $this->getTableGUI() instanceof ilTable2GUI &&
            $a_field instanceof ilTableFilterItem
        ) {
            $this->table_filter_fields[$a_field->getFieldId()] = $a_field;
            $this->getTableGUI()->addFilterItem($a_field);
        }
    }

References ilFormPropertyGUI\getFieldId(), getForm(), and getTableGUI().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ extractPostValues()

ilADTSearchBridge::extractPostValues ( array $a_post = null )

protected

Extract data from (post) values.

Parameters

array $a_post

Returns: mixed

Definition at line 210 of file class.ilADTSearchBridge.php.

    {
        $element_id = $this->getElementId();
        $multi = strpos($this->getElementId(), "[");
 
        // get rid of this case
        if ($a_post === null) {
            $a_post = $this->http->request()->getParsedBody();
            if ($multi !== false) {
                $post = $a_post[substr($element_id, 0, $multi)][substr($element_id, $multi + 1, -1)] ?? null;
            } else {
                $post = $a_post[$element_id] ?? null;
            }
        } elseif ($multi !== false) {
            $post = $a_post[substr($element_id, $multi + 1, -1)] ?? null;
        } else {
            $post = $a_post[$element_id] ?? null;
        }
        return $post;
    }

References $post, getElementId(), and ILIAS\FileDelivery\http().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getElementId()

ilADTSearchBridge::getElementId ( )

Definition at line 78 of file class.ilADTSearchBridge.php.

                                  : string
    {
        return $this->id;
    }

References $id.

Here is the caller graph for this function:

◆ getForm()

ilADTSearchBridge::getForm ( )

Definition at line 68 of file class.ilADTSearchBridge.php.

                             : ?ilPropertyFormGUI
    {
        return $this->form;
    }

References $form.

Here is the caller graph for this function:

◆ getSearchColumn()

ilADTSearchBridge::getSearchColumn ( )

Reimplemented in ilADTEnumSearchBridgeMulti, and ilADTEnumSearchBridgeSingle.

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

                                     : string
    {
        return self::DEFAULT_SEARCH_COLUMN;
    }

References DEFAULT_SEARCH_COLUMN.

◆ getSerializedValue()

ilADTSearchBridge::getSerializedValue ( )

abstract

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

Reimplemented in ilADTDateSearchBridgeRange, ilADTDateSearchBridgeSingle, ilADTDateTimeSearchBridgeRange, ilADTDateTimeSearchBridgeSingle, ilADTEnumSearchBridgeMulti, ilADTEnumSearchBridgeSingle, ilADTExternalLinkSearchBridgeSingle, ilADTFloatSearchBridgeSingle, ilADTIntegerSearchBridgeSingle, ilADTInternalLinkSearchBridgeSingle, ilADTLocalizedTextSearchBridgeSingle, ilADTLocationSearchBridgeSingle, and ilADTTextSearchBridgeSingle.

Referenced by ilAdvancedMDFieldDefinition\getSearchValueSerialized().

Here is the caller graph for this function:

◆ getSQLCondition()

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

abstract

Get SQL condition for current value(s)

Reimplemented in ilADTDateSearchBridgeRange, ilADTDateSearchBridgeSingle, ilADTDateTimeSearchBridgeRange, ilADTDateTimeSearchBridgeSingle, ilADTEnumSearchBridgeMulti, ilADTEnumSearchBridgeSingle, ilADTExternalLinkSearchBridgeSingle, ilADTFloatSearchBridgeSingle, ilADTIntegerSearchBridgeSingle, ilADTInternalLinkSearchBridgeSingle, ilADTLocalizedTextSearchBridgeSingle, ilADTLocationSearchBridgeSingle, and ilADTTextSearchBridgeSingle.

Referenced by ilAdvancedMDFieldDefinitionSelect\findBySingleValue(), and ilAdvancedMDFieldDefinition\searchSubObjects().

Here is the caller graph for this function:

◆ getTableGUI()

ilADTSearchBridge::getTableGUI ( )

Get table gui.

Definition at line 106 of file class.ilADTSearchBridge.php.

                                 : ?ilTable2GUI
    {
        return $this->table_gui;
    }

References $table_gui.

Referenced by addToParentElement().

Here is the caller graph for this function:

◆ getTitle()

ilADTSearchBridge::getTitle ( )

Definition at line 88 of file class.ilADTSearchBridge.php.

                              : string
    {
        return $this->title;
    }

References $title.

Here is the caller graph for this function:

◆ importFromPost()

ilADTSearchBridge::importFromPost ( array $a_post = null )

abstract

Todo:: make post required

Reimplemented in ilADTDateSearchBridgeRange, ilADTDateSearchBridgeSingle, ilADTDateTimeSearchBridgeRange, ilADTDateTimeSearchBridgeSingle, ilADTEnumSearchBridgeMulti, ilADTEnumSearchBridgeSingle, ilADTExternalLinkSearchBridgeSingle, ilADTFloatSearchBridgeSingle, ilADTIntegerSearchBridgeSingle, ilADTInternalLinkSearchBridgeSingle, ilADTLocalizedTextSearchBridgeSingle, ilADTLocationSearchBridgeSingle, and ilADTTextSearchBridgeSingle.

◆ isInCondition()

ilADTSearchBridge::isInCondition ( ilADT $a_adt )

Compare directly against ADT.

Reimplemented in ilADTDateSearchBridgeRange, ilADTDateSearchBridgeSingle, ilADTDateTimeSearchBridgeRange, ilADTDateTimeSearchBridgeSingle, ilADTEnumSearchBridgeMulti, ilADTEnumSearchBridgeSingle, ilADTExternalLinkSearchBridgeSingle, ilADTFloatSearchBridgeSingle, ilADTIntegerSearchBridgeSingle, ilADTInternalLinkSearchBridgeSingle, ilADTLocalizedTextSearchBridgeSingle, and ilADTTextSearchBridgeSingle.

Definition at line 259 of file class.ilADTSearchBridge.php.

                                               : bool
    {
        return false;
    }

◆ isNull()

ilADTSearchBridge::isNull ( )

abstract

Reimplemented in ilADTSearchBridgeRange, and ilADTSearchBridgeSingle.

◆ isValidADTDefinition()

ilADTSearchBridge::isValidADTDefinition ( ilADTDefinition $a_adt_def )

abstractprotected

Reimplemented in ilADTDateSearchBridgeRange, ilADTDateSearchBridgeSingle, ilADTDateTimeSearchBridgeRange, ilADTDateTimeSearchBridgeSingle, ilADTEnumSearchBridgeMulti, ilADTEnumSearchBridgeSingle, ilADTFloatSearchBridgeSingle, ilADTIntegerSearchBridgeSingle, ilADTLocalizedTextSearchBridgeSingle, ilADTLocationSearchBridgeSingle, and ilADTTextSearchBridgeSingle.

Referenced by ilADTSearchBridgeMulti\setDefinition(), ilADTSearchBridgeRange\setDefinition(), and ilADTSearchBridgeSingle\setDefinition().

Here is the caller graph for this function:

◆ loadFilter()

ilADTSearchBridge::loadFilter ( )

abstract

Load filter value(s) into ADT.

Reimplemented in ilADTDateSearchBridgeRange, ilADTDateSearchBridgeSingle, ilADTDateTimeSearchBridgeRange, ilADTDateTimeSearchBridgeSingle, ilADTEnumSearchBridgeMulti, ilADTEnumSearchBridgeSingle, ilADTExternalLinkSearchBridgeSingle, ilADTFloatSearchBridgeSingle, ilADTIntegerSearchBridgeSingle, ilADTInternalLinkSearchBridgeSingle, ilADTLocalizedTextSearchBridgeSingle, ilADTLocationSearchBridgeSingle, and ilADTTextSearchBridgeSingle.

◆ readFilter()

ilADTSearchBridge::readFilter ( )

protected

Load value(s) from filter store (in session)

Returns

Definition at line 140 of file class.ilADTSearchBridge.php.

    {
        if (!$this->table_gui instanceof ilTable2GUI) {
            return null;
        }
        /*
         * BT 35593: changes in ilFormPropertyGUI::clearFromSession make it necessary
         * to have a flat array of all the filter inputs in the session.
         */
        $value = ilSession::get(
            "form_" . $this->table_gui->getId() . "_" . $this->getElementId()
        ) ?? '';
        if ($value) {
            return unserialize($value);
        }
        return '';
    }

References ilSession\get().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDefinition()

ilADTSearchBridge::setDefinition ( ilADTDefinition $a_adt_def )

abstractprotected

Reimplemented in ilADTSearchBridgeMulti, ilADTSearchBridgeRange, and ilADTSearchBridgeSingle.

Referenced by __construct().

Here is the caller graph for this function:

◆ setElementId()

ilADTSearchBridge::setElementId ( string $a_value )

Definition at line 73 of file class.ilADTSearchBridge.php.

                                                 : void
    {
        $this->id = $a_value;
    }

◆ setForm()

ilADTSearchBridge::setForm ( ilPropertyFormGUI $a_form )

Definition at line 63 of file class.ilADTSearchBridge.php.

                                                      : void
    {
        $this->form = $a_form;
    }

References ILIAS\Repository\form().

Here is the call graph for this function:

◆ setSerializedValue()

ilADTSearchBridge::setSerializedValue ( string $a_value )

abstract

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

Reimplemented in ilADTDateSearchBridgeRange, ilADTDateSearchBridgeSingle, ilADTDateTimeSearchBridgeRange, ilADTDateTimeSearchBridgeSingle, ilADTEnumSearchBridgeMulti, ilADTEnumSearchBridgeSingle, ilADTExternalLinkSearchBridgeSingle, ilADTFloatSearchBridgeSingle, ilADTIntegerSearchBridgeSingle, ilADTInternalLinkSearchBridgeSingle, ilADTLocalizedTextSearchBridgeSingle, ilADTLocationSearchBridgeSingle, and ilADTTextSearchBridgeSingle.

Referenced by ilAdvancedMDFieldDefinition\setSearchValueSerialized().

Here is the caller graph for this function:

◆ setTableGUI()

ilADTSearchBridge::setTableGUI ( ilTable2GUI $a_table )

Definition at line 98 of file class.ilADTSearchBridge.php.

                                                     : void
    {
        $this->table_gui = $a_table;
    }

◆ setTitle()

ilADTSearchBridge::setTitle ( string $a_value )

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

                                             : void
    {
        $this->title = trim($a_value);
    }

◆ shouldBeImportedFromPost()

ilADTSearchBridge::shouldBeImportedFromPost ( $a_post )

protected

Check if incoming values should be imported at all.

Parameters

string | int $a_post

Returns: bool

Reimplemented in ilADTDateSearchBridgeRange, ilADTDateSearchBridgeSingle, ilADTDateTimeSearchBridgeRange, ilADTDateTimeSearchBridgeSingle, and ilADTLocationSearchBridgeSingle.

Definition at line 200 of file class.ilADTSearchBridge.php.

                                                        : bool
    {
        return true;
    }

Referenced by ilADTEnumSearchBridgeMulti\importFromPost(), ilADTEnumSearchBridgeSingle\importFromPost(), ilADTExternalLinkSearchBridgeSingle\importFromPost(), ilADTFloatSearchBridgeSingle\importFromPost(), ilADTIntegerSearchBridgeSingle\importFromPost(), ilADTInternalLinkSearchBridgeSingle\importFromPost(), ilADTLocalizedTextSearchBridgeSingle\importFromPost(), and ilADTTextSearchBridgeSingle\importFromPost().

Here is the caller graph for this function:

◆ validate()

ilADTSearchBridge::validate ( )

abstract

Validate current data.

Returns: bool

Reimplemented in ilADTSearchBridgeRange, and ilADTSearchBridgeSingle.

◆ writeFilter()

ilADTSearchBridge::writeFilter ( $a_value = null )

protected

Write value(s) to filter store (in session)

Parameters

?$a_value

Definition at line 115 of file class.ilADTSearchBridge.php.

                                                   : void
    {
        if (!$this->table_gui instanceof ilTable2GUI) {
            return;
        }
        /*
         * BT 35593: changes in ilFormPropertyGUI::clearFromSession make it necessary
         * to have a flat array for all the filter inputs in the session.
         */
        if ($a_value !== null) {
            ilSession::set(
                "form_" . $this->table_gui->getId() . "_" . $this->getElementId(),
                serialize($a_value)
            );
        } else {
            ilSession::clear(
                "form_" . $this->table_gui->getId() . "_" . $this->getElementId()
            );
        }
    }