Class ThemeSchoolyard

Description

this class implements the schoolyard theme (based on a design by David Prousch)

Located in /program/themes/schoolyard/schoolyard.class.php (line 30)

Theme
   |
   --ThemeSchoolyard
Method Summary
 void ThemeSchoolyard (array $theme_record, int $area_id, int $node_id)
 string get_html ()
 string schoolyard_get_div_quicktop ([string $m = ''])
 string schoolyard_logout ([string $separator = ''], [string $m = ''])
 string schoolyard_printpage ([string $separator = ''], [string $m = ''])
Variables
Methods
Constructor ThemeSchoolyard (line 42)

construct a ThemeSchoolyard object

First we do the regular initialisation, and subsequently we set a few parameters (very un-exciting).

void ThemeSchoolyard (array $theme_record, int $area_id, int $node_id)
  • array $theme_record: the record straight from the database
  • int $area_id: the area of interest
  • int $node_id: the node that will be displayed
get_html (line 71)

construct an output page in HTML

This constructs a full HTML-page, starting at the DTD and ending with the html closing tag.

This routine returns a full HTML-page, usually including logo, (area) title, main navigation, breadcrumbs trail (optional), menu, jumpmenu and a footer with links to printer friendly version + logout. If the page is called with print=1 as one of the get-parameters, all those extra stuff is suppressed by including the additional print.css stylesheet (configurable). This allows for making a clean print of only the content. This additional stylesheet is added only once, even if this routine is called more than once (shouldn't happen). This stylesheet is configurable just like the regular stylesheet.

Note that there might be a jumpmenu (to go to other areas). This is only displayed if there is another area to go to. If the current area is the only one available, we don't bother the user with an extra navigation widget.

  • return: complete HTML-page, ready for output
string get_html ()

Redefinition of:
Theme::get_html()
construct an output page in HTML
schoolyard_get_div_quicktop (line 230)

construct an optional div for quicklinks at the top if any

  • return: ready-to-use HTML-code for div or empty string of nothing to show
string schoolyard_get_div_quicktop ([string $m = ''])
  • string $m: margin for readability
schoolyard_logout (line 209)

conditionally construct a logout link

  • return: ready to use HTML-code
string schoolyard_logout ([string $separator = ''], [string $m = ''])
  • string $separator: a visual separator that is prepended
  • string $m: margin for increased readability
schoolyard_printpage (line 185)

construct a 'print this page' link

  • return: ready to use HTML-code
string schoolyard_printpage ([string $separator = ''], [string $m = ''])
  • string $separator: a visual separator that is prepended
  • string $m: margin for increased readability

Inherited Methods

Inherited From Theme

 Theme::Theme()
 Theme::add_content()
 Theme::add_html_header()
 Theme::add_http_header()
 Theme::add_message()
 Theme::add_meta()
 Theme::add_meta_http_equiv()
 Theme::add_popup_bottom()
 Theme::add_popup_top()
 Theme::add_stylesheet()
 Theme::calc_breadcrumb_trail()
 Theme::construct_tree()
 Theme::dump_subtree()
 Theme::get_address()
 Theme::get_bazaar_style_style()
 Theme::get_bottomline()
 Theme::get_content()
 Theme::get_div_breadcrumbs()
 Theme::get_div_messages()
 Theme::get_html()
 Theme::get_html_head()
 Theme::get_jumpmenu()
 Theme::get_lines()
 Theme::get_logo()
 Theme::get_menu()
 Theme::get_navigation()
 Theme::get_popups()
 Theme::get_properties()
 Theme::get_quickbottom()
 Theme::get_quicklinks()
 Theme::get_quicktop()
 Theme::node2anchor()
 Theme::queue_alert()
 Theme::send_headers()
 Theme::send_output()
 Theme::set_preview_mode()
 Theme::show_tree_walk()

Documentation generated on Tue, 28 Jun 2016 19:11:38 +0200 by phpDocumentor 1.4.0