Skip to content
bendauphinee edited this page Mar 31, 2011 · 2 revisions

This is a list of all functions and what they do.

Public Functions

These were created to wrap the most useful operations.

Group Functions

  • group_create - Create group
  • group_deactivate - Deactivate group
  • group_exists - Check if group exists
  • group_getid - Get group id from name
  • group_umember - Is user member of this group
  • group_umemberships - List groups that user is member of
  • group_uadd - Add a user to group
  • group_urem - Remove a user from group

Permission Functions

  • permission_exists - Check if permission key exists
  • permission_gaccess - Does group have this permission globally
  • permission_glist - List what groups have this permission
  • permission_raccess - Does role have this permission globally
  • permission_rlist - List what roles have this permission
  • permission_tree - Recursive lookup of permissions related to this permission
  • permission_uaccess - Does user have permission globally
  • permission_ulist - List users that have this permission

Resource Functions

  • resource_exists - Check if resource exists
  • resource_gaccess - Check if group has access to this resource
  • resource_gfind - List all resources group has access to of specified type
  • resource_glist - List all groups that are allowed or denied this resource
  • resource_gperm - Check if group has specific permission on resource
  • resource_gpermgrant - Grant group permission for resource
  • resource_gpermrevoke - Revoke group permission for resource
  • resource_info - Get resource information
  • resource_ownerid - Determine the user who owns this resource
  • resource_uaccess - Does user have any access to this resource
  • resource_ufind - List all resources user has access to of specified type
  • resource_ulist - List all users that are allowed or denied this resource
  • resource_uperm - Check if user has specific permission on resource
  • resource_upermgrant - Grant user permission for resource
  • resource_upermrevoke - Revoke user permission for resource

Role Functions

  • role_create - Create a role
  • role_delete - Delete a role
  • role_exists - Check if role exists
  • role_ggrant - Add group to role
  • role_glist - Show what groups are attached to role
  • role_gmember - Check if group is a member of this role
  • role_gmemberships - List what roles group is a member of
  • role_grevoke - Remove group from role
  • role_permadd - Add permission to role
  • role_permlist - List permissions attached to role
  • role_permrem - Remove permission from role
  • role_ulist - List all users attached to role
  • role_umember - Check if user is member of specified role
  • role_umemberships - Determine what roles user is memeber of
  • role_ugrant - Add user to role
  • role_urevoke - Remove user from role

User Functions

  • user_exists - Check if user exists

Everything Else

  • sanityCheck - Protected - Check if a variable is set or empty.

  • _buildQuery - Protected - Build a query for use later on

  • _bq_attachWhere - Protected - Attach a where condition to a query

  • _helper_setpermkey - Private - Turn a single permission key into an array of keys

  • _helper_group_setquerytype - Private - Set type of query for groups

  • _helper_gru_setquerytype - Private - Set type of query based on variables available

  • _helper_gru_sanitygru_norole - Private - Check that required variables are sane based on query type

  • _helper_resowneroverride - Private - Check to see if current user is the owner of resource

  • _helper_set_op_uasu - Private - Set operator user as the current user

  • _helper_set_sup_uasu - Private - Set supplicant user as the current user

  • _permission_tree - Private - Recursive lookup of permission keys

  • _sanityRun_acl - Protected - Checks to ensure required variables are sane (set and valid)

  • check_permission_uaccess - Public - Check if user has access to permission key through user, group, or role grants

  • check_resource_uaccess - Public - Check if user has access to resource through user or group

  • check_resource_uperm - Public - Check if user has specific permission on resource

  • group - Private - Perform group-related functions

  • permission - Private - Perform permission-related functions

  • resource - Private - Perform resource-related functions

  • role - Private - Perform role-related functions

  • user - Private - Perform user-related functions