item_search_service_interface
Contract for High-level Item Search.
Table of Contents
Methods
- first() : mixed
- Returns first matching record or null (Domain or stdClass).
- search() : result_interface
- Perform an advanced search using criteria, metadata, pagination and sorting.
- search_raw() : result_interface
- Convenience wrapper for raw stdClass results.
Methods
first()
Returns first matching record or null (Domain or stdClass).
public
first(search_criteria $criteria, search_metadata_criteria $meta[, null|string $domain_class = null ]) : mixed
Parameters
- $criteria : search_criteria
- $meta : search_metadata_criteria
- $domain_class : null|string = null
search()
Perform an advanced search using criteria, metadata, pagination and sorting.
public
search(search_criteria $criteria, search_metadata_criteria $meta[, null|pagination $pagination = null ][, null|sorting $sorting = null ][, null|string $domain_class = null ]) : result_interface
Parameters
- $criteria : search_criteria
- $meta : search_metadata_criteria
- $pagination : null|pagination = null
- $sorting : null|sorting = null
- $domain_class : null|string = null
-
(null = raw stdClass logic via engine)
Tags
Return values
result_interfacesearch_raw()
Convenience wrapper for raw stdClass results.
public
search_raw(search_criteria $criteria, search_metadata_criteria $meta[, pagination|null $pagination = null ][, sorting|null $sorting = null ]) : result_interface
Parameters
- $criteria : search_criteria
- $meta : search_metadata_criteria
- $pagination : pagination|null = null
- $sorting : sorting|null = null