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

Procedural File: function.pnmodgetvar.php

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



Page Details:

Zikula Application Framework



Tags:

version:  $Id: function.pnmodgetvar.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_pnmodgetvar [line 40]

string smarty_function_pnmodgetvar( array $params, object &$smarty, bool $html, string $assign, string $default)

Smarty function to get module variable

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

Note that the results should be handled by the pnvarprepfordisplay of the pnvarprephtmldisplay modifiers before being displayed.

Available parameters:

  • module: The well-known name of a module from which to obtain the variable
  • name: The name of the module variable to obtain
  • assign: If set, the results are assigned to the corresponding variable instead of printed out
Example <!--[pnmodgetvar module="Example" name="foobar"]-->




Tags:

return:  The module variable
author:  Andreas Stratmann
since:  03/05/19


Parameters

array   $params   All attributes passed to this function from the template
object   &$smarty   Reference to the Smarty object
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
string   $default   (optional) The default value to return if the config variable is not set
[ Top ]



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