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

Docs for page pnadminapi.php

[ class tree: Zikula_System_Modules ] [ index: Zikula_System_Modules ] [ all elements ] [ Todo List ]

Procedural File: pnadminapi.php

Source Location: /Admin/pnadminapi.php

Classes:



Page Details:

Zikula Application Framework



Tags:

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







Admin_adminapi_addmodtocategory [line 248]

mixed Admin_adminapi_addmodtocategory( $args, string $args['module'], int $args['category'])

add a module to a category



Tags:

return:  admin category ID on success, false on failure
author:  Mark West


Parameters

string   $args['module']   name of the module
int   $args['category']   number of the category
   $args  
[ Top ]


Admin_adminapi_countitems [line 236]

int Admin_adminapi_countitems( )

utility function to count the number of items held by this module



Tags:

return:  number of items held by this module
author:  Mark West


[ Top ]


Admin_adminapi_create [line 20]

mixed Admin_adminapi_create( $args, string $args['catname'], string $args['description'])

create a admin category



Tags:

return:  admin category ID on success, false on failure
author:  Mark West


Parameters

string   $args['catname']   name of the category
string   $args['description']   description of the category
   $args  
[ Top ]


Admin_adminapi_delete [line 53]

bool Admin_adminapi_delete( $args, int $args['cid'])

delete a admin category



Tags:

return:  true on success, false on failure
author:  Mark West


Parameters

int   $args['cid']   ID of the category
   $args  
[ Top ]


Admin_adminapi_get [line 210]

mixed Admin_adminapi_get( $args, int $args['cid'])

get a specific category



Tags:

return:  item array, or false on failure
author:  Mark West


Parameters

int   $args['cid']   id of example item to get
   $args  
[ Top ]


Admin_adminapi_getall [line 161]

mixed Admin_adminapi_getall( $args, int $args['startnum'], int $args['numitems'])

get all admin categories



Tags:

return:  array of items, or false on failure
author:  Mark West


Parameters

int   $args['startnum']   starting record number
int   $args['numitems']   number of items to get
   $args  
[ Top ]


admin_adminapi_getlinks [line 368]

array admin_adminapi_getlinks( )

get available admin panel links



Tags:

return:  array of admin links
author:  Mark West


[ Top ]


Admin_adminapi_getmodcategory [line 284]

mixed Admin_adminapi_getmodcategory( $args, int $args['mid'])

Get the category a module belongs to



Tags:

return:  category id, or false on failure
author:  Mark West


Parameters

int   $args['mid']   id of the module
   $args  
[ Top ]


Admin_adminapi_getmodstyles [line 324]

mixed Admin_adminapi_getmodstyles( $args, int $args['mid'])

Get the category a module belongs to



Tags:

return:  array of styles if successful, or false on failure
author:  Mark West


Parameters

int   $args['mid']   id of the module
   $args  
[ Top ]


Admin_adminapi_update [line 115]

bool Admin_adminapi_update( $args, int $args['cid'], string $args['catname'], string $args['description'])

update a admin category



Tags:

return:  true on success, false on failure
author:  Mark West


Parameters

int   $args['cid']   the ID of the category
string   $args['catname']   the new name of the category
string   $args['description']   the new description of the category
   $args  
[ Top ]


Packages:

Files:

Classes: