external link search bridge More...

Inheritance diagram for ilADTExternalLinkSearchBridgeSingle:

Collaboration diagram for ilADTExternalLinkSearchBridgeSingle:

Public Member Functions
	loadFilter ()
	Load from filter. More...

	addToForm ()
	add external link property to form More...

	importFromPost (?array $a_post=null)

	getSQLCondition (string $a_element_id, int $mode=self::SQL_LIKE, array $quotedWords=[])
	Get sql condition. More...

	isInCondition (ilADT $a_adt)
	Is in condition. More...

	getSerializedValue ()
	get serialized value More...

	setSerializedValue (string $a_value)
	Set serialized value. 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)
	Is valid type. More...

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

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

external link search bridge

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Member Function Documentation

◆ addToForm()

ilADTExternalLinkSearchBridgeSingle::addToForm ( )

add external link property to form

Reimplemented from ilADTSearchBridge.

Definition at line 52 of file class.ilADTExternalLinkSearchBridgeSingle.php.

                               : void
    {
        $url = new ilTextInputGUI($this->getTitle(), $this->getElementId());
        $url->setSize(255);
        $url->setValue($this->getADT()->getUrl());
        $this->addToParentElement($url);
    }

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

Here is the call graph for this function:

◆ buildSQLCondition()

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

protected

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

                                                                                                                 : string
    {
        if (!$quotedWords) {
            if ($this->isNull() || !$this->isValid()) {
                return '';
            }
            $quotedWords = $this->getADT()->getUrl();
        }
 
        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(), ilADTSearchBridge\SQL_LIKE, ilADTSearchBridge\SQL_LIKE_END, ilADTSearchBridge\SQL_LIKE_START, and ilADTSearchBridge\SQL_STRICT.

Referenced by getSQLCondition().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSerializedValue()

ilADTExternalLinkSearchBridgeSingle::getSerializedValue ( )

get serialized value

Returns: string

Reimplemented from ilADTSearchBridge.

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

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

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

Here is the call graph for this function:

◆ getSQLCondition()

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

Get sql condition.

Parameters

string	$a_element_id
int	$mode
array	$quotedWords

Returns: string

Reimplemented from ilADTSearchBridge.

Definition at line 92 of file class.ilADTExternalLinkSearchBridgeSingle.php.

                                                                                                            : string
    {
        return $this->buildSQLCondition($a_element_id, $mode, $quotedWords) . ' OR ' .
            $this->buildSQLCondition('title', $mode, $quotedWords);
    }

References buildSQLCondition().

Here is the call graph for this function:

◆ importFromPost()

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

Todo:: make post required

Reimplemented from ilADTSearchBridge.

Definition at line 60 of file class.ilADTExternalLinkSearchBridgeSingle.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()->setUrl($post);
        } elseif (array_key_exists($this->getElementId(), $this->table_filter_fields)) {
            $this->table_filter_fields[$this->getElementId()]->setValue($post);
            $this->writeFilter($post);
            $this->getADT()->setUrl($post);
        } else {
            $this->writeFilter();
            $this->getADT()->setUrl(null);
        }
        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()

ilADTExternalLinkSearchBridgeSingle::isInCondition ( ilADT $a_adt )

Is in condition.

Parameters

ilADT $a_adt

Returns: bool

Reimplemented from ilADTSearchBridge.

Definition at line 152 of file class.ilADTExternalLinkSearchBridgeSingle.php.

                                               : bool
    {
        if ($this->getADT()->getCopyOfDefinition()->isComparableTo($a_adt)) {
            $search_term = strtolower(trim((string) $this->getADT()->getUrl()));
            $title = strtolower(trim((string) $a_adt->getTitle()));
            $url = strtolower(trim((string) $a_adt->getUrl()));
            return
                str_contains($title, $search_term) ||
                str_contains($url, $search_term);
        }
        return false;
    }

References ilADTSearchBridge\$title, $url, and ilADTSearchBridgeSingle\getADT().

Here is the call graph for this function:

◆ isValidADTDefinition()

ilADTExternalLinkSearchBridgeSingle::isValidADTDefinition ( \ilADTDefinition $a_adt_def )

protected

Is valid type.

Parameters

ilADT $a_adt

Returns: bool

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

                                                                        : bool
    {
        return $a_adt_def instanceof ilADTExternalLinkDefinition;
    }

◆ loadFilter()

ilADTExternalLinkSearchBridgeSingle::loadFilter ( )

Load from filter.

Reimplemented from ilADTSearchBridge.

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

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

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

Here is the call graph for this function:

◆ setSerializedValue()

ilADTExternalLinkSearchBridgeSingle::setSerializedValue ( string $a_value )

Set serialized value.

Parameters

string $a_value

Reimplemented from ilADTSearchBridge.

Definition at line 181 of file class.ilADTExternalLinkSearchBridgeSingle.php.

                                                       : void
    {
        $a_value = unserialize($a_value);
        if (is_array($a_value)) {
            $this->getADT()->setUrl($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/ExternalLink/class.ilADTExternalLinkSearchBridgeSingle.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addToForm()

◆ buildSQLCondition()

◆ getSerializedValue()

◆ getSQLCondition()

◆ importFromPost()

◆ isInCondition()

◆ isValidADTDefinition()

◆ loadFilter()

◆ setSerializedValue()