/functions/template/abook_util.php

Description

abook_util.php

The following functions are utility functions for templates. Do not echo output in these functions.

Functions
addAbookSort (line 27)

Display a column header with sort buttons

  • author: Steve Brown
  • since: 1.5.2
void addAbookSort (string $field, array $current_page_args)
  • string $field: Which field to display
  • array $current_page_args: All known query string arguments for the current page request; structured as an associative array of key/value pairs
get_abook_paginator (line 88)

Creates an address book paginator

  • return: The paginator, ready for output
string get_abook_paginator (boolean $abook_page_selector, int $abook_page_selector_max, int $page_number, int $page_size, int $total_addresses, boolean $show_all, array $current_page_args, boolean $compact)
  • boolean $abook_page_selector: Whether or not to show the page selector
  • int $abook_page_selector_max: The maximum number of page links to show on screen
  • int $page_number: What page is being viewed - 0 if not used
  • int $page_size: Maximum number of addresses to be shown per page
  • int $total_addresses: The total count of addresses in the backend
  • boolean $show_all: Whether or not all addresses are being shown
  • array $current_page_args: All known query string arguments for the current page request; structured as an associative array of key/value pairs
  • boolean $compact: Whether or not to build a smaller, "compact" paginator
make_abook_paginator_link (line 303)

Build a page (pagination) link for use with the address book list page

void make_abook_paginator_link (int $page_number, string $text, array $current_page_args)
  • int $page_number: The page number for the link
  • string $text: The link text
  • array $current_page_args: All known query string arguments for the current page request; structured as an associative array of key/value pairs

Documentation generated on Fri, 22 Aug 2014 04:17:07 +0200 by phpDocumentor 1.4.3