Class ilADTEnumSearchBridgeMulti. More...

Inheritance diagram for ilADTEnumSearchBridgeMulti:

Collaboration diagram for ilADTEnumSearchBridgeMulti:

Public Member Functions
	setSearchMode (int $a_mode)

	getSearchColumn ()

	loadFilter ()

	addToForm ()

	importFromPost (?array $a_post=null)

	getSQLCondition (string $a_element_id, int $mode=self::SQL_LIKE, array $quotedWords=[])

	isInCondition (ilADT $a_adt)

	getSerializedValue ()

	setSerializedValue (string $a_value)

Public Member Functions inherited from ilADTSearchBridgeSingle
	getADT ()
	Get ADT. More...

	isNull ()

	isValid ()

	validate ()

Public Member Functions inherited from ilADTSearchBridge
	__construct (ilADTDefinition $a_adt_def)

	isNull ()

	setForm (ilPropertyFormGUI $a_form)

	getForm ()

	setElementId (string $a_value)

	getElementId ()

	setTitle (string $a_value)

	getTitle ()

	getSearchColumn ()

	setTableGUI (ilTable2GUI $a_table)

	getTableGUI ()
	Get table gui. More...

	loadFilter ()
	Load filter value(s) into ADT. More...

	addToForm ()
	Add ADT-specific fields to form. More...

	addToFilterForm ()
	Add ADT-specific fields to filter. More...

	importFromPost (?array $a_post=null)

	validate ()
	Validate current data. More...

	getSQLCondition (string $a_element_id, int $mode=self::SQL_LIKE, array $quotedWords=[])
	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 (string $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	SQL_STRICT = 1

const	SQL_LIKE = 2

const	SQL_LIKE_END = 3

const	SQL_LIKE_START = 4

const	DEFAULT_SEARCH_COLUMN = 'value'

Protected Member Functions
	isValidADTDefinition (ilADTDefinition $a_adt_def)

	convertADTDefinitionToMulti (ilADTDefinition $a_adt_def)

Protected Member Functions inherited from ilADTSearchBridgeMulti
	setDefinition (ilADTDefinition $a_adt_def)

	convertADTDefinitionToMulti (ilADTDefinition $a_adt_def)

Protected Member Functions inherited from ilADTSearchBridgeSingle
	setDefinition (ilADTDefinition $a_adt_def)

Protected Member Functions inherited from ilADTSearchBridge
	isValidADTDefinition (ilADTDefinition $a_adt_def)

	setDefinition (ilADTDefinition $a_adt_def)

	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 (string $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
bool	$multi_source

int	$search_mode = self::SEARCH_MODE_ALL

Protected Attributes inherited from ilADTSearchBridgeSingle
ilADT	$adt

Protected Attributes inherited from ilADTSearchBridge
ilPropertyFormGUI	$form = null

ilTable2GUI	$table_gui = null

array	$table_filter_fields = []

string	$id = ''

string	$title = ''

string	$info = ''

ilLanguage	$lng

ilDBInterface	$db

HttpServices	$http

Detailed Description

Class ilADTEnumSearchBridgeMulti.

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

Member Function Documentation

◆ addToForm()

ilADTEnumSearchBridgeMulti::addToForm ( )

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

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

                                : void
     {
         $def = $this->getADT()->getCopyOfDefinition();
 
         $options = $def->getOptions();
 
         $cbox = new ilCheckboxGroupInputGUI($this->getTitle(), $this->getElementId());
         $cbox->setValue($this->getADT()->getSelections());
 
         foreach ($options as $value => $caption) {
             $option = new ilCheckboxOption($caption, (string) $value);
             $cbox->addOption($option);
         }
 
         $this->addToParentElement($cbox);
     }

Here is the call graph for this function:

◆ convertADTDefinitionToMulti()

ilADTEnumSearchBridgeMulti::convertADTDefinitionToMulti ( ilADTDefinition $a_adt_def )

protected

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

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

                                                                               : ilADTDefinition
     {
         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;
         }
     }

Here is the call graph for this function:

◆ getSearchColumn()

ilADTEnumSearchBridgeMulti::getSearchColumn ( )

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

Referenced by getSQLCondition().

                                      : string
     {
         return self::ENUM_SEARCH_COLUMN;
     }

Here is the caller graph for this function:

◆ getSerializedValue()

ilADTEnumSearchBridgeMulti::getSerializedValue ( )

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

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

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

Here is the call graph for this function:

◆ getSQLCondition()

ilADTEnumSearchBridgeMulti::getSQLCondition	(	string	$a_element_id,
		int	$mode = `self::SQL_LIKE`,
		array	$quotedWords = `[]`
	)

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

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

                                                                                                             : string
     {
         if (!$this->isNull() && $this->isValid()) {
             return $this->db->in(
                 $this->getSearchColumn(),
                 (array) $this->getADT()->getSelections(),
                 false,
                 ilDBConstants::T_INTEGER
             );
         }
         return '';
     }

Here is the call graph for this function:

◆ importFromPost()

ilADTEnumSearchBridgeMulti::importFromPost ( ?array $a_post = null )

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

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

                                                          : bool
     {
         $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();
             // BT 35593: multi enum filter should reset when nothing is selected
             if (array_key_exists($this->getElementId(), $this->table_filter_fields)) {
                 $this->writeFilter();
             }
         }
         return true;
     }

Here is the call graph for this function:

◆ isInCondition()

ilADTEnumSearchBridgeMulti::isInCondition ( ilADT $a_adt )

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

References ilADTSearchBridgeSingle\getADT().

                                                : bool
     {
         assert($a_adt instanceof ilADTMultiEnum);
 
         $current = $this->getADT()->getSelections();
         if (is_array($current) &&
             count($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 !count(array_diff($current, (array) $a_adt->getSelections()));
             }
         }
         return false;
     }

Here is the call graph for this function:

◆ isValidADTDefinition()

ilADTEnumSearchBridgeMulti::isValidADTDefinition ( ilADTDefinition $a_adt_def )

protected

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

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

◆ loadFilter()

ilADTEnumSearchBridgeMulti::loadFilter ( )

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

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

                                 : void
     {
         $value = $this->readFilter();
         if ($value !== null) {
             if (is_string($value)) {
                 $value = [$value];
             }
             $this->getADT()->setSelections($value);
         }
     }

Here is the call graph for this function:

◆ setSearchMode()

ilADTEnumSearchBridgeMulti::setSearchMode ( int $a_mode )

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

                                               : void
     {
         $this->search_mode = $a_mode;
     }

◆ setSerializedValue()

ilADTEnumSearchBridgeMulti::setSerializedValue ( string $a_value )

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

References ilADTSearchBridgeSingle\getADT().

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

Here is the call graph for this function:

Field Documentation

◆ $multi_source

bool ilADTEnumSearchBridgeMulti::$multi_source

protected

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

◆ $search_mode

int ilADTEnumSearchBridgeMulti::$search_mode = self::SEARCH_MODE_ALL

protected

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

◆ ENUM_SEARCH_COLUMN

const ilADTEnumSearchBridgeMulti::ENUM_SEARCH_COLUMN = 'value_index'

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

◆ SEARCH_MODE_ALL

const ilADTEnumSearchBridgeMulti::SEARCH_MODE_ALL = 1

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

◆ SEARCH_MODE_ANY

const ilADTEnumSearchBridgeMulti::SEARCH_MODE_ANY = 2

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

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

components/ILIAS/ADT/classes/Types/Enum/class.ilADTEnumSearchBridgeMulti.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ addToForm()

◆ convertADTDefinitionToMulti()

◆ getSearchColumn()

◆ getSerializedValue()

◆ getSQLCondition()

◆ importFromPost()

◆ isInCondition()

◆ isValidADTDefinition()

◆ loadFilter()

◆ setSearchMode()

◆ setSerializedValue()

Field Documentation

◆ $multi_source

◆ $search_mode

◆ ENUM_SEARCH_COLUMN

◆ SEARCH_MODE_ALL

◆ SEARCH_MODE_ANY