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

Procedural File: function.pngetstatusmsg.php

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



Page Details:

Zikula Application Framework



Tags:

version:  $Id: function.pngetstatusmsg.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_pngetstatusmsg [line 48]

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

Smarty function to obtain status message

This function obtains the last status message posted for this session. The status message exists in one of two session variables: '_PNStatusMsg' for a status message, or '_PNErrorMsg' for an error message. If both a status and an error message exists then the error message is returned.

This is is a destructive function - it deletes the two session variables '_PNStatusMsg' and 'erorrmsg' during its operation.

Note that you must not cache the outputs from this function, as its results change aech time it is called. The Zikula developers are looking for ways to automise this.

Available parameters:

  • assign: If set, the status message is assigned to the corresponding variable instead of printed out
  • style, class: If set, the status message is being put in a div tag with the respective attributes
  • tag: You can specify if you would like a span or a div tag
Example <!--[pngetstatusmsg|pnvarprephtmldisplay]--> <!--[pngetstatusmsg style="color:red;" |pnvarprephtmldisplay]--> <!--[pngetstatusmsg class="statusmessage" tag="span"|pnvarprephtmldisplay]-->




Tags:

return:  the value of the last status message posted, or void if no status message exists
author:  Jörg Napp
deprecated:  
todo:  prevent this function from being cached (Smarty 2.6.0)
since:  16. Sept. 2003


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:03 +0200 by phpDocumentor 1.4.1