ILIAS  release_8 Revision v8.24
Public Member Functions | Protected Member Functions
ilADTLocalizedTextSearchBridgeSingle Class Reference
+ Inheritance diagram for ilADTLocalizedTextSearchBridgeSingle:
+ Collaboration diagram for ilADTLocalizedTextSearchBridgeSingle:

Public Member Functions

 loadFilter ()
 Load filter value(s) into ADT. More...
 
 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...
 
 loadFilter ()
 Load filter value(s) into ADT. More...
 
 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...
 

Protected Member Functions

 isValidADTDefinition (ilADTDefinition $a_adt_def)
 
 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

- Data Fields inherited from ilADTTextSearchBridgeSingle
const SQL_STRICT = 1
 
const SQL_LIKE = 2
 
const SQL_LIKE_END = 3
 
const SQL_LIKE_START = 4
 
- 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 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 21 of file class.ilADTLocalizedTextSearchBridgeSingle.php.

Member Function Documentation

◆ addToForm()

ilADTLocalizedTextSearchBridgeSingle::addToForm ( )

Add ADT-specific fields to form.

Reimplemented from ilADTTextSearchBridgeSingle.

Definition at line 40 of file class.ilADTLocalizedTextSearchBridgeSingle.php.

40 : void
41 {
42 $text = new ilTextInputGUI($this->getTitle(), $this->getElementId());
43 $text->setSize(20);
44 $text->setMaxLength(512);
45 $text->setSubmitFormOnEnter(true);
46
47 $text->setValue($this->getADT()->getText());
48
49 $this->addToParentElement($text);
50 }
ilADTSearchBridge\addToParentElement
addToParentElement(ilFormPropertyGUI $a_field)
Add form field to parent element.
Definition: class.ilADTSearchBridge.php:167
ilTextInputGUI
This class represents a text property in a property form.
Definition: class.ilTextInputGUI.php:27

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

+ Here is the call graph for this function:

◆ getSerializedValue()

ilADTLocalizedTextSearchBridgeSingle::getSerializedValue ( )

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

Reimplemented from ilADTTextSearchBridgeSingle.

Definition at line 137 of file class.ilADTLocalizedTextSearchBridgeSingle.php.

137 : string
138 {
139 if (!$this->isNull() && $this->isValid()) {
140 return serialize(array($this->getADT()->getText()));
141 }
142 return '';
143 }

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

+ Here is the call graph for this function:

◆ getSQLCondition()

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

Get SQL condition for current value(s)

Reimplemented from ilADTTextSearchBridgeSingle.

Definition at line 72 of file class.ilADTLocalizedTextSearchBridgeSingle.php.

72 : string
73 {
74 if (!$quotedWords) {
75 if ($this->isNull() || !$this->isValid()) {
76 return '';
77 }
78 $quotedWords = $this->getADT()->getText();
79 }
80
81 switch ($mode) {
82 case self::SQL_STRICT:
83 if (!is_array($quotedWords)) {
84 return $a_element_id . " = " . $this->db->quote($quotedWords, "text");
85 } else {
86 return $this->db->in($a_element_id, $quotedWords, false, "text");
87 }
88
89 // no break
90 case self::SQL_LIKE:
91 if (!is_array($quotedWords)) {
92 return $this->db->like($a_element_id, "text", "%" . $quotedWords . "%");
93 } else {
94 $tmp = array();
95 foreach ($quotedWords as $word) {
96 if ($word) {
97 $tmp[] = $this->db->like($a_element_id, "text", "%" . $word . "%");
98 }
99 }
100 if (count($tmp)) {
101 return "(" . implode(" OR ", $tmp) . ")";
102 }
103 }
104 break;
105
106 case self::SQL_LIKE_END:
107 if (!is_array($quotedWords)) {
108 return $this->db->like($a_element_id, "text", $quotedWords . "%");
109 }
110 break;
111
112 case self::SQL_LIKE_START:
113 if (!is_array($quotedWords)) {
114 return $this->db->like($a_element_id, "text", "%" . $quotedWords);
115 }
116 break;
117 }
118 return '';
119 }

References ilADTSearchBridgeSingle\getADT(), ilADTSearchBridgeSingle\isNull(), ilADTSearchBridgeSingle\isValid(), ilADTTextSearchBridgeSingle\SQL_LIKE, ilADTTextSearchBridgeSingle\SQL_LIKE_END, ilADTTextSearchBridgeSingle\SQL_LIKE_START, and ilADTTextSearchBridgeSingle\SQL_STRICT.

+ Here is the call graph for this function:

◆ importFromPost()

ilADTLocalizedTextSearchBridgeSingle::importFromPost ( array  $a_post = null)
Todo:
make post required

Reimplemented from ilADTTextSearchBridgeSingle.

Definition at line 52 of file class.ilADTLocalizedTextSearchBridgeSingle.php.

52 : bool
53 {
54 $post = $this->extractPostValues($a_post);
55
56 if ($post && $this->shouldBeImportedFromPost($post)) {
57 if ($this->getForm() instanceof ilPropertyFormGUI) {
58 $item = $this->getForm()->getItemByPostVar($this->getElementId());
59 $item->setValue($post);
60 } elseif (array_key_exists($this->getElementId(), $this->table_filter_fields)) {
61 $this->table_filter_fields[$this->getElementId()]->setValue($post);
62 $this->writeFilter($post);
63 }
64 $this->getADT()->setText($post);
65 } else {
66 $this->writeFilter();
67 $this->getADT()->setText();
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()

ilADTLocalizedTextSearchBridgeSingle::isInCondition ( ilADT  $a_adt)

Compare directly against ADT.

Reimplemented from ilADTTextSearchBridgeSingle.

Definition at line 121 of file class.ilADTLocalizedTextSearchBridgeSingle.php.

121 : bool
122 {
123 if ($this->getADT()->getCopyOfDefinition()->isComparableTo($a_adt)) {
124 foreach ($a_adt->getTranslations() as $language => $text) {
125 $search_term = strtolower(trim((string) $this->getADT()->getText()));
126 $text = strtolower(trim((string) $text));
127 if (str_contains($text, $search_term)) {
128 return true;
129 }
130 }
131 }
132 return false;
133 }

References ilADTSearchBridgeSingle\getADT().

+ Here is the call graph for this function:

◆ isValidADTDefinition()

ilADTLocalizedTextSearchBridgeSingle::isValidADTDefinition ( ilADTDefinition  $a_adt_def)
protected

Reimplemented from ilADTTextSearchBridgeSingle.

Definition at line 23 of file class.ilADTLocalizedTextSearchBridgeSingle.php.

23 : bool
24 {
25 return ($a_adt_def instanceof ilADTLocalizedTextDefinition);
26 }

◆ loadFilter()

ilADTLocalizedTextSearchBridgeSingle::loadFilter ( )

Load filter value(s) into ADT.

Reimplemented from ilADTTextSearchBridgeSingle.

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

30 : void
31 {
32 $value = $this->readFilter();
33 if ($value !== null) {
34 $this->getADT()->setText($value);
35 }
36 }
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()

ilADTLocalizedTextSearchBridgeSingle::setSerializedValue ( string  $a_value)

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

Reimplemented from ilADTTextSearchBridgeSingle.

Definition at line 145 of file class.ilADTLocalizedTextSearchBridgeSingle.php.

145 : void
146 {
147 $a_value = unserialize($a_value);
148 if (is_array($a_value)) {
149 $this->getADT()->setText($a_value[0]);
150 }
151 }

References ilADTSearchBridgeSingle\getADT().

+ Here is the call graph for this function:
The documentation for this class was generated from the following file: