ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
ilADTTextSearchBridgeSingle Class Reference
+ Inheritance diagram for ilADTTextSearchBridgeSingle:
+ Collaboration diagram for ilADTTextSearchBridgeSingle:

Public Member Functions

 loadFilter ()
 
 addToForm ()
 
 importFromPost (array $a_post=null)
 
 getSQLCondition ($a_element_id, $a_mode=self::SQL_LIKE, $a_value=null)
 
 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 SQL_STRICT = 1
 
const SQL_LIKE = 2
 
const SQL_LIKE_END = 3
 
const SQL_LIKE_START = 4
 

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

Additional Inherited Members

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

Member Function Documentation

◆ addToForm()

ilADTTextSearchBridgeSingle::addToForm ( )

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

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

31  {
32  $text = new ilTextInputGUI($this->getTitle(), $this->getElementId());
33  $text->setSize(20);
34  $text->setMaxLength(512);
35  $text->setSubmitFormOnEnter(true);
36 
37  $text->setValue($this->getADT()->getText());
38 
39  $this->addToParentElement($text);
40  }
$text
Definition: errorreport.php:18
This class represents a text property in a property form.
getElementId()
Get element id.
addToParentElement(ilFormPropertyGUI $a_field)
Add form field to parent element.
+ Here is the call graph for this function:

◆ getSerializedValue()

ilADTTextSearchBridgeSingle::getSerializedValue ( )

Definition at line 126 of file class.ilADTTextSearchBridgeSingle.php.

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

127  {
128  if (!$this->isNull() && $this->isValid()) {
129  return serialize(array($this->getADT()->getText()));
130  }
131  }
Create styles array
The data for the language used.
+ Here is the call graph for this function:

◆ getSQLCondition()

ilADTTextSearchBridgeSingle::getSQLCondition (   $a_element_id,
  $a_mode = self::SQL_LIKE,
  $a_value = null 
)

Definition at line 65 of file class.ilADTTextSearchBridgeSingle.php.

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

66  {
67  global $ilDB;
68 
69  if (!$a_value) {
70  if ($this->isNull() || !$this->isValid()) {
71  return;
72  }
73  $a_value = $this->getADT()->getText();
74  }
75 
76  switch ($a_mode) {
77  case self::SQL_STRICT:
78  if (!is_array($a_value)) {
79  return $a_element_id . " = " . $ilDB->quote($a_value, "text");
80  } else {
81  return $ilDB->in($a_element_id, $a_value, "", "text");
82  }
83  break;
84 
85  case self::SQL_LIKE:
86  if (!is_array($a_value)) {
87  return $ilDB->like($a_element_id, "text", "%" . $a_value . "%");
88  } else {
89  $tmp = array();
90  foreach ($a_value as $word) {
91  if ($word) {
92  $tmp[] = $ilDB->like($a_element_id, "text", "%" . $word . "%");
93  }
94  }
95  if (sizeof($tmp)) {
96  return "(" . implode(" OR ", $tmp) . ")";
97  }
98  }
99  break;
100 
101  case self::SQL_LIKE_END:
102  if (!is_array($a_value)) {
103  return $ilDB->like($a_element_id, "text", $a_value . "%");
104  }
105  break;
106 
107  case self::SQL_LIKE_START:
108  if (!is_array($a_value)) {
109  return $ilDB->like($a_element_id, "text", "%" . $a_value);
110  }
111  break;
112  }
113  }
Create styles array
The data for the language used.
global $ilDB
+ Here is the call graph for this function:

◆ importFromPost()

ilADTTextSearchBridgeSingle::importFromPost ( array  $a_post = null)

Definition at line 42 of file class.ilADTTextSearchBridgeSingle.php.

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

43  {
44  $post = $this->extractPostValues($a_post);
45 
46  if ($post && $this->shouldBeImportedFromPost($post)) {
47  if ($this->getForm() instanceof ilPropertyFormGUI) {
48  $item = $this->getForm()->getItemByPostVar($this->getElementId());
49  $item->setValue($post);
50  } elseif (array_key_exists($this->getElementId(), $this->table_filter_fields)) {
51  $this->table_filter_fields[$this->getElementId()]->setValue($post);
52  $this->writeFilter($post);
53  }
54 
55  $this->getADT()->setText($post);
56  } else {
57  $this->writeFilter();
58  $this->getADT()->setText();
59  }
60  }
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()

ilADTTextSearchBridgeSingle::isInCondition ( ilADT  $a_adt)

Definition at line 115 of file class.ilADTTextSearchBridgeSingle.php.

References ilADTSearchBridgeSingle\getADT().

116  {
117  assert($a_adt instanceof ilADTText);
118 
119  // :TODO: search mode (see above)
120  return $this->getADT()->equals($a_adt);
121  }
+ Here is the call graph for this function:

◆ isValidADTDefinition()

ilADTTextSearchBridgeSingle::isValidADTDefinition ( ilADTDefinition  $a_adt_def)
protected

Definition at line 12 of file class.ilADTTextSearchBridgeSingle.php.

13  {
14  return ($a_adt_def instanceof ilADTTextDefinition);
15  }

◆ loadFilter()

ilADTTextSearchBridgeSingle::loadFilter ( )

Definition at line 19 of file class.ilADTTextSearchBridgeSingle.php.

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

20  {
21  $value = $this->readFilter();
22  if ($value !== null) {
23  $this->getADT()->setText($value);
24  }
25  }
readFilter()
Load value(s) from filter store (in session)
+ Here is the call graph for this function:

◆ setSerializedValue()

ilADTTextSearchBridgeSingle::setSerializedValue (   $a_value)

Definition at line 133 of file class.ilADTTextSearchBridgeSingle.php.

References ilADTSearchBridgeSingle\getADT().

134  {
135  $a_value = unserialize($a_value);
136  if (is_array($a_value)) {
137  $this->getADT()->setText($a_value[0]);
138  }
139  }
+ Here is the call graph for this function:

Field Documentation

◆ SQL_LIKE

const ilADTTextSearchBridgeSingle::SQL_LIKE = 2

◆ SQL_LIKE_END

const ilADTTextSearchBridgeSingle::SQL_LIKE_END = 3

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

◆ SQL_LIKE_START

const ilADTTextSearchBridgeSingle::SQL_LIKE_START = 4

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

◆ SQL_STRICT

const ilADTTextSearchBridgeSingle::SQL_STRICT = 1

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


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