/templates/util_paginator.php

Description

Template logic

The following functions are utility functions for this template. Do not echo output in those functions. Output is generated above this comment block

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

Load forms functions, needed for addsubmit().

Functions
get_compact_paginator_str (line 44)

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,  $javascript_on,  $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: show all messages at once (non paginate mode)
  • $javascript_on
  • $page_selector
get_paginator_link (line 26)

Generate a paginator link.

string get_paginator_link (string $box, integer $start_msg, string $text)
  • string $box: Mailbox name
  • integer $start_msg: Message Offset
  • string $text: text used for paginator link
get_paginator_str (line 165)

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,  $page_selector,  $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: show all messages at once (non paginate mode)
  • $page_selector
  • $page_selector_max

Documentation generated on Sat, 07 Oct 2006 16:14:05 +0300 by phpDocumentor 1.3.0RC6