ILIAS  trunk Revision v11.0_alpha-1761-g6dbbfa7b760
All Data Structures Namespaces Files Functions Variables Enumerations Enumerator Modules Pages
ilADTSearchBridgeSingle Class Reference

Class ilADTSearchBridgeSingle. More...

+ Inheritance diagram for ilADTSearchBridgeSingle:
+ Collaboration diagram for ilADTSearchBridgeSingle:

Public Member Functions

 getADT ()
 Get ADT. More...
 
 isNull ()
 
 isValid ()
 
 validate ()
 
- 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...
 
 addToFilterForm ()
 Add ADT-specific fields to filter. 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

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

Protected Attributes

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
 

Additional Inherited Members

- 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'
 

Detailed Description

Member Function Documentation

◆ getADT()

ilADTSearchBridgeSingle::getADT ( )

Get ADT.

Returns
ilADT|null

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

References $adt.

Referenced by ilADTTextSearchBridgeSingle\addTextInputToForm(), ilADTDateSearchBridgeSingle\addToForm(), ilADTDateTimeSearchBridgeSingle\addToForm(), ilADTFloatSearchBridgeSingle\addToForm(), ilADTIntegerSearchBridgeSingle\addToForm(), ilADTEnumSearchBridgeSingle\addToForm(), ilADTExternalLinkSearchBridgeSingle\addToForm(), ilADTLocationSearchBridgeSingle\addToForm(), ilADTEnumSearchBridgeMulti\addToForm(), ilPresentationTableGUI\getADTSearchBridges(), ilADTIntegerSearchBridgeSingle\getSerializedValue(), ilADTFloatSearchBridgeSingle\getSerializedValue(), ilADTDateSearchBridgeSingle\getSerializedValue(), ilADTDateTimeSearchBridgeSingle\getSerializedValue(), ilADTEnumSearchBridgeSingle\getSerializedValue(), ilADTLocalizedTextSearchBridgeSingle\getSerializedValue(), ilADTInternalLinkSearchBridgeSingle\getSerializedValue(), ilADTTextSearchBridgeSingle\getSerializedValue(), ilADTEnumSearchBridgeMulti\getSerializedValue(), ilADTExternalLinkSearchBridgeSingle\getSerializedValue(), ilADTLocationSearchBridgeSingle\getSerializedValue(), ilADTLocalizedTextSearchBridgeSingle\getSQLCondition(), ilADTIntegerSearchBridgeSingle\getSQLCondition(), ilADTFloatSearchBridgeSingle\getSQLCondition(), ilADTDateTimeSearchBridgeSingle\getSQLCondition(), ilADTDateSearchBridgeSingle\getSQLCondition(), ilADTEnumSearchBridgeSingle\getSQLCondition(), ilADTTextSearchBridgeSingle\getSQLCondition(), ilADTExternalLinkSearchBridgeSingle\getSQLCondition(), ilADTInternalLinkSearchBridgeSingle\getSQLCondition(), ilADTEnumSearchBridgeMulti\getSQLCondition(), ilADTLocationSearchBridgeSingle\getSQLCondition(), ilADTLocalizedTextSearchBridgeSingle\importFromPost(), ilADTExternalLinkSearchBridgeSingle\importFromPost(), ilADTDateSearchBridgeSingle\importFromPost(), ilADTDateTimeSearchBridgeSingle\importFromPost(), ilADTFloatSearchBridgeSingle\importFromPost(), ilADTIntegerSearchBridgeSingle\importFromPost(), ilADTEnumSearchBridgeSingle\importFromPost(), ilADTTextSearchBridgeSingle\importFromPost(), ilADTInternalLinkSearchBridgeSingle\importFromPost(), ilADTEnumSearchBridgeMulti\importFromPost(), ilADTLocationSearchBridgeSingle\importFromPost(), ilADTIntegerSearchBridgeSingle\isInCondition(), ilADTFloatSearchBridgeSingle\isInCondition(), ilADTDateTimeSearchBridgeSingle\isInCondition(), ilADTDateSearchBridgeSingle\isInCondition(), ilADTEnumSearchBridgeSingle\isInCondition(), ilADTLocalizedTextSearchBridgeSingle\isInCondition(), ilADTInternalLinkSearchBridgeSingle\isInCondition(), ilADTEnumSearchBridgeMulti\isInCondition(), ilADTTextSearchBridgeSingle\isInCondition(), ilADTExternalLinkSearchBridgeSingle\isInCondition(), isNull(), isValid(), ilADTLocalizedTextSearchBridgeSingle\loadFilter(), ilADTDateTimeSearchBridgeSingle\loadFilter(), ilADTFloatSearchBridgeSingle\loadFilter(), ilADTIntegerSearchBridgeSingle\loadFilter(), ilADTEnumSearchBridgeSingle\loadFilter(), ilADTTextSearchBridgeSingle\loadFilter(), ilADTExternalLinkSearchBridgeSingle\loadFilter(), ilADTEnumSearchBridgeMulti\loadFilter(), ilADTInternalLinkSearchBridgeSingle\loadFilter(), ilADTIntegerSearchBridgeSingle\setSerializedValue(), ilADTFloatSearchBridgeSingle\setSerializedValue(), ilADTDateTimeSearchBridgeSingle\setSerializedValue(), ilADTDateSearchBridgeSingle\setSerializedValue(), ilADTEnumSearchBridgeSingle\setSerializedValue(), ilADTLocalizedTextSearchBridgeSingle\setSerializedValue(), ilADTTextSearchBridgeSingle\setSerializedValue(), ilADTInternalLinkSearchBridgeSingle\setSerializedValue(), ilADTEnumSearchBridgeMulti\setSerializedValue(), ilADTExternalLinkSearchBridgeSingle\setSerializedValue(), ilADTLocationSearchBridgeSingle\setSerializedValue(), and validate().

42  : ?ilADT
43  {
44  return $this->adt;
45  }
ADT base class.
Definition: class.ilADT.php:25
+ Here is the caller graph for this function:

◆ isNull()

ilADTSearchBridgeSingle::isNull ( )

Definition at line 47 of file class.ilADTSearchBridgeSingle.php.

References getADT().

Referenced by ilADTIntegerSearchBridgeSingle\getSerializedValue(), ilADTFloatSearchBridgeSingle\getSerializedValue(), ilADTDateTimeSearchBridgeSingle\getSerializedValue(), ilADTDateSearchBridgeSingle\getSerializedValue(), ilADTEnumSearchBridgeSingle\getSerializedValue(), ilADTLocalizedTextSearchBridgeSingle\getSerializedValue(), ilADTInternalLinkSearchBridgeSingle\getSerializedValue(), ilADTTextSearchBridgeSingle\getSerializedValue(), ilADTEnumSearchBridgeMulti\getSerializedValue(), ilADTExternalLinkSearchBridgeSingle\getSerializedValue(), ilADTLocationSearchBridgeSingle\getSerializedValue(), ilADTLocalizedTextSearchBridgeSingle\getSQLCondition(), ilADTIntegerSearchBridgeSingle\getSQLCondition(), ilADTFloatSearchBridgeSingle\getSQLCondition(), ilADTDateSearchBridgeSingle\getSQLCondition(), ilADTDateTimeSearchBridgeSingle\getSQLCondition(), ilADTEnumSearchBridgeSingle\getSQLCondition(), ilADTTextSearchBridgeSingle\getSQLCondition(), ilADTExternalLinkSearchBridgeSingle\getSQLCondition(), ilADTInternalLinkSearchBridgeSingle\getSQLCondition(), ilADTEnumSearchBridgeMulti\getSQLCondition(), and ilADTLocationSearchBridgeSingle\getSQLCondition().

47  : bool
48  {
49  return !$this->getADT() instanceof ilADT || $this->getADT()->isNull();
50  }
ADT base class.
Definition: class.ilADT.php:25
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ isValid()

ilADTSearchBridgeSingle::isValid ( )

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

References getADT().

Referenced by ilADTIntegerSearchBridgeSingle\getSerializedValue(), ilADTFloatSearchBridgeSingle\getSerializedValue(), ilADTDateTimeSearchBridgeSingle\getSerializedValue(), ilADTDateSearchBridgeSingle\getSerializedValue(), ilADTEnumSearchBridgeSingle\getSerializedValue(), ilADTLocalizedTextSearchBridgeSingle\getSerializedValue(), ilADTInternalLinkSearchBridgeSingle\getSerializedValue(), ilADTTextSearchBridgeSingle\getSerializedValue(), ilADTEnumSearchBridgeMulti\getSerializedValue(), ilADTExternalLinkSearchBridgeSingle\getSerializedValue(), ilADTLocalizedTextSearchBridgeSingle\getSQLCondition(), ilADTIntegerSearchBridgeSingle\getSQLCondition(), ilADTFloatSearchBridgeSingle\getSQLCondition(), ilADTDateTimeSearchBridgeSingle\getSQLCondition(), ilADTDateSearchBridgeSingle\getSQLCondition(), ilADTEnumSearchBridgeSingle\getSQLCondition(), ilADTTextSearchBridgeSingle\getSQLCondition(), ilADTExternalLinkSearchBridgeSingle\getSQLCondition(), ilADTInternalLinkSearchBridgeSingle\getSQLCondition(), ilADTEnumSearchBridgeMulti\getSQLCondition(), and validate().

52  : bool
53  {
54  return $this->getADT() instanceof ilADT && $this->getADT()->isValid();
55  }
ADT base class.
Definition: class.ilADT.php:25
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setDefinition()

ilADTSearchBridgeSingle::setDefinition ( ilADTDefinition  $a_adt_def)
protected

Definition at line 28 of file class.ilADTSearchBridgeSingle.php.

References ilADTFactory\getInstance(), and ilADTSearchBridge\isValidADTDefinition().

28  : void
29  {
30  if ($this->isValidADTDefinition($a_adt_def)) {
31  $this->adt = ilADTFactory::getInstance()->getInstanceByDefinition($a_adt_def);
32  return;
33  }
34 
35  throw new InvalidArgumentException('ilADTSearchBridge type mismatch.');
36  }
isValidADTDefinition(ilADTDefinition $a_adt_def)
+ Here is the call graph for this function:

◆ validate()

ilADTSearchBridgeSingle::validate ( )

Definition at line 57 of file class.ilADTSearchBridgeSingle.php.

References getADT(), ilADTSearchBridge\getElementId(), ilADTSearchBridge\getForm(), and isValid().

57  : bool
58  {
59  if (!$this->getADT() instanceof ilADT) {
60  return false;
61  }
62  if (!$this->isValid()) {
63  $tmp = array();
64  $mess = $this->getADT()->getValidationErrors();
65  foreach ($mess as $error_code) {
66  $tmp[] = $this->getADT()->translateErrorCode($error_code);
67  }
68  $field = $this->getForm()->getItemByPostVar($this->getElementId());
69  $field->setAlert(implode("<br />", $tmp));
70 
71  return false;
72  }
73  return true;
74  }
ADT base class.
Definition: class.ilADT.php:25
+ Here is the call graph for this function:

Field Documentation

◆ $adt

ilADT ilADTSearchBridgeSingle::$adt
protected

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