Procedural File: pnadmin.php

Source Location: /system/Admin_Messages/pnadmin.php

Page Details:

Zikula Application Framework

Tags:

version:	$Id: pnadmin.php 24342 2008-06-06 12:03:14Z markwest $
copyright:	(c) 2002, Zikula Development Team
link:	http://www.zikula.org
filesource:	Source Code for this file
license:	http://www.gnu.org/copyleft/gpl.html
license:	GNU/GPL

Admin_Messages_admin_create [line 76]

bool Admin_Messages_admin_create(
 $args, string $args['title'], string $args['content'], string $args['language'], int $args['active'], int $args['expire'], int $args['view'])

This is a standard function that is called with the results of the

form supplied by Admin_Messages_admin_new() to create a new item

Tags:

return:	true if creation successful, false otherwiise
author:	Mark West
see:	Admin_Messages_admin_new()

Parameters

string	$args['title']	the title of the admin message
string	$args['content']	the text of the admin message
string	$args['language']	the language of the admin message
int	$args['active']	active status of the admin message
int	$args['expire']	the expiry date of the message
int	$args['view']	who can view the message
	$args

[ Top ]

Admin_Messages_admin_delete [line 212]

mixed Admin_Messages_admin_delete(
 $args, int $args['mid'], 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:

return:	HTML output string if no confirmation, true if succesful, false otherwise
author:	Mark West

Parameters

int	$args['mid']	the id of the admin message to delete
int	$args['objectid']	generic object id maps to mid if present
bool	$args['confirmation']	confirmation of the deletion
	$args

[ Top ]

Admin_Messages_admin_main [line 25]

string Admin_Messages_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:

return:	HTML output string
author:	Mark West

[ Top ]

Admin_Messages_admin_modify [line 115]

string Admin_Messages_admin_modify(
 $args, int $args['mid'], int $args['objectid'])

modify an Admin Message

This is a standard function that is called whenever an administrator wishes to modify a current module item

Tags:

return:	HTML output string
author:	Mark West

Parameters

int	$args['mid']	the id of the admin message to modify
int	$args['objectid']	generic object id maps to mid if present
	$args

[ Top ]

Admin_Messages_admin_modifyconfig [line 387]

string Admin_Messages_admin_modifyconfig(
)

This is a standard function to modify the configuration parameters of the

module

Tags:

return:	HTML output string
author:	Mark West

[ Top ]

Admin_Messages_admin_new [line 46]

string Admin_Messages_admin_new(
)

add a new admin message

This is a standard function that is called whenever an administrator wishes to create a new module item

Tags:

return:	HTML output string
author:	Mark West

[ Top ]

Admin_Messages_admin_update [line 162]

bool Admin_Messages_admin_update(
 $args, int $args['mid'], int $args['objectid'], string $args['title'], string $args['content'], string $args['language'], int $args['active'], int $args['expire'], int $args['view'])

This is a standard function that is called with the results of the

form supplied by Admin_Messages_admin_modify() to update a current item

Tags:

return:	true if successful, false otherwise
author:	Mark West
see:	Admin_Messages_admin_modify()

Parameters

int	$args['mid']	the id of the admin message to update
int	$args['objectid']	generic object id maps to mid if present
string	$args['title']	the title of the admin message
string	$args['content']	the text of the admin message
string	$args['language']	the language of the admin message
int	$args['active']	active status of the admin message
int	$args['expire']	the expiry date of the message
int	$args['view']	who can view the message
	$args

[ Top ]

Admin_Messages_admin_updateconfig [line 412]

bool Admin_Messages_admin_updateconfig(
[int $itemsperpage = the number messages per page in the admin panel])

This is a standard function to update the configuration parameters of the

module given the information passed back by the modification form

Tags:

return:	true if successful, false otherwise
author:	Mark West
see:	Admin_Messages_admin_modifyconfig()

Parameters

int

$itemsperpage

the number messages per page in the admin panel

[ Top ]

Admin_Messages_admin_view [line 272]

string Admin_Messages_admin_view(
[int $startnum = the start item id for the pager])

view items

Tags:

return:	HTML output string
author:	Mark West

Parameters

int

$startnum

the start item id for the pager

[ Top ]

Documentation generated on Fri, 18 Jul 2008 21:51:29 +0200 by phpDocumentor 1.4.1