LISTSESSION.php
WIKINDX : Bibliographic Management system.
Tags
Table of Contents
Functions
- handleParams() : array<string|int, mixed>
- Handle the params array and act as a gateway to other functions
- initialiseParams() : array<string|int, mixed>
- Initialise params for each type of list.
- commonInit() : array<string|int, mixed>
- Initialise common list parameters
- qsearchInit() : array<string|int, mixed>
- Initialise qsearch parameters
- citeInit() : array<string|int, mixed>
- Initialise cite parameters
- basketInit() : array<string|int, mixed>
- Initialise basket parameters
- browseInit() : array<string|int, mixed>
- Initialise browse parameters
- ideasInit() : array<string|int, mixed>
- Initialise ideas parameters
- advsearchInit() : array<string|int, mixed>
- Initialise advsearch parameters
- advsearchForm() : array<string|int, mixed>
- Get some advsearch parameters for initialising the advsearch form
- setParams() : array<string|int, mixed>
- Set a parameter. Multiple parameters can be set.
- finalize() : mixed
- After completion of listing, save parameters
Functions
handleParams()
Handle the params array and act as a gateway to other functions
handleParams(string $method[, mixed $extra = FALSE ][, string $type = FALSE ]) : array<string|int, mixed>
Parameters
- $method : string
- $extra : mixed = FALSE
-
Default FALSE
- $type : string = FALSE
-
Default FALSE
Return values
array<string|int, mixed>initialiseParams()
Initialise params for each type of list.
initialiseParams(string $type, array<string|int, mixed> $extra) : array<string|int, mixed>
Parameters
- $type : string
- $extra : array<string|int, mixed>
Return values
array<string|int, mixed>commonInit()
Initialise common list parameters
commonInit(array<string|int, mixed> $vars, array<string|int, mixed> $params, string $type, bool $reorder) : array<string|int, mixed>
Parameters
- $vars : array<string|int, mixed>
- $params : array<string|int, mixed>
- $type : string
- $reorder : bool
Return values
array<string|int, mixed>qsearchInit()
Initialise qsearch parameters
qsearchInit(array<string|int, mixed> $vars, array<string|int, mixed> $params, string $type, bool $reorder) : array<string|int, mixed>
Parameters
- $vars : array<string|int, mixed>
- $params : array<string|int, mixed>
- $type : string
- $reorder : bool
Return values
array<string|int, mixed>citeInit()
Initialise cite parameters
citeInit(array<string|int, mixed> $vars, array<string|int, mixed> $params, string $type, bool $reorder) : array<string|int, mixed>
Parameters
- $vars : array<string|int, mixed>
- $params : array<string|int, mixed>
- $type : string
- $reorder : bool
Return values
array<string|int, mixed>basketInit()
Initialise basket parameters
basketInit(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed>browseInit()
Initialise browse parameters
browseInit(array<string|int, mixed> $vars, array<string|int, mixed> $params, string $type, bool $reorder) : array<string|int, mixed>
Parameters
- $vars : array<string|int, mixed>
- $params : array<string|int, mixed>
- $type : string
- $reorder : bool
Return values
array<string|int, mixed>ideasInit()
Initialise ideas parameters
ideasInit(array<string|int, mixed> $vars, array<string|int, mixed> $params, mixed $reorder) : array<string|int, mixed>
Parameters
- $vars : array<string|int, mixed>
- $params : array<string|int, mixed>
- $reorder : mixed
Return values
array<string|int, mixed>advsearchInit()
Initialise advsearch parameters
advsearchInit(array<string|int, mixed> $vars, array<string|int, mixed> $params, string $type, bool $reorder) : array<string|int, mixed>
Parameters
- $vars : array<string|int, mixed>
- $params : array<string|int, mixed>
- $type : string
- $reorder : bool
Return values
array<string|int, mixed>advsearchForm()
Get some advsearch parameters for initialising the advsearch form
advsearchForm(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed>setParams()
Set a parameter. Multiple parameters can be set.
setParams(array<string|int, mixed> $extra, array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $extra : array<string|int, mixed>
- $params : array<string|int, mixed>
Return values
array<string|int, mixed>finalize()
After completion of listing, save parameters
finalize(string $listStmt, mixed $type, array<string|int, mixed> $params) : mixed
Parameters
- $listStmt : string
-
*param string $type
- $type : mixed
- $params : array<string|int, mixed>