Class: Services_Amazon_S3_Resource

Source Location: /Services_Amazon_S3-0.1.0/S3/Resource.php

Class Overview

Services_Amazon_S3_Resource is the base class for Services_Amazon_S3_Resource_Bucket and Services_Amazon_S3_Resource_Object.

Author(s):

Christian Schmidt <chsc at peytz.dk>

Version:

Release: 0.1.0

Copyright:

2008 Peytz & Co. A/S

Variables

Methods

Child classes:

Services_Amazon_S3_Resource_Bucket: Services_Amazon_S3_Resource_Bucket represents an Amazon S3 bucket, i.e. a container for objects.

Services_Amazon_S3_Resource_Object: Services_Amazon_S3_Resource_Object represents an Amazon S3 object, i.e. a file stored in the S3 storage service.

Inherited Variables

Inherited Methods

Class Details

[line 65]
Services_Amazon_S3_Resource is the base class for Services_Amazon_S3_Resource_Bucket and Services_Amazon_S3_Resource_Object.

Author: Christian Schmidt <chsc@peytz.dk>
Version: Release: 0.1.0
Copyright: 2008 Peytz & Co. A/S
Link: http://pear.php.net/package/Services_Amazon_S3
Abstract:
License: New BSD License

[ Top ]

Class Variables

$acl =

[line 80]

The access control list for this bucket.

This may be one of the predefined ACLs specified by a Services_Amazon_S3_AccessControlList::ACL_xxx constant, or a Services_Amazon_S3_AccessControlList instance.

Access: public

Type:

string|Services_Amazon_S3_AccessControlList

[ Top ]

$exists = false

[line 87]

Whether this object is known to exist or the server. This is updated in self::load().

Access: protected

Type:

bool

[ Top ]

$s3 =

[line 71]

The service instance this resource belongs to.

Access: public

Type:

Services_Amazon_S3

[ Top ]

Method Detail

delete [line 118]

void delete(
)

Deletes this resource from the server.

Throws: Services_Amazon_S3_Exception
Access: public

[ Top ]

getUrl [line 94]

string getUrl(
)

Returns the URL of this resource.

Return: an absolute URL
Abstract:
Access: public

[ Top ]

load [line 102]

bool load(
)

Loads this resource from the server and propagates relevant properties.

Return: true, if resource exists on server
Abstract:
Throws: Services_Amazon_S3_Exception
Access: public

Overridden in child classes as:

Services_Amazon_S3_Resource_Bucket::load(): Loads this resource from the server and propagates relevant properties.

Services_Amazon_S3_Resource_Object::load(): Loads this object from the server.

[ Top ]

loadACL [line 134]

void loadACL(
)

Loads this resource's access control list from the server and propagates the acl property.

Throws: Services_Amazon_S3_Exception
Access: public

[ Top ]

save [line 110]

void save(
)

Saves this resource to the server (including its access control list).

Abstract:
Throws: Services_Amazon_S3_Exception
Access: public

Overridden in child classes as:

Services_Amazon_S3_Resource_Bucket::save(): Saves this resource to the server. On existing buckets, only the ACL is saved. When saving an existing bucket, load() should be called in advance.

Services_Amazon_S3_Resource_Object::save(): Saves this object to the server.

[ Top ]