ILIAS  release_8 Revision v8.24
Public Member Functions | Data Fields | Protected Member Functions
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)
 
 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...
 
- Public Member Functions inherited from ilADTSearchBridgeSingle
 getADT ()
 Get ADT. More...
 
 isNull ()
 
 isValid ()
 
 validate ()
 Validate current data. More...
 
- 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...
 
 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'
 
- 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)
 
- 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...
 

Additional Inherited Members

- 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

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 31 of file class.ilADTEnumSearchBridgeSingle.php.

31 : void
32 {
33 $def = $this->getADT()->getCopyOfDefinition();
34
35 $options = $def->getOptions();
36 asort($options); // ?
37
38 $this->lng->loadLanguageModule("search");
39 $options = array("" => $this->lng->txt("search_any")) + $options;
40
41 $select = new ilSelectInputGUI($this->getTitle(), $this->getElementId());
42 $select->setOptions($options);
43
44 $select->setValue($this->getADT()->getSelection());
45
46 $this->addToParentElement($select);
47 }
ilADTSearchBridge\addToParentElement
addToParentElement(ilFormPropertyGUI $a_field)
Add form field to parent element.
Definition: class.ilADTSearchBridge.php:167
ilSelectInputGUI
This class represents a selection list property in a property form.
Definition: class.ilSelectInputGUI.php:27

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

+ Here is the call graph for this function:

◆ getSearchColumn()

ilADTEnumSearchBridgeSingle::getSearchColumn ( )

Reimplemented from ilADTSearchBridge.

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

24 : string
25 {
26 return self::ENUM_SEARCH_COLUMN;
27 }

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)

Reimplemented from ilADTSearchBridge.

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

92 : string
93 {
94 if (!$this->isNull() && $this->isValid()) {
95 return serialize(array($this->getADT()->getSelection()));
96 }
97 return '';
98 }

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

+ Here is the call graph for this function:

◆ getSQLCondition()

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

Get SQL condition for current value(s)

Reimplemented from ilADTSearchBridge.

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

74 : string
75 {
76 $search_column = $this->getSearchColumn();
77 if (!$this->isNull() && $this->isValid()) {
78 return $search_column . ' = ' . $this->db->quote($this->getADT()->getSelection(), ilDBConstants::T_TEXT);
79 }
80 return '';
81 }

References 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)
Todo:
make post required

Reimplemented from ilADTSearchBridge.

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

49 : bool
50 {
51 $post = $this->extractPostValues($a_post);
52 if (
53 is_numeric($post) &&
54 $this->shouldBeImportedFromPost($post)
55 ) {
56 if ($this->getForm() instanceof ilPropertyFormGUI) {
57 $item = $this->getForm()->getItemByPostVar($this->getElementId());
58 $item->setValue($post);
59 } elseif (array_key_exists($this->getElementId(), $this->table_filter_fields)) {
60 $this->table_filter_fields[$this->getElementId()]->setValue($post);
61 $this->writeFilter($post);
62 }
63
64 $this->getADT()->setSelection($post);
65 } else {
66 $this->writeFilter();
67 $this->getADT()->setSelection();
68 }
69 return true;
70 }
ilADTSearchBridge\extractPostValues
extractPostValues(array $a_post=null)
Extract data from (post) values.
Definition: class.ilADTSearchBridge.php:210
ilADTSearchBridge\shouldBeImportedFromPost
shouldBeImportedFromPost($a_post)
Check if incoming values should be imported at all.
Definition: class.ilADTSearchBridge.php:200
ilADTSearchBridge\writeFilter
writeFilter($a_value=null)
Write value(s) to filter store (in session)
Definition: class.ilADTSearchBridge.php:115
ilPropertyFormGUI
This class represents a property form user interface.
Definition: class.ilPropertyFormGUI.php:31
$post
$post
Definition: ltitoken.php:49

References $post, 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.

Reimplemented from ilADTSearchBridge.

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

83 : bool
84 {
85 assert($a_adt instanceof ilADTEnum);
86
87 return $this->getADT()->equals($a_adt);
88 }

References ilADTSearchBridgeSingle\getADT().

+ Here is the call graph for this function:

◆ isValidADTDefinition()

ilADTEnumSearchBridgeSingle::isValidADTDefinition ( ilADTDefinition  $a_adt_def)
protected

Reimplemented from ilADTSearchBridge.

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

9 : bool
10 {
11 return ($a_adt_def instanceof ilADTEnumDefinition);
12 }

◆ loadFilter()

ilADTEnumSearchBridgeSingle::loadFilter ( )

Load filter value(s) into ADT.

Reimplemented from ilADTSearchBridge.

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

16 : void
17 {
18 $value = $this->readFilter();
19 if ($value !== null) {
20 $this->getADT()->setSelection($value);
21 }
22 }
ilADTSearchBridge\readFilter
readFilter()
Load value(s) from filter store (in session)
Definition: class.ilADTSearchBridge.php:140

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

+ Here is the call graph for this function:

◆ setSerializedValue()

ilADTEnumSearchBridgeSingle::setSerializedValue ( string  $a_value)

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

Reimplemented from ilADTSearchBridge.

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

100 : void
101 {
102 $a_value = unserialize($a_value);
103 if (is_array($a_value) && !empty($a_value)) {
104 $this->getADT()->setSelection($a_value[0]);
105 }
106 }

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: