Procedural File: pnadmin.php
Source Location: /Admin/pnadmin.php
Page Details:
Zikula Application Framework
Tags:
Admin_admin_adminpanel [line 253]
string Admin_admin_adminpanel(
$args, int $args['acid'])
|
|
Display main admin panel for a category
Tags:
Parameters
| int |
$args['acid'] |
the id of the category to be displayed |
| |
$args |
|
Admin_admin_categorymenu [line 519]
string Admin_admin_categorymenu(
$args)
|
|
Main category menu
Tags:
Parameters
Admin_admin_create [line 57]
mixed Admin_admin_create(
$args, string $args['catname'], string $args['description'])
|
|
This is a standard function that is called with the results of the
form supplied by admin_admin_new() to create a new category
Tags:
Parameters
| string |
$args['catname'] |
the name of the category to be created |
| string |
$args['description'] |
the description of the category to be created |
| |
$args |
|
Admin_admin_delete [line 161]
mixed Admin_admin_delete(
$args, int $args['cid'], int $args['objectid'], bool $args['confirmation'])
|
|
delete item
This is a standard function that is called whenever an administrator wishes to delete a current module item. Note that this function is the equivalent of both of the modify() and update() functions above as it both creates a form and processes its output. This is fine for simpler functions, but for more complex operations such as creation and modification it is generally easier to separate them into separate functions. There is no requirement in the Zikula MDG to do one or the other, so either or both can be used as seen appropriate by the module developer
Tags:
Parameters
| int |
$args['cid'] |
the id of the category to be deleted |
| int |
$args['objectid'] |
generic object id maps to cid if present |
| bool |
$args['confirmation'] |
confirmation that this item can be deleted |
| |
$args |
|
Admin_admin_help [line 656]
display the module help page
Admin_admin_main [line 24]
string Admin_admin_main(
)
|
|
the main administration function
This function is the default function, and is called whenever the module is initiated without defining arguments. As such it can be used for a number of things, but most commonly it either just shows the module menu and returns or calls whatever the module designer feels should be the default function (often this is the view() function)
Tags:
Admin_admin_modify [line 86]
string Admin_admin_modify(
$args, int $args['cid'], int $args['objectid'])
|
|
Modify a category
This is a standard function that is called whenever an administrator wishes to modify an admin category
Tags:
Parameters
| int |
$args['cid'] |
category id |
| int |
$args['objectid'] |
generic object id maps to cid if present |
| |
$args |
|
Admin_admin_modifyconfig [line 386]
string Admin_admin_modifyconfig(
)
|
|
This is a standard function to modify the configuration parameters of the
module
Tags:
Admin_admin_new [line 36]
string Admin_admin_new(
)
|
|
Add a new admin category
This is a standard function that is called whenever an administrator wishes to create a new module item
Tags:
Admin_admin_update [line 122]
bool Admin_admin_update(
$args, int $args['cid'], int $args['objectid'], string $args['catname'], string $args['description'])
|
|
This is a standard function that is called with the results of the
form supplied by template_admin_modify() to update a current item
Tags:
Parameters
| int |
$args['cid'] |
the id of the item to be updated |
| int |
$args['objectid'] |
generic object id maps to cid if present |
| string |
$args['catname'] |
the name of the category to be updated |
| string |
$args['description'] |
the description of the item to be updated |
| |
$args |
|
Admin_admin_updateconfig [line 435]
string Admin_admin_updateconfig(
int $modulesperrow, int $admingraphic, int $modulename,...)
|
|
This is a standard function to update the configuration parameters of the
module given the information passed back by the modification form
Tags:
Parameters
| int |
$modulesperrow |
the number of modules to display per row in the admin panel |
| int |
$admingraphic |
switch for display of admin icons |
| int |
$modulename,... |
the id of the category to set for each module |
Admin_admin_view [line 207]
string Admin_admin_view(
[ $args = array()], int $startnum)
|
|
View all admin categories
Tags:
Parameters
| int |
$startnum |
the starting id to view from - optional |
| |
$args |
|
|
