Right

The Right Helper gives you the ability to manipulate user rights with ease. It helps you determining the current logged user rights.

Methods

Create a new Right Helper

__construct(\VMware_VCloud_SDK_Service $service) 

Arguments

$service

\VMware_VCloud_SDK_Service

The vCloud Director SDK Service

Create a new Right Helper and returns it without modifications. This form allow chaining in ALL versions of PHP:

create(\VMware_VCloud_SDK_Service $service) : \VCloud\Helpers\Right
static

\VCloud\Helpers\Right::create($service)->queryRecords(...)

Since PHP 5.4, Class member access on instantiation is allowed:

new (\VCloud\Helpers\Right($service))->queryRecords(...)

Arguments

$service

\VMware_VCloud_SDK_Service

The vCloud Director SDK Service

Response

\VCloud\Helpers\Right

Returns a new Right Handler

Get the cached Service helper, or create it

getServiceHelper() : \VCloud\Helpers\Service

Response

\VCloud\Helpers\Service

Return the Service helper associated with this helper

Get the cached Query helper, or create it

getQueryHelper() : \VCloud\Helpers\Query

Response

\VCloud\Helpers\Query

Return the Query helper associated with this helper

Determine whether the currently logged user is an "Organization Administrator". An "Organization Administrator" is a user with the following rights:

isCurrentUserOrganizationAdmin() : \VCloud\Helpers\Returns
  • General: Administrator Control
    • General: Administrator View

Response

\VCloud\Helpers\Returns

true if the currently logged user is an "Organization Administrator", false otherwise.

Get all existing rights

getAllRights() : array

Response

array

Returns all rights registered in vCloud Director

Find a right by its name

getRightByName(string $name) : array

Arguments

$name

string

The name of the right to look for

Response

array

Returns all rights registered in vCloud Director

Determine whether the currently logged user has all the given rights or not

hasCurrentUserRights(array $rights) : boolean

Arguments

$rights

array

The rights to look for (array of VMware_VCloud_API_QueryResultRightRecordType)

Response

boolean

Returns true if the currently logged user has ALL the given rights

Determine whether the currently logged user has a given right or not

hasCurrentUserRight(\VMware_VCloud_API_QueryResultRightRecordType $right) : boolean

Arguments

$right

\VMware_VCloud_API_QueryResultRightRecordType

The rights to look for

Response

boolean

Returns true if the currently logged user has the given right

Get the currently logged user's group references

getCurrentUserGroupReferences() : array

Response

array

Returns an array of \VMware_VCloud_API_ReferenceType objects

Get the currently logged user's groups

getCurrentUserGroups() : array

Response

array

Returns an array of \VMware_VCloud_SDK_Group objects

Get the currently logged user's roles

getCurrentUserRoles() : array

Response

array

Returns an array of \VMware_VCloud_SDK_Role objects

Get the currently logged user's right references

getCurrentUserRightReferences() : array

Response

array

Returns an array of \VMware_VCloud_API_ReferenceType objects

Constants

Rights bundled with vCloud Director

CATALOG_ADD_VAPP_FROM_MY_CLOUD

CATALOG_CHANGE_OWNER

CATALOG_CHANGE_OWNER

CATALOG_CREATE_DELETE_A_CATALOG

CATALOG_CREATE_DELETE_A_CATALOG

CATALOG_EDIT_PROPERTIES

CATALOG_EDIT_PROPERTIES

CATALOG_PUBLISH

CATALOG_PUBLISH

CATALOG_SHARING

CATALOG_SHARING

CATALOG_VIEW_PRIVATE_AND_SHARED_CATALOGS

CATALOG_VIEW_PRIVATE_AND_SHARED_CATALOGS

CATALOG_VIEW_PUBLISHED_CATALOGS

CATALOG_VIEW_PUBLISHED_CATALOGS

DISK_CREATE

DISK_CREATE

DISK_DELETE

DISK_DELETE

DISK_EDIT_PROPERTIES

DISK_EDIT_PROPERTIES

DISK_VIEW_PROPERTIES

DISK_VIEW_PROPERTIES

GENERAL_ADMINISTRATOR_CONTROL

GENERAL_ADMINISTRATOR_CONTROL

GENERAL_ADMINISTRATOR_VIEW

GENERAL_ADMINISTRATOR_VIEW

GENERAL_SEND_NOTIFICATION

GENERAL_SEND_NOTIFICATION

GROUP_USER_VIEW

GROUP_USER_VIEW

ORGANIZATION_NETWORK_EDIT_PROPERTIES

ORGANIZATION_NETWORK_EDIT_PROPERTIES

ORGANIZATION_NETWORK_VIEW

ORGANIZATION_NETWORK_VIEW

ORGANIZATION_VDC_GATEWAY_CONFIGURE_SERVICES

ORGANIZATION_VDC_GATEWAY_CONFIGURE_SERVICES

ORGANIZATION_VDC_NETWORK_EDIT_PROPERTIES

ORGANIZATION_VDC_NETWORK_EDIT_PROPERTIES

ORGANIZATION_VDC_NETWORK_VIEW

ORGANIZATION_VDC_NETWORK_VIEW

ORGANIZATION_VDC_STORAGE_PROFILE_SET_DEFAULT

ORGANIZATION_VDC_STORAGE_PROFILE_SET_DEFAULT

ORGANIZATION_VDC_VIEW

ORGANIZATION_VDC_VIEW

ORGANIZATION_EDIT_FEDERATION_SETTINGS

ORGANIZATION_EDIT_FEDERATION_SETTINGS

ORGANIZATION_EDIT_LEASES_POLICY

ORGANIZATION_EDIT_LEASES_POLICY

ORGANIZATION_EDIT_PASSWORD_POLICY

ORGANIZATION_EDIT_PASSWORD_POLICY

ORGANIZATION_EDIT_PROPERTIES

ORGANIZATION_EDIT_PROPERTIES

ORGANIZATION_EDIT_QUOTAS_POLICY

ORGANIZATION_EDIT_QUOTAS_POLICY

ORGANIZATION_EDIT_SMTP_SETTINGS

ORGANIZATION_EDIT_SMTP_SETTINGS

ORGANIZATION_VIEW

ORGANIZATION_VIEW

VAPP_TEMPLATE_MEDIA_COPY

VAPP_TEMPLATE_MEDIA_COPY

VAPP_TEMPLATE_MEDIA_CREATE_UPLOAD

VAPP_TEMPLATE_MEDIA_CREATE_UPLOAD

VAPP_TEMPLATE_MEDIA_EDIT

VAPP_TEMPLATE_MEDIA_EDIT

VAPP_TEMPLATE_MEDIA_VIEW

VAPP_TEMPLATE_MEDIA_VIEW

VAPP_TEMPLATE_CHECKOUT

VAPP_TEMPLATE_CHECKOUT

VAPP_TEMPLATE_DOWNLOAD

VAPP_TEMPLATE_DOWNLOAD

VAPP_CHANGE_OWNER

VAPP_CHANGE_OWNER

VAPP_COPY

VAPP_COPY

VAPP_CREATE_RECONFIGURE

VAPP_CREATE_RECONFIGURE

VAPP_DELETE

VAPP_DELETE

VAPP_EDIT_PROPERTIES

VAPP_EDIT_PROPERTIES

VAPP_EDIT_VM_CPU

VAPP_EDIT_VM_CPU

VAPP_EDIT_VM_HARD_DISK

VAPP_EDIT_VM_HARD_DISK

VAPP_EDIT_VM_MEMORY

VAPP_EDIT_VM_MEMORY

VAPP_EDIT_VM_NETWORK

VAPP_EDIT_VM_NETWORK

VAPP_EDIT_VM_PROPERTIES

VAPP_EDIT_VM_PROPERTIES

VAPP_MANAGE_VM_PASSWORD_SETTINGS

VAPP_MANAGE_VM_PASSWORD_SETTINGS

VAPP_POWER_OPERATIONS

VAPP_POWER_OPERATIONS

VAPP_SHARING

VAPP_SHARING

VAPP_SNAPSHOT_OPERATIONS

VAPP_SNAPSHOT_OPERATIONS

VAPP_USE_CONSOLE

VAPP_USE_CONSOLE

Properties

vCloud Director SDK Service

service : \VMware_VCloud_SDK_Service
var

vCloud Director SDK Service

Type(s)

\VMware_VCloud_SDK_Service

Cached current user rights

currentUserRights : array
var

Cached current user rights

Type(s)

array

Cached service helper

serviceHelper : \VCloud\Helpers\Service
var

Cached service helper

Type(s)

\VCloud\Helpers\Service

Cached query helper

queryHelper : \VCloud\Helpers\Query
var

Cached query helper

Type(s)

\VCloud\Helpers\Query