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

Procedural File: function.pnmodapifunc.php

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



Page Details:

Zikula Application Framework



Tags:

version:  $Id: function.pnmodapifunc.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_pnmodapifunc [line 44]

string smarty_function_pnmodapifunc( array $params, object &$smarty)

Smarty function to to execute a module API function

This function calls a calls a specific module API function. It returns whatever the return value of the resultant function is if it succeeds. Note that in contrast to the API function pnModAPIFunc you need not to load the module API with pnModAPILoad.

Available parameters:

  • modname: The well-known name of a module to execute a function from (required)
  • type: The type of function to execute; currently one of 'user' or 'admin' (default is 'user')
  • func: The name of the module function to execute (default is 'main')
  • assign: The name of a variable to which the results are assigned
  • all remaining parameters are passed to the module API function
Examples <!--[pnmodfunc modname="News" type="user" func="getarticles" id="3"]-->

<!--[pnmodapifunc modname="foobar" type="user" func="getfoo" id="1" assign="myfoo"]--> <!--[myfoo.title]-->




Tags:

return:  the results of the module API function
author:  Jörg Napp
author:  Andreas Stratmann
see:  function.pnmodfunc.php::smarty_function_pnmodfunc()
since:  03/05/23


Parameters

array   $params   All attributes passed to this function from the template
object   &$smarty   Reference to the Smarty object
[ Top ]



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