Phing API Documentation
Back to top  

Service_Amazon_S3

Extends \Service_Amazon

Abstract Service_Amazon_S3 class.

Provides common methods and properties to all of the S3 tasks

version

$ID$
package

phing.tasks.ext
author

Andrei Serdeliuc [email protected]

Methods

__construct

__construct()
inherited

Property getter

__get(mixed $var) : mixed
inherited

If the property hasn't been previously set (through the task call normally), it will try to load it from the project

This way, we can define global properties for the "Amazon" service, like key and secret

Arguments

$var

mixed

Response

mixed

__isset

__isset(string $var) : boolean
inherited

Arguments

$var

string

Response

boolean

__set

__set(string $var, mixed $val)
inherited

Arguments

$var

string

$val

mixed

Create a bucket

createBucket() : boolean
Throws
\BuildException

Response

boolean

Entry point to children tasks

execute() : void
abstract

getBucket

getBucket() : string
Throws
\BuildException

if bucket is not set

Response

string

We only instantiate the client once per task call

getClient() : \Aws\S3\S3Client
Throws
\BuildException

Response

\Aws\S3\S3Client

Returns an instance of Services_Amazon_S3_Resource_Bucket

getClientInstance() : \Aws\S3\S3Client

Response

\Aws\S3\S3Client

Returns the description of the current action.

getDescription() : string
inherited

Response

string

the description of the current action, or null if no description is available.

getKey

getKey() : string
inherited
Throws
\BuildException

if key is not set

Response

string

Returns the file/location where this task was defined.

getLocation() : \Location
inherited

Response

\Location

the file/location where this task was defined. Should not return null.

Returns an instance of Services_Amazon_S3_Resource_Object

getObjectInstance(mixed $object) : \Aws\Result
Throws
\BuildException

Arguments

$object

mixed

Response

\Aws\Result

Returns the owning target of this task.

getOwningTarget() : \Target
inherited

Response

\Target

The target object that owns this task

Returns a reference to current project

getProject() : \Project
inherited

Response

\Project

Reference to current porject object

Returns a name

getRegisterSlot(string $slotName) : \RegisterSlot
inherited

Arguments

$slotName

string

Response

\RegisterSlot

Returns the wrapper object for runtime configuration

getRuntimeConfigurableWrapper() : \RuntimeConfigurable
inherited

Response

\RuntimeConfigurable

The wrapper object used by this task

getSecret

getSecret() : string
inherited
Throws
\BuildException

if secret is not set

Response

string

Returns the name of task, used only for log messages

getTaskName() : string
inherited

Response

string

Name of this task

Returns the name of the task under which it was invoked, usually the XML tagname

getTaskType() : string
inherited

Response

string

The type of this task (XML Tag)

Called by the parser to let the task initialize properly.

init()
inherited

Should throw a BuildException if something goes wrong with the build

This is abstract here, but may not be overloaded by subclasses.

Throws
\BuildException

Check if the current bucket is available

isBucketAvailable() : boolean
Throws
\BuildException

Response

boolean

Check if the object already exists in the current bucket

isObjectAvailable(mixed $object) : boolean

Arguments

$object

mixed

Response

boolean

Logs a message with the given priority.

log(string $msg, integer $level = \Project::MSG_INFO) : void
inherited

Arguments

$msg

string

The message to be logged.

$level

integer

The message's priority at this message should have

Called by the project to let the task do it's work. This method may be called more than once, if the task is invoked more than once. For example, if target1 and target2 both depend on target3, then running <em>phing target1 target2</em> will run all tasks in target3 twice.

main()
inherited abstract

Should throw a BuildException if someting goes wrong with the build

This is abstract here. Must be overloaded by real tasks.

Configure this task if it hasn't been done already.

maybeConfigure()
inherited

Perfrom this task

perform() : void
inherited
Throws
\BuildException
\Error

setBucket

setBucket(string $bucket)
Throws
\BuildException

if $bucket is a empty string

Arguments

$bucket

string

Sets a description of the current action. This may be used for logging purposes.

setDescription(string $desc)
inherited

Arguments

$desc

string

Description of the current action. May be null, indicating that no description is available.

setKey

setKey(string $key)
inherited
Throws
\BuildException

if $key is an empty string

Arguments

$key

string

Sets the file/location where this task was defined.

setLocation(\Location $location)
inherited

Arguments

$location

\Location

The file/location where this task was defined. Should not be null

Sets the owning target this task belongs to.

setOwningTarget(\Target $target)
inherited

Arguments

$target

\Target

References the project to the current component.

setProject(\Project $project) : void
inherited

Arguments

$project

\Project

The reference to the current project

Sets the wrapper object this task should use for runtime configurable elements.

setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
inherited

Arguments

$wrapper

\RuntimeConfigurable

The wrapper object this task should use

setSecret

setSecret(string $secret)
inherited
Throws
\BuildException

if $secret is a empty string

Arguments

$secret

string

Sets the name of this task for log messages

setTaskName(string $name)
inherited

Arguments

$name

string

Sets the type of the task. Usually this is the name of the XML tag

setTaskType(string $name)
inherited

Arguments

$name

string

The type of this task (XML Tag)

Properties

Services_Amazon_S3 client

_client : \Aws\S3\S3Client

(default value: null)

var

Type(s)

\Aws\S3\S3Client

Collection of set options

_options : array
inherited

We set these magically so we can also load then from the environment

(default value: array())

var

Type(s)

array

Owning Target object

target : \Target
inherited
var

Type(s)

\Target

Internal taskname (req)

taskType : string
inherited
var

Type(s)

string

Taskname for logger

taskName : string
inherited
var

Type(s)

string

Wrapper of the task

wrapper : \RuntimeConfigurable
inherited
var

Type(s)

\RuntimeConfigurable

Holds a reference to the project that a project component (a task, a target, etc.) belongs to

project : \Project
inherited
var

A reference to the current project instance

Type(s)

\Project

location

location : \Location
inherited
var

Type(s)

\Location

description

description : string
inherited
var

Type(s)

string