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: /Groups/pnadminapi.php

Classes:



Page Details:

Zikula Application Framework



Tags:

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







Groups_adminapi_adduser [line 184]

bool Groups_adminapi_adduser( $args, int $args['gid'], int $args['uid'])

add a user to a group item



Tags:

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


Parameters

int   $args['gid']   the ID of the item
int   $args['uid']   the ID of the user
   $args  
[ Top ]


Groups_adminapi_create [line 19]

mixed Groups_adminapi_create( $args, string $args['name'])

create a new group item



Tags:

return:  group ID on success, false on failure
author:  Mark West


Parameters

string   $args['name']   name of the group
   $args  
[ Top ]


Groups_adminapi_delete [line 69]

bool Groups_adminapi_delete( $args, int $args['gid'])

delete a group item



Tags:

return:  true on success, false on failure
author:  Mark West
todo:  call permissions API to remove group permissions associated with the group


Parameters

int   $args['gid']   ID of the item
   $args  
[ Top ]


Groups_adminapi_getapplicationinfo [line 357]

array Groups_adminapi_getapplicationinfo( $args, int $args['gid'], int $args['userid'])

get application info



Tags:

author:  F. Chestnut


Parameters

int   $args['gid']  
int   $args['userid']  
   $args  
[ Top ]


Groups_adminapi_getapplications [line 308]

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

get applications



Tags:

return:  array, false on failure


Parameters

int   $args['startnum']  
int   $args['numitems']  
   $args  
[ Top ]


Groups_adminapi_getgidbyname [line 271]

int Groups_adminapi_getgidbyname( $args['name'] $args, $args['checkgid'] 1)

get a specific group id from a group name



Tags:

return:  item, or false on failure
author:  F. Chestnut


Parameters

$args['checkgid']   1   optional gid of the group
$args['name']   $args   name of group item to get
[ Top ]


Groups_adminapi_getlinks [line 448]

array Groups_adminapi_getlinks( )

get available admin panel links



Tags:

return:  array of admin links
author:  Mark West


[ Top ]


Groups_adminapi_pendingaction [line 393]

bool Groups_adminapi_pendingaction( $args, int $args['gid'], int $args['userid'], string $args['action'])

pending action



Tags:

author:  F. Chestnut


Parameters

int   $args['gid']  
int   $args['userid']  
string   $args['action']  
   $args  
[ Top ]


Groups_adminapi_removeuser [line 225]

bool Groups_adminapi_removeuser( $args, int $args['gid'], int $args['uid'])

remove a user from a group item



Tags:

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


Parameters

int   $args['gid']   the ID of the item
int   $args['uid']   the ID of the user
   $args  
[ Top ]


Groups_adminapi_update [line 119]

bool Groups_adminapi_update( $args, int $args['gid'], string $args['name'])

update a group item



Tags:

return:  true if successful, false otherwise
author:  Mark West
todo:  add missing 'name' to modargs check


Parameters

int   $args['gid']   the ID of the item
string   $args['name']   the new name of the item
   $args  
[ Top ]


Packages:

Files:

Classes: