ilADTEnumSearchBridgeSingle Class Reference

Inheritance diagram for ilADTEnumSearchBridgeSingle:

Collaboration diagram for ilADTEnumSearchBridgeSingle:

Public Member Functions
	loadFilter ()
	Load filter value(s) into ADT. More...
	getSearchColumn ()
	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)
	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...
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	ENUM_SEARCH_COLUMN = 'value_index'
Data Fields inherited from ilADTSearchBridge
const	DEFAULT_SEARCH_COLUMN = 'value'

Protected Member Functions
	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
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.ilADTEnumSearchBridgeSingle.php.

Member Function Documentation

addToForm()

ilADTEnumSearchBridgeSingle::addToForm

(

)

Add ADT-specific fields to form.

Reimplemented from ilADTSearchBridge.

Definition at line 32 of file class.ilADTEnumSearchBridgeSingle.php.

    {
        global $DIC;
 
        $lng = $DIC['lng'];
        
        $def = $this->getADT()->getCopyOfDefinition();
        
        $options = $def->getOptions();
        asort($options); // ?
        
        $lng->loadLanguageModule("search");
        $options = array("" => $lng->txt("search_any")) + $options;
        
        $select = new ilSelectInputGUI($this->getTitle(), $this->getElementId());
        $select->setOptions($options);
        
        $select->setValue($this->getADT()->getSelection());
        
        $this->addToParentElement($select);
    }

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

Here is the call graph for this function:

getSearchColumn()

ilADTEnumSearchBridgeSingle::getSearchColumn

(

)

Reimplemented from ilADTSearchBridge.

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

                                      : string
    {
        return self::ENUM_SEARCH_COLUMN;
    }

References ENUM_SEARCH_COLUMN.

Referenced by getSQLCondition().

Here is the caller graph for this function:

getSerializedValue()

ilADTEnumSearchBridgeSingle::getSerializedValue

(

)

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

Returns

string

Reimplemented from ilADTSearchBridge.

Definition at line 102 of file class.ilADTEnumSearchBridgeSingle.php.

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

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

Here is the call graph for this function:

getSQLCondition()

ilADTEnumSearchBridgeSingle::getSQLCondition

(

$a_element_id

)

Get SQL condition for current value(s)

Parameters

string

$a_element_id

Returns

string

Reimplemented from ilADTSearchBridge.

Definition at line 79 of file class.ilADTEnumSearchBridgeSingle.php.

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $search_column = $this->getSearchColumn();
        if (!$this->isNull() && $this->isValid()) {
            return $search_column . ' = ' . $ilDB->quote($this->getADT()->getSelection(), ilDBConstants::T_TEXT);
        }
        return '';
    }

References $DIC, $ilDB, ilADTSearchBridgeSingle\getADT(), getSearchColumn(), ilADTSearchBridgeSingle\isNull(), ilADTSearchBridgeSingle\isValid(), and ilDBConstants\T_TEXT.

Here is the call graph for this function:

importFromPost()

ilADTEnumSearchBridgeSingle::importFromPost

(

array

$a_post = null

)

Import values from (search) form request POST data.

Returns

bool

Reimplemented from ilADTSearchBridge.

Definition at line 54 of file class.ilADTEnumSearchBridgeSingle.php.

    {
        $post = $this->extractPostValues($a_post);
        if (
            is_numeric($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()->setSelection($post);
        } else {
            $this->writeFilter();
            $this->getADT()->setSelection();
        }
    }

References ilADTSearchBridge\extractPostValues(), ilADTSearchBridgeSingle\getADT(), ilADTSearchBridge\getElementId(), ilADTSearchBridge\getForm(), ilADTSearchBridge\shouldBeImportedFromPost(), and ilADTSearchBridge\writeFilter().

Here is the call graph for this function:

isInCondition()

ilADTEnumSearchBridgeSingle::isInCondition

(

ilADT

$a_adt

)

Compare directly against ADT.

Parameters

ilADT

$a_adt

Returns

bool

Reimplemented from ilADTSearchBridge.

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

    {
        assert($a_adt instanceof ilADTEnum);
        
        return $this->getADT()->equals($a_adt);
    }

References ilADTSearchBridgeSingle\getADT().

Here is the call graph for this function:

isValidADTDefinition()

ilADTEnumSearchBridgeSingle::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 ilADTSearchBridge.

Definition at line 9 of file class.ilADTEnumSearchBridgeSingle.php.

    {
        return ($a_adt_def instanceof ilADTEnumDefinition);
    }

loadFilter()

ilADTEnumSearchBridgeSingle::loadFilter

(

)

Load filter value(s) into ADT.

Reimplemented from ilADTSearchBridge.

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

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

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

Here is the call graph for this function:

setSerializedValue()

ilADTEnumSearchBridgeSingle::setSerializedValue

(

$a_value

)

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

Parameters

string

Reimplemented from ilADTSearchBridge.

Definition at line 109 of file class.ilADTEnumSearchBridgeSingle.php.

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

References ilADTSearchBridgeSingle\getADT().

Here is the call graph for this function:

Field Documentation

ENUM_SEARCH_COLUMN

const ilADTEnumSearchBridgeSingle::ENUM_SEARCH_COLUMN = 'value_index'

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

Referenced by getSearchColumn().

---

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

• Services/ADT/classes/Types/Enum/class.ilADTEnumSearchBridgeSingle.php