PHP Class Google\Cloud\Iam\PolicyBuilder

Example: use Google\Cloud\Iam\PolicyBuilder; $builder = new PolicyBuilder(); $builder->addBinding('roles/admin', [ 'user:[email protected]' ]); $result = $builder->result();

Datei anzeigen Open project: GoogleCloudPlatform/gcloud-php Class Usage Examples

Public Methods

Method	Description
__construct ( array $policy = [] )	Create a PolicyBuilder.
addBinding ( string $role, array $members ) : PolicyBuilder	Add a new binding to the policy.
result ( ) : array	Create a policy array with data in the correct format.
setBindings ( array $bindings = [] ) : PolicyBuilder	Override all stored bindings on the policy.
setEtag ( string $etag ) : PolicyBuilder	Update the etag on the policy.
setVersion ( integer $version ) : PolicyBuilder	Update the version of the policy.

Private Methods

Method	Description
validateMember ( string $member ) : void	Validate that each member is in the correct format.

Method Details

__construct() public method

Create a PolicyBuilder.

public __construct ( array $policy = [] )
$policy	array	A policy array

addBinding() public method

Example: $builder->addBinding('roles/admin', [ 'user:[email protected]' ]);

public addBinding ( string $role, array $members ) : PolicyBuilder
$role	string	A valid role for the service
$members	array	An array of members to assign to the binding
return	PolicyBuilder

result() public method

Example: $policy = $builder->result();

public result ( ) : array
return	array	An array of policy data

setBindings() public method

Example: $builder->setBindings([ [ 'role' => roles/admin', 'members' => [ 'user:[email protected]' ] ] ]);

public setBindings ( array $bindings = [] ) : PolicyBuilder
$bindings	array	[optional] An array of bindings
return	PolicyBuilder

setEtag() public method

Example: $builder->setEtag($oldPolicy['etag']);

public setEtag ( string $etag ) : PolicyBuilder
$etag	string	used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that updates to existing policies make use of the etag to avoid race conditions.
return	PolicyBuilder

setVersion() public method

Example: $builder->setVersion(1);

public setVersion ( integer $version ) : PolicyBuilder
$version	integer	Version of the Policy. Defaults to `0`.
return	PolicyBuilder