im_users_in_group

EveAndersson.com : API Browser : im_users_in_group

im_users_in_group

im_users_in_group group_id current_user_id [ description ] \
    [ add_admin_links ] [ return_url ] [ limit_to_users_in_group_id ] \
    [ dont_allow_users_in_group_id ] [ link_type ] \
    [ also_add_to_group_id ]
Defined in tcl/intranet-defs.tcl

Returns an html formatted list of all the users in the specified group. Includes optional links to add people, add/remove yourself, and spam Required Arguments: ------------------- - group_id: Group we're interested in. We'll display the users in this group - current_user_id: The user_id of the person viewing the page that called this function. This is used to add links like "Add yourself"... Optional Arguments: ------------------- - description: A description of the group. We use pass this to the spam function for UI - add_admin_links: Boolean. If 1, we add links to add/email people. Current user must be member of the specified group_id to add him/herself - return_url: Where to go after we do something like add a user - limit_to_users_in_group_id: Only shows users who belong to group_id and who are also members of the group specified in limit_to_users_in_group_id. For example, if group_id is an intranet project, and limit_to_users_group_id is the group_id of the employees group, we only display users who are members of both the employees and this project groups - dont_allow_users_in_group_id: Similar to limit_to_users_in_group_id, but says that if a user belongs to the group_id specified by dont_allow_users_in_group_id, then don't display that user. - link_type: if set to "email_only" then the links returned have no html tags - also_add_to_group_id: If we're adding users to a group, we might also want to add them to another group at the same time. If you set also _add_to_group_id to a group_id, the user will be added first to group_id, then to also_add_to_group_id. Note that adding the person to both groups is NOT atomic. Notes: ------------------- This function has quickly grown out-of-hand with all the additional flags needed. Originally, it seemed like a good idea to encapsulate the admin functions for intranet projects/customers/etc. in one piece of reusable code. However, it would be more useful in the future to create separate functions for each category of group in the intranet, and to use ad_proc to allow for cleaner extension.

Parameters:
group_id
current_user_id
description (optional)
add_admin_links (defaults to "0")
return_url (optional)
limit_to_users_in_group_id (optional)
dont_allow_users_in_group_id (optional)
link_type (optional)
also_add_to_group_id (optional)
[ show source ]

Show another procedure:

eve@eveandersson.com