1. class
  2. OpenStack
  3. Identity
  4. v3
  5. Models
  6. Group

Group

class Group extends OperatorResource implements Creatable, Listable, Retrievable, Updateable, Deletable

Traits

OpenStack\Common\Api\OperatorTrait

Properties

$domainId string
$id string
$description string
$links
$name string

Methods

create (array $data) : Creatable

Create a new resource according to the configuration set in the options.

retrieve () : void

Retrieve details of the current resource from the remote API.

update () : void

Update the current resource with the configuration set out in the user options.

delete () : void

Permanently delete this resource.

listUsers (array $options = array()) : Generator

No description

addUser (array $options)

No description

removeUser (array $options)

No description

checkMembership (array $options) : bool

No description

Details

View source
create(array $data)

Create a new resource according to the configuration set in the options.

Parameters

$data array {see \OpenStack\Identity\v3\Api::postGroups}

Return value

Creatable

Example code

$creatable = $group->create($data);

View source
retrieve()

Retrieve details of the current resource from the remote API.

Return value

void

Example code

$group->retrieve();

View source
update()

Update the current resource with the configuration set out in the user options.

Return value

void

Example code

$group->update();

View source
delete()

Permanently delete this resource.

Return value

void

Example code

$group->delete();

View source
listUsers(array $options = array())

Parameters

$options array {see \OpenStack\Identity\v3\Api::getGroupUsers}

Return value

Generator

Example code

$generator = $group->listUsers($options);

View source
addUser(array $options)

Parameters

$options array {see \OpenStack\Identity\v3\Api::putGroupUser}

Example code

$group->addUser($options);

View source
removeUser(array $options)

Parameters

$options array {see \OpenStack\Identity\v3\Api::deleteGroupUser}

Example code

$group->removeUser($options);

View source
checkMembership(array $options)

Parameters

$options array {see \OpenStack\Identity\v3\Api::headGroupUser}

Return value

bool

Example code

$bool = $group->checkMembership($options);