OBS Groups API manual

Size: px

Start display at page:

Download "OBS Groups API manual"

Corey Sullivan
5 years ago
Views:

1 OBS Groups API manual Including OBS Groups library into external Joomla component...1 Main functions...1 get_user_permissions($user,$objectid,$component)...1 draw_permissions_form($objectid,...2 savepermissions()...2 Additional functions...2 get_object_groups($objectid,$component,$level=0)...2 get_object_users($objectid,$component,$level=0)...3 set_user_permissions($user,$objectid,$component,$perm)...3 set_group_permissions($group,$objectid,$component,$perm)...3 get_group_permissions($group, $objectid, $component)...3 get_user_groups($user,$level=0)...4 get_groups_users($groups)...4 get_groups()...4 get_groups_info($grlist)...4 get_users_info($usrlist)...4 get_parent_groups($group)...5 get_children_groups($group)...5 clear_permissions($objectid, $component)...5 updateusers()...5 copypermissions($component,$objectid1, $objectid2)...5 Including OBS Groups library into external Joomla component if(file_exists($mosconfig_absolute_path. "/administrator/components/com_obs_groups/api.obs_groups.php")) include( $mosconfig_absolute_path. "/administrator/components/com_obs_groups/api.obs_groups.php"); else{ echo( "Can't found OBS Groups component"); } Main functions get_user_permissions($user,$objectid,$component) Check level of user permissions on an object. $user - user identifier; $component - component that owns object. integer value. 0 no access, 1 Read access, 2 Read/Write access.

2 draw_permissions_form($objectid, $component,$objecttitle,$addhiddens, $showcancel=true,$formaction='index.php') Draws HTML form for editing of an object permissions. $component - component that owns object; $objecttitle - object title to draw in the title of the form; $addhiddens - array of pairs name=>value. These pairs will be included in the form as hidden fields $showcancel - checks if to show Cancel button; $formaction - value of the action attribute of the form Example: draw_permissions_form('cat0', $option, 'Main category', array('option'=>$option,'task'=>'savecatperms','catid'=>0), false, 'index2.php'); savepermissions() Save submitted permissions form to the database. If was hit button Save then all changes are updated in the database. If Cancel button was hit then all changes are ignored. Example: $task = mosgetparam( $_REQUEST, 'task', '' ); $category = mosgetparam( $_REQUEST, 'catid', 0 ); if($task == 'savecatperms'){ savepermissions(); mosredirect("index2.php?option=$option&catid=$category"); } Additional functions get_object_groups($objectid,$component,$level=0) Return groups and permissions that were set on an object $level - Indicate if return only direct groups (if 0) or children of object's groups too (if 1) Associative array: groupid=>permission(1 or 2)

3 get_object_users($objectid,$component,$level=0) Return users and permissions that were set on an object $level - Indicate if return only direct users (if 0) or members of object's groups too (if 1) Associative array: user=>permission(1 or 2) set_user_permissions($user,$objectid,$component,$perm) Set user permissions on an object $user - The user ID $perm - Permissions level (0 No access, 1 Read, 2 - Read/Write) 1 - if success, 0 - if error set_group_permissions($group,$objectid,$component,$perm) Set group permissions on an object $group - The group ID $perm - Permissions level (0 No access, 1 Read, 2 - Read/Write) 1 - if success, 0 - if error get_group_permissions($group, $objectid, $component) Return group permissions on an object $group - group identifier; $component - component that owns object.

4 integer value. 0 no access, 1 Read access, 2 Read/Write access. get_user_groups($user,$level=0) Return user's groups $user - The user ID $level - Check if return only direct groups (if 0) or parents of user's groups too (if 1) The list of groups' IDs get_groups_users($groups) Return groups' users $group - group identifier; The list of users' IDs get_groups() Return all enabled groups The list of groups' Ids get_groups_info($grlist) Return groups' full info. $grlist - GroupID or Array of groupids The associative array of groups' info. GroupID=>GroupObject Members of group object: id - group id; title - group title; parent - group parent id; description - description; default - Id group is default group then 'y', else 'n'. get_users_info($usrlist) Return users' full info

5 $usrlist - UserID or Array of UserIDs The associative array of users' info. Keys - IDs, values - users' objects (standart Joomla users) get_parent_groups($group) Return group parents $group - group identifier or array of identifiers; The list of groups' Ids get_children_groups($group) Return group children $group - group identifier or array of identifiers; The list of groups' Ids clear_permissions($objectid, $component) Clear permissions for an object $component - component that owns object. True if success updateusers() Include all new users into default groups True if success copypermissions($component,$objectid1, $objectid2) Copy permissions of an object to another one

6 $component - component that owns object; $objectid1 - The source object ID $objectid2 - The target object ID True if success

Secret Server SOAP Web Services API Guide

Secret Server SOAP Web Services API Guide Table of Contents Overview... 1 Accessing Web Services... 1 Concepts... 1 Token... 1 s... 2 Windows Authentication... 2 Common... 2 Sample Code... 3 Web Service