Inheritance diagram for ilADTLocalizedTextSearchBridgeSingle:

Collaboration diagram for ilADTLocalizedTextSearchBridgeSingle:

Public Member Functions
	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)

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

	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)

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

Protected Member Functions inherited from ilADTTextSearchBridgeSingle
	isValidADTDefinition (ilADTDefinition $a_adt_def)

	addTextInputToForm (bool $submit_on_enter)

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 ilADTTextSearchBridgeSingle
const	SQL_STRICT = 1

const	SQL_LIKE = 2

const	SQL_LIKE_END = 3

const	SQL_LIKE_START = 4

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

Definition at line 21 of file class.ilADTLocalizedTextSearchBridgeSingle.php.

Member Function Documentation

◆ addToFilterForm()

ilADTLocalizedTextSearchBridgeSingle::addToFilterForm ( )

Add ADT-specific fields to filter.

This needs to be separated from other forms to avoid weird js interactions, but can probably be dropped when moving to KS (see #39225).

Reimplemented from ilADTTextSearchBridgeSingle.

Definition at line 45 of file class.ilADTLocalizedTextSearchBridgeSingle.php.

                                     : void
    {
        $this->addTextInputToForm(false);
    }

References ilADTTextSearchBridgeSingle\addTextInputToForm().

Here is the call graph for this function:

◆ addToForm()

ilADTLocalizedTextSearchBridgeSingle::addToForm ( )

Add ADT-specific fields to form.

Reimplemented from ilADTTextSearchBridgeSingle.

Definition at line 40 of file class.ilADTLocalizedTextSearchBridgeSingle.php.

                               : void
    {
        $this->addTextInputToForm(true);
    }

References ilADTTextSearchBridgeSingle\addTextInputToForm().

Here is the call graph for this function:

◆ getSerializedValue()

ilADTLocalizedTextSearchBridgeSingle::getSerializedValue ( )

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

Reimplemented from ilADTTextSearchBridgeSingle.

Definition at line 139 of file class.ilADTLocalizedTextSearchBridgeSingle.php.

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

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

Here is the call graph for this function:

◆ getSQLCondition()

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

Get SQL condition for current value(s)

Reimplemented from ilADTTextSearchBridgeSingle.

Definition at line 70 of file class.ilADTLocalizedTextSearchBridgeSingle.php.

                                                                                                            : string
    {
        if (!$quotedWords) {
            if ($this->isNull() || !$this->isValid()) {
                return '';
            }
            $quotedWords = $this->getADT()->getText();
        }
 
        switch ($mode) {
            case self::SQL_STRICT:
                if (!is_array($quotedWords)) {
                    return $a_element_id . " = " . $this->db->quote($quotedWords, "text");
                } else {
                    return $this->db->in($a_element_id, $quotedWords, false, "text");
                }
 
                // no break
            case self::SQL_LIKE:
                if (!is_array($quotedWords)) {
                    return $this->db->like($a_element_id, "text", "%" . $quotedWords . "%");
                } else {
                    $tmp = array();
                    foreach ($quotedWords as $word) {
                        if ($word) {
                            $tmp[] = $this->db->like($a_element_id, "text", "%" . $word . "%");
                        }
                    }
                    if (count($tmp)) {
                        return "(" . implode(" OR ", $tmp) . ")";
                    }
                }
                break;
 
            case self::SQL_LIKE_END:
                if (!is_array($quotedWords)) {
                    return $this->db->like($a_element_id, "text", $quotedWords . "%");
                }
                break;
 
            case self::SQL_LIKE_START:
                if (!is_array($quotedWords)) {
                    return $this->db->like($a_element_id, "text", "%" . $quotedWords);
                }
                break;
        }
        return '';
    }

References ilADTSearchBridgeSingle\getADT(), ilADTSearchBridgeSingle\isNull(), ilADTSearchBridgeSingle\isValid(), ilADTTextSearchBridgeSingle\SQL_LIKE, ilADTTextSearchBridgeSingle\SQL_LIKE_END, ilADTTextSearchBridgeSingle\SQL_LIKE_START, and ilADTTextSearchBridgeSingle\SQL_STRICT.

Here is the call graph for this function:

◆ importFromPost()

ilADTLocalizedTextSearchBridgeSingle::importFromPost ( ?array $a_post = null )

Todo:: make post required

Reimplemented from ilADTTextSearchBridgeSingle.

Definition at line 50 of file class.ilADTLocalizedTextSearchBridgeSingle.php.

                                                         : bool
    {
        $post = $this->extractPostValues($a_post);
 
        if ($post && $this->shouldBeImportedFromPost($post)) {
            if ($this->getForm() instanceof ilPropertyFormGUI) {
                $item = $this->getForm()->getItemByPostVar($this->getElementId());
                $item->setValue($post);
            } elseif (array_key_exists($this->getElementId(), $this->table_filter_fields)) {
                $this->table_filter_fields[$this->getElementId()]->setValue($post);
                $this->writeFilter($post);
            }
            $this->getADT()->setText($post);
        } else {
            $this->writeFilter();
            $this->getADT()->setText();
        }
        return true;
    }

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

Here is the call graph for this function:

◆ isInCondition()

ilADTLocalizedTextSearchBridgeSingle::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 ilADTTextSearchBridgeSingle.

Definition at line 119 of file class.ilADTLocalizedTextSearchBridgeSingle.php.

                                               : bool
    {
        if ($this->getADT()->getCopyOfDefinition()->isComparableTo($a_adt)) {
            $relevant_translation = $a_adt->getCopyOfDefinition()->getMultilingualValueSupport() ?
                $a_adt->getTranslations() :
                [$a_adt->getTextForLanguage($a_adt->getCopyOfDefinition()->getDefaultLanguage())];
 
            foreach ($relevant_translation as $text) {
                $search_term = strtolower(trim((string) $this->getADT()->getText()));
                $text = strtolower(trim((string) $text));
                if (str_contains($text, $search_term)) {
                    return true;
                }
            }
        }
        return false;
    }

References ilADTSearchBridgeSingle\getADT(), and ilADT\getCopyOfDefinition().

Here is the call graph for this function:

◆ isValidADTDefinition()

ilADTLocalizedTextSearchBridgeSingle::isValidADTDefinition ( ilADTDefinition $a_adt_def )

protected

Reimplemented from ilADTTextSearchBridgeSingle.

Definition at line 23 of file class.ilADTLocalizedTextSearchBridgeSingle.php.

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

◆ loadFilter()

ilADTLocalizedTextSearchBridgeSingle::loadFilter ( )

Load filter value(s) into ADT.

Reimplemented from ilADTTextSearchBridgeSingle.

Definition at line 30 of file class.ilADTLocalizedTextSearchBridgeSingle.php.

                                : void
    {
        $value = $this->readFilter();
        if ($value !== null) {
            $this->getADT()->setText($value);
        }
    }

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

Here is the call graph for this function:

◆ setSerializedValue()

ilADTLocalizedTextSearchBridgeSingle::setSerializedValue ( string $a_value )

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

Reimplemented from ilADTTextSearchBridgeSingle.

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

                                                       : void
    {
        $a_value = unserialize($a_value);
        if (is_array($a_value)) {
            $this->getADT()->setText($a_value[0]);
        }
    }

References ilADTSearchBridgeSingle\getADT().

Here is the call graph for this function:

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

components/ILIAS/ADT/classes/Types/LocalizedText/class.ilADTLocalizedTextSearchBridgeSingle.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addToFilterForm()

◆ addToForm()

◆ getSerializedValue()

◆ getSQLCondition()

◆ importFromPost()

◆ isInCondition()

◆ isValidADTDefinition()

◆ loadFilter()

◆ setSerializedValue()