ILIAS\MetaData\Services\Search\Searcher Class Reference

Inheritance diagram for ILIAS\MetaData\Services\Search\Searcher:

Collaboration diagram for ILIAS\MetaData\Services\Search\Searcher:

Public Member Functions
	__construct (ClauseFactory $clause_factory, FilterFactory $filter_factory, RepositoryInterface $repository)
	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)
	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...

Protected Attributes
ClauseFactory	$clause_factory
FilterFactory	$filter_factory
RepositoryInterface	$repository

Detailed Description

Definition at line 31 of file Searcher.php.

Constructor & Destructor Documentation

__construct()

ILIAS\MetaData\Services\Search\Searcher::__construct	(	ClauseFactory	$clause_factory,
		FilterFactory	$filter_factory,
		RepositoryInterface	$repository
	)

Definition at line 37 of file Searcher.php.

      {
        $this->clause_factory = $clause_factory;
        $this->filter_factory = $filter_factory;
        $this->repository = $repository;
    }

References ILIAS\MetaData\Services\Search\Searcher\$clause_factory, ILIAS\MetaData\Services\Search\Searcher\$filter_factory, ILIAS\MetaData\Services\Search\Searcher\$repository, and ILIAS\UI\examples\Deck\repository().

Here is the call graph for this function:

Member Function Documentation

execute()

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

Returns

RessourceIDInterface[]

Implements ILIAS\MetaData\Services\Search\SearcherInterface.

Definition at line 66 of file Searcher.php.

     : \Generator {
        yield from $this->repository->searchMD(
            $clause,
            $limit,
            $offset,
            ...$filters
        );
    }

getClauseFactory()

ILIAS\MetaData\Services\Search\Searcher::getClauseFactory

(

)

Get a factory where you can assemble your search clause.

Implements ILIAS\MetaData\Services\Search\SearcherInterface.

Definition at line 47 of file Searcher.php.

                                      : ClauseFactory
    {
        return $this->clause_factory;
    }

References ILIAS\MetaData\Services\Search\Searcher\$clause_factory.

getFilter()

ILIAS\MetaData\Services\Search\Searcher::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

\ILIAS\MetaData\Services\ServicesInterface::read()} for a description of what those are), or placeholders to accept either any value or to force two parameters to match.

Implements ILIAS\MetaData\Services\Search\SearcherInterface.

Definition at line 52 of file Searcher.php.

     : FilterInterface {
        if ($sub_id === 0) {
            $sub_id = Placeholder::OBJ_ID;
        }
        return $this->filter_factory->get($obj_id, $sub_id, $type);
    }

Field Documentation

$clause_factory

ClauseFactory ILIAS\MetaData\Services\Search\Searcher::$clause_factory

protected

Definition at line 33 of file Searcher.php.

Referenced by ILIAS\MetaData\Services\Search\Searcher\__construct(), and ILIAS\MetaData\Services\Search\Searcher\getClauseFactory().

$filter_factory

FilterFactory ILIAS\MetaData\Services\Search\Searcher::$filter_factory

protected

Definition at line 34 of file Searcher.php.

Referenced by ILIAS\MetaData\Services\Search\Searcher\__construct().

$repository

RepositoryInterface ILIAS\MetaData\Services\Search\Searcher::$repository

protected

Definition at line 35 of file Searcher.php.

Referenced by ILIAS\MetaData\Services\Search\Searcher\__construct().

---

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

• components/ILIAS/MetaData/classes/Services/Search/Searcher.php