# tasks/ext/Service/Amazon/S3.php

## \Service_Amazon_S3
jump to top

Package: phing\tasks\ext

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)

Default value `null` Details

Type
  \Services_Amazon_S3
Access
  protected
See
  \Services_Amazon_S3

### Methods

`__get( ) : void`

`__isset( ) : void`

`__set( ) : void`

`createBucket( ) : void`

Create a bucket

Details

Access
  public

`execute( ) : void`
abstract

Entry point to children tasks

Details

Abstract
Access
  public

`getBucket( ) : void`

`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

`getClient( ) : \Services_Amazon_S3`

We only instantiate the client once per task call

Returns

Type | Description
--- | ---
\Services_Amazon_S3 |

Details

Access
  public

`getDescription( ) : void`

`getKey( ) : void`

`getLocation( ) : void`

`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

`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

`getOwningTarget( ) : void`

`getProject( ) : void`

`getRegisterSlot( ) : void`

`getRuntimeConfigurableWrapper( ) : void`

`getSecret( ) : void`

`getTaskName( ) : void`

`getTaskType( ) : void`

`init( ) : void`

`isBucketAvailable( ) : bool`

Check if the current bucket is available

Returns

Type | Description
--- | ---
bool |

Details

Access
  public

`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

`log( ) : void`

`main( ) : void`
final

Main entry point, doesn't do anything

Details

Access
  public
Final

`maybeConfigure( ) : void`

`perform( ) : void`

`setBucket( $bucket ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$bucket |  |

`setDescription( ) : void`

`setKey( ) : void`

`setLocation( ) : void`

`setOwningTarget( ) : void`

`setProject( ) : void`

`setRuntimeConfigurableWrapper( ) : void`

`setSecret( ) : void`

`setTaskName( ) : void`

`setTaskType( ) : void`

Documentation was generated by DocBlox 0.17.1.