Class gui

Description

GUI

Initialize the Smarty template engine and provide methods to access it. Discover and prepare themes and initialize gettext for localization.

Located in /lib/gui.class.php (line 49)

session
   |
   --gui
Direct descendents
Class Description
 class dbc StockManiac Database Connection (DBC)
Variable Summary
 object $themes
 object $_smarty
Method Summary
 bool __construct ()
 void append (string $var, mixed $val)
 void assign (string $var, mixed $val)
 void debug ()
 void display (string $tpl)
 float get_microtime ()
 mixed get_template_vars (string $var)
 array get_themes ()
 void register_object (string $name,  &$obj, [array $allowed_methods = null], [bool $new_params_style = true], object $obj)
 void set_default_theme (string $theme_name)
Variables
object $themes (line 62)

internal themes object, to be used by child classes

  • access: public
  • usedby: gui
object $_smarty (line 56)

internal smarty object

  • access: private

Inherited Variables

Inherited from session

session::$err
Methods
Constructor __construct (line 75)

Constructor

bool __construct ()

Redefinition of:
session::__construct()

Redefined in descendants as:
append (line 179)

wrapper around native Smarty method.

  • access: public
void append (string $var, mixed $val)
  • string $var
  • mixed $val
assign (line 144)

wrapper around native Smarty method.

  • access: public
void assign (string $var, mixed $val)
  • string $var
  • mixed $val
debug (line 250)

Print content any type of variable using print_r() for debugging.

Accept var1, var2, ..., varN as input. You may pass as many parameters as you like.

ATTENTION: the package building tools look for calls on this method and will issue a warning. All sich calls should be removed before any final release! Just for the sake of security....

  • access: public
void debug ()
display (line 189)

wrapper around native Smarty method.

  • access: public
void display (string $tpl)
  • string $tpl
get_microtime (line 266)

Return microtime as of now.

Useful for debugging performance issues.

  • access: public
float get_microtime ()
get_template_vars (line 167)

wrapper around native Smarty method.

  • access: public
mixed get_template_vars (string $var)
  • string $var
get_themes (line 204)

Return array of all known themes.

  • access: public
array get_themes ()
register_object (line 157)

wrapper around native Smarty method.

  • access: public
void register_object (string $name,  &$obj, [array $allowed_methods = null], [bool $new_params_style = true], object $obj)
  • string $name
  • object $obj
  • array $allowed_methods
  • bool $new_params_style
  • &$obj
set_default_theme (line 214)

Set default theme to be used.

  • access: public
void set_default_theme (string $theme_name)
  • string $theme_name

Inherited Methods

Inherited From session

 session::__construct()
 session::sess_destroy()
 session::sess_exists()
 session::sess_get_var()
 session::sess_store_var()
 session::sess_unset_var()

Documentation generated on Sun, 22 Aug 2010 11:20:19 +0200 by phpDocumentor 1.4.3