ILIAS\MetaData\Copyright\Search\Searcher Class Reference

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

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

Public Member Functions
	__construct (SearchFilterFactory $search_filter_factory, SearchClauseFactory $search_clause_factory, PathFactory $path_factory, CopyrightIdentifierHandler $copyright_identifier_handler,)
	search (LOMRepository $lom_repository, int $first_entry_id, int ... $further_entry_ids)
	withRestrictionToRepositoryObjects (bool $restricted)
	withAdditionalTypeFilter (string $type)

Protected Attributes
SearchFilterFactory	$search_filter_factory
SearchClauseFactory	$search_clause_factory
PathFactory	$path_factory
CopyrightIdentifierHandler	$copyright_identifier_handler
array	$types = []
bool	$restricted_to_repo_objects = false

Detailed Description

Definition at line 33 of file Searcher.php.

Constructor & Destructor Documentation

__construct()

ILIAS\MetaData\Copyright\Search\Searcher::__construct	(	SearchFilterFactory	$search_filter_factory,
		SearchClauseFactory	$search_clause_factory,
		PathFactory	$path_factory,
		CopyrightIdentifierHandler	$copyright_identifier_handler
	)

Definition at line 46 of file Searcher.php.

References ILIAS\MetaData\Copyright\Search\Searcher\$copyright_identifier_handler, ILIAS\MetaData\Copyright\Search\Searcher\$path_factory, ILIAS\MetaData\Copyright\Search\Searcher\$search_clause_factory, and ILIAS\MetaData\Copyright\Search\Searcher\$search_filter_factory.

      {
        $this->search_filter_factory = $search_filter_factory;
        $this->search_clause_factory = $search_clause_factory;
        $this->path_factory = $path_factory;
        $this->copyright_identifier_handler = $copyright_identifier_handler;
    }

Member Function Documentation

search()

ILIAS\MetaData\Copyright\Search\Searcher::search	(	LOMRepository	$lom_repository,
		int	$first_entry_id,
		int ...	$further_entry_ids
	)

Returns

RessourceIDInterface[]

Implements ILIAS\MetaData\Copyright\Search\SearcherInterface.

Definition at line 61 of file Searcher.php.

References ILIAS\File\Capabilities\ANY, ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\from(), null, and ILIAS\MetaData\Search\Clauses\OR.

     : \Generator {
        $path_to_copyright = $this->path_factory->custom()
                                                ->withNextStep('rights')
                                                ->withNextStep('description')
                                                ->withNextStep('string')
                                                ->get();

        $copyright_search_clauses = [];
        foreach ([$first_entry_id, ...$further_entry_ids] as $entry_id) {
            $copyright_search_clauses[] = $this->search_clause_factory->getBasicClause(
                $path_to_copyright,
                Mode::EQUALS,
                $this->copyright_identifier_handler->buildIdentifierFromEntryID($entry_id)
            );
        }
        $full_search_clause = $this->search_clause_factory->getJoinedClauses(
            Operator::OR,
            ...$copyright_search_clauses
        );

        $filters = [];
        foreach ($this->types as $type) {
            $filters[] = $this->search_filter_factory->get(
                Placeholder::ANY,
                $this->restricted_to_repo_objects ? Placeholder::OBJ_ID : Placeholder::ANY,
                $type
            );
        }
        if (empty($filters) && $this->restricted_to_repo_objects) {
            $filters[] = $this->search_filter_factory->get(
                Placeholder::ANY,
                Placeholder::OBJ_ID,
                Placeholder::ANY
            );
        }

        yield from $lom_repository->searchMD($full_search_clause, null, null, ...$filters);
    }

Here is the call graph for this function:

withAdditionalTypeFilter()

ILIAS\MetaData\Copyright\Search\Searcher::withAdditionalTypeFilter

(

string

$type

)

Implements ILIAS\MetaData\Copyright\Search\SearcherInterface.

Definition at line 111 of file Searcher.php.

                                                          : SearcherInterface
    {
        $clone = clone $this;
        $clone->types[] = $type;
        return $clone;
    }

withRestrictionToRepositoryObjects()

ILIAS\MetaData\Copyright\Search\Searcher::withRestrictionToRepositoryObjects

(

bool

$restricted

)

Implements ILIAS\MetaData\Copyright\Search\SearcherInterface.

Definition at line 104 of file Searcher.php.

                                                                        : SearcherInterface
    {
        $clone = clone $this;
        $clone->restricted_to_repo_objects = $restricted;
        return $clone;
    }

Field Documentation

$copyright_identifier_handler

CopyrightIdentifierHandler ILIAS\MetaData\Copyright\Search\Searcher::$copyright_identifier_handler

protected

Definition at line 38 of file Searcher.php.

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

$path_factory

PathFactory ILIAS\MetaData\Copyright\Search\Searcher::$path_factory

protected

Definition at line 37 of file Searcher.php.

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

$restricted_to_repo_objects

bool ILIAS\MetaData\Copyright\Search\Searcher::$restricted_to_repo_objects = false

protected

Definition at line 44 of file Searcher.php.

$search_clause_factory

SearchClauseFactory ILIAS\MetaData\Copyright\Search\Searcher::$search_clause_factory

protected

Definition at line 36 of file Searcher.php.

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

$search_filter_factory

SearchFilterFactory ILIAS\MetaData\Copyright\Search\Searcher::$search_filter_factory

protected

Definition at line 35 of file Searcher.php.

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

$types

array ILIAS\MetaData\Copyright\Search\Searcher::$types = []

protected

Definition at line 43 of file Searcher.php.

---

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

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