AcpBuilder
in package
Builder for creating Access Control Policies
Table of Contents
Properties
Methods
- addGrant() : $this
- Create and store a Grant for the ACL
- addGrantForEmail() : $this
- Create and store a Grant with a AmazonCustomerByEmail Grantee for the ACL
- addGrantForGroup() : $this
- Create and store a Grant with a Group Grantee for the ACL
- addGrantForUser() : $this
- Create and store a Grant with a CanonicalUser Grantee for the ACL
- build() : Acp
- Builds the ACP and returns it
- newInstance() : static
- Static method for chainable instantiation
- setOwner() : $this
- Sets the owner to be set on the ACL
Properties
$grants
protected
array<string|int, mixed>
$grants
= array()
An array of Grant objects for the ACL
$owner
protected
Grantee
$owner
The owner for the ACL
Methods
addGrant()
Create and store a Grant for the ACL
public
addGrant(string $permission, Grantee $grantee) : $this
Parameters
- $permission : string
-
Permission for the Grant
- $grantee : Grantee
-
The Grantee for the Grant
Return values
$thisaddGrantForEmail()
Create and store a Grant with a AmazonCustomerByEmail Grantee for the ACL
public
addGrantForEmail(string $permission, string $email) : $this
Parameters
- $permission : string
-
Permission for the Grant
- $email : string
-
Grantee email address
Return values
$thisaddGrantForGroup()
Create and store a Grant with a Group Grantee for the ACL
public
addGrantForGroup(string $permission, string $group) : $this
Parameters
- $permission : string
-
Permission for the Grant
- $group : string
-
Grantee group
Return values
$thisaddGrantForUser()
Create and store a Grant with a CanonicalUser Grantee for the ACL
public
addGrantForUser(string $permission, string $id[, string $displayName = null ]) : $this
Parameters
- $permission : string
-
Permission for the Grant
- $id : string
-
Grantee identifier
- $displayName : string = null
-
Grantee display name
Return values
$thisbuild()
Builds the ACP and returns it
public
build() : Acp
Return values
AcpnewInstance()
Static method for chainable instantiation
public
static newInstance() : static
Return values
staticsetOwner()
Sets the owner to be set on the ACL
public
setOwner(string $id[, string $displayName = null ]) : $this
Parameters
- $id : string
-
Owner identifier
- $displayName : string = null
-
Owner display name