interface item_search_service_interface

Contract for High-level Item Search.

Methods

search(search_criteria $criteria, search_metadata_criteria $meta, pagination|null $pagination = null, sorting|null $sorting = null, string|null $domain_class = null)

Perform an advanced search using criteria, metadata, pagination and sorting.

search_raw(search_criteria $criteria, search_metadata_criteria $meta, pagination|null $pagination = null, sorting|null $sorting = null)

Convenience wrapper for raw stdClass results.

mixed
first(search_criteria $criteria, search_metadata_criteria $meta, string|null $domain_class = null)

Returns first matching record or null (Domain or stdClass).

Details

Perform an advanced search using criteria, metadata, pagination and sorting.

Parameters

search_criteria $criteria
search_metadata_criteria $meta
pagination|null $pagination
sorting|null $sorting
string|null $domain_class

(null = raw stdClass logic via engine)

Return Value

result_interface

Exceptions

dml_exception

at line 56
result_interface search_raw(search_criteria $criteria, search_metadata_criteria $meta, pagination|null $pagination = null, sorting|null $sorting = null)

Convenience wrapper for raw stdClass results.

Parameters

search_criteria $criteria
search_metadata_criteria $meta
pagination|null $pagination
sorting|null $sorting

Return Value

result_interface

at line 72
mixed first(search_criteria $criteria, search_metadata_criteria $meta, string|null $domain_class = null)

Returns first matching record or null (Domain or stdClass).

Parameters

search_criteria $criteria
search_metadata_criteria $meta
string|null $domain_class

Return Value

mixed