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

Docs for page pnuserapi.php

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

Procedural File: pnuserapi.php

Source Location: /Groups/pnuserapi.php

Classes:



Page Details:

Zikula Application Framework



Tags:

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







Groups_userapi_adduser [line 508]

bool Groups_userapi_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_userapi_cancelapp [line 361]

bool Groups_userapi_cancelapp( array $args)

delete app from group_applications





Parameters

array   $args  
[ Top ]


Groups_userapi_countgroupmembers [line 142]

int Groups_userapi_countgroupmembers( int $args)

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



Tags:

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


Parameters

int   $args   args['gid'] id of group item to get
[ Top ]


Groups_userapi_countitems [line 131]

int Groups_userapi_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 ]


Groups_userapi_get [line 67]

mixed Groups_userapi_get( int $args, int 1, int 2)

get a specific group item



Tags:

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


Parameters

int   1   args['startnum'] record number to start get from (group membership)
int   2   args['numitems'] number of items to get (group membership)
int   $args   args['gid'] id of group item to get
[ Top ]


Groups_userapi_getall [line 20]

mixed Groups_userapi_getall( int $args, int 1)

get all group items



Tags:

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


Parameters

int   1   args['numitems'] number of items to get
int   $args   args['startnum'] record number to start get from
[ Top ]


Groups_userapi_getallgroups [line 205]

array Groups_userapi_getallgroups( array $args)

Get all groups



Tags:

return:  of groups


Parameters

array   $args  
[ Top ]


Groups_userapi_getusergroups [line 165]

mixed Groups_userapi_getusergroups( int $args)

get all of a users group memberships



Tags:

return:  array of group items, or false on failure
author:  Mark West
since:  v1.8


Parameters

int   $args   args['uid'] user id
[ Top ]


groups_userapi_isgroupmember [line 621]

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

check if a user is a member of a group



Tags:

return:  true if member of a group, false otherwise
author:  John Alarcon


Parameters

int   $args['uid']   user id
int   $args['gid']   group id
   $args  
[ Top ]


Groups_userapi_isuserpending [line 395]

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

check if user is pending





Parameters

int   $args['uid']   user id
int   $args['gid']   group id
   $args  
[ Top ]


Groups_userapi_removeuser [line 555]

bool Groups_userapi_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_userapi_saveapplication [line 318]

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

save application





Parameters

int   $args['uid']   user id
int   $args['gid']   group id
   $args  
[ Top ]


Groups_userapi_userupdate [line 424]

bool Groups_userapi_userupdate( $args, int $args['uid'], int $args['gtype'], string $args['action'])

update user





Parameters

int   $args['uid']   user id
int   $args['gtype']  
string   $args['action']  
   $args  
[ Top ]


Groups_userapi_whosonline [line 598]

mixed Groups_userapi_whosonline( unknown_type $args)

find who is online



Tags:

return:  array of users, or false


Parameters

unknown_type   $args  
[ Top ]


Packages:

Files:

Classes: