ZOOMCOMMON
in package
ZOOMCOMMON class. Common routines for zoom
Table of Contents
Methods
- __construct() : mixed
- calculateSlices() : array<string|int, mixed>
- Calculate the resource id slices and get the link titles
- checkForMessages() : mixed
- Check for any messages (typically from NAVIGATE such as after adding items to the basket)
- createLinks() : string
- Create the zoom links
- displayResources() : mixed
- Display resources at end of zoom chain
- displayTotalList() : mixed
- Display all resources without zooming
- getLastZoom() : array<string|int, mixed>
- Get and return the last row and column in the zoom list (remove last element and store list again if moving up a level)
- init() : mixed
- Initialize the zoom environment
- setHeading() : mixed
- Set the title and any 'return to last zoom' link
- setLastZoom() : mixed
- Set last row and column in the zoom list
Methods
__construct()
public
__construct() : mixed
calculateSlices()
Calculate the resource id slices and get the link titles
public
calculateSlices(array<string|int, mixed> $row, int $rowNum[, bool $titles = false ]) : array<string|int, mixed>
Parameters
- $row : array<string|int, mixed>
- $rowNum : int
- $titles : bool = false
-
= FALSE
Return values
array<string|int, mixed>checkForMessages()
Check for any messages (typically from NAVIGATE such as after adding items to the basket)
public
checkForMessages() : mixed
createLinks()
Create the zoom links
public
createLinks(array<string|int, mixed> $links, string $action, mixed $rowNum) : string
Parameters
- $links : array<string|int, mixed>
- $action : string
- $rowNum : mixed
Return values
stringdisplayResources()
Display resources at end of zoom chain
public
displayResources(string $action, string $title[, bool $reorder = false ]) : mixed
Parameters
- $action : string
- $title : string
- $reorder : bool = false
-
Default FALSE
displayTotalList()
Display all resources without zooming
public
displayTotalList(array<string|int, mixed> $ids[, bool $reorder = false ]) : mixed
Parameters
- $ids : array<string|int, mixed>
- $reorder : bool = false
-
Default FALSE
getLastZoom()
Get and return the last row and column in the zoom list (remove last element and store list again if moving up a level)
public
getLastZoom() : array<string|int, mixed>
Return values
array<string|int, mixed>init()
Initialize the zoom environment
public
init(string $order[, bool $newTab = false ]) : mixed
Parameters
- $order : string
- $newTab : bool = false
-
Default = FALSE
setHeading()
Set the title and any 'return to last zoom' link
public
setHeading(string $action, string $title) : mixed
Parameters
- $action : string
- $title : string
setLastZoom()
Set last row and column in the zoom list
public
setLastZoom() : mixed