Shimmie2 / SCore
Public Member Functions | Protected Member Functions
Page Class Reference

A data structure for holding all the bits of data that make up a page. More...

Inheritance diagram for Page:
CustomPage

List of all members.

Public Member Functions

 display ()
 Display the page according to the mode and data given.

Protected Member Functions

 add_auto_html_headers ()

Overall

 set_mode ($mode)
 Set what this page should do; "page", "data", or "redirect".
 set_type ($type)
 Set the page's MIME type.

"data" mode

 set_data ($data)
 Set the raw data to be sent.
 set_filename ($filename)
 Set the recommended download filename.

"redirect" mode

 set_redirect ($redirect)
 Set the URL to redirect to (remember to use make_link() if linking to a page in the same site)

"page" mode

 set_title ($title)
 Set the window title.
 set_heading ($heading)
 Set the main heading.
 set_subheading ($subheading)
 Set the sub heading.
 add_html_header ($line, $position=50)
 Add a line to the HTML head section.
 add_http_header ($line, $position=50)
 Add a http header to be sent to the client.
 get_all_html_headers ()
 Get all the HTML headers that are currently set and return as a string.
 delete_all_html_headers ()
 Removes all currently set HTML headers.
 add_block (Block $block)
 Add a Block of data.

Detailed Description

A data structure for holding all the bits of data that make up a page.

The various extensions all add whatever they want to this structure, then Layout turns it into HTML


Member Function Documentation

Page::add_auto_html_headers ( ) [protected]
Page::add_block ( Block block)

Add a Block of data.

Page::add_html_header ( line,
position = 50 
)

Add a line to the HTML head section.

Page::add_http_header ( line,
position = 50 
)

Add a http header to be sent to the client.

Page::delete_all_html_headers ( )

Removes all currently set HTML headers.

(Be careful..)

Page::display ( )

Display the page according to the mode and data given.

Page::get_all_html_headers ( )

Get all the HTML headers that are currently set and return as a string.

Page::set_data ( data)

Set the raw data to be sent.

Page::set_filename ( filename)

Set the recommended download filename.

Page::set_heading ( heading)

Set the main heading.

Page::set_mode ( mode)

Set what this page should do; "page", "data", or "redirect".

Page::set_redirect ( redirect)

Set the URL to redirect to (remember to use make_link() if linking to a page in the same site)

Page::set_subheading ( subheading)

Set the sub heading.

Page::set_title ( title)

Set the window title.

Page::set_type ( type)

Set the page's MIME type.


The documentation for this class was generated from the following file: