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

Class: ZNF_Presentation_Render

Source Location: /Presentation/Render.php

Class ZNF_Presentation_Render

Class Overview

ZNF_Presentation_Render specifies the abstract class that renderization classes should extends.

Located in /Presentation/Render.php [line 38]



		
				Author(s):
		
		
		API Tags:
Abstract:  
Access:  public

Information Tags:
Version:  SVN $Id: Render.php 44 2007-07-22 23:55:30Z evolic $
Copyright:  2004-2007 The ZNF Development Team
Link:  http://www.zeronotice.org
Since:  Release 0.6.2
License:  LGPL

Properties

Methods

[ Top ]
Descendants
Child Class Description
ZNF_Presentation_XSLT ZNF_Presentation_XSLT class, extends the ZNF_Presentation_Render class and implements renderization with PHP XSLTProcessor.
ZNF_Presentation_Smarty ZNF_Presentation_Smarty class extends the ZNF_Presentation_Render class and use the Smarty class of the Smarty package for the renderization.

[ Top ]
Property Summary
ZNF_Config_AppConfig   $_appConfig   The ZNF_Config_AppConfig instance.
string   $_nextPath   The nextPath property of the ZNF_Action_ActionMapping.
string   $_package   The name of the package to which the template refers.
string   $_path   The path property of the ZNF_Action_ActionMapping.

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

[ Top ]
Properties
ZNF_Config_AppConfig   $_appConfig [line 47]

The ZNF_Config_AppConfig instance.

API Tags:
Access:  protected


[ Top ]
string   $_nextPath = null [line 71]

The nextPath property of the ZNF_Action_ActionMapping.

API Tags:
Access:  protected


[ Top ]
string   $_package = null [line 55]

The name of the package to which the template refers.

API Tags:
Access:  protected


[ Top ]
string   $_path = null [line 63]

The path property of the ZNF_Action_ActionMapping.

API Tags:
Access:  protected


[ Top ]
Methods
Constructor __construct  [line 82]

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

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

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

API Tags:
Access:  public


Redefined in descendants as:

[ Top ]
assign  [line 288]

  void assign( string $param, mixed $value  )

Assigns values to template parameters.

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

API Tags:
Abstract:  
Access:  public


Redefined in descendants as:

[ Top ]
display  [line 297]

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

Executes the renderization and displays the result.

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

API Tags:
Abstract:  
Access:  public


Redefined in descendants as:

[ Top ]
fetch  [line 307]

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

Executes the renderization and returns the result.

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

API Tags:
Abstract:  
Access:  public


Redefined in descendants as:

[ Top ]
_getConstants  [line 120]

  array _getConstants( )

Get the ZNF constants to be assigned to the templates.

  • znf.baseHref: concatenation of hostname and relative path of the public script directory, used as prefix in hyperlinks in order to refer to correct URIs.
  • znf.actionIndex: Name of the GET attribute used to select the action to execute.
  • znf.moduleIndex: Name of the GET attribute used to select the module configuration.
  • znf.changeModuleIndex: Name of the GET attribute used to select persistently the module configuration.
  • znf.themePath: relative path of the current theme, used as prefix in hyperlinks (css, javascripts, images...) in order to refer to correct paths.
  • znf.packagePath: relative path of the package in use, used as prefix in hyperlinks (css, javascripts, images...) in order to refer to correct paths.
  • znf.path: current action path.
  • znf.nextPath: next action path to request.
  • znf.credits: ZNF credits.


API Tags:
Access:  protected


[ Top ]
_getPackageTemplatePath  [line 200]

  string _getPackageTemplatePath( string $template  )

Returns the path of a package template, tries to load the template in a predefined order.

  • overloaded package template in the current theme and lang path
  • current package and current lang template
  • current package and default lang template

Parameters:
string   $template:  File name of the template to get

API Tags:
Access:  protected


[ Top ]
_getTemplatePath  [line 233]

  string _getTemplatePath( string $template  )

Returns the path to get the template requested.

Parameters:
string   $template:  File name of the template

API Tags:
Access:  protected


[ Top ]
_getThemePath  [line 254]

  string _getThemePath( )

Returns the path of a theme, tries to find the theme base directory in a predefined order.

  • current theme and current lang theme base directory
  • current theme and default lang theme base directory
  • default theme and default lang theme base directory


API Tags:
Access:  protected


[ Top ]
_getThemeTemplatePath  [line 161]

  string _getThemeTemplatePath( string $template  )

Returns the path of a theme template, tries to load the template in a predefined order.

  • current theme and current lang template
  • current theme and default lang template
  • default theme and default lang template

Parameters:
string   $template:  File name of the template to get

API Tags:
Access:  protected


[ Top ]

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