ilADTSearchBridge Class Reference

ADT search bridge base class. More...

Inheritance diagram for ilADTSearchBridge:

Collaboration diagram for ilADTSearchBridge:

Public Member Functions
	__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...
	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...
	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...

Protected Attributes
	$form
	$table_gui
	$table_filter_fields
	$id
	$title
	$info

Detailed Description

ADT search bridge base class.

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilADTSearchBridge::__construct

(

ilADTDefinition

$a_adt_def

)

Constructor.

Parameters

ilADT

$a_adt_def

Returns

self

Definition at line 28 of file class.ilADTSearchBridge.php.

        {
                $this->setDefinition($a_adt_def);               
        }               

References setDefinition().

Here is the call graph for this function:

Member Function Documentation

addToElementId()

ilADTSearchBridge::addToElementId (   $a_add )

protected

Add sub-element.

Parameters

string

$a_add

Returns

string

Definition at line 224 of file class.ilADTSearchBridge.php.

        {               
                return $this->getElementId()."[".$a_add."]";            
        }

References getElementId().

Referenced by ilADTDateSearchBridgeRange\addToForm(), ilADTDateSearchBridgeSingle\addToForm(), ilADTDateTimeSearchBridgeRange\addToForm(), ilADTDateTimeSearchBridgeSingle\addToForm(), ilADTLocationSearchBridgeSingle\addToForm(), ilADTLocationSearchBridgeSingle\importFromPost(), and ilADTSearchBridgeRange\validate().

Here is the call graph for this function:

Here is the caller graph for this function:

addToForm()

ilADTSearchBridge::addToForm ( )

abstract

Add ADT-specific fields to form.

Reimplemented in ilADTDateSearchBridgeRange, ilADTDateSearchBridgeSingle, ilADTDateTimeSearchBridgeRange, ilADTDateTimeSearchBridgeSingle, ilADTEnumSearchBridgeMulti, ilADTEnumSearchBridgeSingle, ilADTFloatSearchBridgeSingle, ilADTIntegerSearchBridgeSingle, ilADTLocationSearchBridgeSingle, and ilADTTextSearchBridgeSingle.

addToParentElement()

ilADTSearchBridge::addToParentElement ( ilFormPropertyGUI  $a_field )

protected

Add form field to parent element.

Parameters

ilFormPropertyGUI

$a_field

Definition at line 201 of file class.ilADTSearchBridge.php.

        {               
                if($this->getForm() instanceof ilPropertyFormGUI)
                {
                        $this->getForm()->addItem($a_field);            
                }
                else if($this->getTableGUI() instanceof ilTable2GUI)
                {                       
                        $this->table_filter_fields[$a_field->getFieldId()] = $a_field;
                        $this->getTableGUI()->addFilterItem($a_field);                  
                        
                        // :TODO:
                        // $a_field->readFromSession();
                        // $this->getTableGUI()->filter[$this->getElementId()] = $a_field->getValue();
                }
        }

References ilFormPropertyGUI\getFieldId(), getForm(), and getTableGUI().

Referenced by ilADTDateSearchBridgeRange\addToForm(), ilADTDateSearchBridgeSingle\addToForm(), ilADTDateTimeSearchBridgeRange\addToForm(), ilADTDateTimeSearchBridgeSingle\addToForm(), ilADTEnumSearchBridgeMulti\addToForm(), ilADTEnumSearchBridgeSingle\addToForm(), ilADTFloatSearchBridgeSingle\addToForm(), ilADTIntegerSearchBridgeSingle\addToForm(), ilADTLocationSearchBridgeSingle\addToForm(), and ilADTTextSearchBridgeSingle\addToForm().

Here is the call graph for this function:

Here is the caller graph for this function:

extractPostValues()

ilADTSearchBridge::extractPostValues ( array  $a_post = null )

protected

Extract data from (post) values.

Parameters

array

$a_post

Returns

mixed

Definition at line 256 of file class.ilADTSearchBridge.php.

        {               
                $element_id = $this->getElementId();
                $multi = strpos($this->getElementId(), "[");
                
                if(!$a_post)
                {
                        $a_post = $_POST;                                                               
                        if($multi !== false)
                        {                                                                               
                                $post = $a_post[substr($element_id, 0, $multi)][substr($element_id, $multi+1, -1)];
                        }
                        else
                        {
                                $post = $a_post[$element_id];
                        }
                }
                else
                {
                        if($multi !== false)
                        {                                                                               
                                $post = $a_post[substr($element_id, $multi+1, -1)];
                        }
                        else
                        {
                                $post = $a_post[$element_id];
                        }
                }
                
                return $post;
        }                       

References $_POST, and getElementId().

Referenced by ilADTDateSearchBridgeRange\importFromPost(), ilADTDateSearchBridgeSingle\importFromPost(), ilADTDateTimeSearchBridgeRange\importFromPost(), ilADTDateTimeSearchBridgeSingle\importFromPost(), ilADTEnumSearchBridgeMulti\importFromPost(), ilADTEnumSearchBridgeSingle\importFromPost(), ilADTFloatSearchBridgeSingle\importFromPost(), ilADTIntegerSearchBridgeSingle\importFromPost(), ilADTLocationSearchBridgeSingle\importFromPost(), and ilADTTextSearchBridgeSingle\importFromPost().

Here is the call graph for this function:

Here is the caller graph for this function:

getElementId()

ilADTSearchBridge::getElementId

(

)

Get element id.

Returns

string

Definition at line 97 of file class.ilADTSearchBridge.php.

        {
                return $this->id;
        }

References $id.

Referenced by addToElementId(), ilADTDateSearchBridgeRange\addToForm(), ilADTDateSearchBridgeSingle\addToForm(), ilADTDateTimeSearchBridgeRange\addToForm(), ilADTDateTimeSearchBridgeSingle\addToForm(), ilADTEnumSearchBridgeMulti\addToForm(), ilADTEnumSearchBridgeSingle\addToForm(), ilADTFloatSearchBridgeSingle\addToForm(), ilADTIntegerSearchBridgeSingle\addToForm(), ilADTTextSearchBridgeSingle\addToForm(), extractPostValues(), ilADTDateSearchBridgeRange\importFromPost(), ilADTDateSearchBridgeSingle\importFromPost(), ilADTDateTimeSearchBridgeRange\importFromPost(), ilADTDateTimeSearchBridgeSingle\importFromPost(), ilADTEnumSearchBridgeMulti\importFromPost(), ilADTEnumSearchBridgeSingle\importFromPost(), ilADTFloatSearchBridgeSingle\importFromPost(), ilADTIntegerSearchBridgeSingle\importFromPost(), ilADTLocationSearchBridgeSingle\importFromPost(), ilADTTextSearchBridgeSingle\importFromPost(), readFilter(), ilADTSearchBridgeSingle\validate(), and writeFilter().

Here is the caller graph for this function:

getForm()

ilADTSearchBridge::getForm

(

)

Get form.

Returns

ilPropertyFormGUI

Definition at line 77 of file class.ilADTSearchBridge.php.

        {
                return $this->form;
        }

References $form.

Referenced by ilADTDateSearchBridgeRange\addToForm(), ilADTDateTimeSearchBridgeRange\addToForm(), addToParentElement(), ilADTDateSearchBridgeRange\importFromPost(), ilADTDateSearchBridgeSingle\importFromPost(), ilADTDateTimeSearchBridgeRange\importFromPost(), ilADTDateTimeSearchBridgeSingle\importFromPost(), ilADTEnumSearchBridgeMulti\importFromPost(), ilADTEnumSearchBridgeSingle\importFromPost(), ilADTFloatSearchBridgeSingle\importFromPost(), ilADTIntegerSearchBridgeSingle\importFromPost(), ilADTLocationSearchBridgeSingle\importFromPost(), ilADTTextSearchBridgeSingle\importFromPost(), ilADTDateSearchBridgeRange\shouldBeImportedFromPost(), ilADTDateTimeSearchBridgeRange\shouldBeImportedFromPost(), ilADTSearchBridgeRange\validate(), and ilADTSearchBridgeSingle\validate().

Here is the caller graph for this function:

getSerializedValue()

ilADTSearchBridge::getSerializedValue ( )

abstract

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

Returns

string

Reimplemented in ilADTDateSearchBridgeRange, ilADTDateSearchBridgeSingle, ilADTDateTimeSearchBridgeRange, ilADTDateTimeSearchBridgeSingle, ilADTEnumSearchBridgeMulti, ilADTEnumSearchBridgeSingle, ilADTFloatSearchBridgeSingle, ilADTIntegerSearchBridgeSingle, ilADTLocationSearchBridgeSingle, and ilADTTextSearchBridgeSingle.

Referenced by ilAdvancedMDFieldDefinition\getSearchValueSerialized().

Here is the caller graph for this function:

getSQLCondition()

ilADTSearchBridge::getSQLCondition (   $a_element_id )

abstract

Get SQL condition for current value(s)

Parameters

string

$a_element_id

Returns

string

Reimplemented in ilADTDateSearchBridgeRange, ilADTDateSearchBridgeSingle, ilADTDateTimeSearchBridgeRange, ilADTDateTimeSearchBridgeSingle, ilADTEnumSearchBridgeMulti, ilADTEnumSearchBridgeSingle, ilADTFloatSearchBridgeSingle, ilADTIntegerSearchBridgeSingle, and ilADTLocationSearchBridgeSingle.

Referenced by ilAdvancedMDFieldDefinition\searchObjects(), ilAdvancedMDFieldDefinitionText\searchObjects(), and ilAdvancedMDFieldDefinition\searchSubObjects().

Here is the caller graph for this function:

getTableGUI()

ilADTSearchBridge::getTableGUI

(

)

Get table gui.

Returns

ilTable2GUI

Definition at line 142 of file class.ilADTSearchBridge.php.

        {
                return $this->table_gui;
        }

References $table_gui.

Referenced by addToParentElement().

Here is the caller graph for this function:

getTitle()

ilADTSearchBridge::getTitle

(

)

Get title.

Returns

string

Definition at line 117 of file class.ilADTSearchBridge.php.

        {
                return $this->title;
        }

References $title.

Referenced by ilADTDateSearchBridgeRange\addToForm(), ilADTDateSearchBridgeSingle\addToForm(), ilADTDateTimeSearchBridgeRange\addToForm(), ilADTDateTimeSearchBridgeSingle\addToForm(), ilADTEnumSearchBridgeMulti\addToForm(), ilADTEnumSearchBridgeSingle\addToForm(), ilADTFloatSearchBridgeSingle\addToForm(), ilADTIntegerSearchBridgeSingle\addToForm(), ilADTLocationSearchBridgeSingle\addToForm(), and ilADTTextSearchBridgeSingle\addToForm().

Here is the caller graph for this function:

importFromPost()

ilADTSearchBridge::importFromPost ( array  $a_post = null )

abstract

Import values from (search) form request POST data.

Returns

bool

Reimplemented in ilADTDateSearchBridgeRange, ilADTDateSearchBridgeSingle, ilADTDateTimeSearchBridgeRange, ilADTDateTimeSearchBridgeSingle, ilADTEnumSearchBridgeMulti, ilADTEnumSearchBridgeSingle, ilADTFloatSearchBridgeSingle, ilADTIntegerSearchBridgeSingle, ilADTLocationSearchBridgeSingle, and ilADTTextSearchBridgeSingle.

isInCondition()

ilADTSearchBridge::isInCondition

(

ilADT

$a_adt

)

Compare directly against ADT.

Parameters

ilADT

$a_adt

Returns

boolean

Definition at line 321 of file class.ilADTSearchBridge.php.

        {
                return false;
        }       

isNull()

ilADTSearchBridge::isNull ( )

abstract

Is null ?

Returns

bool

Reimplemented in ilADTSearchBridgeRange, and ilADTSearchBridgeSingle.

isValidADTDefinition()

ilADTSearchBridge::isValidADTDefinition ( ilADTDefinition  $a_adt_def )

abstractprotected

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 in ilADTDateSearchBridgeRange, ilADTDateSearchBridgeSingle, ilADTDateTimeSearchBridgeRange, ilADTDateTimeSearchBridgeSingle, ilADTEnumSearchBridgeMulti, ilADTEnumSearchBridgeSingle, ilADTFloatSearchBridgeSingle, ilADTIntegerSearchBridgeSingle, ilADTLocationSearchBridgeSingle, and ilADTTextSearchBridgeSingle.

Referenced by ilADTSearchBridgeMulti\setDefinition(), ilADTSearchBridgeRange\setDefinition(), and ilADTSearchBridgeSingle\setDefinition().

Here is the caller graph for this function:

loadFilter()

ilADTSearchBridge::loadFilter ( )

abstract

Load filter value(s) into ADT.

Reimplemented in ilADTDateSearchBridgeRange, ilADTDateSearchBridgeSingle, ilADTDateTimeSearchBridgeRange, ilADTDateTimeSearchBridgeSingle, ilADTEnumSearchBridgeMulti, ilADTEnumSearchBridgeSingle, ilADTFloatSearchBridgeSingle, ilADTIntegerSearchBridgeSingle, ilADTLocationSearchBridgeSingle, and ilADTTextSearchBridgeSingle.

readFilter()

ilADTSearchBridge::readFilter ( )

protected

Load value(s) from filter store (in session)

Parameters

string

$a_element_id

Definition at line 173 of file class.ilADTSearchBridge.php.

        {
                if(!$this->table_gui instanceof ilTable2GUI)
                {
                        return;
                }
                $value = $_SESSION["form_".$this->table_gui->getId()][$this->getElementId()];
                if($value)
                {
                        return unserialize($value);
                }
        }

References $_SESSION, and getElementId().

Referenced by ilADTDateSearchBridgeRange\loadFilter(), ilADTDateSearchBridgeSingle\loadFilter(), ilADTDateTimeSearchBridgeRange\loadFilter(), ilADTDateTimeSearchBridgeSingle\loadFilter(), ilADTEnumSearchBridgeMulti\loadFilter(), ilADTEnumSearchBridgeSingle\loadFilter(), ilADTFloatSearchBridgeSingle\loadFilter(), ilADTIntegerSearchBridgeSingle\loadFilter(), ilADTLocationSearchBridgeSingle\loadFilter(), and ilADTTextSearchBridgeSingle\loadFilter().

Here is the call graph for this function:

Here is the caller graph for this function:

setDefinition()

ilADTSearchBridge::setDefinition ( ilADTDefinition  $a_adt_def )

abstractprotected

Set ADT definition.

Parameters

ilADTDefinition

$a_adt_def

Reimplemented in ilADTSearchBridgeMulti, ilADTSearchBridgeRange, and ilADTSearchBridgeSingle.

Referenced by __construct().

Here is the caller graph for this function:

setElementId()

ilADTSearchBridge::setElementId

(

$a_value

)

Set element id (aka form field)

Parameters

string

$a_value

Definition at line 87 of file class.ilADTSearchBridge.php.

        {
                $this->id = (string)$a_value;
        }

setForm()

ilADTSearchBridge::setForm

(

ilPropertyFormGUI

$a_form

)

Set form.

Parameters

ilPropertyFormGUI

$a_form

Definition at line 67 of file class.ilADTSearchBridge.php.

        {
                $this->form = $a_form;
        }

setSerializedValue()

ilADTSearchBridge::setSerializedValue (   $a_value )

abstract

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

Parameters

string

Reimplemented in ilADTDateSearchBridgeRange, ilADTDateSearchBridgeSingle, ilADTDateTimeSearchBridgeRange, ilADTDateTimeSearchBridgeSingle, ilADTEnumSearchBridgeMulti, ilADTEnumSearchBridgeSingle, ilADTFloatSearchBridgeSingle, ilADTIntegerSearchBridgeSingle, ilADTLocationSearchBridgeSingle, and ilADTTextSearchBridgeSingle.

Referenced by ilAdvancedMDFieldDefinition\setSearchValueSerialized().

Here is the caller graph for this function:

setTableGUI()

ilADTSearchBridge::setTableGUI

(

ilTable2GUI

$a_table

)

Set table gui (for filter mode)

Parameters

ilTable2GUI

$a_table

Definition at line 132 of file class.ilADTSearchBridge.php.

        {
                $this->table_gui = $a_table;
        }

setTitle()

ilADTSearchBridge::setTitle

(

$a_value

)

Set title (aka form field caption)

Parameters

string

$a_value

Definition at line 107 of file class.ilADTSearchBridge.php.

        {
                $this->title = trim($a_value);
        }

shouldBeImportedFromPost()

ilADTSearchBridge::shouldBeImportedFromPost (   $a_post )

protected

Check if incoming values should be imported at all.

Parameters

mixed

$a_post

Returns

bool

Reimplemented in ilADTLocationSearchBridgeSingle.

Definition at line 245 of file class.ilADTSearchBridge.php.

        {
                return true;
        }

Referenced by ilADTEnumSearchBridgeMulti\importFromPost(), ilADTEnumSearchBridgeSingle\importFromPost(), ilADTFloatSearchBridgeSingle\importFromPost(), ilADTIntegerSearchBridgeSingle\importFromPost(), and ilADTTextSearchBridgeSingle\importFromPost().

Here is the caller graph for this function:

validate()

ilADTSearchBridge::validate ( )

abstract

Validate current data.

Returns

bool

Reimplemented in ilADTSearchBridgeRange, and ilADTSearchBridgeSingle.

writeFilter()

ilADTSearchBridge::writeFilter (   $a_value = null )

protected

Write value(s) to filter store (in session)

Parameters

mixed

$a_value

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

        {
                if(!$this->table_gui instanceof ilTable2GUI)
                {
                        return;
                }
                if($a_value !== null)
                {
                        $_SESSION["form_".$this->table_gui->getId()][$this->getElementId()] = serialize($a_value);
                }
                else
                {
                        unset($_SESSION["form_".$this->table_gui->getId()][$this->getElementId()]);
                }
        }

References $_SESSION, and getElementId().

Referenced by ilADTDateSearchBridgeRange\importFromPost(), ilADTDateSearchBridgeSingle\importFromPost(), ilADTDateTimeSearchBridgeRange\importFromPost(), ilADTDateTimeSearchBridgeSingle\importFromPost(), ilADTEnumSearchBridgeMulti\importFromPost(), ilADTEnumSearchBridgeSingle\importFromPost(), and ilADTTextSearchBridgeSingle\importFromPost().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$form

ilADTSearchBridge::$form

protected

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

Referenced by getForm().

$id

ilADTSearchBridge::$id

protected

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

Referenced by getElementId().

$info

ilADTSearchBridge::$info

protected

Definition at line 20 of file class.ilADTSearchBridge.php.

$table_filter_fields

ilADTSearchBridge::$table_filter_fields

protected

Definition at line 17 of file class.ilADTSearchBridge.php.

$table_gui

ilADTSearchBridge::$table_gui

protected

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

Referenced by getTableGUI().

$title

ilADTSearchBridge::$title

protected

Definition at line 19 of file class.ilADTSearchBridge.php.

Referenced by getTitle().

---

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

• Services/ADT/classes/Bridges/class.ilADTSearchBridge.php