Procedural File: pnadmin.php
Source Location: /Groups/pnadmin.php
Page Details:
Zikula Application Framework
Tags:
Groups_admin_adduser [line 571]
string Groups_admin_adduser(
int $args, mixed 1)
|
|
This is a standard function to add a user to a group
Tags:
Parameters
| mixed |
1 |
'uid' the id of the user (int) or an array of userids |
| int |
$args |
'gid' the id of the group |
Groups_admin_create [line 207]
bool Groups_admin_create(
string $args)
|
|
This is a standard function that is called with the results of the
form supplied by groups admin_new() to create a new group
Tags:
Parameters
| string |
$args |
'name' the name of the group to be created |
Groups_admin_delete [line 367]
mixed Groups_admin_delete(
int $args, bool 1, int 2)
|
|
delete group
This is a standard function that is called whenever an administrator wishes to delete a current group 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
| bool |
1 |
'confirmation' confirmation that this item can be deleted |
| int |
2 |
'objectid' generic object id mapped onto gid if present |
| int |
$args |
'gid' the id of the item to be deleted |
Groups_admin_groupmembership [line 441]
string Groups_admin_groupmembership(
int $args, int 1)
|
|
This is a standard function to display members of a group
Tags:
Parameters
| int |
1 |
'objectid' generic object id mapped onto gid if present |
| int |
$args |
'gid' the id of the group to list membership for |
Groups_admin_main [line 24]
string Groups_admin_main(
)
|
|
Groups Module 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:
Groups_admin_modify [line 256]
string Groups_admin_modify(
int $args, int 1)
|
|
modify a group
This is a standard function that is called whenever an administrator wishes to modify a current group item
Tags:
Parameters
| int |
1 |
'objectid' generic object id mapped onto gid if present |
| int |
$args |
'gid' the id of the group to be modified |
Groups_admin_modifyconfig [line 764]
string Groups_admin_modifyconfig(
)
|
|
This is a standard function to modify the configuration parameters of the
module
Tags:
Groups_admin_new [line 175]
string Groups_admin_new(
)
|
|
Add a new group
This is a standard function that is called whenever an administrator wishes to create a new group
Tags:
Groups_admin_removeuser [line 612]
string Groups_admin_removeuser(
int $args, int 1)
|
|
This is a standard function to add a user to a group
Tags:
Parameters
| int |
1 |
'uid' the id of the user |
| int |
$args |
'gid' the id of the group |
Groups_admin_update [line 313]
bool Groups_admin_update(
int $args, int 1, string 2)
|
|
This is a standard function that is called with the results of the
form supplied by groups_admin_modify() to update a current group item
Tags:
Parameters
| int |
1 |
'objectid' generic object id mapped onto gid if present |
| string |
2 |
'name' the name of the group to be updated |
| int |
$args |
'gid' the id of the group to be modified |
Groups_admin_updateconfig [line 802]
bool Groups_admin_updateconfig(
)
|
|
This is a standard function to update the configuration parameters of the
module given the information passed back by the modification form
Tags:
Groups_admin_userpending [line 641]
void Groups_admin_userpending(
)
|
|
display a list of group applications
Groups_admin_userupdate [line 685]
void Groups_admin_userupdate(
)
|
|
update group applications
Groups_admin_view [line 58]
string Groups_admin_view(
)
|
|
View all groups
this function creates a tabular output of all group items in the module
Tags:
|
