ILIAS  release_8 Revision v8.19-1-g4e8f2f9140c
All Data Structures Namespaces Files Functions Variables 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...
 
 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

Class ilADTSearchBridgeSingle.

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

Member Function Documentation

◆ getADT()

ilADTSearchBridgeSingle::getADT ( )

Get ADT.

Returns
ilADT|null

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

References $adt.

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

26  : ?ilADT
27  {
28  return $this->adt;
29  }
ADT base class.
Definition: class.ilADT.php:11
+ Here is the caller graph for this function:

◆ isNull()

ilADTSearchBridgeSingle::isNull ( )

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

References getADT().

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

31  : bool
32  {
33  return !$this->getADT() instanceof ilADT || $this->getADT()->isNull();
34  }
ADT base class.
Definition: class.ilADT.php:11
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ isValid()

ilADTSearchBridgeSingle::isValid ( )

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

References getADT().

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

36  : bool
37  {
38  return $this->getADT() instanceof ilADT && $this->getADT()->isValid();
39  }
ADT base class.
Definition: class.ilADT.php:11
+ 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 12 of file class.ilADTSearchBridgeSingle.php.

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

12  : void
13  {
14  if ($this->isValidADTDefinition($a_adt_def)) {
15  $this->adt = ilADTFactory::getInstance()->getInstanceByDefinition($a_adt_def);
16  return;
17  }
18 
19  throw new InvalidArgumentException('ilADTSearchBridge type mismatch.');
20  }
isValidADTDefinition(ilADTDefinition $a_adt_def)
+ Here is the call graph for this function:

◆ validate()

ilADTSearchBridgeSingle::validate ( )

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

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

41  : bool
42  {
43  if (!$this->getADT() instanceof ilADT) {
44  return false;
45  }
46  if (!$this->isValid()) {
47  $tmp = array();
48  $mess = $this->getADT()->getValidationErrors();
49  foreach ($mess as $error_code) {
50  $tmp[] = $this->getADT()->translateErrorCode($error_code);
51  }
52  $field = $this->getForm()->getItemByPostVar($this->getElementId());
53  $field->setAlert(implode("<br />", $tmp));
54 
55  return false;
56  }
57  return true;
58  }
ADT base class.
Definition: class.ilADT.php:11
+ 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: