ILIAS
trunk Revision v11.0_alpha-3011-gc6b235a2e85
|
ADT search bridge base class. More...
Public Member Functions | |
__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... | |
Data Fields | |
const | SQL_STRICT = 1 |
const | SQL_LIKE = 2 |
const | SQL_LIKE_END = 3 |
const | SQL_LIKE_START = 4 |
const | DEFAULT_SEARCH_COLUMN = 'value' |
Protected Member Functions | |
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 | |
ilPropertyFormGUI | $form = null |
ilTable2GUI | $table_gui = null |
array | $table_filter_fields = [] |
string | $id = '' |
string | $title = '' |
string | $info = '' |
ilLanguage | $lng |
ilDBInterface | $db |
HttpServices | $http |
ADT search bridge base class.
Definition at line 28 of file class.ilADTSearchBridge.php.
ilADTSearchBridge::__construct | ( | ilADTDefinition | $a_adt_def | ) |
Reimplemented in ilADTLocationSearchBridgeSingle.
Definition at line 47 of file class.ilADTSearchBridge.php.
References $DIC, ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and setDefinition().
|
protected |
Add sub-element.
string | $a_add |
Definition at line 185 of file class.ilADTSearchBridge.php.
References getElementId().
Referenced by ilADTDateSearchBridgeRange\addToForm(), ilADTDateTimeSearchBridgeRange\addToForm(), ilADTLocationSearchBridgeSingle\addToForm(), ilADTLocationSearchBridgeSingle\importFromPost(), and ilADTSearchBridgeRange\validate().
ilADTSearchBridge::addToFilterForm | ( | ) |
Add ADT-specific fields to filter.
This needs to be separated from other forms to avoid weird js interactions, but can probably be dropped when moving to KS (see #39225).
Reimplemented in ilADTLocalizedTextSearchBridgeSingle, and ilADTTextSearchBridgeSingle.
Definition at line 200 of file class.ilADTSearchBridge.php.
References addToForm().
|
abstract |
Add ADT-specific fields to form.
Reimplemented in ilADTDateSearchBridgeRange, ilADTDateSearchBridgeSingle, ilADTDateTimeSearchBridgeRange, ilADTDateTimeSearchBridgeSingle, ilADTEnumSearchBridgeMulti, ilADTEnumSearchBridgeSingle, ilADTExternalLinkSearchBridgeSingle, ilADTFloatSearchBridgeSingle, ilADTIntegerSearchBridgeSingle, ilADTInternalLinkSearchBridgeSingle, ilADTLocalizedTextSearchBridgeSingle, ilADTLocationSearchBridgeSingle, and ilADTTextSearchBridgeSingle.
Referenced by addToFilterForm().
|
protected |
Add form field to parent element.
ilFormPropertyGUI | $a_field |
Definition at line 167 of file class.ilADTSearchBridge.php.
References ilFormPropertyGUI\getFieldId(), getForm(), and getTableGUI().
Referenced by ilADTTextSearchBridgeSingle\addTextInputToForm(), ilADTDateSearchBridgeRange\addToForm(), ilADTDateSearchBridgeSingle\addToForm(), ilADTDateTimeSearchBridgeRange\addToForm(), ilADTDateTimeSearchBridgeSingle\addToForm(), ilADTEnumSearchBridgeMulti\addToForm(), ilADTEnumSearchBridgeSingle\addToForm(), ilADTExternalLinkSearchBridgeSingle\addToForm(), ilADTFloatSearchBridgeSingle\addToForm(), ilADTIntegerSearchBridgeSingle\addToForm(), ilADTInternalLinkSearchBridgeSingle\addToForm(), and ilADTLocationSearchBridgeSingle\addToForm().
|
protected |
Extract data from (post) values.
array | $a_post |
Definition at line 220 of file class.ilADTSearchBridge.php.
References $post, getElementId(), and ILIAS\FileDelivery\http().
Referenced by ilADTDateSearchBridgeRange\importFromPost(), ilADTDateSearchBridgeSingle\importFromPost(), ilADTDateTimeSearchBridgeRange\importFromPost(), ilADTDateTimeSearchBridgeSingle\importFromPost(), ilADTEnumSearchBridgeMulti\importFromPost(), ilADTEnumSearchBridgeSingle\importFromPost(), ilADTExternalLinkSearchBridgeSingle\importFromPost(), ilADTFloatSearchBridgeSingle\importFromPost(), ilADTIntegerSearchBridgeSingle\importFromPost(), ilADTInternalLinkSearchBridgeSingle\importFromPost(), ilADTLocalizedTextSearchBridgeSingle\importFromPost(), ilADTLocationSearchBridgeSingle\importFromPost(), and ilADTTextSearchBridgeSingle\importFromPost().
ilADTSearchBridge::getElementId | ( | ) |
Definition at line 78 of file class.ilADTSearchBridge.php.
References $id.
Referenced by ilADTTextSearchBridgeSingle\addTextInputToForm(), addToElementId(), ilADTDateSearchBridgeRange\addToForm(), ilADTDateSearchBridgeSingle\addToForm(), ilADTDateTimeSearchBridgeRange\addToForm(), ilADTDateTimeSearchBridgeSingle\addToForm(), ilADTEnumSearchBridgeMulti\addToForm(), ilADTEnumSearchBridgeSingle\addToForm(), ilADTExternalLinkSearchBridgeSingle\addToForm(), ilADTFloatSearchBridgeSingle\addToForm(), ilADTIntegerSearchBridgeSingle\addToForm(), ilADTInternalLinkSearchBridgeSingle\addToForm(), extractPostValues(), ilADTDateSearchBridgeRange\importFromPost(), ilADTDateSearchBridgeSingle\importFromPost(), ilADTDateTimeSearchBridgeRange\importFromPost(), ilADTDateTimeSearchBridgeSingle\importFromPost(), ilADTEnumSearchBridgeMulti\importFromPost(), ilADTEnumSearchBridgeSingle\importFromPost(), ilADTExternalLinkSearchBridgeSingle\importFromPost(), ilADTFloatSearchBridgeSingle\importFromPost(), ilADTIntegerSearchBridgeSingle\importFromPost(), ilADTInternalLinkSearchBridgeSingle\importFromPost(), ilADTLocalizedTextSearchBridgeSingle\importFromPost(), ilADTLocationSearchBridgeSingle\importFromPost(), ilADTTextSearchBridgeSingle\importFromPost(), and ilADTSearchBridgeSingle\validate().
ilADTSearchBridge::getForm | ( | ) |
Definition at line 68 of file class.ilADTSearchBridge.php.
References $form.
Referenced by ilADTDateSearchBridgeRange\addToForm(), ilADTDateTimeSearchBridgeRange\addToForm(), addToParentElement(), ilADTDateSearchBridgeRange\importFromPost(), ilADTDateSearchBridgeSingle\importFromPost(), ilADTDateTimeSearchBridgeRange\importFromPost(), ilADTDateTimeSearchBridgeSingle\importFromPost(), ilADTEnumSearchBridgeMulti\importFromPost(), ilADTEnumSearchBridgeSingle\importFromPost(), ilADTExternalLinkSearchBridgeSingle\importFromPost(), ilADTFloatSearchBridgeSingle\importFromPost(), ilADTIntegerSearchBridgeSingle\importFromPost(), ilADTInternalLinkSearchBridgeSingle\importFromPost(), ilADTLocalizedTextSearchBridgeSingle\importFromPost(), ilADTLocationSearchBridgeSingle\importFromPost(), ilADTTextSearchBridgeSingle\importFromPost(), ilADTDateSearchBridgeRange\shouldBeImportedFromPost(), ilADTDateTimeSearchBridgeRange\shouldBeImportedFromPost(), ilADTSearchBridgeRange\validate(), and ilADTSearchBridgeSingle\validate().
ilADTSearchBridge::getSearchColumn | ( | ) |
Reimplemented in ilADTEnumSearchBridgeMulti, and ilADTEnumSearchBridgeSingle.
Definition at line 93 of file class.ilADTSearchBridge.php.
References DEFAULT_SEARCH_COLUMN.
|
abstract |
Get current value(s) in serialized form (for easy persisting)
Reimplemented in ilADTDateSearchBridgeRange, ilADTDateSearchBridgeSingle, ilADTDateTimeSearchBridgeRange, ilADTDateTimeSearchBridgeSingle, ilADTEnumSearchBridgeMulti, ilADTEnumSearchBridgeSingle, ilADTExternalLinkSearchBridgeSingle, ilADTFloatSearchBridgeSingle, ilADTIntegerSearchBridgeSingle, ilADTInternalLinkSearchBridgeSingle, ilADTLocalizedTextSearchBridgeSingle, ilADTLocationSearchBridgeSingle, and ilADTTextSearchBridgeSingle.
Referenced by ilAdvancedMDFieldDefinition\getSearchValueSerialized().
|
abstract |
Get SQL condition for current value(s)
Reimplemented in ilADTDateSearchBridgeRange, ilADTDateSearchBridgeSingle, ilADTDateTimeSearchBridgeRange, ilADTDateTimeSearchBridgeSingle, ilADTEnumSearchBridgeMulti, ilADTEnumSearchBridgeSingle, ilADTExternalLinkSearchBridgeSingle, ilADTFloatSearchBridgeSingle, ilADTIntegerSearchBridgeSingle, ilADTInternalLinkSearchBridgeSingle, ilADTLocalizedTextSearchBridgeSingle, ilADTLocationSearchBridgeSingle, and ilADTTextSearchBridgeSingle.
Referenced by ilAdvancedMDFieldDefinitionSelect\findBySingleValue(), and ilAdvancedMDFieldDefinition\searchSubObjects().
ilADTSearchBridge::getTableGUI | ( | ) |
Get table gui.
Definition at line 106 of file class.ilADTSearchBridge.php.
References $table_gui.
Referenced by addToParentElement().
ilADTSearchBridge::getTitle | ( | ) |
Definition at line 88 of file class.ilADTSearchBridge.php.
References $title.
Referenced by ilADTTextSearchBridgeSingle\addTextInputToForm(), ilADTDateSearchBridgeRange\addToForm(), ilADTDateSearchBridgeSingle\addToForm(), ilADTDateTimeSearchBridgeRange\addToForm(), ilADTDateTimeSearchBridgeSingle\addToForm(), ilADTEnumSearchBridgeMulti\addToForm(), ilADTEnumSearchBridgeSingle\addToForm(), ilADTExternalLinkSearchBridgeSingle\addToForm(), ilADTFloatSearchBridgeSingle\addToForm(), ilADTIntegerSearchBridgeSingle\addToForm(), ilADTInternalLinkSearchBridgeSingle\addToForm(), and ilADTLocationSearchBridgeSingle\addToForm().
|
abstract |
Reimplemented in ilADTDateSearchBridgeRange, ilADTDateSearchBridgeSingle, ilADTDateTimeSearchBridgeRange, ilADTDateTimeSearchBridgeSingle, ilADTEnumSearchBridgeMulti, ilADTEnumSearchBridgeSingle, ilADTExternalLinkSearchBridgeSingle, ilADTFloatSearchBridgeSingle, ilADTIntegerSearchBridgeSingle, ilADTInternalLinkSearchBridgeSingle, ilADTLocalizedTextSearchBridgeSingle, ilADTLocationSearchBridgeSingle, and ilADTTextSearchBridgeSingle.
ilADTSearchBridge::isInCondition | ( | ilADT | $a_adt | ) |
Compare directly against ADT.
This is currently only used in ilAdvancedMDValues::queryForRecords, e.g. in the filter of mediapools. Other filter/search use cases use instead getSQLCondition.
Reimplemented in ilADTDateSearchBridgeRange, ilADTDateSearchBridgeSingle, ilADTDateTimeSearchBridgeRange, ilADTDateTimeSearchBridgeSingle, ilADTEnumSearchBridgeMulti, ilADTEnumSearchBridgeSingle, ilADTExternalLinkSearchBridgeSingle, ilADTFloatSearchBridgeSingle, ilADTIntegerSearchBridgeSingle, ilADTInternalLinkSearchBridgeSingle, ilADTLocalizedTextSearchBridgeSingle, and ilADTTextSearchBridgeSingle.
Definition at line 273 of file class.ilADTSearchBridge.php.
|
abstract |
Reimplemented in ilADTSearchBridgeRange, and ilADTSearchBridgeSingle.
|
abstractprotected |
Reimplemented in ilADTDateSearchBridgeRange, ilADTDateSearchBridgeSingle, ilADTDateTimeSearchBridgeRange, ilADTDateTimeSearchBridgeSingle, ilADTEnumSearchBridgeMulti, ilADTEnumSearchBridgeSingle, ilADTFloatSearchBridgeSingle, ilADTIntegerSearchBridgeSingle, ilADTLocalizedTextSearchBridgeSingle, ilADTLocationSearchBridgeSingle, and ilADTTextSearchBridgeSingle.
Referenced by ilADTSearchBridgeMulti\setDefinition(), ilADTSearchBridgeRange\setDefinition(), and ilADTSearchBridgeSingle\setDefinition().
|
abstract |
Load filter value(s) into ADT.
Reimplemented in ilADTDateSearchBridgeRange, ilADTDateSearchBridgeSingle, ilADTDateTimeSearchBridgeRange, ilADTDateTimeSearchBridgeSingle, ilADTEnumSearchBridgeMulti, ilADTEnumSearchBridgeSingle, ilADTExternalLinkSearchBridgeSingle, ilADTFloatSearchBridgeSingle, ilADTIntegerSearchBridgeSingle, ilADTInternalLinkSearchBridgeSingle, ilADTLocalizedTextSearchBridgeSingle, ilADTLocationSearchBridgeSingle, and ilADTTextSearchBridgeSingle.
|
protected |
Load value(s) from filter store (in session)
Definition at line 140 of file class.ilADTSearchBridge.php.
References ilSession\get().
Referenced by ilADTDateSearchBridgeRange\loadFilter(), ilADTDateSearchBridgeSingle\loadFilter(), ilADTDateTimeSearchBridgeRange\loadFilter(), ilADTDateTimeSearchBridgeSingle\loadFilter(), ilADTEnumSearchBridgeMulti\loadFilter(), ilADTEnumSearchBridgeSingle\loadFilter(), ilADTExternalLinkSearchBridgeSingle\loadFilter(), ilADTFloatSearchBridgeSingle\loadFilter(), ilADTIntegerSearchBridgeSingle\loadFilter(), ilADTInternalLinkSearchBridgeSingle\loadFilter(), ilADTLocalizedTextSearchBridgeSingle\loadFilter(), ilADTLocationSearchBridgeSingle\loadFilter(), and ilADTTextSearchBridgeSingle\loadFilter().
|
abstractprotected |
Reimplemented in ilADTSearchBridgeMulti, ilADTSearchBridgeRange, and ilADTSearchBridgeSingle.
Referenced by __construct().
ilADTSearchBridge::setElementId | ( | string | $a_value | ) |
Definition at line 73 of file class.ilADTSearchBridge.php.
ilADTSearchBridge::setForm | ( | ilPropertyFormGUI | $a_form | ) |
Definition at line 63 of file class.ilADTSearchBridge.php.
References ILIAS\Repository\form().
|
abstract |
Set current value(s) in serialized form (for easy persisting)
Reimplemented in ilADTDateSearchBridgeRange, ilADTDateSearchBridgeSingle, ilADTDateTimeSearchBridgeRange, ilADTDateTimeSearchBridgeSingle, ilADTEnumSearchBridgeMulti, ilADTEnumSearchBridgeSingle, ilADTExternalLinkSearchBridgeSingle, ilADTFloatSearchBridgeSingle, ilADTIntegerSearchBridgeSingle, ilADTInternalLinkSearchBridgeSingle, ilADTLocalizedTextSearchBridgeSingle, ilADTLocationSearchBridgeSingle, and ilADTTextSearchBridgeSingle.
Referenced by ilAdvancedMDFieldDefinition\setSearchValueSerialized().
ilADTSearchBridge::setTableGUI | ( | ilTable2GUI | $a_table | ) |
Definition at line 98 of file class.ilADTSearchBridge.php.
ilADTSearchBridge::setTitle | ( | string | $a_value | ) |
Definition at line 83 of file class.ilADTSearchBridge.php.
|
protected |
Check if incoming values should be imported at all.
string | int | $a_post |
Reimplemented in ilADTDateSearchBridgeRange, ilADTDateSearchBridgeSingle, ilADTDateTimeSearchBridgeRange, ilADTDateTimeSearchBridgeSingle, and ilADTLocationSearchBridgeSingle.
Definition at line 210 of file class.ilADTSearchBridge.php.
Referenced by ilADTEnumSearchBridgeMulti\importFromPost(), ilADTEnumSearchBridgeSingle\importFromPost(), ilADTExternalLinkSearchBridgeSingle\importFromPost(), ilADTFloatSearchBridgeSingle\importFromPost(), ilADTIntegerSearchBridgeSingle\importFromPost(), ilADTInternalLinkSearchBridgeSingle\importFromPost(), ilADTLocalizedTextSearchBridgeSingle\importFromPost(), and ilADTTextSearchBridgeSingle\importFromPost().
|
abstract |
Validate current data.
Reimplemented in ilADTSearchBridgeRange, and ilADTSearchBridgeSingle.
|
protected |
Write value(s) to filter store (in session)
?$a_value |
Definition at line 115 of file class.ilADTSearchBridge.php.
References ilSession\clear(), and ilSession\set().
Referenced by ilADTDateSearchBridgeRange\importFromPost(), ilADTDateSearchBridgeSingle\importFromPost(), ilADTDateTimeSearchBridgeRange\importFromPost(), ilADTDateTimeSearchBridgeSingle\importFromPost(), ilADTEnumSearchBridgeMulti\importFromPost(), ilADTEnumSearchBridgeSingle\importFromPost(), ilADTExternalLinkSearchBridgeSingle\importFromPost(), ilADTInternalLinkSearchBridgeSingle\importFromPost(), ilADTLocalizedTextSearchBridgeSingle\importFromPost(), and ilADTTextSearchBridgeSingle\importFromPost().
|
protected |
Definition at line 44 of file class.ilADTSearchBridge.php.
|
protected |
Definition at line 36 of file class.ilADTSearchBridge.php.
Referenced by getForm().
|
protected |
Definition at line 45 of file class.ilADTSearchBridge.php.
|
protected |
Definition at line 39 of file class.ilADTSearchBridge.php.
Referenced by getElementId().
|
protected |
Definition at line 41 of file class.ilADTSearchBridge.php.
|
protected |
Definition at line 43 of file class.ilADTSearchBridge.php.
|
protected |
Definition at line 38 of file class.ilADTSearchBridge.php.
|
protected |
Definition at line 37 of file class.ilADTSearchBridge.php.
Referenced by getTableGUI().
|
protected |
Definition at line 40 of file class.ilADTSearchBridge.php.
Referenced by ilADTInternalLinkSearchBridgeSingle\addToForm(), getTitle(), ilADTExternalLinkSearchBridgeSingle\isInCondition(), and ilADTInternalLinkSearchBridgeSingle\isInCondition().
const ilADTSearchBridge::DEFAULT_SEARCH_COLUMN = 'value' |
Definition at line 34 of file class.ilADTSearchBridge.php.
Referenced by getSearchColumn().
const ilADTSearchBridge::SQL_LIKE = 2 |
Definition at line 31 of file class.ilADTSearchBridge.php.
Referenced by ilADTExternalLinkSearchBridgeSingle\buildSQLCondition().
const ilADTSearchBridge::SQL_LIKE_END = 3 |
Definition at line 32 of file class.ilADTSearchBridge.php.
Referenced by ilADTExternalLinkSearchBridgeSingle\buildSQLCondition().
const ilADTSearchBridge::SQL_LIKE_START = 4 |
Definition at line 33 of file class.ilADTSearchBridge.php.
Referenced by ilADTExternalLinkSearchBridgeSingle\buildSQLCondition().
const ilADTSearchBridge::SQL_STRICT = 1 |
Definition at line 30 of file class.ilADTSearchBridge.php.
Referenced by ilADTExternalLinkSearchBridgeSingle\buildSQLCondition().