Class pages

Description

Pages class

A class for managing pages of text. Initially written to provide support for sending text to WAP phones, where the content had to be paged into small chunks due to the limited capacity of the phones.

Located in /paging-defs.php (line 42)

RenderableObject
   |
   --pages
Variable Summary
 mixed $content
 mixed $lookahead
 mixed $lookback
 mixed $pageno
 mixed $pagesize
 mixed $pagetext
 mixed $paginghref
Method Summary
 pages pages ([string $content = ""], [string $paginghref = ""], [integer $pagesize = 800], [integer $lookahead = 250], [mixed $lookback = 120])
 void html ([mixed $pgno = 1])
 string page (integer $pgno, [string $brtag = "
"
])
 void wml ([mixed $pgno = 1])
Variables
mixed $content = "" (line 44)

Pages content

mixed $lookahead = 250 (line 48)

Number of chars to look ahead

mixed $lookback = 120 (line 50)

Number of chars to look back

mixed $pageno = 0 (line 52)

Current page number

mixed $pagesize = 800 (line 46)

Size of each page in characters

mixed $pagetext = "" (line 54)

Text for current page

mixed $paginghref = "" (line 56)

URL for getting next page

Methods
Constructor pages (line 67)

Constructor Creates the basic text paging object.

pages pages ([string $content = ""], [string $paginghref = ""], [integer $pagesize = 800], [integer $lookahead = 250], [mixed $lookback = 120])
  • string $content: Text content for pages
  • string $paginghref: URL for getting next page (back or forward)
  • integer $pagesize: No. characters to look back
  • integer $lookahead: No. characters to look ahead
html (line 138)

Deliver HTML format page

void html ([mixed $pgno = 1])

Redefinition of:
RenderableObject::html()
Return output suitable for normal HTML-capable device. This method must be over-ridden by a method of the same name in the descendant class which renders output to web browsers.
page (line 82)

Deliver page N Delivers the text content for the specified page.

  • return: Text content for specified page
string page (integer $pgno, [string $brtag = "
"
])
  • integer $pgno: Number of the page to deliver
  • string $brtag: Line-break tag to us (defaults to WML)
wml (line 133)

Deliver WML format page

void wml ([mixed $pgno = 1])

Redefinition of:
RenderableObject::wml()
Return output suitable for normal wap-capable device. This method must be over-ridden by a method of the same name in the descendant class which renders output to wap devices.

Inherited Methods

Inherited From RenderableObject

 RenderableObject::RenderableObject()
 RenderableObject::html()
 RenderableObject::render()
 RenderableObject::wml()
 RenderableObject::wmlup()
 RenderableObject::xml()

Documentation generated by phpDocumentor 1.3.0RC3