Documentation

ChildApiModel extends ArcheModel
in package

Description of ApiModel

Tags
author

nczirjak

Table of Contents

Properties

$config  : mixed
$drupalDb  : mixed
$limit  : mixed
$offset  : mixed
$order  : mixed
$repoDb  : mixed
$siteLang  : mixed
$childProperties  : mixed
$data  : mixed
$rootAcdhType  : mixed
$sqlTypes  : mixed

Methods

__construct()  : mixed
getAcdhtype()  : string
getCount()  : int
Get the number of the child resources for the pagination
getPropertiesByClass()  : array<string|int, mixed>
Get the properties for the sql search by the root resource acdh type
getViewData()  : array<string|int, mixed>
Get the actual page view data
setSqlTimeout()  : mixed
Set the sql execution max time
closeDBConnection()  : mixed
ordering()  : object
Create the order values for the sql
orderingByFields()  : object
reOrderResult()  : array<string|int, mixed>
Reorder the result because of the easyrdf
setActiveConnection()  : mixed
Allow the DB connection
sortAssociativeArrayByKey()  : array<string|int, mixed>
Reorder the Easyrdf result because the dataset is already filtered by the API But the actual order is not possible from the easyrdf, so we have to sort is manually.
checkChildProperties()  : mixed
Check the root for the special properties
formatTypeFilter()  : string
Format the acdh type for the sql query as an array
getChildTypes()  : array<string|int, mixed>
getConceptTypes()  : mixed
getInstituteTypes()  : array<string|int, mixed>
getOrganisationTypes()  : array<string|int, mixed>
getPersonTypes()  : array<string|int, mixed>
getPlaceTypes()  : array<string|int, mixed>
getProjectTypes()  : array<string|int, mixed>
getProperties()  : string
Get the root resource acdh type
getPublicationTypes()  : array<string|int, mixed>

Properties

Methods

getAcdhtype()

public getAcdhtype() : string
Return values
string

getCount()

Get the number of the child resources for the pagination

public getCount(string $identifier) : int
Parameters
$identifier : string
Return values
int

getPropertiesByClass()

Get the properties for the sql search by the root resource acdh type

public getPropertiesByClass(string $repoid) : array<string|int, mixed>
Parameters
$repoid : string
Return values
array<string|int, mixed>

getViewData()

Get the actual page view data

public getViewData([string $identifier = "" ][, int $limit = 10 ][, int $page = 0 ][, string $orderby = "titleasc" ]) : array<string|int, mixed>
Parameters
$identifier : string = ""
$limit : int = 10
$page : int = 0
$orderby : string = "titleasc"
Return values
array<string|int, mixed>

setSqlTimeout()

Set the sql execution max time

public setSqlTimeout([string $timeout = '7000' ]) : mixed
Parameters
$timeout : string = '7000'

closeDBConnection()

protected closeDBConnection() : mixed

ordering()

Create the order values for the sql

protected ordering([string $orderby = "titleasc" ]) : object
Parameters
$orderby : string = "titleasc"
Return values
object

orderingByFields()

protected orderingByFields(array<string|int, mixed> $valuesAndFields[, string $orderby = "titleasc" ]) : object
Parameters
$valuesAndFields : array<string|int, mixed>
$orderby : string = "titleasc"
Return values
object

reOrderResult()

Reorder the result because of the easyrdf

protected reOrderResult(array<string|int, mixed> $data, string $order) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>
$order : string
Return values
array<string|int, mixed>

setActiveConnection()

Allow the DB connection

protected setActiveConnection() : mixed

sortAssociativeArrayByKey()

Reorder the Easyrdf result because the dataset is already filtered by the API But the actual order is not possible from the easyrdf, so we have to sort is manually.

protected sortAssociativeArrayByKey(array<string|int, mixed> $array, string $key, string $direction) : array<string|int, mixed>

.

Parameters
$array : array<string|int, mixed>
$key : string
$direction : string
Return values
array<string|int, mixed>

checkChildProperties()

Check the root for the special properties

private checkChildProperties(string $class) : mixed
Parameters
$class : string

formatTypeFilter()

Format the acdh type for the sql query as an array

private formatTypeFilter() : string
Return values
string

getChildTypes()

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

getInstituteTypes()

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

getOrganisationTypes()

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

getPersonTypes()

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

getPlaceTypes()

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

getProjectTypes()

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

getProperties()

Get the root resource acdh type

private getProperties(string $repoid) : string
Parameters
$repoid : string
Return values
string

getPublicationTypes()

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

        
On this page

Search results