/functions/template/paginator_util.php

Description

paginator_util.php

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

Includes
include_once (SM_PATH.'functions/forms.php') (line 17)

Load forms functions, needed for addsubmit().

Functions
get_compact_paginator_str (line 55)

This function computes the comapact paginator string.

  • return: paginate string with links to pages
string get_compact_paginator_str (string $box, integer $iOffset, integer $iTotal, integer $iLimit, bool $bShowAll, bool $javascript_on, bool $page_selector)
  • string $box: mailbox name
  • integer $iOffset: offset in total number of messages
  • integer $iTotal: total number of messages
  • integer $iLimit: maximum number of messages to show on a page
  • bool $bShowAll: whether or not to show all messages at once ("show all" == non paginate mode)
  • bool $javascript_on: whether or not javascript is currently enabled
  • bool $page_selector: whether or not to show the page selection widget
get_paginator_link (line 29)

Generate a paginator link.

string get_paginator_link (string $box, integer $start_msg, string $text, [string $accesskey = 'NONE'])
  • string $box: Mailbox name
  • integer $start_msg: Message Offset
  • string $text: The text used for paginator link
  • string $accesskey: The access key for the link, if any
get_paginator_str (line 205)

This function computes the paginator string.

  • return: paginate string with links to pages
string get_paginator_str (string $box, integer $iOffset, integer $iTotal, integer $iLimit, bool $bShowAll, bool $page_selector, integer $page_selector_max)
  • string $box: mailbox name
  • integer $iOffset: offset in total number of messages
  • integer $iTotal: total number of messages
  • integer $iLimit: maximum number of messages to show on a page
  • bool $bShowAll: whether or not to show all messages at once ("show all" == non paginate mode)
  • bool $page_selector: whether or not to show the page selection widget
  • integer $page_selector_max: maximum number of pages to show on the screen

Documentation generated on Wed, 26 Nov 2014 04:19:05 +0100 by phpDocumentor 1.4.3