Documentation

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
checkUserPersmission()  : type
Check the user permission of the actual resource
childData()  : type
The Child DataTable api endpoint
childTreeData()  : type
The Child tree view api endpoint
collectionConceptDT()  : type
ConceptScheme collection content datatable
contributedDT()  : type
Person contributed DT
expertData()  : JsonResponse
Get all metadata for the given resource
get3DURL()  : type
Download and get the 3d object file url
hasMembersDT()  : type
Organisation inverse of ismemberof
involvedDT()  : type
Organisation invvoled DT
isPartOfDT()  : mixed
nextPrevItem()  : type
Get the next and previous child elements
ontologyJs()  : type
Create the Ontology html table for the CKEDITOR
publicationsDT()  : type
Publications datatable endpoint
relatedDT()  : type
Related resources data table
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
The magic smart search function
smartSearchAutoComplete()  : Response
smartSearchDateFacets()  : Response
spatialDT()  : type
Place spatial DT
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
checkTmpDirs()  : mixed
getCurrentLanguage()  : type
Get the site actual language
setProps()  : array<string|int, mixed>

Properties

Methods

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
Response

breadcrumbData()

Breadcrumb endpoint

public breadcrumbData(string $id[, string $lang = "en" ]) : type
Parameters
$id : string
$lang : string = "en"
Return values
type

checkUserPersmission()

Check the user permission of the actual resource

public checkUserPersmission(string $identifier, string $aclRead) : type
Parameters
$identifier : string
$aclRead : string
Return values
type

childData()

The Child DataTable api endpoint

public childData(string $identifier, string $lang) : type
Parameters
$identifier : string
$lang : string
Return values
type

childTreeData()

The Child tree view api endpoint

public childTreeData(string $identifier, string $lang) : type
Parameters
$identifier : string
$lang : string
Return values
type

collectionConceptDT()

ConceptScheme collection content datatable

public collectionConceptDT(string $identifier, string $lang) : type
Parameters
$identifier : string
$lang : string
Return values
type

contributedDT()

Person contributed DT

public contributedDT(string $identifier, string $lang) : type
Parameters
$identifier : string
$lang : string
Return values
type

expertData()

Get all metadata for the given resource

public expertData(string $id[, string $lang = "en" ]) : JsonResponse
Parameters
$id : string
$lang : string = "en"
Return values
JsonResponse

get3DURL()

Download and get the 3d object file url

public get3DURL(string $identifier) : type
Parameters
$identifier : string
Return values
type

hasMembersDT()

Organisation inverse of ismemberof

public hasMembersDT(string $identifier, string $lang) : type
Parameters
$identifier : string
$lang : string
Return values
type

involvedDT()

Organisation invvoled DT

public involvedDT(string $identifier, string $lang) : type
Parameters
$identifier : string
$lang : string
Return values
type

isPartOfDT()

public isPartOfDT(string $identifier, string $lang) : mixed
Parameters
$identifier : string
$lang : string

nextPrevItem()

Get the next and previous child elements

public nextPrevItem(string $rootId, string $resourceId, string $lang) : type
Parameters
$rootId : string
$resourceId : string
$lang : string
Return values
type

ontologyJs()

Create the Ontology html table for the CKEDITOR

public ontologyJs(string $lang) : type
Parameters
$lang : string
Return values
type

publicationsDT()

Publications datatable endpoint

public publicationsDT(string $identifier, string $lang) : type
Parameters
$identifier : string
$lang : string
Return values
type

relatedDT()

Related resources data table

public relatedDT(string $identifier, string $lang) : type
Parameters
$identifier : string
$lang : string
Return values
type

rootTable()

Root table api endpoint: /browser/api/rootTable/en

public rootTable(string $lang) : type
Parameters
$lang : string
Return values
type

rprDT()

Related resources and publications endpoint

public rprDT(string $identifier, string $lang) : type
Parameters
$identifier : string
$lang : string
Return values
type

searchCoordinates()

Smartsearch MAP coordinates - not in use anymore?

public searchCoordinates([string $lang = "en" ]) : type
Parameters
$lang : string = "en"
Return values
type

smartSearch()

The magic smart search function

public smartSearch() : Response
Return values
Response

smartSearchAutoComplete()

public smartSearchAutoComplete(string $str) : Response
Parameters
$str : string
Return values
Response

smartSearchDateFacets()

public smartSearchDateFacets() : Response
Return values
Response

spatialDT()

Place spatial DT

public spatialDT(string $identifier, string $lang) : type
Parameters
$identifier : string
$lang : string
Return values
type

topCollections()

Home page topcollections slider endpoint

public topCollections(int $count[, string $lang = "en" ]) : JsonResponse
Parameters
$count : int
$lang : string = "en"
Return values
JsonResponse

topCollectionsDT()

Top collections datatable view - not in use anymore?

public topCollectionsDT([string $lang = "en" ]) : JsonResponse
Parameters
$lang : string = "en"
Return values
JsonResponse

vcr()

CLARIN VCR

public vcr() : Response
Return values
Response

versionsList()

Resource versions data endpoint

public versionsList(string $identifier[, string $lang = "en" ]) : type
Parameters
$identifier : string
$lang : string = "en"
Return values
type

changeAPILanguage()

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
type

setProps()

private setProps() : array<string|int, mixed>
Return values
array<string|int, mixed>

        
On this page

Search results