tasks/ext/Service/Amazon/S3.php
Show:
inherited
inherited
Classes
\Service_Amazon_S3
Package: phing\tasks\ext
Default value
Abstract Service_Amazon_S3 class.
Provides common methods and properties to all of the S3 tasks
- Parent(s)
- \Service_Amazon < \Task < \ProjectComponent
- Children
- \S3PutTask
- \S3GetTask
- Abstract
- Author
- Andrei Serdeliuc
- Extends
- Service_Amazon
- Version
- $ID$
Properties
\Services_Amazon_S3
$_client= 'null'
Services_Amazon_S3 client
(default value: null)
nullDetails- Type
- \Services_Amazon_S3
- Access
- protected
- See
- \Services_Amazon_S3
Methods
__get(
)
:
void__isset(
)
:
void__set(
)
:
voidcreateBucket(
)
:
voidCreate a bucket
Details
- Access
- public
execute(
)
:
void
abstract
Entry point to children tasks
Details
- Abstract
- Access
- public
getBucket(
)
:
voidgetBucketInstance(
)
:
\Services_Amazon_S3_Resource_BucketReturns an instance of Services_Amazon_S3_Resource_Bucket
Returns
Details
| Type | Description |
|---|---|
| \Services_Amazon_S3_Resource_Bucket |
- Access
- public
getClient(
)
:
\Services_Amazon_S3We only instantiate the client once per task call
Returns
Details
| Type | Description |
|---|---|
| \Services_Amazon_S3 |
- Access
- public
getDescription(
)
:
voidgetKey(
)
:
voidgetLocation(
)
:
voidgetObjectContents(
string $object
)
:
mixedGet the contents of an object (by it's name)
Parameters
Returns
Details
| Name | Type | Description |
|---|---|---|
| $object | string |
| Type | Description |
|---|---|
| mixed |
- Access
- public
getObjectInstance(
mixed $object
)
:
\Services_Amazon_S3_Resource_ObjectReturns an instance of Services_Amazon_S3_Resource_Object
Parameters
Returns
Details
| Name | Type | Description |
|---|---|---|
| $object | mixed |
| Type | Description |
|---|---|
| \Services_Amazon_S3_Resource_Object |
- Access
- public
getOwningTarget(
)
:
voidgetProject(
)
:
voidgetRegisterSlot(
)
:
voidgetRuntimeConfigurableWrapper(
)
:
voidgetSecret(
)
:
voidgetTaskName(
)
:
voidgetTaskType(
)
:
voidinit(
)
:
voidisBucketAvailable(
)
:
boolCheck if the current bucket is available
Returns
Details
| Type | Description |
|---|---|
| bool |
- Access
- public
isObjectAvailable(
mixed $object
)
:
boolCheck if the object already exists in the current bucket
Parameters
Returns
Details
| Name | Type | Description |
|---|---|---|
| $object | mixed |
| Type | Description |
|---|---|
| bool |
- Access
- public
log(
)
:
voidmain(
)
:
void
final
Main entry point, doesn't do anything
Details
- Access
- public
- Final
maybeConfigure(
)
:
voidperform(
)
:
voidsetBucket(
$bucket
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $bucket |
setDescription(
)
:
voidsetKey(
)
:
voidsetLocation(
)
:
voidsetOwningTarget(
)
:
voidsetProject(
)
:
voidsetRuntimeConfigurableWrapper(
)
:
voidsetSecret(
)
:
voidsetTaskName(
)
:
voidsetTaskType(
)
:
void