Summary: Function Detail: Function

Functions

Function Summary
string	zm_plugin_admin_url(string function, string params, boolean echo) Create a plugin admin page URL.
string	zm_plugin_url(string target, string params, boolean echo) Create a plugin view/admin page URL.
string	zm_plugin_value_element(ZMConfigValue value, boolean echo) Generate form element for the given config value.
ZMPluginPage	zm_simple_config_form(ZMPlugin plugin, string fkt, string title, boolean all) Create a simple plugin config form.

Function Detail

public string zm_plugin_admin_url(string function, string params, boolean echo)

Create a plugin admin page URL.

Parameters:: function - The view function name; default is null to use the current.; params - Query string style parameter; if ''.; echo - If true, the URI will be echo'ed as well as returned.
Returns:: A full URL.

public string zm_plugin_url(string target, string params, boolean echo)

Create a plugin view/admin page URL.

This function can be used in places where code is executed in both storefront and admin context.

In contrast to zm_plugin_admin_url, this function will accept either a view name, a function name or both as target.

Format for target is as follows:

View only: Same as for ZMToolboxNet::url.
Admin only: Same as for zm_plugin_admin_url except that the function name is preceeded by ;.
View and function: Viewname and function separated by ;; example: wiki;zm_wiki_admin.

Parameters:: target - The target.; params - Query string style parameter; if null add all current parameter.; echo - If true, the URI will be echo'ed as well as returned.
Returns:: A full URL.

public string zm_plugin_value_element(ZMConfigValue value, boolean echo)

Generate form element for the given config value.

Parameters:: value - The value.; echo - If true, the HTML will be echo'ed as well as returned.
Returns:: HTML code.

public ZMPluginPage zm_simple_config_form(ZMPlugin plugin, string fkt, string title, boolean all)

Create a simple plugin config form.

Parameters:: plugin - The plugin.; fkt - The view function.; title - Optional title; default is null to use the plugin name.; all - Allows to exclude the common values (status/sort order); default is true to show all.
Returns:: The plugin page instance.

Summary: Function Detail: Function