Zikula_Template_Plugins
[ class tree: Zikula_Template_Plugins ] [ index: Zikula_Template_Plugins ] [ all elements ]

Procedural File: function.pnpagegetvar.php

Source Location: /system/pnRender/plugins/function.pnpagegetvar.php



Page Details:

Zikula Application Framework



Tags:

version:  $Id: function.pnpagegetvar.php 24342 2008-06-06 12:03:14Z markwest $
copyright:  (c) 2004, Zikula Development Team
link:  http://www.zikula.org
filesource:  Source Code for this file
license:  GNU/GPL








smarty_function_pnpagegetvar [line 48]

string smarty_function_pnpagegetvar( array $params, object &$smarty, string $name, bool $html, string $assign)

Smarty function to get page variable

This function obtains a page-specific variable from the Zikula system.

Available parameters:

  • name: The name of the page variable to obtain
  • assign: If set, the results are assigned to the corresponding variable instead of printed out
Zikula doesn't impose any restriction on the page variabl's name except for duplicate and reserved names. As of this writing, the list of reserved names consists of
  • title
  • description
  • keywords
  • stylesheet
  • javascript
  • body
  • rawtext
  • footer

Example <!--[pnpagegetvar name="title"]-->




Tags:

return:  The module variable
author:  Mark West
since:  30/03/06


Parameters

array   $params   All attributes passed to this function from the template
object   &$smarty   Reference to the Smarty object
string   $name   Name of the page variable to get
bool   $html   (optional) If true then result will be treated as html content
string   $assign   (optional) If set then result will be assigned to this template variable
[ Top ]



Documentation generated on Fri, 18 Jul 2008 21:46:08 +0200 by phpDocumentor 1.4.1