WIKINDX API 6.6.7

LISTSESSION
in package

LISTSESSION class

Handle cleanly, and from one point, sessions and temporary data for list, browse, search etc. operations.

Possible operations using this class are: list (LISTRESOURCES), browse (LISTSOMERESOURCES via BROWSExxx or directly via links on single resource view, statistics, category tree etc.) qsearch (QUICKSEARCH), advsearch (SEARCH i.e., advanced search), basket (BASKET), ideas (IDEAS), cite (INSERTCITATION).

Session variables for each of the above have a prefix allowing parameters such as ascDesc, order, search term etc. to be stored and recalled separately. Quick search, for example, has the prefix 'qsearch_' and so on (use the naming convention above).

Note that some session variables are shared between various operations (e.g., ListStmt statement for passing to CMS, AllIds [basket and ideas have their own AllIds and no ListStmt], search_Highlight, and ideas_Highlight): sql_ListStmt and the list of ordered resource ids sql_AllIds (produced from sql_ListStmt) are set in BIBCITEGATEWAY::getResourceData().

Table of Contents

Properties

$browserTabID  : mixed
string
$db  : mixed
object
$session  : mixed
object
$store  : mixed
object

Methods

advsearchInit()  : array<string|int, mixed>
Initialise advsearch parameters
basketInit()  : array<string|int, mixed>
Initialise basket parameters
browseInit()  : array<string|int, mixed>
Initialise browse parameters
citeInit()  : array<string|int, mixed>
Initialise cite parameters
commonInit()  : array<string|int, mixed>
Initialise common list parameters
ideasInit()  : array<string|int, mixed>
Initialise ideas parameters
qsearchInit()  : array<string|int, mixed>
Initialise qsearch parameters
setItemArray()  : mixed
Write an array of values to storage

Properties

$browserTabID

string

private mixed $browserTabID = \FALSE

Methods

advsearchInit()

Initialise advsearch parameters

private 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>

basketInit()

Initialise basket parameters

private 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

private 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>

citeInit()

Initialise cite parameters

private 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>

commonInit()

Initialise common list parameters

private 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>

ideasInit()

Initialise ideas parameters

private ideasInit(array<string|int, mixed> $params, array<string|int, mixed> $vars, mixed $reorder) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>
$vars : array<string|int, mixed>
$reorder : mixed
Return values
array<string|int, mixed>

qsearchInit()

Initialise qsearch parameters

private 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>

setItemArray()

Write an array of values to storage

private setItemArray(array<string|int, mixed> $params, string $prefix[, bool $keepZero = TRUE ]) : mixed

Careful not to get unexpected results if you use this! For this reason, it is currently unused.

Parameters
$params : array<string|int, mixed>
$prefix : string
$keepZero : bool = TRUE

Default TRUE


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results