API
in package
API hooks
Table of Contents
Properties
Methods
- getIdParam() : array<string|int, string>
- Extract ids or return an HTTP error
- getOrderParam() : string
- Extract the <order> GET parameter and return it
- getSqlMethodParam() : string
- Extract the <sqlMethod> GET parameter and return it
- setBibStyle() : mixed
- Extract the <bibStyle> GET parameter and set the current user style accordingly
- setLanguage() : mixed
- Extract the <language> GET parameter and set the current user locale accordingly
Properties
$bibCite
private
mixed
$bibCite
$db
private
mixed
$db
$vars
private
mixed
$vars
Methods
getIdParam()
Extract ids or return an HTTP error
private
getIdParam() : array<string|int, string>
Return ids passed with
Return values
array<string|int, string> —Array of Ids
getOrderParam()
Extract the <order> GET parameter and return it
private
getOrderParam() : string
Return values
string —Name of a field used to sort the result (Default is 'creatorSurname')
getSqlMethodParam()
Extract the <sqlMethod> GET parameter and return it
private
getSqlMethodParam() : string
Default is 'or' and unknown value fallback to 'or'.
Return values
string —Lowercase name of an SQL logical operator (and, or)
setBibStyle()
Extract the <bibStyle> GET parameter and set the current user style accordingly
private
setBibStyle() : mixed
If the style requested is unknown, the default Style configured for the CMS API is used.
setLanguage()
Extract the <language> GET parameter and set the current user locale accordingly
private
setLanguage() : mixed
If the language requested is unknown, the preferred application language is used.