init__templates_results_browser (line 24)
Standard code module initialisation function.
void
init__templates_results_browser
()
results_browser (line 48)
Get the tempcode for a results browser.
tempcode
results_browser
(tempcode $title, ?mixed $category_id, integer $start, ID_TEXT $start_name, integer $max, ID_TEXT $max_name, integer $max_rows, [?mixed $root = NULL], [?ID_TEXT $type = NULL], [boolean $keep_all = false], [boolean $keep_post = false], [integer $max_page_links = 10], [?array $_selectors = NULL])
-
tempcode
$title: The title/name of the resource we are browsing through
-
?mixed
$category_id: The category ID we are browsing in (NULL: not applicable)
-
integer
$start: The current position in the browser
-
ID_TEXT
$start_name: The parameter name used to store our position in the results (usually, 'start')
-
integer
$max: The maximum number of rows to show per browser page
-
ID_TEXT
$max_name: The parameter name used to store the total number of results to show per-page (usually, 'max')
-
integer
$max_rows: The maximum number of rows in the entire dataset
-
?mixed
$root: The virtual root category this browser uses (NULL: no such concept for our results browser)
-
?ID_TEXT
$type: The page type this browser is browsing through (e.g. 'category') (NULL: none)
-
boolean
$keep_all: Whether to keep get data when browsing through
-
boolean
$keep_post: Whether to keep post data when browsing through
-
integer
$max_page_links: The maximum number of quick-jump page links to show
-
?array
$_selectors: List of per-page selectors to show (NULL: show hard-coded ones)
_build_results_browser_cat_url (line 203)
Helper function to work out a results browser URL.
mixed
_build_results_browser_cat_url
(array $url_array, array $post_array, ?ID_TEXT $type, ?mixed $root, ?mixed $category_id, boolean $keep_all)
-
array
$url_array: Map of GET array segments to use (others will be added by this function)
-
array
$post_array: Map of POST array segments (relayed as GET) to use
-
?ID_TEXT
$type: The page type this browser is browsing through (e.g. 'category') (NULL: none)
-
?mixed
$root: The virtual root category this browser uses (NULL: no such concept for our results browser)
-
?mixed
$category_id: The category ID we are browsing in (NULL: not applicable)
-
boolean
$keep_all: Whether to keep get data when browsing through