Zikula: A Flexible Open Source Content Management System
home | forum | international support | contact us

Docs for page pnadmin.php

Procedural File: pnadmin.php

Source Location: /Ephemerids/pnadmin.php

Classes:



Page Details:

Zikula Application Framework



Tags:

version:  $Id: pnadmin.php 24383 2008-06-12 14:15:02Z markwest $
copyright:  (c) 2002, Zikula Development Team
link:  http://www.zikula.org
license:  GNU/GPL








Ephemerids_admin_create [line 73]

mixed Ephemerids_admin_create( 'Date_Day' $args, 'Date_Month' 1, 'Date_Year' 2, 'content' 3, 'language' 4)

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

form supplied by Ephemerids_admin_new() to create a new item




Tags:

return:  ephemerid id on success, false on failiure
author:  Mark West


Parameters

'Date_Month'   1   the month of the emphererid
'Date_Year'   2   the year of the emphererid
'content'   3   the ephmerid description
'language'   4   the language of the ephemerid
'Date_Day'   $args   the day of the emphererid
[ Top ]



Ephemerids_admin_delete [line 204]

mixed Ephemerids_admin_delete( 'eid' $args, 'objectid' 1, 'confirmation' 2)

Delete an ephemerid

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 string if no confirmation, true if delete successful, false otherwise
author:  Mark West


Parameters

'objectid'   1   generic object id maps to eid if present
'confirmation'   2   confirmation that this item can be deleted
'eid'   $args   the id of the ephemerid to be deleted
[ Top ]



Ephemerids_admin_main [line 24]

string Ephemerids_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 string
author:  Mark West


[ Top ]



Ephemerids_admin_modify [line 111]

string Ephemerids_admin_modify( 'eid' $args, 'objectid' 1)

Modify an ephemerid

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




Tags:

return:  HTML string
author:  Mark West


Parameters

'objectid'   1   generic object id maps to eid if presents
'eid'   $args   the id of the item to be modified
[ Top ]



Ephemerids_admin_modifyconfig [line 319]

stringHTML Ephemerids_admin_modifyconfig( )

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

module




Tags:

return:  string
author:  Mark West


[ Top ]



Ephemerids_admin_new [line 45]

string Ephemerids_admin_new( )

Add a new ephemerid

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




Tags:

return:  HTML string
author:  Mark West


[ Top ]



Ephemerids_admin_update [line 156]

bool Ephemerids_admin_update( 'eid' $args, 'objectid' 1, 'Date_Day' 2, 'Date_Month' 3, 'Date_Year' 4, 'content' 5, 'language' 6)

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

form supplied by Ephemerids_admin_modify() to update a current item




Tags:

return:  true on update success, false on failiure
author:  Mark West


Parameters

'objectid'   1   generic object id maps to eid if present
'Date_Day'   2   the day of the emphererid
'Date_Month'   3   the month of the emphererid
'Date_Year'   4   the year of the emphererid
'content'   5   the ephmerid description
'language'   6   the language of the ephemerid
'eid'   $args   the id of the ephemerid
[ Top ]



Ephemerids_admin_updateconfig [line 342]

bool Ephemerids_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:

return:  true if update successful, false otherwise
author:  Mark West


[ Top ]



Ephemerids_admin_view [line 262]

string Ephemerids_admin_view( )

View ephemerids This is a standard function called to present the administrator with a list of all items held by the module.



Tags:

return:  HTML string
author:  Mark West


[ Top ]


Packages:

Files:

Classes: