ApiController
extends ArcheBaseController
in package
Description of ArcheBaseController
Table of Contents
Properties
- $config : Config
- $helper : mixed
- $model : mixed
- $ontology : Ontology
- $pdo : PDO
- $repoDb : RepoDb
- $schema : Schema
- $siteLang : mixed
Methods
- __construct() : mixed
- archeChangeLanguage() : Response
- Change language session variable API Because of the special path handling, the basic language selector is not working
- breadcrumbData() : type
- Breadcrumb endpoint
- childData() : type
- The Child DataTable api endpoint
- childTreeData() : type
- The Child tree view api endpoint
- expertData() : JsonResponse
- Get all metadata for the given resource
- ontologyJs() : type
- Create the Ontology html table for the CKEDITOR
- publicationsDT() : type
- Publications datatable endpoint
- rootTable() : type
- Root table api endpoint: /browser/api/rootTable/en
- rprDT() : type
- Related resources and publications endpoint
- searchCoordinates() : type
- Smartsearch MAP coordinates - not in use anymore?
- smartSearch() : Response
- smartSearchAutoComplete() : Response
- smartSearchDateFacets() : Response
- topCollections() : JsonResponse
- Home page topcollections slider endpoint
- topCollectionsDT() : JsonResponse
- Top collections datatable view - not in use anymore?
- vcr() : Response
- CLARIN VCR
- versionsList() : type
- Resource versions data endpoint
- changeAPILanguage() : void
- If the API needs a different response language then we have to change the session lang params to get the desired lang string translation
- getCurrentLanguage() : type
- Get the site actual language
- setProps() : array<string|int, mixed>
Properties
$config
protected
Config
$config
$helper
protected
mixed
$helper
$model
protected
mixed
$model
$ontology
protected
Ontology
$ontology
$pdo
protected
PDO
$pdo
$repoDb
protected
RepoDb
$repoDb
$schema
protected
Schema
$schema
$siteLang
protected
mixed
$siteLang
Methods
__construct()
public
__construct() : mixed
archeChangeLanguage()
Change language session variable API Because of the special path handling, the basic language selector is not working
public
archeChangeLanguage([string $lng = 'en' ]) : Response
Parameters
- $lng : string = 'en'
Return values
ResponsebreadcrumbData()
Breadcrumb endpoint
public
breadcrumbData(string $id[, string $lang = "en" ]) : type
Parameters
- $id : string
- $lang : string = "en"
Return values
typechildData()
The Child DataTable api endpoint
public
childData(string $identifier, string $lang) : type
Parameters
- $identifier : string
- $lang : string
Return values
typechildTreeData()
The Child tree view api endpoint
public
childTreeData(string $identifier, string $lang) : type
Parameters
- $identifier : string
- $lang : string
Return values
typeexpertData()
Get all metadata for the given resource
public
expertData(string $id[, string $lang = "en" ]) : JsonResponse
Parameters
- $id : string
- $lang : string = "en"
Return values
JsonResponseontologyJs()
Create the Ontology html table for the CKEDITOR
public
ontologyJs(string $lang) : type
Parameters
- $lang : string
Return values
typepublicationsDT()
Publications datatable endpoint
public
publicationsDT(string $identifier, string $lang) : type
Parameters
- $identifier : string
- $lang : string
Return values
typerootTable()
Root table api endpoint: /browser/api/rootTable/en
public
rootTable(string $lang) : type
Parameters
- $lang : string
Return values
typerprDT()
Related resources and publications endpoint
public
rprDT(string $identifier, string $lang) : type
Parameters
- $identifier : string
- $lang : string
Return values
typesearchCoordinates()
Smartsearch MAP coordinates - not in use anymore?
public
searchCoordinates([string $lang = "en" ]) : type
Parameters
- $lang : string = "en"
Return values
typesmartSearch()
public
smartSearch() : Response
Return values
ResponsesmartSearchAutoComplete()
public
smartSearchAutoComplete(string $str) : Response
Parameters
- $str : string
Return values
ResponsesmartSearchDateFacets()
public
smartSearchDateFacets() : Response
Return values
ResponsetopCollections()
Home page topcollections slider endpoint
public
topCollections(int $count[, string $lang = "en" ]) : JsonResponse
Parameters
- $count : int
- $lang : string = "en"
Return values
JsonResponsetopCollectionsDT()
Top collections datatable view - not in use anymore?
public
topCollectionsDT([string $lang = "en" ]) : JsonResponse
Parameters
- $lang : string = "en"
Return values
JsonResponsevcr()
CLARIN VCR
public
vcr() : Response
Return values
ResponseversionsList()
Resource versions data endpoint
public
versionsList(string $identifier[, string $lang = "en" ]) : type
Parameters
- $identifier : string
- $lang : string = "en"
Return values
typechangeAPILanguage()
If the API needs a different response language then we have to change the session lang params to get the desired lang string translation
protected
changeAPILanguage(string $lang) : void
Parameters
- $lang : string
getCurrentLanguage()
Get the site actual language
private
getCurrentLanguage() : type
Return values
typesetProps()
private
setProps() : array<string|int, mixed>