WIKINDX API trunk

PAGING

Table of Contents

Functions

getPagingParams()  : array<string|int, mixed>
Get the paging start and total
getNum()  : string
Get information on the number or characters being used for alphabetical and dictionary paging
setLinks()  : array<string|int, mixed>
Get links for alphabetical and dictionary paging
getZoomSlices()  : void
Get zooming paging slices
calculateZoomSlices()  : mixed
Calculate the zoom slices
getZoomLinks()  : array<string|int, mixed>
Get the zoom links
zoomToTop()  : string
Set zoom top link link
zoomUpOneLevel()  : string
Set zoom up one level link
storeZoomData()  : void
Store the zoom session
getRootLink()  : mixed
Get the root link for the paging link
linksInfo()  : string
Format display information string
getUserBib()  : array<string|int, mixed>
Check for user bibliographies
getBib()  : mixed
Get details about the bibliography being used

Functions

getPagingParams()

Get the paging start and total

getPagingParams(array<string|int, mixed> $vars) : array<string|int, mixed>
Parameters
$vars : array<string|int, mixed>
Return values
array<string|int, mixed>

getNum()

Get information on the number or characters being used for alphabetical and dictionary paging

getNum(array<string|int, mixed> $pagingArray, string $conjunction, int $start, int $total) : string
Parameters
$pagingArray : array<string|int, mixed>
$conjunction : string
$start : int
$total : int
Return values
string

setLinks()

Get links for alphabetical and dictionary paging

setLinks(array<string|int, mixed> $pagingArray, string $conjunction, int $start, string $browserTabID, string $queryString) : array<string|int, mixed>
Parameters
$pagingArray : array<string|int, mixed>
$conjunction : string
$start : int
$browserTabID : string
$queryString : string
Return values
array<string|int, mixed>

getZoomSlices()

Get zooming paging slices

getZoomSlices(int $paging, int $start, int $total, int $maxLinks, array<string|int, mixed> $vars, string $queryString, string $prefix) : void
Parameters
$paging : int
$start : int
$total : int
$maxLinks : int
$vars : array<string|int, mixed>
$queryString : string
$prefix : string

calculateZoomSlices()

Calculate the zoom slices

calculateZoomSlices(int $paging, int $start, int $total, int $maxLinks, int $row, array<string|int, mixed> $storeSlices, array<string|int, mixed> $vars, object $icons, object $store, string $rootLink, string $queryString, string $prefix, mixed $BT, bool $reloaded) : mixed
Parameters
$paging : int
$start : int
$total : int
$maxLinks : int
$row : int
$storeSlices : array<string|int, mixed>
$vars : array<string|int, mixed>
$icons : object
$store : object
$rootLink : string
$queryString : string
$prefix : string
$BT : mixed
$reloaded : bool

getZoomLinks()

Get the zoom links

getZoomLinks(int $paging, int $start, array<string|int, mixed> $starts, array<string|int, mixed> $ends, array<string|int, mixed> $slices, int $row, int $sliceSize, array<string|int, mixed> $storeColumns, array<string|int, mixed> $storeStarts, array<string|int, mixed> $storeEnds, object $icons, string $rootLink, string $queryString, string $BT) : array<string|int, mixed>
Parameters
$paging : int
$start : int
$starts : array<string|int, mixed>
$ends : array<string|int, mixed>
$slices : array<string|int, mixed>
$row : int
$sliceSize : int
$storeColumns : array<string|int, mixed>
$storeStarts : array<string|int, mixed>
$storeEnds : array<string|int, mixed>
$icons : object
$rootLink : string
$queryString : string
$BT : string
Return values
array<string|int, mixed>

zoomToTop()

Set zoom top link link

zoomToTop(object $icons, string $rootLink, string $queryString, string $BT) : string
Parameters
$icons : object
$rootLink : string
$queryString : string
$BT : string
Return values
string

zoomUpOneLevel()

Set zoom up one level link

zoomUpOneLevel(int $row, array<string|int, mixed> $storeColumns, array<string|int, mixed> $storeStarts, array<string|int, mixed> $storeEnds, object $icons, string $rootLink, string $queryString, string $BT) : string
Parameters
$row : int
$storeColumns : array<string|int, mixed>
$storeStarts : array<string|int, mixed>
$storeEnds : array<string|int, mixed>
$icons : object
$rootLink : string
$queryString : string
$BT : string
Return values
string

storeZoomData()

Store the zoom session

storeZoomData(string $prefix, string $storeSlices, string $storeSliceSizes, string $storeStarts, string $storeEnds, string $storeColumns, object $store) : void
Parameters
$prefix : string
$storeSlices : string
$storeSliceSizes : string
$storeStarts : string
$storeEnds : string
$storeColumns : string
$store : object

getRootLink()

Get the root link for the paging link

getRootLink(string $queryString) : mixed
Parameters
$queryString : string

linksInfo()

Format display information string

linksInfo(int $start, int $total, int $paging[, false|string $bibTitle = FALSE ][, false|string $ideas = FALSE ]) : string
Parameters
$start : int
$total : int
$paging : int
$bibTitle : false|string = FALSE

Default is FALSE

$ideas : false|string = FALSE

Default is FALSE

Return values
string

getUserBib()

Check for user bibliographies

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

getBib()

Get details about the bibliography being used

getBib(string $bibTitle) : mixed
Parameters
$bibTitle : string 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results