ILIAS\MetaData\Copyright\Search\SearcherTest Class Reference

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

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

Public Member Functions
	testSearch ()
	testSearchWithMultipleEntries ()
	testSearchRestrictedToRepositoryObjects ()
	testSearchRestrictedToObjectType ()
	testSearchRestrictedToMultipleObjectTypes ()
	testSearchRestrictedToMultipleObjectTypesAndRepositoryObjects ()

Protected Member Functions
	getRessourceID (int $idx)
	assertCorrectSearchResults (RessourceIDInterface ... $ids)
	getLOMRepository ()
	getSearchFilterFactory ()
	getSearchClauseFactory ()
	getPathFactory ()
	getIdentifierHandler ()

Detailed Description

Definition at line 48 of file SearcherTest.php.

Member Function Documentation

assertCorrectSearchResults()

ILIAS\MetaData\Copyright\Search\SearcherTest::assertCorrectSearchResults ( RessourceIDInterface ...  $ids )

protected

Definition at line 59 of file SearcherTest.php.

Referenced by ILIAS\MetaData\Copyright\Search\SearcherTest\testSearch(), ILIAS\MetaData\Copyright\Search\SearcherTest\testSearchRestrictedToMultipleObjectTypes(), ILIAS\MetaData\Copyright\Search\SearcherTest\testSearchRestrictedToMultipleObjectTypesAndRepositoryObjects(), ILIAS\MetaData\Copyright\Search\SearcherTest\testSearchRestrictedToObjectType(), ILIAS\MetaData\Copyright\Search\SearcherTest\testSearchRestrictedToRepositoryObjects(), and ILIAS\MetaData\Copyright\Search\SearcherTest\testSearchWithMultipleEntries().

                                                                               : void
    {
        $this->assertCount(3, $ids);
        $this->assertSame(1, $ids[0]->idx);
        $this->assertSame(2, $ids[1]->idx);
        $this->assertSame(3, $ids[2]->idx);
    }

Here is the caller graph for this function:

getIdentifierHandler()

ILIAS\MetaData\Copyright\Search\SearcherTest::getIdentifierHandler ( )

protected

Definition at line 200 of file SearcherTest.php.

Referenced by ILIAS\MetaData\Copyright\Search\SearcherTest\testSearch(), ILIAS\MetaData\Copyright\Search\SearcherTest\testSearchRestrictedToMultipleObjectTypes(), ILIAS\MetaData\Copyright\Search\SearcherTest\testSearchRestrictedToMultipleObjectTypesAndRepositoryObjects(), ILIAS\MetaData\Copyright\Search\SearcherTest\testSearchRestrictedToObjectType(), ILIAS\MetaData\Copyright\Search\SearcherTest\testSearchRestrictedToRepositoryObjects(), and ILIAS\MetaData\Copyright\Search\SearcherTest\testSearchWithMultipleEntries().

                                             : IdentifierHandler
    {
        return new class () extends NullHandler {
            public function buildIdentifierFromEntryID(int $entry_id): string
            {
                return 'identifier_' . $entry_id;
            }
        };
    }

Here is the caller graph for this function:

getLOMRepository()

ILIAS\MetaData\Copyright\Search\SearcherTest::getLOMRepository ( )

protected

Definition at line 67 of file SearcherTest.php.

References ILIAS\__construct(), ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\from(), and ILIAS\MetaData\Copyright\Search\SearcherTest\getRessourceID().

Referenced by ILIAS\MetaData\Copyright\Search\SearcherTest\testSearch(), ILIAS\MetaData\Copyright\Search\SearcherTest\testSearchRestrictedToMultipleObjectTypes(), ILIAS\MetaData\Copyright\Search\SearcherTest\testSearchRestrictedToMultipleObjectTypesAndRepositoryObjects(), ILIAS\MetaData\Copyright\Search\SearcherTest\testSearchRestrictedToObjectType(), ILIAS\MetaData\Copyright\Search\SearcherTest\testSearchRestrictedToRepositoryObjects(), and ILIAS\MetaData\Copyright\Search\SearcherTest\testSearchWithMultipleEntries().

                                         : RepositoryInterface
    {
        $returns = [
            $this->getRessourceID(1),
            $this->getRessourceID(2),
            $this->getRessourceID(3)
        ];

        return new class ($returns) extends NullRepository {
            public array $exposed_searches = [];

            public function __construct(protected array $returns)
            {
            }

            public function searchMD(
                ClauseInterface $clause,
                ?int $limit,
                ?int $offset,
                FilterInterface ...$filters
            ): \Generator {
                $filter_data = [];
                foreach ($filters as $filter) {
                    $filter_data[] = $filter->exposed_data;
                }
                $this->exposed_searches[] = [
                    'clause' => $clause->exposed_data,
                    'limit' => $limit,
                    'offset' => $offset,
                    'filters' => $filter_data
                ];

                yield from $this->returns;
            }
        };
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPathFactory()

ILIAS\MetaData\Copyright\Search\SearcherTest::getPathFactory ( )

protected

Definition at line 166 of file SearcherTest.php.

References $path, ILIAS\__construct(), ILIAS\UI\examples\Chart\Bar\Horizontal\custom(), and ILIAS\Export\ImportHandler\File\XML\Manifest\toString.

Referenced by ILIAS\MetaData\Copyright\Search\SearcherTest\testSearch(), ILIAS\MetaData\Copyright\Search\SearcherTest\testSearchRestrictedToMultipleObjectTypes(), ILIAS\MetaData\Copyright\Search\SearcherTest\testSearchRestrictedToMultipleObjectTypesAndRepositoryObjects(), ILIAS\MetaData\Copyright\Search\SearcherTest\testSearchRestrictedToObjectType(), ILIAS\MetaData\Copyright\Search\SearcherTest\testSearchRestrictedToRepositoryObjects(), and ILIAS\MetaData\Copyright\Search\SearcherTest\testSearchWithMultipleEntries().

                                       : PathFactory
    {
        return new class () extends NullPathFactory {
            public function custom(): BuilderInterface
            {
                return new class () extends NullBuilder {
                    protected array $path = [];

                    public function withNextStep(string $name, bool $add_as_first = false): BuilderInterface
                    {
                        $clone = clone $this;
                        $clone->path[] = $name;
                        return $clone;
                    }

                    public function get(): PathInterface
                    {
                        $string = implode('>', $this->path);
                        return new class ($string) extends NullPath {
                            public function __construct(protected string $string)
                            {
                            }

                            public function toString(): string
                            {
                                return $this->string;
                            }
                        };
                    }
                };
            }
        };
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRessourceID()

ILIAS\MetaData\Copyright\Search\SearcherTest::getRessourceID ( int  $idx )

protected

Definition at line 50 of file SearcherTest.php.

References ILIAS\__construct().

Referenced by ILIAS\MetaData\Copyright\Search\SearcherTest\getLOMRepository().

                                               : RessourceIDInterface
    {
        return new class ($idx) extends NullRessourceID {
            public function __construct(public int $idx)
            {
            }
        };
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSearchClauseFactory()

ILIAS\MetaData\Copyright\Search\SearcherTest::getSearchClauseFactory ( )

protected

Definition at line 122 of file SearcherTest.php.

References $path, ILIAS\__construct(), and ILIAS\MetaData\Paths\PathInterface\toString().

Referenced by ILIAS\MetaData\Copyright\Search\SearcherTest\testSearch(), ILIAS\MetaData\Copyright\Search\SearcherTest\testSearchRestrictedToMultipleObjectTypes(), ILIAS\MetaData\Copyright\Search\SearcherTest\testSearchRestrictedToMultipleObjectTypesAndRepositoryObjects(), ILIAS\MetaData\Copyright\Search\SearcherTest\testSearchRestrictedToObjectType(), ILIAS\MetaData\Copyright\Search\SearcherTest\testSearchRestrictedToRepositoryObjects(), and ILIAS\MetaData\Copyright\Search\SearcherTest\testSearchWithMultipleEntries().

                                               : ClauseFactory
    {
        return new class () extends NullClauseFactory {
            public function getBasicClause(
                PathInterface $path,
                Mode $mode,
                string $value,
                bool $is_mode_negated = false
            ): ClauseInterface {
                $exposed = [
                    'path' => $path->toString(),
                    'mode' => $mode,
                    'value' => $value,
                    'is_mode_negated' => $is_mode_negated,
                ];
                return new class ($exposed) extends NullClause {
                    public function __construct(public array $exposed_data)
                    {
                    }
                };
            }

            public function getJoinedClauses(
                Operator $operator,
                ClauseInterface $first_clause,
                ClauseInterface ...$further_clauses
            ): ClauseInterface {
                $clause_data = [];
                foreach ([$first_clause, ...$further_clauses] as $clause) {
                    $clause_data[] = $clause->exposed_data;
                }
                $exposed = [
                    'operator' => $operator,
                    'subclauses' => $clause_data
                ];
                return new class ($exposed) extends NullClause {
                    public function __construct(public array $exposed_data)
                    {
                    }
                };
            }
        };
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSearchFilterFactory()

ILIAS\MetaData\Copyright\Search\SearcherTest::getSearchFilterFactory ( )

protected

Definition at line 104 of file SearcherTest.php.

References ILIAS\__construct(), and ILIAS\File\Capabilities\ANY.

Referenced by ILIAS\MetaData\Copyright\Search\SearcherTest\testSearch(), ILIAS\MetaData\Copyright\Search\SearcherTest\testSearchRestrictedToMultipleObjectTypes(), ILIAS\MetaData\Copyright\Search\SearcherTest\testSearchRestrictedToMultipleObjectTypesAndRepositoryObjects(), ILIAS\MetaData\Copyright\Search\SearcherTest\testSearchRestrictedToObjectType(), ILIAS\MetaData\Copyright\Search\SearcherTest\testSearchRestrictedToRepositoryObjects(), and ILIAS\MetaData\Copyright\Search\SearcherTest\testSearchWithMultipleEntries().

                                               : FilterFactory
    {
        return new class () extends NullFilterFactory {
            public function get(
                Placeholder|int $obj_id = Placeholder::ANY,
                Placeholder|int $sub_id = Placeholder::ANY,
                Placeholder|string $type = Placeholder::ANY
            ): FilterInterface {
                $exposed = ['obj_id' => $obj_id, 'sub_id' => $sub_id, 'type' => $type];
                return new class ($exposed) extends NullFilter {
                    public function __construct(public array $exposed_data)
                    {
                    }
                };
            }
        };
    }

Here is the call graph for this function:

Here is the caller graph for this function:

testSearch()

ILIAS\MetaData\Copyright\Search\SearcherTest::testSearch

(

)

Definition at line 210 of file SearcherTest.php.

References $results, ILIAS\MetaData\Copyright\Search\SearcherTest\assertCorrectSearchResults(), ILIAS\MetaData\Copyright\Search\SearcherTest\getIdentifierHandler(), ILIAS\MetaData\Copyright\Search\SearcherTest\getLOMRepository(), ILIAS\MetaData\Copyright\Search\SearcherTest\getPathFactory(), ILIAS\MetaData\Copyright\Search\SearcherTest\getSearchClauseFactory(), ILIAS\MetaData\Copyright\Search\SearcherTest\getSearchFilterFactory(), null, and ILIAS\MetaData\Search\Clauses\OR.

                                : void
    {
        $searcher = new Searcher(
            $this->getSearchFilterFactory(),
            $this->getSearchClauseFactory(),
            $this->getPathFactory(),
            $this->getIdentifierHandler()
        );

        $results = $searcher->search($repo = $this->getLOMRepository(), 32);

        $this->assertCorrectSearchResults(...$results);
        $this->assertEquals(
            [[
                'clause' => [
                    'operator' => Operator::OR,
                    'subclauses' => [[
                        'path' => 'rights>description>string',
                        'mode' => Mode::EQUALS,
                        'value' => 'identifier_32',
                        'is_mode_negated' => false
                    ]]
                ],
                'limit' => null,
                'offset' => null,
                'filters' => []
            ]],
            $repo->exposed_searches
        );
    }

Here is the call graph for this function:

testSearchRestrictedToMultipleObjectTypes()

ILIAS\MetaData\Copyright\Search\SearcherTest::testSearchRestrictedToMultipleObjectTypes

(

)

Definition at line 362 of file SearcherTest.php.

References $results, ILIAS\File\Capabilities\ANY, ILIAS\MetaData\Copyright\Search\SearcherTest\assertCorrectSearchResults(), ILIAS\MetaData\Copyright\Search\SearcherTest\getIdentifierHandler(), ILIAS\MetaData\Copyright\Search\SearcherTest\getLOMRepository(), ILIAS\MetaData\Copyright\Search\SearcherTest\getPathFactory(), ILIAS\MetaData\Copyright\Search\SearcherTest\getSearchClauseFactory(), ILIAS\MetaData\Copyright\Search\SearcherTest\getSearchFilterFactory(), null, and ILIAS\MetaData\Search\Clauses\OR.

                                                               : void
    {
        $searcher = new Searcher(
            $this->getSearchFilterFactory(),
            $this->getSearchClauseFactory(),
            $this->getPathFactory(),
            $this->getIdentifierHandler()
        );

        $results = $searcher->withAdditionalTypeFilter('some type')
                            ->withAdditionalTypeFilter('some other type')
                            ->withAdditionalTypeFilter('a third type')
                            ->search($repo = $this->getLOMRepository(), 32);

        $this->assertCorrectSearchResults(...$results);
        $this->assertEquals(
            [[
                 'clause' => [
                     'operator' => Operator::OR,
                     'subclauses' => [[
                         'path' => 'rights>description>string',
                         'mode' => Mode::EQUALS,
                         'value' => 'identifier_32',
                         'is_mode_negated' => false
                     ]]
                 ],
                 'limit' => null,
                 'offset' => null,
                 'filters' => [
                     [
                         'obj_id' => Placeholder::ANY,
                         'sub_id' => Placeholder::ANY,
                         'type' => 'some type'
                     ],
                     [
                         'obj_id' => Placeholder::ANY,
                         'sub_id' => Placeholder::ANY,
                         'type' => 'some other type'
                     ],
                     [
                         'obj_id' => Placeholder::ANY,
                         'sub_id' => Placeholder::ANY,
                         'type' => 'a third type'
                     ]
                 ]
             ]],
            $repo->exposed_searches
        );
    }

Here is the call graph for this function:

testSearchRestrictedToMultipleObjectTypesAndRepositoryObjects()

ILIAS\MetaData\Copyright\Search\SearcherTest::testSearchRestrictedToMultipleObjectTypesAndRepositoryObjects

(

)

Definition at line 412 of file SearcherTest.php.

References $results, ILIAS\File\Capabilities\ANY, ILIAS\MetaData\Copyright\Search\SearcherTest\assertCorrectSearchResults(), ILIAS\MetaData\Copyright\Search\SearcherTest\getIdentifierHandler(), ILIAS\MetaData\Copyright\Search\SearcherTest\getLOMRepository(), ILIAS\MetaData\Copyright\Search\SearcherTest\getPathFactory(), ILIAS\MetaData\Copyright\Search\SearcherTest\getSearchClauseFactory(), ILIAS\MetaData\Copyright\Search\SearcherTest\getSearchFilterFactory(), null, and ILIAS\MetaData\Search\Clauses\OR.

                                                                                   : void
    {
        $searcher = new Searcher(
            $this->getSearchFilterFactory(),
            $this->getSearchClauseFactory(),
            $this->getPathFactory(),
            $this->getIdentifierHandler()
        );

        $results = $searcher->withAdditionalTypeFilter('some type')
                            ->withAdditionalTypeFilter('some other type')
                            ->withAdditionalTypeFilter('a third type')
                            ->withRestrictionToRepositoryObjects(true)
                            ->search($repo = $this->getLOMRepository(), 32);

        $this->assertCorrectSearchResults(...$results);
        $this->assertEquals(
            [[
                 'clause' => [
                     'operator' => Operator::OR,
                     'subclauses' => [[
                         'path' => 'rights>description>string',
                         'mode' => Mode::EQUALS,
                         'value' => 'identifier_32',
                         'is_mode_negated' => false
                     ]]
                 ],
                 'limit' => null,
                 'offset' => null,
                 'filters' => [
                     [
                         'obj_id' => Placeholder::ANY,
                         'sub_id' => Placeholder::OBJ_ID,
                         'type' => 'some type'
                     ],
                     [
                         'obj_id' => Placeholder::ANY,
                         'sub_id' => Placeholder::OBJ_ID,
                         'type' => 'some other type'
                     ],
                     [
                         'obj_id' => Placeholder::ANY,
                         'sub_id' => Placeholder::OBJ_ID,
                         'type' => 'a third type'
                     ]
                 ]
             ]],
            $repo->exposed_searches
        );
    }

Here is the call graph for this function:

testSearchRestrictedToObjectType()

ILIAS\MetaData\Copyright\Search\SearcherTest::testSearchRestrictedToObjectType

(

)

Definition at line 324 of file SearcherTest.php.

References $results, ILIAS\File\Capabilities\ANY, ILIAS\MetaData\Copyright\Search\SearcherTest\assertCorrectSearchResults(), ILIAS\MetaData\Copyright\Search\SearcherTest\getIdentifierHandler(), ILIAS\MetaData\Copyright\Search\SearcherTest\getLOMRepository(), ILIAS\MetaData\Copyright\Search\SearcherTest\getPathFactory(), ILIAS\MetaData\Copyright\Search\SearcherTest\getSearchClauseFactory(), ILIAS\MetaData\Copyright\Search\SearcherTest\getSearchFilterFactory(), null, and ILIAS\MetaData\Search\Clauses\OR.

                                                      : void
    {
        $searcher = new Searcher(
            $this->getSearchFilterFactory(),
            $this->getSearchClauseFactory(),
            $this->getPathFactory(),
            $this->getIdentifierHandler()
        );

        $results = $searcher->withAdditionalTypeFilter('some type')
                            ->search($repo = $this->getLOMRepository(), 32);

        $this->assertCorrectSearchResults(...$results);
        $this->assertEquals(
            [[
                 'clause' => [
                     'operator' => Operator::OR,
                     'subclauses' => [[
                         'path' => 'rights>description>string',
                         'mode' => Mode::EQUALS,
                         'value' => 'identifier_32',
                         'is_mode_negated' => false
                     ]]
                 ],
                 'limit' => null,
                 'offset' => null,
                 'filters' => [
                     [
                         'obj_id' => Placeholder::ANY,
                         'sub_id' => Placeholder::ANY,
                         'type' => 'some type'
                     ]
                 ]
             ]],
            $repo->exposed_searches
        );
    }

Here is the call graph for this function:

testSearchRestrictedToRepositoryObjects()

ILIAS\MetaData\Copyright\Search\SearcherTest::testSearchRestrictedToRepositoryObjects

(

)

Definition at line 286 of file SearcherTest.php.

References $results, ILIAS\File\Capabilities\ANY, ILIAS\MetaData\Copyright\Search\SearcherTest\assertCorrectSearchResults(), ILIAS\MetaData\Copyright\Search\SearcherTest\getIdentifierHandler(), ILIAS\MetaData\Copyright\Search\SearcherTest\getLOMRepository(), ILIAS\MetaData\Copyright\Search\SearcherTest\getPathFactory(), ILIAS\MetaData\Copyright\Search\SearcherTest\getSearchClauseFactory(), ILIAS\MetaData\Copyright\Search\SearcherTest\getSearchFilterFactory(), null, and ILIAS\MetaData\Search\Clauses\OR.

                                                             : void
    {
        $searcher = new Searcher(
            $this->getSearchFilterFactory(),
            $this->getSearchClauseFactory(),
            $this->getPathFactory(),
            $this->getIdentifierHandler()
        );

        $results = $searcher->withRestrictionToRepositoryObjects(true)
                            ->search($repo = $this->getLOMRepository(), 32);

        $this->assertCorrectSearchResults(...$results);
        $this->assertEquals(
            [[
                 'clause' => [
                     'operator' => Operator::OR,
                     'subclauses' => [[
                         'path' => 'rights>description>string',
                         'mode' => Mode::EQUALS,
                         'value' => 'identifier_32',
                         'is_mode_negated' => false
                     ]]
                 ],
                 'limit' => null,
                 'offset' => null,
                 'filters' => [
                     [
                         'obj_id' => Placeholder::ANY,
                         'sub_id' => Placeholder::OBJ_ID,
                         'type' => Placeholder::ANY
                     ]
                 ]
             ]],
            $repo->exposed_searches
        );
    }

Here is the call graph for this function:

testSearchWithMultipleEntries()

ILIAS\MetaData\Copyright\Search\SearcherTest::testSearchWithMultipleEntries

(

)

Definition at line 241 of file SearcherTest.php.

References $results, ILIAS\MetaData\Copyright\Search\SearcherTest\assertCorrectSearchResults(), ILIAS\MetaData\Copyright\Search\SearcherTest\getIdentifierHandler(), ILIAS\MetaData\Copyright\Search\SearcherTest\getLOMRepository(), ILIAS\MetaData\Copyright\Search\SearcherTest\getPathFactory(), ILIAS\MetaData\Copyright\Search\SearcherTest\getSearchClauseFactory(), ILIAS\MetaData\Copyright\Search\SearcherTest\getSearchFilterFactory(), null, and ILIAS\MetaData\Search\Clauses\OR.

                                                   : void
    {
        $searcher = new Searcher(
            $this->getSearchFilterFactory(),
            $this->getSearchClauseFactory(),
            $this->getPathFactory(),
            $this->getIdentifierHandler()
        );

        $results = $searcher->search($repo = $this->getLOMRepository(), 32, 9, 1234);

        $this->assertCorrectSearchResults(...$results);
        $this->assertEquals(
            [[
                 'clause' => [
                     'operator' => Operator::OR,
                     'subclauses' => [
                         [
                             'path' => 'rights>description>string',
                             'mode' => Mode::EQUALS,
                             'value' => 'identifier_32',
                             'is_mode_negated' => false
                         ],
                         [
                             'path' => 'rights>description>string',
                             'mode' => Mode::EQUALS,
                             'value' => 'identifier_9',
                             'is_mode_negated' => false
                         ],
                         [
                             'path' => 'rights>description>string',
                             'mode' => Mode::EQUALS,
                             'value' => 'identifier_1234',
                             'is_mode_negated' => false
                         ]
                     ]
                 ],
                 'limit' => null,
                 'offset' => null,
                 'filters' => []
             ]],
            $repo->exposed_searches
        );
    }

Here is the call graph for this function:

---

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

• components/ILIAS/MetaData/tests/Copyright/Search/SearcherTest.php