phpDocumentor ZNF
Presentation
[ class tree: ZNF ] [ index: ZNF ] [ all elements ]

Class: ZNF_Presentation_Smarty

Source Location: /Presentation/Smarty.php

Class ZNF_Presentation_Smarty

Class Overview

ZNF_Presentation_Smarty class extends the ZNF_Presentation_Render class and use the Smarty class of the Smarty package for the renderization.

Render data using package or theme templates.

Located in /Presentation/Smarty.php [line 41]

ZNF_Presentation_Render
   |
   --ZNF_Presentation_Smarty
Author(s): API Tags:
Access:  public

Information Tags:
Version:  SVN $Id: Smarty.php 43 2007-06-26 23:36:35Z aronnax $
Copyright:  2004-2007 The ZNF Development Team
Link:  http://www.zeronotice.org
Since:  Release 0.5.0
License:  LGPL

Properties

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From ZNF_Presentation_Render

ZNF_Presentation_Render::$_appConfig
ZNF_Presentation_Render::$_nextPath
ZNF_Presentation_Render::$_package
ZNF_Presentation_Render::$_path

Inherited From ZNF_Presentation_Render

ZNF_Presentation_Render::__construct()
Constructs a new ZNF_Presentation_Render object and sets the internal properties with application settings.
ZNF_Presentation_Render::assign()
Assigns values to template parameters.
ZNF_Presentation_Render::display()
Executes the renderization and displays the result.
ZNF_Presentation_Render::fetch()
Executes the renderization and returns the result.
ZNF_Presentation_Render::_getConstants()
Get the ZNF constants to be assigned to the templates.
ZNF_Presentation_Render::_getPackageTemplatePath()
Returns the path of a package template, tries to load the template in a predefined order.
ZNF_Presentation_Render::_getTemplatePath()
Returns the path to get the template requested.
ZNF_Presentation_Render::_getThemePath()
Returns the path of a theme, tries to find the theme base directory in a predefined order.
ZNF_Presentation_Render::_getThemeTemplatePath()
Returns the path of a theme template, tries to load the template in a predefined order.

[ Top ]
Property Summary
string   $_smarty   The Smarty object

[ Top ]
Method Summary
ZNF_Presentation_Smarty   __construct()   Constructs a new ZNF_Presentation_Smarty object and sets the internal properties with application settings.
void   __destruct()   Destroys the ZNF_Presentation_Smarty object.</>
void   assign()   Assigns values to smarty template variables.
void   display()   Executes and displays the smarty template results.
string   fetch()   Executes and returns the smarty template results.
void   _assignConstants()   Assign to a smarty template the ZNF constants.

[ Top ]
Properties
string   $_smarty = null [line 58]

The Smarty object

API Tags:
Access:  protected


[ Top ]
Methods
Constructor __construct  [line 69]

  ZNF_Presentation_Smarty __construct( [string $package = null], [ZNF_Action_ActionMapping $mapping = null]  )

Constructs a new ZNF_Presentation_Smarty object and sets the internal properties with application settings.

Parameters:
string   $package:  Name of the package to which the smarty template refers, leave null this parameter to refer to the theme smarty templates
ZNF_Action_ActionMapping   $mapping: 

API Tags:
Access:  public


Redefinition of:
ZNF_Presentation_Render::__construct()
Constructs a new ZNF_Presentation_Render object and sets the internal properties with application settings.

[ Top ]
Destructor __destruct  [line 153]

  void __destruct( )

Destroys the ZNF_Presentation_Smarty object.</>


API Tags:
Access:  public


[ Top ]
assign  [line 132]

  void assign( string $param, mixed $value  )

Assigns values to smarty template variables.

Parameters:
string   $param:  The smarty template parameter name
mixed   $value:  The value to assign

API Tags:
Access:  public


Redefinition of:
ZNF_Presentation_Render::assign()
Assigns values to template parameters.

[ Top ]
display  [line 117]

  void display( string $template, [mixed $data = null]  )

Executes and displays the smarty template results.

Gets the path of the smarty template, calls ZNF_Presentation_Smarty->_assignConstants() and calls the display() method of Smarty.

Parameters:
string   $template:  File name of the smarty template
mixed   $data:  Additional data to process

API Tags:
Access:  public


Redefinition of:
ZNF_Presentation_Render::display()
Executes the renderization and displays the result.

[ Top ]
fetch  [line 97]

  string fetch( string $template, [mixed $data = null]  )

Executes and returns the smarty template results.

Gets the path of the smarty template, calls ZNF_Presentation_Smarty->_assignConstants() and calls the fetch() method of Smarty.

Parameters:
string   $template:  File name of the smarty template
mixed   $data:  Additional data to process

API Tags:
Access:  public


Redefinition of:
ZNF_Presentation_Render::fetch()
Executes the renderization and returns the result.

[ Top ]
_assignConstants  [line 142]

  void _assignConstants( )

Assign to a smarty template the ZNF constants.


API Tags:
Access:  protected


[ Top ]
Constants
SMARTY_CACHING = false [line 44]

[ Top ]
SMARTY_COMPILE_CHECK = true [line 46]

[ Top ]
SMARTY_DEBUGGING = ZNF::DEBUG [line 48]

[ Top ]
SMARTY_FORCE_COMPILE = false [line 50]

[ Top ]

Documentation generated on Wed, 14 Nov 2007 23:47:41 +0100 by phpDocumentor 1.4.0