Documentation

Grant
in package
implements ToArrayInterface

Amazon S3 Grant model

Table of Contents

Interfaces

ToArrayInterface
An object that can be represented as an array

Properties

$grantee  : Grantee
$parameterMap  : array<string|int, mixed>
$permission  : string

Methods

__construct()  : mixed
Constructs an ACL
getGrantee()  : Grantee
Get the grantee affected by the grant
getParameterArray()  : array<string|int, mixed>
Returns an array of the operation parameter and value to set on the operation
getPermission()  : string
Get the permission set by the grant
setGrantee()  : $this
Set the grantee affected by the grant
setPermission()  : $this
Set the permission set by the grant
toArray()  : array<string|int, mixed>
Get the array representation of an object

Properties

$grantee

protected Grantee $grantee

The grantee affected by the grant

$parameterMap

protected static array<string|int, mixed> $parameterMap = array(\Aws\S3\Enum\Permission::READ => 'GrantRead', \Aws\S3\Enum\Permission::WRITE => 'GrantWrite', \Aws\S3\Enum\Permission::READ_ACP => 'GrantReadACP', \Aws\S3\Enum\Permission::WRITE_ACP => 'GrantWriteACP', \Aws\S3\Enum\Permission::FULL_CONTROL => 'GrantFullControl')

A map of permissions to operation parameters

$permission

protected string $permission

The permission set by the grant

Methods

__construct()

Constructs an ACL

public __construct(Grantee $grantee, string $permission) : mixed
Parameters
$grantee : Grantee

Affected grantee

$permission : string

Permission applied

getGrantee()

Get the grantee affected by the grant

public getGrantee() : Grantee
Return values
Grantee

getParameterArray()

Returns an array of the operation parameter and value to set on the operation

public getParameterArray() : array<string|int, mixed>
Return values
array<string|int, mixed>

getPermission()

Get the permission set by the grant

public getPermission() : string
Return values
string

setGrantee()

Set the grantee affected by the grant

public setGrantee(Grantee $grantee) : $this
Parameters
$grantee : Grantee

Affected grantee

Return values
$this

setPermission()

Set the permission set by the grant

public setPermission(string $permission) : $this
Parameters
$permission : string

Permission applied

Tags
throws
InvalidArgumentException
Return values
$this

toArray()

Get the array representation of an object

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results