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)
	Import from post. More...

	getSQLCondition ($a_element_id, $a_mode=self::SQL_LIKE, $a_value=null)
	Get sql condition. More...

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

	getSerializedValue ()
	get serialized value More...

	setSerializedValue ($a_value)
	Set serialized value. More...

Public Member Functions inherited from ilADTSearchBridgeSingle
	getADT ()
	Get ADT. More...

	isNull ()
	Is null ? More...

	isValid ()

	validate ()
	Validate current data. More...

Public Member Functions inherited from ilADTSearchBridge
	__construct (ilADTDefinition $a_adt_def)
	Constructor. More...

	isNull ()
	Is null ? More...

	setForm (ilPropertyFormGUI $a_form)
	Set form. More...

	getForm ()
	Get form. More...

	setElementId ($a_value)
	Set element id (aka form field) More...

	getElementId ()
	Get element id. More...

	setTitle ($a_value)
	Set title (aka form field caption) More...

	getTitle ()
	Get title. More...

	getSearchColumn ()

	setTableGUI (ilTable2GUI $a_table)
	Set table gui (for filter mode) More...

	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)
	Import values from (search) form request POST data. More...

	validate ()
	Validate current data. More...

	getSQLCondition ($a_element_id)
	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 ($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

Data Fields inherited from ilADTSearchBridge
const	DEFAULT_SEARCH_COLUMN = 'value'

Protected Member Functions
	isValidADTDefinition (\ilADTDefinition $a_adt_def)
	Is valid type. More...

Protected Member Functions inherited from ilADTSearchBridgeSingle
	setDefinition (ilADTDefinition $a_adt_def)
	Set ADT definition. More...

Protected Member Functions inherited from ilADTSearchBridge
	isValidADTDefinition (ilADTDefinition $a_adt_def)
	Check if given ADT definition is valid. More...

	setDefinition (ilADTDefinition $a_adt_def)
	Set ADT definition. More...

	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 ($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
Protected Attributes inherited from ilADTSearchBridgeSingle
	$adt

Protected Attributes inherited from ilADTSearchBridge
	$form

	$table_gui

	$table_filter_fields = []

	$id

	$title

	$info

Detailed Description

external link search bridge

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

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

Member Function Documentation

◆ addToForm()

ilADTExternalLinkSearchBridgeSingle::addToForm ( )

add external link property to form

Reimplemented from ilADTSearchBridge.

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

    {
        $def = $this->getADT()->getCopyOfDefinition();
 
        $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:

◆ getSerializedValue()

ilADTExternalLinkSearchBridgeSingle::getSerializedValue ( )

get serialized value

Returns: type

Reimplemented from ilADTSearchBridge.

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

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

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

Here is the call graph for this function:

◆ getSQLCondition()

ilADTExternalLinkSearchBridgeSingle::getSQLCondition	(	$a_element_id,
		$a_mode = `self::SQL_LIKE`,
		$a_value = `null`
	)

Get sql condition.

Parameters

int $a_element_id

Returns: string

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

    {
        $db = $GLOBALS['DIC']->database();
 
        if (!$a_value) {
            if ($this->isNull() || !$this->isValid()) {
                return;
            }
            $a_value = $this->getADT()->getUrl();
        }
 
        switch ($a_mode) {
            case self::SQL_STRICT:
                if (!is_array($a_value)) {
                    return $a_element_id . " = " . $db->quote($a_value, "text");
                } else {
                    return $db->in($a_element_id, $a_value, "", "text");
                }
                break;
 
            case self::SQL_LIKE:
                if (!is_array($a_value)) {
                    return $db->like($a_element_id, "text", "%" . $a_value . "%");
                } else {
                    $tmp = array();
                    foreach ($a_value as $word) {
                        if ($word) {
                            $tmp[] = $db->like($a_element_id, "text", "%" . $word . "%");
                        }
                    }
                    if (sizeof($tmp)) {
                        return "(" . implode(" OR ", $tmp) . ")";
                    }
                }
                break;
 
            case self::SQL_LIKE_END:
                if (!is_array($a_value)) {
                    return $db->like($a_element_id, "text", $a_value . "%");
                }
                break;
 
            case self::SQL_LIKE_START:
                if (!is_array($a_value)) {
                    return $db->like($a_element_id, "text", "%" . $a_value);
                }
                break;
        }
    }

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

Here is the call graph for this function:

◆ importFromPost()

ilADTExternalLinkSearchBridgeSingle::importFromPost ( array $a_post = null )

Import from post.

Parameters

array $a_post

Reimplemented from ilADTSearchBridge.

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

    {
        $post = $this->extractPostValues($a_post);
 
        if ($post && $this->shouldBeImportedFromPost($post)) {
 
            if ($this->getForm() instanceof ilPropertyFormGUI) {
                $item = $this->getForm()->getItemByPostVar($this->getElementId());
                $item->setValue($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->getADT()->setUrl(null);
            $this->writeFilter();
        }
    }

References 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 139 of file class.ilADTExternalLinkSearchBridgeSingle.php.

    {
        if ($this->getADT()->getCopyOfDefinition()->isComparableTo($a_adt)) {
            return
                strcasecmp(trim($this->getADT()->getUrl()), trim($a_adt->getUrl())) === 0 ||
                strcasecmp(trim($this->getADT()->getUrl()), trim($a_adt->getTitle())) === 0;
        }
        return false;
    }

References 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 24 of file class.ilADTExternalLinkSearchBridgeSingle.php.

    {
        return $a_adt_def instanceof ilADTExternalLinkDefinition;
    }

◆ loadFilter()

ilADTExternalLinkSearchBridgeSingle::loadFilter ( )

Load from filter.

Reimplemented from ilADTSearchBridge.

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

    {
        $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 ( $a_value )

Set serialized value.

Parameters

string $a_value

Reimplemented from ilADTSearchBridge.

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

    {
        $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:

Field Documentation

◆ SQL_LIKE

const ilADTExternalLinkSearchBridgeSingle::SQL_LIKE = 2

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

Referenced by getSQLCondition().

◆ SQL_LIKE_END

const ilADTExternalLinkSearchBridgeSingle::SQL_LIKE_END = 3

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

Referenced by getSQLCondition().

◆ SQL_LIKE_START

const ilADTExternalLinkSearchBridgeSingle::SQL_LIKE_START = 4

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

Referenced by getSQLCondition().

◆ SQL_STRICT

const ilADTExternalLinkSearchBridgeSingle::SQL_STRICT = 1

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

Referenced by getSQLCondition().

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

Services/ADT/classes/Types/ExternalLink/class.ilADTExternalLinkSearchBridgeSingle.php

Public Member Functions

Data Fields

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addToForm()

◆ getSerializedValue()

◆ getSQLCondition()

◆ importFromPost()

◆ isInCondition()

◆ isValidADTDefinition()

◆ loadFilter()

◆ setSerializedValue()

Field Documentation

◆ SQL_LIKE

◆ SQL_LIKE_END

◆ SQL_LIKE_START

◆ SQL_STRICT