SearcherInterface.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\MetaData\Services\Search;

use ILIAS\MetaData\Elements\RessourceID\RessourceIDInterface;
use ILIAS\MetaData\Search\Clauses\FactoryInterface;
use ILIAS\MetaData\Search\Clauses\ClauseInterface;
use ILIAS\MetaData\Search\Filters\FilterInterface;
use ILIAS\MetaData\Search\Filters\Placeholder;

interface SearcherInterface
{
    public function getClauseFactory(): FactoryInterface;

    public function getFilter(
        int|Placeholder $obj_id = Placeholder::ANY,
        int|Placeholder $sub_id = Placeholder::ANY,
        string|Placeholder $type = Placeholder::ANY
    ): FilterInterface;

    public function execute(
        ClauseInterface $clause,
        ?int $limit,
        ?int $offset,
        FilterInterface ...$filters
    ): \Generator;
}