classes/phing/tasks/ext/Service/Amazon/S3.php

\Service_Amazon_S3

Abstract Service_Amazon_S3 class.

Provides common methods and properties to all of the S3 tasks

Extends from
\Service_Amazon
abstract
author
Andrei Serdeliuc
copyright
2001,2002 THYRELL. All rights reserved
extends
Service_Amazon
package
phing.tasks.ext
version
$ID$

Properties

Propertyprotected\Services_Amazon_S3  $_client= 'null'

Services_Amazon_S3 client

(default value: null)

Default valuenullDetails
Type
\Services_Amazon_S3
access
protected
see
\Services_Amazon_S3

Methods

methodpublic  createBucket( ) : void
Create a bucket
Details
access
public
methodpublic  execute( ) : void
abstractEntry point to children tasks
Details
abstract
access
public
methodpublic  getBucket( ) :
methodpublic  getBucketInstance( ) : \Services_Amazon_S3_Resource_Bucket
Returns an instance of Services_Amazon_S3_Resource_Bucket
Returns
Type Description
\Services_Amazon_S3_Resource_Bucket
Details
access
public
methodpublic  getClient( ) : \Services_Amazon_S3
We only instantiate the client once per task call
Returns
Type Description
\Services_Amazon_S3
Details
access
public
methodpublic  getObjectContents( string $object ) : mixed
Get the contents of an object (by it's name)
Parameters
Name Type Description
$object string
Returns
Type Description
mixed
Details
access
public
methodpublic  getObjectInstance( mixed $object ) : \Services_Amazon_S3_Resource_Object
Returns an instance of Services_Amazon_S3_Resource_Object
Parameters
Name Type Description
$object mixed
Returns
Type Description
\Services_Amazon_S3_Resource_Object
Details
access
public
methodpublic  isBucketAvailable( ) : bool
Check if the current bucket is available
Returns
Type Description
bool
Details
access
public
methodpublic  isObjectAvailable( mixed $object ) : bool
Check if the object already exists in the current bucket
Parameters
Name Type Description
$object mixed
Returns
Type Description
bool
Details
access
public
methodpublic  main( ) : void
finalMain entry point, doesn't do anything
Details
access
public
final
methodpublic  setBucket(  $bucket ) :
Parameters
Name Type Description
$bucket
Documentation was generated by DocBlox 0.13.1.