ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
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 (ilADT $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 49 of file class.ilADTEnumSearchBridgeMulti.php.

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

50  {
51  global $DIC;
52 
53  $lng = $DIC['lng'];
54 
55  $def = $this->getADT()->getCopyOfDefinition();
56 
57  $options = $def->getOptions();
58  asort($options); // ?
59 
60  $cbox = new ilCheckboxGroupInputGUI($this->getTitle(), $this->getElementId());
61  $cbox->setValue($this->getADT()->getSelections());
62 
63  foreach ($options as $value => $caption) {
64  $option = new ilCheckboxOption($caption, $value);
65  $cbox->addOption($option);
66  }
67 
68  $this->addToParentElement($cbox);
69  }
This class represents an option in a checkbox group.
global $DIC
Definition: saml.php:7
$lng
This class represents a property in a property form.
$def
Definition: croninfo.php:21
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 $def, ilADTFactory\getInstance(), and ilADTDefinition\getType().

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

◆ getSerializedValue()

ilADTEnumSearchBridgeMulti::getSerializedValue ( )

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

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

154  {
155  if (!$this->isNull() && $this->isValid()) {
156  return serialize($this->getADT()->getSelections());
157  }
158  }
+ Here is the call graph for this function:

◆ getSQLCondition()

ilADTEnumSearchBridgeMulti::getSQLCondition (   $a_element_id)

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

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

Referenced by ilAdvancedMDFieldDefinitionSelectMulti\findBySingleValue().

96  {
97  global $DIC;
98 
99  $ilDB = $DIC['ilDB'];
100 
101  if (!$this->isNull() && $this->isValid()) {
102  $type = ($this->getADT() instanceof ilADTMultiEnumText)
103  ? "text"
104  : "integer";
105 
106  if ($this->multi_source) {
107  include_once "Services/ADT/classes/Types/MultiEnum/class.ilADTMultiEnumDBBridge.php";
108 
109  // #16827 / #17087
110  $mode_concat = ($this->search_mode == self::SEARCH_MODE_ANY)
111  ? " OR "
112  : " AND ";
113 
114  $parts = array();
115  foreach ($this->getADT()->getSelections() as $item) {
116  $item = "%" . ilADTMultiEnumDBBridge::SEPARATOR .
117  $item .
119  $parts[] = $ilDB->like($a_element_id, "text", $item, false);
120  }
121  return "(" . implode($mode_concat, $parts) . ")";
122  }
123 
124  return $ilDB->in($a_element_id, $this->getADT()->getSelections(), "", $type);
125  }
126  }
$type
global $DIC
Definition: saml.php:7
if(!file_exists(getcwd() . '/ilias.ini.php'))
registration confirmation script for ilias
Definition: confirmReg.php:12
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 71 of file class.ilADTEnumSearchBridgeMulti.php.

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

72  {
73  $post = $this->extractPostValues($a_post);
74 
75  if ($post && $this->shouldBeImportedFromPost($post)) {
76  if ($this->getForm() instanceof ilPropertyFormGUI) {
77  $item = $this->getForm()->getItemByPostVar($this->getElementId());
78  $item->setValue($post);
79  } elseif (array_key_exists($this->getElementId(), $this->table_filter_fields)) {
80  $this->table_filter_fields[$this->getElementId()]->setValue($post);
81  $this->writeFilter($post);
82  }
83 
84  if (is_array($post)) {
85  $this->getADT()->setSelections($post);
86  }
87  } else {
88  $this->getADT()->setSelections();
89  }
90  }
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.
$post
Definition: post.php:34
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 ( ilADT  $a_adt)

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

References $current, and ilADTSearchBridgeSingle\getADT().

129  {
130  assert($a_adt instanceof ilADTMultiEnum);
131 
132  $current = $this->getADT()->getSelections();
133  if (is_array($current) &&
134  sizeof($current)) {
135  // #16827 / #17087
136  if ($this->search_mode == self::SEARCH_MODE_ANY) {
137  foreach ((array) $a_adt->getSelections() as $value) {
138  if (in_array($value, $current)) {
139  return true;
140  }
141  }
142  } else {
143  // #18028
144  return !(bool) sizeof(array_diff($current, (array) $a_adt->getSelections()));
145  }
146  }
147  return false;
148  }
+ 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 38 of file class.ilADTEnumSearchBridgeMulti.php.

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

39  {
40  $value = $this->readFilter();
41  if ($value !== null) {
42  $this->getADT()->setSelections($value);
43  }
44  }
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 160 of file class.ilADTEnumSearchBridgeMulti.php.

References ilADTSearchBridgeSingle\getADT().

161  {
162  $a_value = unserialize($a_value);
163  if (is_array($a_value)) {
164  $this->getADT()->setSelections($a_value);
165  }
166  }
+ 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: