MetadataInterface
in
Interface for different metadata providers.
OAI-PMH metadata can be generated in various ways. This interface provides a common API enabling the \acdhOeaw\arche\oaipmh\Oai class to handle metadata no matter how they are generated.
Tags
Table of Contents
Methods
- __construct() : mixed
- Creates a metadata object for a given repository resource.
- extendSearchDataQuery() : QueryPart
- Allows to extend a search query with additional clauses specific to the given metadata source.
- extendSearchFilterQuery() : QueryPart
- Allows to extend a search query with additional clauses specific to the given metadata source.
- getXml() : DOMElement
- Returns resource's XML metadata
Methods
__construct()
Creates a metadata object for a given repository resource.
public
__construct(RepoResourceDb $resource, object $searchResultRow, MetadataFormat $format) : mixed
Parameters
- $resource : RepoResourceDb
-
a repository resource object
- $searchResultRow : object
-
SPARQL search query result row
- $format : MetadataFormat
-
metadata format descriptor describing this resource
extendSearchDataQuery()
Allows to extend a search query with additional clauses specific to the given metadata source.
public
static extendSearchDataQuery(MetadataFormat $format) : QueryPart
Remark! PHP doesn't consider static methods as an interface part therefore existance of this method in classes implementing this interface is not enforced.
Parameters
- $format : MetadataFormat
-
metadata format descriptor
Return values
QueryPartextendSearchFilterQuery()
Allows to extend a search query with additional clauses specific to the given metadata source.
public
static extendSearchFilterQuery(MetadataFormat $format) : QueryPart
Remark! PHP doesn't consider static methods as an interface part therefore existance of this method in classes implementing this interface is not enforced.
Parameters
- $format : MetadataFormat
-
metadata format descriptor
Return values
QueryPartgetXml()
Returns resource's XML metadata
public
getXml() : DOMElement