ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilADTEnumSearchBridgeMulti Class Reference
+ Inheritance diagram for ilADTEnumSearchBridgeMulti:
+ Collaboration diagram for ilADTEnumSearchBridgeMulti:

Public Member Functions

 setSearchMode ($a_mode)
 
 loadFilter ()
 
 addToForm ()
 
 importFromPost (array $a_post=null)
 
 getSQLCondition ($a_element_id)
 
 isInCondition (ilADTMultiEnum $a_adt)
 
 getSerializedValue ()
 
 setSerializedValue ($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)
 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...
 

Data Fields

const SEARCH_MODE_ALL = 1
 
const SEARCH_MODE_ANY = 2
 

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)
 Convert definition to multi version. More...
 
- Protected Member Functions inherited from ilADTSearchBridgeSingle
 setDefinition (ilADTDefinition $a_adt_def)
 
- 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 ( )

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

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

54  {
55  global $lng;
56 
57  $def = $this->getADT()->getCopyOfDefinition();
58 
59  $options = $def->getOptions();
60  asort($options); // ?
61 
62  $cbox = new ilCheckboxGroupInputGUI($this->getTitle(), $this->getElementId());
63  $cbox->setValue($this->getADT()->getSelections());
64 
65  foreach($options as $value => $caption)
66  {
67  $option = new ilCheckboxOption($caption, $value);
68  $cbox->addOption($option);
69  }
70 
71  $this->addToParentElement($cbox);
72  }
This class represents an option in a checkbox group.
if(!is_array($argv)) $options
This class represents a property in a property form.
global $lng
Definition: privfeed.php:40
getElementId()
Get element id.
addToParentElement(ilFormPropertyGUI $a_field)
Add form field to parent element.
+ Here is the call graph for this function:

◆ convertADTDefinitionToMulti()

ilADTEnumSearchBridgeMulti::convertADTDefinitionToMulti ( ilADTDefinition  $a_adt_def)
protected

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

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

25  {
26  if($a_adt_def->getType() == "Enum")
27  {
28  $this->multi_source = false;
29  $def = ilADTFactory::getInstance()->getDefinitionInstanceByType("MultiEnum");
30  $def->setNumeric($a_adt_def->isNumeric());
31  $def->setOptions($a_adt_def->getOptions());
32  return $def;
33  }
34  else
35  {
36  $this->multi_source = true;
37  return $a_adt_def;
38  }
39  }
static getInstance()
Get singleton.
getType()
Get type (from class/instance)
+ Here is the call graph for this function:

◆ getSerializedValue()

ilADTEnumSearchBridgeMulti::getSerializedValue ( )

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

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

169  {
170  if(!$this->isNull() && $this->isValid())
171  {
172  return serialize($this->getADT()->getSelections());
173  }
174  }
+ Here is the call graph for this function:

◆ getSQLCondition()

ilADTEnumSearchBridgeMulti::getSQLCondition (   $a_element_id)

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

References $ilDB, ilADTSearchBridgeSingle\getADT(), ilADTSearchBridgeSingle\isNull(), ilADTSearchBridgeSingle\isValid(), and ilADTMultiEnumDBBridge\SEPARATOR.

Referenced by ilAdvancedMDFieldDefinitionSelectMulti\findBySingleValue().

106  {
107  global $ilDB;
108 
109  if(!$this->isNull() && $this->isValid())
110  {
111  $type = ($this->getADT() instanceof ilADTMultiEnumText)
112  ? "text"
113  : "integer";
114 
115  if($this->multi_source)
116  {
117  include_once "Services/ADT/classes/Types/MultiEnum/class.ilADTMultiEnumDBBridge.php";
118 
119  // #16827 / #17087
120  $mode_concat = ($this->search_mode == self::SEARCH_MODE_ANY)
121  ? " OR "
122  : " AND ";
123 
124  $parts = array();
125  foreach($this->getADT()->getSelections() as $item)
126  {
127  $item = "%".ilADTMultiEnumDBBridge::SEPARATOR.
128  $item.
130  $parts[] = $ilDB->like($a_element_id, "text", $item, false);
131  }
132  return "(".implode($mode_concat, $parts).")";
133  }
134 
135  return $ilDB->in($a_element_id, $this->getADT()->getSelections(), "", $type);
136  }
137  }
if(!file_exists(getcwd().'/ilias.ini.php')) if(isset( $_GET["client_id"]))
registration confirmation script for ilias
Definition: confirmReg.php:20
global $ilDB
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ importFromPost()

ilADTEnumSearchBridgeMulti::importFromPost ( array  $a_post = null)

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

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

75  {
76  $post = $this->extractPostValues($a_post);
77 
78  if($post && $this->shouldBeImportedFromPost($post))
79  {
80  if($this->getForm() instanceof ilPropertyFormGUI)
81  {
82  $item = $this->getForm()->getItemByPostVar($this->getElementId());
83  $item->setValue($post);
84  }
85  else if(array_key_exists($this->getElementId(), $this->table_filter_fields))
86  {
87  $this->table_filter_fields[$this->getElementId()]->setValue($post);
88  $this->writeFilter($post);
89  }
90 
91  if(is_array($post))
92  {
93  $this->getADT()->setSelections($post);
94  }
95  }
96  else
97  {
98  $this->getADT()->setSelections();
99  }
100  }
This class represents a property form user interface.
extractPostValues(array $a_post=null)
Extract data from (post) values.
shouldBeImportedFromPost($a_post)
Check if incoming values should be imported at all.
writeFilter($a_value=null)
Write value(s) to filter store (in session)
getElementId()
Get element id.
+ Here is the call graph for this function:

◆ isInCondition()

ilADTEnumSearchBridgeMulti::isInCondition ( ilADTMultiEnum  $a_adt)

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

References ilADTSearchBridgeSingle\getADT(), and ilADTMultiEnum\getSelections().

140  {
141  $current = $this->getADT()->getSelections();
142  if(is_array($current) &&
143  sizeof($current))
144  {
145  // #16827 / #17087
146  if($this->search_mode == self::SEARCH_MODE_ANY)
147  {
148  foreach((array)$a_adt->getSelections() as $value)
149  {
150  if(in_array($value, $current))
151  {
152  return true;
153  }
154  }
155  }
156  else
157  {
158  // #18028
159  return !(bool)sizeof(array_diff($current, (array)$a_adt->getSelections()));
160  }
161  }
162  return false;
163  }
+ Here is the call graph for this function:

◆ isValidADTDefinition()

ilADTEnumSearchBridgeMulti::isValidADTDefinition ( ilADTDefinition  $a_adt_def)
protected

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

19  {
20  return ($a_adt_def instanceof ilADTEnumDefinition ||
21  $a_adt_def instanceof ilADTMultiEnumDefinition);
22  }

◆ loadFilter()

ilADTEnumSearchBridgeMulti::loadFilter ( )

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

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

42  {
43  $value = $this->readFilter();
44  if($value !== null)
45  {
46  $this->getADT()->setSelections($value);
47  }
48  }
readFilter()
Load value(s) from filter store (in session)
+ Here is the call graph for this function:

◆ setSearchMode()

ilADTEnumSearchBridgeMulti::setSearchMode (   $a_mode)

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

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

◆ setSerializedValue()

ilADTEnumSearchBridgeMulti::setSerializedValue (   $a_value)

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

References ilADTSearchBridgeSingle\getADT().

177  {
178  $a_value = unserialize($a_value);
179  if(is_array($a_value))
180  {
181  $this->getADT()->setSelections($a_value);
182  }
183  }
+ Here is the call graph for this function:

Field Documentation

◆ $multi_source

ilADTEnumSearchBridgeMulti::$multi_source
protected

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

◆ $search_mode

ilADTEnumSearchBridgeMulti::$search_mode
protected

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

◆ SEARCH_MODE_ALL

const ilADTEnumSearchBridgeMulti::SEARCH_MODE_ALL = 1

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

◆ SEARCH_MODE_ANY

const ilADTEnumSearchBridgeMulti::SEARCH_MODE_ANY = 2

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


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