Interface fs3Bucket

Description

This interface defines methods needed for manipulation objects in a bucket.

Located in /classes/fs3Bucket.php (line 15)


	
			
Method Summary
void createBucket ()
void deleteBucket ()
void deleteObject (string $objectPath)
array getBucket (string $prefix)
object data getObject (string $objectPath)
void putObject (string $objectPath, string $objectData, [string $acl = 'public-read'])
void setReadOnlyMaster (fs3Bucket $master)
Methods
createBucket (line 56)

This method creates a new bucket. The bucket name is the one assigned to the instance.

  • exception: fs3Exception on error.
  • access: public
void createBucket ()
deleteBucket (line 64)

This method delete a bucket. The bucket name is the one assigned to the instance.

  • exception: fs3Exception on error.
  • access: public
void deleteBucket ()
deleteObject (line 48)

This method removes a object from the bucket.

This operation does not affect the master repsoitory if set.

  • exception: fs3Exception on error.
  • access: public
void deleteObject (string $objectPath)
  • string $objectPath: the path to the object in the bucket.
getBucket (line 73)

This method creats a list of objects from the bucket.

  • return: of fs3ObjectInfo instances
  • exception: fs3Exception on error.
  • access: public
array getBucket (string $prefix)
  • string $prefix: the path prefix
getObject (line 26)

This method gets an object from the bucket.

If there is a master set, it will first check its own bucket before requesting it from the master.

  • return: as a string
  • exception: fs3Exception on error.
  • access: public
object data getObject (string $objectPath)
  • string $objectPath: the path to the object in the bucket.
putObject (line 39)

This method saves an object in the bucket.

This operation does not affect the master bucket if set.

  • exception: fs3Exception on error.
  • access: public
void putObject (string $objectPath, string $objectData, [string $acl = 'public-read'])
  • string $objectPath: the path to the object in the bucket.
  • string $objectData: the contents of the object.
  • string $acl: the access control level for the object. Options are private, public-read, public-read-write, and authenticated-read.
setReadOnlyMaster (line 84)

This method assigns a read-only master bucket. It is just another

implementation of the fs3Bucket. This is used to create union buckets for example. Also, useful when developing against huge existing object stores and ensuring that the master one does not get corrupted.

  • access: public
void setReadOnlyMaster (fs3Bucket $master)

Documentation generated on Thu, 04 Feb 2010 04:14:25 +0000 by phpDocumentor 1.4.3