Procedural File: pnadmin.php
Source Location: /News/pnadmin.php
Page Details:
Zikula Application Framework
Tags:
News_admin_delete [line 232]
mixed News_admin_delete(
int $args, int 1, int 2)
|
|
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 |
1 |
'objectid' generic object id maps to sid if present |
| int |
2 |
'confirmation' confirmation that this news item can be deleted |
| int |
$args |
'sid' the id of the news item to be deleted |
News_admin_main [line 24]
string News_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:
News_admin_modify [line 59]
string News_admin_modify(
int $args, int 1)
|
|
modify an item
This is a standard function that is called whenever an administrator wishes to modify a current module item
Tags:
Parameters
| int |
1 |
'objectid' generic object id maps to sid if present |
| int |
$args |
'sid' the id of the item to be modified |
News_admin_modifyconfig [line 423]
string News_admin_modifyconfig(
)
|
|
This is a standard function to modify the configuration parameters of the
module
Tags:
News_admin_new [line 44]
create a new news article
this function is purely a wrapper for the output from news_user_new
Tags:
News_admin_update [line 160]
bool News_admin_update(
int $args, int 1, string 2, string 3, string 4, string 5, int 6, string 7, int 8, string 9, int 10, int 11)
|
|
This is a standard function that is called with the results of the
form supplied by News_admin_modify() to update a current item
Tags:
Parameters
| int |
1 |
'objectid' generic object id maps to sid if present |
| string |
2 |
'title' the title of the news item |
| string |
3 |
'urltitle' the title of the news item formatted for the url |
| string |
4 |
'language' the language of the news item |
| string |
5 |
'bodytext' the summary text of the news item |
| int |
6 |
'bodytextcontenttype' the content type of the summary text |
| string |
7 |
'extendedtext' the body text of the news item |
| int |
8 |
'extendedtextcontenttype' the content type of the body text |
| string |
9 |
'notes' any administrator notes |
| int |
10 |
'published_status' the published status of the item |
| int |
11 |
'ihome' publish the article in the homepage |
| int |
$args |
'sid' the id of the item to be updated |
News_admin_updateconfig [line 458]
bool News_admin_updateconfig(
[int 0 = 'itemsperpage' number of articles per page])
|
|
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 |
0 |
'itemsperpage' number of articles per page |
News_admin_view [line 293]
string News_admin_view(
int $args)
|
|
view items
Tags:
Parameters
| int |
$args |
'startnum' starting number for paged output |
|
