Inheritance diagram for ilADTEnumSearchBridgeMulti:

Collaboration diagram for ilADTEnumSearchBridgeMulti:

Public Member Functions
	setSearchMode ($a_mode)

	getSearchColumn ()

	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)
	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'

const	SEARCH_MODE_ALL = 1

const	SEARCH_MODE_ANY = 2

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

	convertADTDefinitionToMulti (ilADTDefinition $a_adt_def)
	Convert definition to multi version. More...

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

	convertADTDefinitionToMulti (ilADTDefinition $a_adt_def)
	Convert definition to multi version. More...

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

Protected Attributes
	$multi_source

	$search_mode

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

Member Function Documentation

◆ addToForm()

ilADTEnumSearchBridgeMulti::addToForm ( )

Add ADT-specific fields to form.

Reimplemented from ilADTSearchBridge.

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

    {
        global $DIC;
 
        $lng = $DIC['lng'];
        
        $def = $this->getADT()->getCopyOfDefinition();
        
        $options = $def->getOptions();
        asort($options); // ?
        
        $cbox = new ilCheckboxGroupInputGUI($this->getTitle(), $this->getElementId());
        $cbox->setValue($this->getADT()->getSelections());
 
        foreach ($options as $value => $caption) {
            $option = new ilCheckboxOption($caption, $value);
            $cbox->addOption($option);
        }
        
        $this->addToParentElement($cbox);
    }

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

Here is the call graph for this function:

◆ convertADTDefinitionToMulti()

ilADTEnumSearchBridgeMulti::convertADTDefinitionToMulti ( ilADTDefinition $a_adt_def )

protected

Convert definition to multi version.

Returns: ilADTDefinition

Reimplemented from ilADTSearchBridgeMulti.

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

    {
        if ($a_adt_def->getType() == "Enum") {
            $this->multi_source = false;
            $def = ilADTFactory::getInstance()->getDefinitionInstanceByType("MultiEnum");
            $def->setNumeric($a_adt_def->isNumeric());
            $def->setOptions($a_adt_def->getOptions());
            return $def;
        } else {
            $this->multi_source = true;
            return $a_adt_def;
        }
    }

References ilADTFactory\getInstance(), and ilADTDefinition\getType().

Here is the call graph for this function:

◆ getSearchColumn()

ilADTEnumSearchBridgeMulti::getSearchColumn ( )

Reimplemented from ilADTSearchBridge.

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

                                      : string
    {
        return self::ENUM_SEARCH_COLUMN;
    }

References ENUM_SEARCH_COLUMN.

Referenced by getSQLCondition().

Here is the caller graph for this function:

◆ getSerializedValue()

ilADTEnumSearchBridgeMulti::getSerializedValue ( )

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

Returns: string

Reimplemented from ilADTSearchBridge.

Definition at line 144 of file class.ilADTEnumSearchBridgeMulti.php.

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

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

Here is the call graph for this function:

◆ getSQLCondition()

ilADTEnumSearchBridgeMulti::getSQLCondition ( $a_element_id )

Get SQL condition for current value(s)

Parameters

string $a_element_id

Returns: string

Reimplemented from ilADTSearchBridge.

Definition at line 103 of file class.ilADTEnumSearchBridgeMulti.php.

    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        if (!$this->isNull() && $this->isValid()) {
            return $ilDB->in(
                $this->getSearchColumn(),
                $this->getADT()->getSelections(),
                '',
                ilDBConstants::T_INTEGER
            );
        }
    }

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

Referenced by ilAdvancedMDFieldDefinitionSelect\findBySingleValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ importFromPost()

ilADTEnumSearchBridgeMulti::importFromPost ( array $a_post = null )

Import values from (search) form request POST data.

Returns: bool

Reimplemented from ilADTSearchBridge.

Definition at line 79 of file class.ilADTEnumSearchBridgeMulti.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);
            }
            
            if (is_array($post)) {
                $this->getADT()->setSelections($post);
            }
        } else {
            $this->getADT()->setSelections();
        }
    }

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

Here is the call graph for this function:

◆ isInCondition()

ilADTEnumSearchBridgeMulti::isInCondition ( ilADT $a_adt )

Compare directly against ADT.

Parameters

ilADT $a_adt

Returns: bool

Reimplemented from ilADTSearchBridge.

Definition at line 119 of file class.ilADTEnumSearchBridgeMulti.php.

    {
        assert($a_adt instanceof ilADTMultiEnum);
        
        $current = $this->getADT()->getSelections();
        if (is_array($current) &&
            sizeof($current)) {
            // #16827 / #17087
            if ($this->search_mode == self::SEARCH_MODE_ANY) {
                foreach ((array) $a_adt->getSelections() as $value) {
                    if (in_array($value, $current)) {
                        return true;
                    }
                }
            } else {
                // #18028
                return !(bool) sizeof(array_diff($current, (array) $a_adt->getSelections()));
            }
        }
        return false;
    }

References ilADTSearchBridgeSingle\getADT().

Here is the call graph for this function:

◆ isValidADTDefinition()

ilADTEnumSearchBridgeMulti::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 26 of file class.ilADTEnumSearchBridgeMulti.php.

    {
        return ($a_adt_def instanceof ilADTEnumDefinition ||
            $a_adt_def instanceof ilADTMultiEnumDefinition);
    }

◆ loadFilter()

ilADTEnumSearchBridgeMulti::loadFilter ( )

Load filter value(s) into ADT.

Reimplemented from ilADTSearchBridge.

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

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

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

Here is the call graph for this function:

◆ setSearchMode()

ilADTEnumSearchBridgeMulti::setSearchMode ( $a_mode )

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

    {
        $this->search_mode = (int) $a_mode;
    }

◆ setSerializedValue()

ilADTEnumSearchBridgeMulti::setSerializedValue ( $a_value )

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

Parameters

string

Reimplemented from ilADTSearchBridge.

Definition at line 151 of file class.ilADTEnumSearchBridgeMulti.php.

    {
        $a_value = unserialize($a_value);
        if (is_array($a_value)) {
            $this->getADT()->setSelections($a_value);
        }
    }