external link search bridge More...

Inheritance diagram for ilADTInternalLinkSearchBridgeSingle:

Collaboration diagram for ilADTInternalLinkSearchBridgeSingle:

Public Member Functions
	addToForm ()

	setTitleQuery (string $query)

	getTitleQuery ()

	loadFilter ()
	/** Load from filter 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 ()

	isValid ()

	validate ()

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)

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

Private Attributes
	$title_query = ''

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

Member Function Documentation

◆ addToForm()

ilADTInternalLinkSearchBridgeSingle::addToForm ( )

Definition at line 34 of file class.ilADTInternalLinkSearchBridgeSingle.php.

References ilADTSearchBridge\$title, ilADTSearchBridge\addToParentElement(), ilADTSearchBridge\getElementId(), and ilADTSearchBridge\getTitle().

     {
         $title = new ilTextInputGUI($this->getTitle(), $this->getElementId());
         $title->setSize(255);
         $this->addToParentElement($title);
     }

Here is the call graph for this function:

◆ getSerializedValue()

ilADTInternalLinkSearchBridgeSingle::getSerializedValue ( )

get serialized value

Returns: type

Definition at line 136 of file class.ilADTInternalLinkSearchBridgeSingle.php.

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

◆ getSQLCondition()

ilADTInternalLinkSearchBridgeSingle::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 99 of file class.ilADTInternalLinkSearchBridgeSingle.php.

     {
         $db = $GLOBALS['DIC']->database();
         
         if (!$a_value) {
             if ($this->isNull() || !$this->isValid()) {
                 return;
             }
             $a_value = $this->getADT()->getTargetRefId();
         }
         
         $subselect = $a_element_id . ' IN ' .
             '( select ref_id from object_reference obr join object_data obd on obr.obj_id = obd.obj_id ' .
             'where ' . $db->like('title', 'text', $a_value . '%') . ' ' .
             ')';
         return $subselect;
     }

◆ getTitleQuery()

ilADTInternalLinkSearchBridgeSingle::getTitleQuery ( )

Definition at line 46 of file class.ilADTInternalLinkSearchBridgeSingle.php.

References $title_query.

                                     : string
     {
         return $this->title_query;
     }

◆ importFromPost()

ilADTInternalLinkSearchBridgeSingle::importFromPost ( array $a_post = null )

Import from post.

Parameters

array $a_post

Definition at line 70 of file class.ilADTInternalLinkSearchBridgeSingle.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->setTitleQuery($post);
                 $this->getADT()->setTargetRefId(1);
             } elseif (array_key_exists($this->getElementId(), $this->table_filter_fields)) {
                 $this->table_filter_fields[$this->getElementId()]->setValue($post);
                 $this->writeFilter($post);
                 $this->setTitleQuery($post);
                 $this->getADT()->setTargetRefId(1);
             }
         } else {
             $this->writeFilter();
             $this->setTitleQuery('');
             $this->getADT()->setTargetRefId(null);
         }
         return true;
     }

◆ isInCondition()

ilADTInternalLinkSearchBridgeSingle::isInCondition ( ilADT $a_adt )

Is in condition.

Parameters

ilADT $a_adt

Returns: bool

Definition at line 122 of file class.ilADTInternalLinkSearchBridgeSingle.php.

     {
         if ($this->getADT()->getCopyOfDefinition()->isComparableTo($a_adt)) {
             $ref_id = $a_adt->getTargetRefId();
             $title = ilObject::_lookupTitle((int) ilObject::_lookupObjId($ref_id));
             return strcasecmp($title, $this->getTitleQuery()) === 0;
         }
         return false;
     }

◆ isValidADTDefinition()

ilADTInternalLinkSearchBridgeSingle::isValidADTDefinition ( \ilADTDefinition $a_adt_def )

protected

Is valid type.

Parameters

ilADT $a_adt

Returns: bool

Definition at line 25 of file class.ilADTInternalLinkSearchBridgeSingle.php.

     {
         return $a_adt_def instanceof ilADTInternalLinkDefinition;
     }

◆ loadFilter()

ilADTInternalLinkSearchBridgeSingle::loadFilter ( )

/** Load from filter

Definition at line 57 of file class.ilADTInternalLinkSearchBridgeSingle.php.

     {
         $value = $this->readFilter();
         if ($value !== null) {
             $this->getADT()->setTargetRefId(1);
             $this->setTitleQuery($value);
         }
     }

◆ setSerializedValue()

ilADTInternalLinkSearchBridgeSingle::setSerializedValue ( $a_value )

Set serialized value.

Parameters

string $a_value

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

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

◆ setTitleQuery()

ilADTInternalLinkSearchBridgeSingle::setTitleQuery ( string $query )

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

References $query.

                                                  : void
     {
         $this->title_query = $query;
     }

Field Documentation

◆ $title_query

ilADTInternalLinkSearchBridgeSingle::$title_query = ''

private

Definition at line 18 of file class.ilADTInternalLinkSearchBridgeSingle.php.

Referenced by getTitleQuery().

◆ SQL_LIKE

const ilADTInternalLinkSearchBridgeSingle::SQL_LIKE = 2

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

◆ SQL_LIKE_END

const ilADTInternalLinkSearchBridgeSingle::SQL_LIKE_END = 3

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

◆ SQL_LIKE_START

const ilADTInternalLinkSearchBridgeSingle::SQL_LIKE_START = 4

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

◆ SQL_STRICT

const ilADTInternalLinkSearchBridgeSingle::SQL_STRICT = 1

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

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

Services/ADT/classes/Types/InternalLink/class.ilADTInternalLinkSearchBridgeSingle.php

Public Member Functions

Data Fields

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addToForm()

◆ getSerializedValue()

◆ getSQLCondition()

◆ getTitleQuery()

◆ importFromPost()

◆ isInCondition()

◆ isValidADTDefinition()

◆ loadFilter()

◆ setSerializedValue()

◆ setTitleQuery()

Field Documentation

◆ $title_query

◆ SQL_LIKE

◆ SQL_LIKE_END

◆ SQL_LIKE_START

◆ SQL_STRICT