ilADTLocalizedTextSearchBridgeSingle Class Reference

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...
	importFromPost (array $a_post=null)
	Import values from (search) form request POST data. More...
	getSQLCondition ($a_element_id, $a_mode=self::SQL_LIKE, $a_value=null)
	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...
	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...
	getSQLCondition ($a_element_id, $a_mode=self::SQL_LIKE, $a_value=null)
	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...
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...

Protected Member Functions
	isValidADTDefinition (ilADTDefinition $a_adt_def)
	Check if given ADT definition is valid. More...
	isValidADTDefinition (ilADTDefinition $a_adt_def)
	Check if given ADT definition is valid. 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
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	DEFAULT_SEARCH_COLUMN = 'value'
Protected Attributes inherited from ilADTSearchBridgeSingle
	$adt
Protected Attributes inherited from ilADTSearchBridge
	$form
	$table_gui
	$table_filter_fields = []
	$id
	$title
	$info

Detailed Description

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

Member Function Documentation

addToForm()

ilADTLocalizedTextSearchBridgeSingle::addToForm

(

)

Add ADT-specific fields to form.

Reimplemented from ilADTTextSearchBridgeSingle.

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

    {
        $text = new ilTextInputGUI($this->getTitle(), $this->getElementId());
        $text->setSize(20);
        $text->setMaxLength(512);
        $text->setSubmitFormOnEnter(true);
        
        $text->setValue($this->getADT()->getText());
        
        $this->addToParentElement($text);
    }

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

Here is the call graph for this function:

getSerializedValue()

ilADTLocalizedTextSearchBridgeSingle::getSerializedValue

(

)

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

Returns

string

Reimplemented from ilADTTextSearchBridgeSingle.

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

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

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

Here is the call graph for this function:

getSQLCondition()

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

Reimplemented from ilADTTextSearchBridgeSingle.

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

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        if (!$a_value) {
            if ($this->isNull() || !$this->isValid()) {
                return;
            }
            $a_value = $this->getADT()->getText();
        }
                        
        switch ($a_mode) {
            case self::SQL_STRICT:
                if (!is_array($a_value)) {
                    return $a_element_id . " = " . $ilDB->quote($a_value, "text");
                } else {
                    return $ilDB->in($a_element_id, $a_value, "", "text");
                }
                break;
 
            case self::SQL_LIKE:
                if (!is_array($a_value)) {
                    return $ilDB->like($a_element_id, "text", "%" . $a_value . "%");
                } else {
                    $tmp = array();
                    foreach ($a_value as $word) {
                        if ($word) {
                            $tmp[] = $ilDB->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 $ilDB->like($a_element_id, "text", $a_value . "%");
                }
                break;
 
            case self::SQL_LIKE_START:
                if (!is_array($a_value)) {
                    return $ilDB->like($a_element_id, "text", "%" . $a_value);
                }
                break;
        }
    }

References $DIC, $ilDB, 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

)

Import values from (search) form request POST data.

Returns

bool

Reimplemented from ilADTTextSearchBridgeSingle.

Definition at line 37 of file class.ilADTLocalizedTextSearchBridgeSingle.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);
            } 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();
        }
    }

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

Parameters

ilADT

$a_adt

Returns

bool

Reimplemented from ilADTTextSearchBridgeSingle.

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

    {
        if ($this->getADT()->getCopyOfDefinition()->isComparableTo($a_adt)) {
            foreach ($a_adt->getTranslations() as $language => $txt) {
                if (strcasecmp($txt, $this->getADT()->getText()) === 0) {
                    return true;
                }
            }
        }
        return false;
    }

References $txt, and ilADTSearchBridgeSingle\getADT().

Here is the call graph for this function:

isValidADTDefinition()

ilADTLocalizedTextSearchBridgeSingle::isValidADTDefinition ( ilADTDefinition  $a_adt_def )

protected

Check if given ADT definition is valid.

:TODO: This could be avoided with type-specifc constructors :TODO: bridge base class?

Parameters

ilADTDefinition

$a_adt_def

Reimplemented from ilADTTextSearchBridgeSingle.

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

    {
        return ($a_adt_def instanceof ilADTLocalizedTextDefinition);
    }

loadFilter()

ilADTLocalizedTextSearchBridgeSingle::loadFilter

(

)

Load filter value(s) into ADT.

Reimplemented from ilADTTextSearchBridgeSingle.

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

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

(

$a_value

)

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

Parameters

string

Reimplemented from ilADTTextSearchBridgeSingle.

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

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

• Services/ADT/classes/Types/LocalizedText/class.ilADTLocalizedTextSearchBridgeSingle.php