ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
Public Member Functions | Data Fields | Protected Member Functions
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 31 of file class.ilADTTextSearchBridgeSingle.php.

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

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

◆ getSerializedValue()

ilADTTextSearchBridgeSingle::getSerializedValue ( )

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

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

148  {
149  if(!$this->isNull() && $this->isValid())
150  {
151  return serialize(array($this->getADT()->getText()));
152  }
153  }
array
Create styles array
The data for the language used.
Definition: 40duplicateStyle.php:19
+ 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 72 of file class.ilADTTextSearchBridgeSingle.php.

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

73  {
74  global $ilDB;
75 
76  if(!$a_value)
77  {
78  if($this->isNull() || !$this->isValid())
79  {
80  return;
81  }
82  $a_value = $this->getADT()->getText();
83  }
84 
85  switch($a_mode)
86  {
87  case self::SQL_STRICT:
88  if(!is_array($a_value))
89  {
90  return $a_element_id." = ".$ilDB->quote($a_value, "text");
91  }
92  else
93  {
94  return $ilDB->in($a_element_id, $a_value, "", "text");
95  }
96  break;
97 
98  case self::SQL_LIKE:
99  if(!is_array($a_value))
100  {
101  return $ilDB->like($a_element_id, "text", "%".$a_value."%");
102  }
103  else
104  {
105  $tmp = array();
106  foreach($a_value as $word)
107  {
108  if($word)
109  {
110  $tmp[] = $ilDB->like($a_element_id, "text", "%".$word."%");
111  }
112  }
113  if(sizeof($tmp))
114  {
115  return "(".implode(" OR ", $tmp).")";
116  }
117  }
118  break;
119 
120  case self::SQL_LIKE_END:
121  if(!is_array($a_value))
122  {
123  return $ilDB->like($a_element_id, "text", $a_value."%");
124  }
125  break;
126 
127  case self::SQL_LIKE_START:
128  if(!is_array($a_value))
129  {
130  return $ilDB->like($a_element_id, "text", "%".$a_value);
131  }
132  break;
133  }
134  }
array
Create styles array
The data for the language used.
Definition: 40duplicateStyle.php:19
$ilDB
global $ilDB
Definition: storeScorm2004.php:16
+ Here is the call graph for this function:

◆ importFromPost()

ilADTTextSearchBridgeSingle::importFromPost ( array  $a_post = null)

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

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

44  {
45  $post = $this->extractPostValues($a_post);
46 
47  if($post && $this->shouldBeImportedFromPost($post))
48  {
49  if($this->getForm() instanceof ilPropertyFormGUI)
50  {
51  $item = $this->getForm()->getItemByPostVar($this->getElementId());
52  $item->setValue($post);
53  }
54  else if(array_key_exists($this->getElementId(), $this->table_filter_fields))
55  {
56  $this->table_filter_fields[$this->getElementId()]->setValue($post);
57  $this->writeFilter($post);
58  }
59 
60  $this->getADT()->setText($post);
61  }
62  else
63  {
64  $this->writeFilter();
65  $this->getADT()->setText();
66  }
67  }
ilPropertyFormGUI
This class represents a property form user interface.
Definition: class.ilPropertyFormGUI.php:47
ilADTSearchBridge\extractPostValues
extractPostValues(array $a_post=null)
Extract data from (post) values.
Definition: class.ilADTSearchBridge.php:256
ilADTSearchBridge\shouldBeImportedFromPost
shouldBeImportedFromPost($a_post)
Check if incoming values should be imported at all.
Definition: class.ilADTSearchBridge.php:245
ilADTSearchBridge\writeFilter
writeFilter($a_value=null)
Write value(s) to filter store (in session)
Definition: class.ilADTSearchBridge.php:152
ilADTSearchBridge\getElementId
getElementId()
Get element id.
Definition: class.ilADTSearchBridge.php:97
+ Here is the call graph for this function:

◆ isInCondition()

ilADTTextSearchBridgeSingle::isInCondition ( ilADT  $a_adt)

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

References ilADTSearchBridgeSingle\getADT().

137  {
138  assert($a_adt instanceof ilADTText);
139 
140  // :TODO: search mode (see above)
141  return $this->getADT()->equals($a_adt);
142  }
+ 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  {
24  $this->getADT()->setText($value);
25  }
26  }
ilADTSearchBridge\readFilter
readFilter()
Load value(s) from filter store (in session)
Definition: class.ilADTSearchBridge.php:173
+ Here is the call graph for this function:

◆ setSerializedValue()

ilADTTextSearchBridgeSingle::setSerializedValue (   $a_value)

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

References ilADTSearchBridgeSingle\getADT().

156  {
157  $a_value = unserialize($a_value);
158  if(is_array($a_value))
159  {
160  $this->getADT()->setText($a_value[0]);
161  }
162  }
+ Here is the call graph for this function:

Field Documentation

◆ SQL_LIKE

const ilADTTextSearchBridgeSingle::SQL_LIKE = 2

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

Referenced by ilAdvancedMDFieldDefinitionText\searchObjects().

◆ 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: