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

Procedural File: function.pnmodurl.php

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



Page Details:

Zikula Application Framework



Tags:

version:  $Id: function.pnmodurl.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_pnmodurl [line 46]

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

Smarty function to create a zikula.orgpatible URL for a specific module function.

This function returns a module URL string if successful. Unlike the API function pnModURL, this is already sanitized to display, so it should not be passed to the pnvarprepfordisplay modifier.

Available parameters:

  • modname: The well-known name of a module for which to create the URL (required)
  • type: The type of function for which to create the URL; currently one of 'user' or 'admin' (default is 'user')
  • func: The actual module function for which to create the URL (default is 'main')
  • fragment: The fragement to target within the URL
  • ssl: See below
  • fqurl: Make a fully qualified URL
  • append: (optional) A string to be appended to the URL
  • assign: If set, the results are assigned to the corresponding variable instead of printed out
  • all remaining parameters are passed to the module function
Example Create a URL to the News 'view' function with parameters 'sid' set to 3 and 'index' set to '0' <a href="<!--[pnmodurl modname="News" type="user" func="view" sid="3" index="0"]-->">Link</a>

Example SSL Create a secure https:// URL to the News 'view' function with parameters 'sid' set to 3 and 'index' set to '0' ssl - set to constant null,true,false NOTE: $ssl = true not $ssl = 'true' null - leave the current status untouched, true - create a ssl url, false - create a non-ssl url <a href="<!--[pnmodurl modname="News" type="user" func="view" sid="3" index="0" ssl=true]-->">Link</a>




Tags:

return:  The URL
author:  Mark West
since:  08/08/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:08 +0200 by phpDocumentor 1.4.1