Class: Services_Amazon_S3_LoggingStatus

Source Location: /Services_Amazon_S3-0.4.0/Services/Amazon/S3/LoggingStatus.php

Class Overview

This class represents logging status for a bucket

Author(s):

Christian Schmidt <chsc at peytz.dk>
Michael Gauthier <mike at silverorange.com>

Version:

Release: @release-version@

Copyright:

2008 Peytz & Co. A/S, 2010 silverorange Inc

Inherited Variables

Inherited Methods

Class Details

[line 91]
This class represents logging status for a bucket

Log access can be granted to individual users and two predefined groups.

A grantee is represented as an associate array. The $grantee['type'] must be set to either Services_Amazon_S3_LoggingStatus::TYPE_CANONICAL_USER, Services_Amazon_S3_LoggingStatus::AMAZON_CUSTOMER_BY_EMAIL or Services_Amazon_S3_LoggingStatus::TYPE_GROUP.

If type is TYPE_CANONICAL_USER, $grantee['ID'] must be set to a canonical Amazon account id. The $grantee['displayName'] may be populated by the server.

If type is TYPE_AMAZON_CUSTOMER_BY_EMAIL, $grantee['emailAddress'] must be set to an email address of an Amazon customer. Note that the server converts this type of grantee to a TYPE_CANONICAL_USER when the logging status is saved and returned in future replies.

If type is TYPE_GROUP, $grantee['URI'] must be set to either Services_Amazon_S3_LoggingStatus::URI_ALL_USERS or Services_Amazon_S3_LoggingStatus::URI_AUTHENTICATED_USERS.

Author: Christian Schmidt <chsc@peytz.dk>
Author: Michael Gauthier <mike@silverorange.com>
Version: Release: @release-version@
Copyright: 2008 Peytz & Co. A/S, 2010 silverorange Inc
Link: http://docs.amazonwebservices.com/AmazonS3/2006-03-01/ServerLogs.html
Link: http://pear.php.net/package/Services_Amazon_S3
License: BSD

[ Top ]

Class Variables

$bucket =

[line 147]

The bucket this logging status applies to

See: Services_Amazon_S3_LoggingStatus::__construct()
Access: public

Type:

Services_Amazon_S3_Bucket

[ Top ]

Method Detail

__construct (Constructor) [line 174]

Services_Amazon_S3_LoggingStatus __construct(
Services_Amazon_S3_Bucket
$bucket)

Creates a new logging status object for a bucket

Access: public

Parameters:

Services_Amazon_S3_Bucket $bucket — the bucket that this logging status applies to.

[ Top ]

getGrantees [line 187]

array getGrantees(
)

Returns an array of grantee arrays.

Access: public

[ Top ]

getPermissions [line 210]

int getPermissions(
array
$grantee, [bool
$implied = false])

Returns the permissions for the specified grantee.

Return: a mask of self::ACL_xxx values
Access: public

Parameters:

array	`$grantee`	—	an associative array
bool	`$implied`	—	if true and $grantee[type] == TYPE_CANONICAL_USER, include implied rights granted to "authenticated users" or "all users"

[ Top ]

load [line 300]

void load(
)

Loads this ACL from the server.

Throws: Services_Amazon_S3_Exception
Access: public

[ Top ]

save [line 364]

void save(
)

Saves this ACL to the server.

Throws: Services_Amazon_S3_Exception
Access: public

[ Top ]

setPermissions [line 246]

int setPermissions(
array
$grantee, int
$permissions)

Returns the permissions for the specified grantee.

Return: a mask of self::PERMISSION_xxx flags
Access: public

Parameters:

array	`$grantee`	—	an associative array
int	`$permissions`	—	a mask of self::ACL_xxx values

[ Top ]