Class Grantee
Amazon S3 Grantee model
- Aws\S3\Model\Grantee implements Guzzle\Common\ToArrayInterface
Methods summary
-
public__construct ( string $id, string $displayName = null, string $expectedType = null )Constructs a Grantee
-
publicsetId ( string $id, string $expectedType = null )Sets the account ID, email, or URL identifying the grantee
-
publicgetId ( )Gets the grantee identifier
-
publicgetEmailAddress ( )Gets the grantee email address (if it is set)
-
publicgetGroupUri ( )Gets the grantee URI (if it is set)
-
publicsetDisplayName ( string $displayName )Sets the display name of the grantee
-
publicgetDisplayName ( )Gets the grantee display name
-
publicgetType ( )Gets the grantee type (determined by ID)
-
publicisCanonicalUser ( )Returns true if this grantee object represents a canonical user by ID
-
publicisAmazonCustomerByEmail ( )Returns true if this grantee object represents a customer by email
-
publicisGroup ( )Returns true if this grantee object represents a group by URL
-
publicgetHeaderValue ( )Returns the value used in headers to specify this grantee
-
publictoArray ( )Get the array representation of an object
Methods detail
Constructs a Grantee
Parameters
- $id
string
$id Grantee identifier- $displayName
string
$displayName Grantee display name- $expectedType
string
$expectedType The expected type of the grantee
Sets the account ID, email, or URL identifying the grantee
Parameters
- $id
string
$id Grantee identifier- $expectedType
string
$expectedType The expected type of the grantee
Returns
Throws
Aws\Common\Exception\UnexpectedValueExceptionif $expectedType is set and the grantee is not of that type after instantiation
Aws\Common\Exception\InvalidArgumentExceptionwhen the ID provided is not a string
Gets the grantee identifier
Returns
stringGets the grantee email address (if it is set)
Returns
null|stringGets the grantee URI (if it is set)
Returns
null|stringSets the display name of the grantee
Parameters
- $displayName
string
$displayName Grantee name
Returns
Throws
Gets the grantee display name
Returns
stringGets the grantee type (determined by ID)
Returns
stringReturns true if this grantee object represents a canonical user by ID
Returns
booleanReturns true if this grantee object represents a customer by email
Returns
booleanReturns true if this grantee object represents a group by URL
Returns
booleanReturns the value used in headers to specify this grantee
Returns
stringGet the array representation of an object
Returns
arrayImplementation of
Magic methods summary
Properties summary
protected static
array
|
$headerMap |
#
A map of grantee types to grant header value prefixes |
protected
string
|
$id |
#
The account ID, email, or URL identifying the grantee |
protected
string
|
$displayName |
#
The display name of the grantee |
protected
string
|
$type |
#
The type of the grantee (CanonicalUser or Group) |