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: /Profile/pnadmin.php

Classes:



Page Details:

Zikula Application Framework



Tags:

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








Profile_admin_activate [line 632]

bool Profile_admin_activate( int $args, int 1)

Process item activation request



Tags:

return:  true if activation successful, false otherwise
author:  Mark West
todo:  remove passing of weight parameter; can be got from API


Parameters

int   1   'weight' current weight of item
int   $args   'dudid' id of item activate
[ Top ]



Profile_admin_create [line 94]

bool Profile_admin_create( string $args, string 1, int 2)

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

form supplied by template_admin_new() to create a new item




Tags:

return:  true if item created, false otherwise
author:  Mark West
see:  Profile_admin_new()


Parameters

string   1   'dtype' the data type of the item to be created
int   2   'length' the length of the item to be created if dtype is string
string   $args   'label' the name of the item to be created
[ Top ]



Profile_admin_deactivate [line 658]

bool Profile_admin_deactivate( int $args, int 1)

Process item deactivation request



Tags:

return:  true if deactivation successful, false otherwise
author:  Mark West
todo:  remove passing of weight parameter; can be got from API


Parameters

int   1   'weight' current weight of item
int   $args   'dudid' id of item deactivate
[ Top ]



Profile_admin_decrease_weight [line 316]

void Profile_admin_decrease_weight( $var)





Parameters

   $var  
[ Top ]



Profile_admin_delete [line 364]

mixed Profile_admin_delete( int $args, int 1, bool 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:

return:  HTML string if no confirmation, true if delete successful, false otherwise
author:  Mark West


Parameters

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



Profile_admin_increase_weight [line 284]

bool Profile_admin_increase_weight( int $args, int 1, string 2, string 3, int 4)

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:

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


Parameters

int   1   'objectid' generic object id maps to dudid if present
string   2   'label' the name of the item to be updated
string   3   'dtype' the data type of the item
int   4   'length' the lenght of item if dtype is string
int   $args   'dudid' the id of the item to be updated
[ Top ]



Profile_admin_main [line 25]

string Profile_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


[ Top ]



Profile_admin_modify [line 153]

string Profile_admin_modify( int $args, int 1)

Modify a dynamic user data item

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

int   1   'objectid' generic object id maps to dudid if present
int   $args   'dudid' the id of the item to be modified
[ Top ]



Profile_admin_modifyconfig [line 569]

string Profile_admin_modifyconfig( )

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

module




Tags:

return:  HTML string
author:  Mark West


[ Top ]



Profile_admin_new [line 46]

string Profile_admin_new( )

Add new dynamic user data item

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 ]



Profile_admin_update [line 227]

bool Profile_admin_update( int $args, int 1, string 2, string 3, int 4)

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:

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


Parameters

int   1   'objectid' generic object id maps to dudid if present
string   2   'label' the name of the item to be updated
string   3   'dtype' the data type of the item
int   4   'length' the lenght of item if dtype is string
int   $args   'dudid' the id of the item to be updated
[ Top ]



Profile_admin_updateconfig [line 594]

bool Profile_admin_updateconfig( [int 0 = 'itemsperpage' the number of items to display on each page in admin view])

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
see:  Profile_modifyconfig()


Parameters

int   0   'itemsperpage' the number of items to display on each page in admin view
[ Top ]



Profile_admin_view [line 427]

string Profile_admin_view( )

View all items held by this module



Tags:

return:  HTML string
author:  Mark West


[ Top ]


Packages:

Files:

Classes: