Squiz Matrix  4.12.2
 All Data Structures Namespaces Functions Variables Pages
Public Member Functions | Static Public Member Functions
Soap_Api_Permission_Role_Service Class Reference
Inheritance diagram for Soap_Api_Permission_Role_Service:

Public Member Functions

 __construct ($assetid=0)
 
 getFunctionList ()
 
 HasAccess ($request)
 
 SetPermission ($request)
 
 GetPermission ($request)
 
 GetRole ($request)
 
 SetRole ($request)
 

Static Public Member Functions

static getComplexElements ($func_list=Array())
 
static getComplexTypes ($func_list=Array())
 
static getSimpleRestrictedTypes ($func_list=Array())
 

Detailed Description

Definition at line 31 of file soap_api_permission_role_service.inc.

Constructor & Destructor Documentation

__construct (   $assetid = 0)

Constructor

Parameters
int$assetidthe asset id to be loaded

Definition at line 41 of file soap_api_permission_role_service.inc.

Member Function Documentation

static getComplexElements (   $func_list = Array())
static

getComplexType

Returns
array public

Definition at line 400 of file soap_api_permission_role_service.inc.

static getComplexTypes (   $func_list = Array())
static

getComplexTypes: return all the complex types used by the API

Returns
array public

Definition at line 486 of file soap_api_permission_role_service.inc.

getFunctionList ( )

Returns a function list of the asset let the children handle this

Returns
string private
See Also
Asset::_getName()

Definition at line 55 of file soap_api_permission_role_service.inc.

GetPermission (   $request)

Description: This operation will return the permission set for on an asset

Parameters
array$asset_infothe info array to find children of a specific asset 
Array (
    'AssetID'           => [The asset in query],
    'PermissionLevel'   => [Read Write Admin],
    'Granted'           => [Apply, Deny, Revoke],
    'AndGreater'        => [Check for effective permission (write = read + write)],
    'ExpandGroups'      => [Return userids inside a group instead just groupid],
    'AllInfo'           => [Apply, Deny, Revoke],
       )
Returns
void public

Definition at line 184 of file soap_api_permission_role_service.inc.

GetRole (   $request)

Description: This operation will return an array of roles and the users/groups which can perform it

Parameters
array$asset_infothe info array to find children of a specific asset 
Array (
    'AssetID'               => [The assetid of the asset the role is applied to],
    'RoleID'                => [The assetid of the the role that is applied],
    'UserID'                => [The assetid of the user performing the role],
    'IncludeAssetID'        => [Whether to include the assetid in the returned array],
    'IncludeGlobals'        => [Whether to query the role view which includes expanded global roles as individual users],
    'IncludeDependants'     => [If false it will filter out the dependant assets],
    'ExpandGroups'          => [when TRUE, any groups defined within a role will be replaced with the userids in that group]
       )
Returns
void public

Definition at line 238 of file soap_api_permission_role_service.inc.

static getSimpleRestrictedTypes (   $func_list = Array())
static

getSimpleRestrictedTypes

Returns
array public

Definition at line 518 of file soap_api_permission_role_service.inc.

HasAccess (   $request)

Description: This operation will check whether the requesting user have a certain access level to a particular asset

Parameters
array$requestThe request information 
Array (
     'AssetID'          => [type code of new asset],
     'PermissionLevel'  => [name for new asset],
       )
Returns
void public

Definition at line 82 of file soap_api_permission_role_service.inc.

SetPermission (   $request)

Description: This operation will set the permission for a user on an asset

Parameters
array$asset_infothe info array to find children of a specific asset 
Array (
    'AssetID'           => [The asset in query],
    'UserID'            => [The user which the permission is applying for],
    'PermissionLevel'   => [Read Write Admin],
    'Grant'             => [Apply, Deny, Revoke],
    'Cascade'           => [Whether to cascade permission down to children],
       )
Returns
void public

Definition at line 119 of file soap_api_permission_role_service.inc.

SetRole (   $request)

Description: This operation will set role for an user to perform on an asset.

Parameters
array$asset_infothe info array to find children of a specific asset 
Array (
    'AssetID'               => [The assetid of the asset the role is applied to],
    'RoleID'                => [The assetid of the the role that is applied],
    'UserID'                => [The assetid of the user performing the role],
    'Action'                => [Add | Delete Role],
    'GlobalRole'            => [Global or non-global role],
    'Cascade'               => [Whether to cascade the role down to children],
       )
Returns
void public

Definition at line 301 of file soap_api_permission_role_service.inc.

The documentation for this class was generated from the following file: