\acdhOeaw\oai\searchBaseSearch

Implements basic OAI-PMH search. It is assumed that all OAI-PMH search facets (id, date, set) and data required to create <header> nodes (again id, date, set) are accessible as repository resource's metadata RDF properties.

Mappings between OAI-PMH terms (id, date, set) and RDF properties is provided by the statically initialized acdhOeaw\util\RepoConfig class.

Includes metadataClass::extendSearchQuery() SPARQL query part in the performed search (where metadataClass is read from the metadata format descriptor).

Summary

Methods
Properties
Constants
__construct()
find()
getCount()
getHeader()
getMetadata()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
getIdFilter()
getDateFilter()
getSetFilter()
getSetClause()
getDeletedClause()
$format
$fedora
$records
N/A

Properties

$format

$format : \acdhOeaw\oai\MetadataFormat

Metadata format descriptor.

Type

\acdhOeaw\oai\MetadataFormat

$fedora

$fedora : \acdhOeaw\fedora\Fedora

Repository connection object

Type

\acdhOeaw\fedora\Fedora

$records

$records : array

Last search results

Type

array

Methods

__construct()

__construct(\acdhOeaw\oai\data\MetadataFormat  $format, \acdhOeaw\fedora\Fedora  $fedora) 

Creates a search engine object.

Parameters

\acdhOeaw\oai\data\MetadataFormat $format

metadata format descriptor

\acdhOeaw\fedora\Fedora $fedora

repository connection object

find()

find(string  $id, string  $from, string  $until, string  $set) 

Performs search using given filter values.

Parameters

string $id

id filter value

string $from

date from filter value

string $until

date to filter value

string $set

set filter value

getCount()

getCount() 

Returns number of resources matching last search (last call of the `find()` method).

getHeader()

getHeader(integer  $pos) : \acdhOeaw\oai\data\HeaderData

Provides the `HeaderData` object for a given search result.

Parameters

integer $pos

seach result resource index

Returns

\acdhOeaw\oai\data\HeaderData

getMetadata()

getMetadata(integer  $pos) : \acdhOeaw\oai\metadata\MetadataInterface

Provides the `MetadataInterface` object for a given search result.

The exact class of the returned object is defined by the class field of the metadata descriptor (see the $format parameter of the constructor method).

Parameters

integer $pos

seach result resource index

Returns

\acdhOeaw\oai\metadata\MetadataInterface

getIdFilter()

getIdFilter(string  $id) : string

Creates SPARQL query clause implementing the id filter.

Parameters

string $id

id filter value

Returns

string

getDateFilter()

getDateFilter(string  $from, string  $until) : string

Creates SPARQL clauses implementing the date filter.

Parameters

string $from

date from filter value

string $until

date to filter value

Returns

string

getSetFilter()

getSetFilter(string  $set) : string

Creates SPARQL clause implementing the set filter.

Parameters

string $set

set filter value

Returns

string

getSetClause()

getSetClause() : string

Creates SPARQL clause getting information on set membership

Returns

string

getDeletedClause()

getDeletedClause() : string

Cretes SPARQL clause getting information on resource deletion.

Returns

string