Application
Table of Contents
Interfaces
- SpatialInterface
- AuthInterface
- Interface for metadata access authorization.
- RepoInterface
- RepoResourceInterface
- ParameterInterface
- ServiceInterface
- iTransformation
- An interface for dissemination services parameters transformation
- RepoResourceInterface
- MetaLookupInterface
- It is a common problem to couple binary data with their metadata.
- DeletedInterface
- Interface for OAI-PMH deleted records implementations.
- MetadataInterface
- Interface for different metadata providers.
- SearchInterface
- Interface for classes implementing OAI-PMH resources search.
- SetInterface
- Interface for OAI-PMH sets implementations.
- NamedEntityInterface
- NamedEntityIteratorInterface
- HandlerInterface
- Description of FormatInterface
- ResourceInterface
Classes
- Resource
- Maps ARCHE resource metadata to a BibLaTeX bibliographic entry.
- Auth
- Description of Auth
- BadRequestException
- Description of RepoException
- BinaryPayload
- Represents a request binary payload.
- ConflictException
- Description of RepoException
- Describe
- Handles the /desribe endpoint
- DuplicatedKeyException
- Description of RepoException
- MetadataManager
- Description of MetadataManager
- HandlersController
- Description of CallbackController
- Metadata
- Manages resources's metadata (loads from database or HTTP request, writes into
the database, serializes to RDF, etc.).
- MetadataGui
- Provides simple HTML serialization of a metadata triples set
- MetadataReadOnly
- Specialized version of the Metadata class.
- NoBinaryException
- Exception thrown by the BinaryPayload class when a resource has no binary
payload.
- RepoException
- Description of RepoException
- Resource
- Description of Resource
- RestController
- Description of RestController
- Search
- Description of Search
- Transaction
- Description of Transaction
- TransactionController
- Description of TransactionController
- UserApi
- Implements the REST API users management API
- OutputFile
- Outputs a file to a client optionally honoring the requested ranges.
- Spatial
- Provides SQL code for extracting geometries from various spatial formats
(geoJSON, KML, GML, raster images)
- Triple
- Description of Triple
- DashboardController
- DashboardHelper
- Description of DashboardHelper
- DisseminationServiceHelper
- Description of DisseminationServiceHelper
- DashboardModel
- Description of DashboardModel
- CacheFile
- DisseminationService
- Description of DisseminationService
- ArcheDashboardPathProcessor
- Doorkeeper
- Description of Doorkeeper
- DoorkeeperException
- Description of DoorkeeperException
- ClarinException
- Description of ClarinException
- Endpoint
- Description of Endpoint
- FcsException
- Description of FcsException
- SruException
- Description of SruException
- SruParameters
- A container for SRU parameters
- SruResponse
- Description of SruResponse
- Parser
- OASIS-CQL Parser
- ParserException
- Description of ParserException
- Term
- Description of Term
- Token
- Description of Token
- AcdhRepoGuiController
- Description of AcdhRepoController
- ArcheBaseController
- Description of ArcheBaseController
- ChildApiController
- Description of ChildApiController
- DetailViewController
- Description of DetailViewController
- DisseminationServicesController
- Description of DisseminationServicesController
- RootViewController
- Description of RootViewController
- SearchViewController
- Description of SearchViewController
- SmartSearchController
- Description of SearchViewController
- VersionsController
- Description of VersionsController
- AcdhRepoGuiConfigEventSubscriber
- AcdhRepoGuiEventSubscriber
- OpenAirTrackingEventSubscriber
- ComplexSearchForm
- ArcheHelper
- Description of ArcheHelper Static Class
- ChildApiHelper
- Description of ApiViewHelper
- DetailViewHelper
- Description of DetailViewHelper
- DisseminationServicesHelper
- Description of DisseminationServicesHelper
- FormHelper
- Description of FormHelper
- GeneralFunctions
- Description of GeneralFunctions
- MetadataGuiHelper
- Description of MetadataGuiHelper
- PagingHelper
- Description of PagingHelper
- RootViewHelper
- Description of RootViewHelper
- SearchViewHelper
- Description of SearchViewHelper
- ArcheModel
- Description of ArcheModel
- BlocksModel
- Description of DetailViewModel
- ChildApiModel
- Description of ApiModel
- DetailViewModel
- Description of DetailViewModel
- DisseminationServicesModel
- Description of DisseminationServicesModel
- GeneralFunctionsModel
- Description of DetailViewModel
- OntologyTwigExtensionModel
- Description of OntologyTwigExtensionModel
- RootViewModel
- Description of RootModel
- SearchViewModel
- Description of SearchViewModel
- BreadCrumbObject
- Description of BreadCrumbObject
- ClarinVCRObject
- Description of ClarinVCRObject
- ResourceObject
- ThreeDObject
- Description of ThreeDObject
- ToolTipObject
- Description of ToolTipObject
- AcdhRepoGuiPathProcessor
- ArcheVersionsBlock
- Provides a 'Version' block.
- LangSwitcherBlock
- Provides a 'LangSwitcherBlock' block.
- RepoSearchBlock
- Provides a 'SearchSD' block.
- SmartSearchBlock
- Provides a 'SmartSearchBlock' block.
- StartPageLeftBlock
- Provides a 'StartPageLeftBlock' block.
- VcrSubmitBlock
- Provides a 'VCR' block.
- exampleData
- GeneralFunctionsTest
- Tests GeneralFunctions
- ResourceObjectTest
- Tests ResourceObject
- PHPUnitUtil
- Description of PHPUnitUtil
- ArcheJsonDecoderExtension
- ArcheTwigDateExtension
- ComposerTwigExtension
- OntologyTwigExtension
- Description of OntologyTwigExtension
- ArcheApiBaseController
- Description of ArcheApiBaseController
- ArcheApiMainController
- Description of ArcheMainApiController
- ChildController
- Description of RPRController
- CollectionBinariesController
- Description of CollectionBinariesController
- CollectionController
- Description of CollectionController
- CollectionScriptController
- Description of CollectionScriptController
- BreadcrumbController
- Description of BreadcrumbController
- InverseDataController
- Description of GetInverseDataController
- RPRController
- Description of RPRController
- TurtleDissController
- Description of TurtleDissController
- FileFormatsHTMLController
- Description of MetadataGuiController
- GndPersonsController
- Description of GndPersonsController
- InverseDataController
- Description of GetInverseDataController
- MembersController
- Description of MembersController
- MetadataController
- Description of MetadataController
- MetadataController
- Description of MetadataController
- MetadataGuiController
- Description of MetadataGuiController
- MetadataGuiHTMLController
- Description of MetadataGuiController
- MetadataOverviewController
- Description of MetadataOverviewController
- RootTableController
- Description of RootTableController
- OntolgyJsController
- Description of OntolgyJsController
- RPRController
- Description of RPRController
- MainController
- Description of CollectionController
- SmartSearchController
- Description of SmartSearchController
- VersionsController
- Description of VersionsController
- FileFormatsHTMLHelper
- Description of MetadataGuiHTMLHelper
- MetadataApiJsonResponse
- MetadataGuiHelper
- Description of MetadataGuiHelper
- MetadataGuiHTMLHelper
- Description of MetadataGuiHTMLHelper
- Utils
- Description of Utils
- ArcheApiModel
- Description of ArcheApiModel
- ChildModel
- Description of RPRModel
- CollectionBinariesModel
- Description of CollectionBinariesModel
- CollectionModel
- Description of CollectionModel
- BreadcrumbModel
- Description of BreadcrumbModel
- InverseDataModel
- Description of InverseDataModel
- RPRModel
- Description of RPRModel
- GndPersonsModel
- Description of GndPersonsModel
- InverseDataModel
- Description of InverseDataModel
- MembersModel
- Description of MembersModel
- MetadataGuiModel
- Description of MetadataGuiModel
- MetadataModel
- Description of MetadataGuiModel
- RootTableModel
- Description of RootTableModel
- OntolgyJsModel
- Description of OntolgyJsModel
- RPRModel
- Description of RPRModel
- EntityTestModel
- Description of CollectionModel
- SearchBlockModel
- Description of CollectionModel
- ChildObject
- Description of RPRObject
- CollectionBinariesObject
- Description of CollectionBinariesObject
- CollectionObject
- Description of CollectionObject
- CollectionScriptObject
- Description of CollectionScriptObject
- TurtleDissObject
- Description of GndPersonObject
- FileFormatObject
- GndPersonsObject
- Description of GndPersonObject
- InverseDataObject
- Description of InverseDataObject
- MainObject
- Description of MainObject
- MembersObject
- Description of MembersObject
- MetadataGuiObject
- Description of MetadataObject
- RootTableObject
- Description of RootTableObject
- OntolgyJsObject
- Description of OntolgyJs
- RPRObject
- Description of RPRObject
- SearchBlockObject
- Description of CollectionObject
- VersionsObject
- Description of VersionsObject
- BinaryPayload
- Simple container for a request binary payload.
- Config
- A container for the yaml configuration allowing to satisfy phpstan checks
by mocking config properties hierarchy.
- AmbiguousMatch
- Description of AmbiguousMatch
- Conflict
- Exception representing the HTTP 409 Conflict return code
- Deleted
- Exception representing the HTTP 410 Gone return code
- ExceptionUtil
- Utility class for unwrapping errors
- NotFound
- Exception representing the HTTP 404 Not Found return code
- RepoLibException
- Description of RepoLibException
- GeneratorPromise
- Description of ResponsePromise
- GraphPromise
- Description of GraphPromise
- RepoResourcePromise
- Description of Psr7ResponsePromise
- ResponsePromise
- Description of Psr7ResponsePromise
- Repo
- A repository connection class.
- RepoDb
- Provides a read only access to the repository on the relational database level.
- RepoResource
- Description of RepoResource
- RepoResourceDb
- Provides a read-only access to the repository resource's metadata.
- RepoResourceResolver
- Returns repository resource object having a given id.
- Schema
- A container for configuration properties.
- SearchConfig
- Stores the repository search configuration, e.g. full text search options and pagination options.
- SearchTerm
- Describes a single search condition.
- SmartSearch
- Provides an API for advanced weighted
- TripleValue
- Simole container for an RDF triple value read from a database
- Format
- Container describing dissemination service return format.
- Parameter
- Represents a dissemination service parameter.
- ParameterDb
- Description of ParameterDb
- Service
- Represents a dissemination service.
- ServiceDb
- Description of ServiceDb
- AddParam
- Assuming value is an URL, adds a given query parameter value.
- Base64Encode
- Base64 encodes given value
- RawUrlEncode
- URL encodes given value
- RemoveProtocol
- URL encodes given value
- SetParam
- Assuming value is an URL, sets a given query parameter value.
- Substr
- Returns value's substring
- UriPart
- Assuming value is an URL extracts given parts of the URL.
- UrlEncode
- URL encodes given value
- RepoResource
- Description of RepoResource
- RepoResourceDb
- Description of RepoResourceDb
- File
- Description of File
- Indexer
- Ingests files into the repository
- IndexerException
- Exception used by the Indexer class, giving access to resources which were
commited when an error occured.
- MetadataCollection
- Class for importing whole metadata graph into the repository.
- MetaLookupConstant
- Returns a fixed set of metadata properties to every file.
- MetaLookupException
- Exception thrown when a resource metadata were not found in the external
source.
- MetaLookupFile
- Implements metadata lookup by searching in a given metadata locations for
a file with an original file name with a given extension appended.
- MetaLookupGraph
- Searches for file metadata inside an RDF graph.
- Redmine
- Helper for updating the ACDH Redmine issues documenting the curation process
- SkippedException
- Exception used to denoted a file has been skipped to to Indexer class
skip rules.
- SkosVocabulary
- A specialization of the MetadataCollection class for ingesting SKOS
vocabularies.
- ProgressMeter
- Helper class for displaying progress meter
- UUID
- Generates UUIDs
(see https://en.wikipedia.org/wiki/Universally_unique_identifier)
- BaseDesc
- Description of BaseDesc
- ClassDesc
- A container for and RDF class description
- Ontology
- Provides an API for the ARCHE oontology.
- PropertyDesc
- A container for an RDF property description
- RestrictionDesc
- A container for an OWL restriction description
- SkosConceptDesc
- Container class for a skos:Concept
- CheckIdentifierController
- Description of ConceptsController
API endpoint for METADATA Editor
- GetDataApiController
- Description of GetDataApiController
API endpoint for METADATA Editor
- MainController
- Description of MainController
- BaseOntologyController
- Description of BaseOntologyController
- MetadataController
- Description of MetadataController
- ConceptsController
- Description of ConceptsController
API endpoint for METADATA Editor
- OrganisationsController
- Description of OrganisationsController
- PersonsController
- Description of PersonsController
- PlacesController
- Description of PersonsController
- PublicationsController
- Description of PublicationsController
- CheckIdentifierModel
- Description of CheckIdentifierModel
- GetDataApiModel
- Description of OrganisationsModel
- MainApiModel
- Description of ArcheApiModel
- MetadataModel
- Description of MetadataModel
- ConceptsModel
- Description of PersonsModel
- OrganisationsModel
- Description of OrganisationsModel
- PersonsModel
- Description of PersonsModel
- PlacesModel
- Description of PlacesModel
- PublicationsModel
- Description of PublicationsModel
- CheckIdentifierObject
- Description of CheckIdentifierObject
- GetDataApiObject
- Description of GetDataApiObject
- MainObject
- Description of MainObject
- BaseOntologyObject
- Description of BaseOntologyObject
- MetadataObject
- Description of MetadataObject
- ConceptsObject
- Description of PersonsObject
- OrganisationsObject
- Description of OrganisationsObject
- PersonsObject
- Description of PersonsObject
- PlacesObject
- Description of PlacesObject
- PublicationsObject
- Description of PublicationsObject
- Cache
- Implements simple caching
- HeaderData
- Container for data required to generate OAI-PMH resource's header.
- MetadataFormat
- Container for OAI-PMH metada format data (both properties used by the OAI-PMH
protocol and by this implementation).
- RepositoryInfo
- Container for OAI-PMH repository information
- ResumptionTokenData
- Description of ResumptionTokenData
- SetInfo
- Simple container for OAI-PMH set data
(https://www.openarchives.org/OAI/openarchivesprotocol.html#Set)
- No
- Implementation of the `acdhOeaw\arche\oaipmh\deleted\DeletedInterface`
for repositories not providing data on deleted resources.
- RdfProperty
- Implementation of the `acdhOeaw\arche\oaipmh\deleted\DeletedInterface` deriving
information on a resource deletion from existence of a given RDF triple
in the resource metadata.
- Tombstone
- Description of Tombstone
- AcdhDcMetadata
- Creates OAI-PMH <metadata> element in Dublin Core format from
a FedoraResource RDF metadata.
- CmdiMetadata
- Specialization of ResMetadata class checking if the CMDI schema matches
metadata format requested by the user.
- DcMetadata
- Creates OAI-PMH <metadata> element in Dublin Core format from
a FedoraResource RDF metadata.
- LiveCmdiMetadata
- Creates <metadata> element by filling in an XML template with values
read from the repository resource's metadata.
- RdfXml
- Creates OAI-PMH <metadata> element in as an RDF-XML serialization of
a FedoraResource RDF metadata.
- ResMetadata
- Creates <metadata> element by simply taking binary content of another
repository resource.
- ValueMapper
- Provides vocabulary mappings. Assumes a value is an URL which can be resolved
to the RDF . Then extracts given property values from the RDF.
- Oai
- Implements controller for the OAI-PMH service:
- checks OAI-PMH requests correctness,
- handles OAI-PMH `identify` and `ListMetadataFormats` commands
- delegates OAI-PMH `GetRecord`, `ListIdentifiers` and `ListRecords` commands
to a chosen class implementing the `acdhOeaw\arche\oaipmh\search\SearchInterface`
- delegates OAI-PMH `ListSets` command to a chosen class extending the
`acdhOeaw\arche\oaipmh\set\SetInterface` class.
- OaiException
- Simple specialized exception class to easy distinguish between OAI-PMH and
internal exceptions.
- BaseSearch
- 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.
- Complex
- Provides full sets support.
- NoSets
- Implements proper reporting of repository without sets.
- Simple
- Provides very simple and straightforward implementation of sets.
- NamedEntityFile
- Description of RefResourceFile
- NamedEntityIteratorFile
- Description of NamedEntityIteratorFile
- NamedEntityIteratorRepo
- Description of NamedEntityIteratorRepo
- NamedEntityRepo
- Description of RefResourceRepo
- PropertyMapping
- Defines a single target ARCHE property mapping
- PropertyMappings
- Description of PropertyMappings
- RefSourcesException
- Description of RefSourcesException
- AccessRightsException
- Description of AccessRightsException
- Proxy
- Simple reverse proxy implementation for dissemination services.
- Resolver
- Resolves an URI being defined as an identifier of a repository object to
the proper dissemination method.
- Entity
- Description of Entity
- Metadata
- Description of Metadata
- Ontology
- Description of Ontology
- Property
- Description of Property
- RdfClass
- Description of Class
- Restriction
- Class checking ontology restrictions consistency.
- ClearCache
- Description of ClearCache
- FileToLargeException
- Description of FileToLargeException
- Fallback
- A fallback thumbnail handler creating a document-like icon filled with
the resource's mime type
- Image
- Creates thumbnails from image files by rescaling it to the desired resolution.
- Text
- Creates the resource thumbnail by plotting first few lines of a resource content.
- NoSuchFileException
- Description of NoSuchFile
- Resource
- Description of Resource
- ResourceMeta
- Description of ResourceMeta
- UriNormalizer
- A simply utility class normalizing the URIs
- UriNormalizerCache
- A PSR-16 compliant memory + (optional) sqlite database cache
for the UriNormalizer class.
- UriNormalizerException
- Description of UriNormalizerException
- UriNormalizerRule
- A container for a URI normalization rule
- UriNormalizerCacheTest
- Description of IndexerTest
- UriNormalizerRuleTest
- Description of IndexerTest
- UriNormalizerTest
- Description of IndexerTest
Traits
- DisseminationServiceTrait
- Description of DisseminationServiceInterface
- ArcheUtilTrait
- Description of ArcheHelper
- PromiseTrait
- Description of PromiseTrait
- RepoResourceTrait
- A common boilet plate code to be reused by all RepoResourceInterface
implementations.
- RepoTrait
- A common (mostly boiler plate) code for classes implementing the RepoInterface.
- ParameterTrait
- Description of ParameterTrait
- ServiceTrait
- Description of ServiceTrait
- RepoResourceTrait
- Description of RepoResourceTrait
- NamedEntityTrait
- Description of NamedEntityTrait