ILIAS  trunk Revision v11.0_alpha-2645-g16283d3b3f8
ILIAS\MetaData\Services\Search\SearcherInterface Interface Reference
+ Inheritance diagram for ILIAS\MetaData\Services\Search\SearcherInterface:
+ Collaboration diagram for ILIAS\MetaData\Services\Search\SearcherInterface:

Public Member Functions

 getClauseFactory ()
 Get a factory where you can assemble your search clause. More...
 
 getFilter (int|Placeholder $obj_id=Placeholder::ANY, int|Placeholder $sub_id=Placeholder::ANY, string|Placeholder $type=Placeholder::ANY)
 Get a filter with which the results of a search can be restricted. More...
 
 execute (ClauseInterface $clause, ?int $limit, ?int $offset, FilterInterface ... $filters)
 Results are always ordered first by obj_id, then sub_id, then type. More...
 

Detailed Description

Definition at line 29 of file SearcherInterface.php.

Member Function Documentation

◆ execute()

ILIAS\MetaData\Services\Search\SearcherInterface::execute ( ClauseInterface  $clause,
?int  $limit,
?int  $offset,
FilterInterface ...  $filters 
)

Results are always ordered first by obj_id, then sub_id, then type.

Multiple filters are joined with a logical OR, values within the same filter with AND.

Returns
RessourceIDInterface[]

Implemented in ILIAS\MetaData\Services\Search\Searcher.

◆ getClauseFactory()

ILIAS\MetaData\Services\Search\SearcherInterface::getClauseFactory ( )

Get a factory where you can assemble your search clause.

Implemented in ILIAS\MetaData\Services\Search\Searcher.

◆ getFilter()

ILIAS\MetaData\Services\Search\SearcherInterface::getFilter ( int|Placeholder  $obj_id = Placeholder::ANY,
int|Placeholder  $sub_id = Placeholder::ANY,
string|Placeholder  $type = Placeholder::ANY 
)

Get a filter with which the results of a search can be restricted.

You can either give specific values for the three identifying parameters of objects (see {

See also
::read()} for a description of what those are), or placeholders to accept either any value or to force two parameters to match.

Implemented in ILIAS\MetaData\Services\Search\Searcher.


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