Downloads an object off S3
Provides common methods and properties to all of the S3 tasks
version |
$Id: 755f7c3784838bc960dba9520a10490c640a61cd $ |
---|---|
package |
phing.tasks.ext |
author |
Andrei Serdeliuc andrei@serdeliuc.ro |
extends |
Service_Amazon_S3 |
__get(mixed $var) : mixed
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
mixed
mixed
__isset( $var) : boolean
boolean
__set( $var, $val)
createBucket() : boolean
boolean
execute() : void
getBucket()
throws | |
---|---|
getBucketInstance() : \Services_Amazon_S3_Resource_Bucket
\Services_Amazon_S3_Resource_Bucket
getClient() : \Services_Amazon_S3
\Services_Amazon_S3
getDescription() : string
string
The text description of the task
getKey()
getLocation() : \Location
getObject() : mixed
throws | |
---|---|
mixed
getObjectContents(string $object) : mixed
throws |
---|
string
mixed
getObjectInstance(mixed $object) : \Services_Amazon_S3_Resource_Object
mixed
\Services_Amazon_S3_Resource_Object
getOwningTarget() : \Target
getProject() : \Project
getRegisterSlot(string $slotName) : \RegisterSlot
getRuntimeConfigurableWrapper() : \RuntimeConfigurable
getSecret()
getTarget() : mixed
throws | |
---|---|
mixed
getTaskName() : string
string
Name of this task
getTaskType() : string
string
The type of this task (XML Tag)
init()
Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
throws | |
---|---|
isBucketAvailable() : boolean
boolean
isObjectAvailable(mixed $object) : boolean
mixed
boolean
log(string $msg, integer $level = \Project::MSG_INFO) : void
string
The message to be logged.
integer
The message's priority at this message should have
main()
Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.
maybeConfigure()
perform()
throws | |
---|---|
setBucket( $bucket)
throws | |
---|---|
setDescription(string $desc)
string
The text describing the task
setKey( $key)
throws | |
---|---|
setLocation(\Location $location)
setObject( $object)
throws | |
---|---|
setOwningTarget(\Target $target)
setProject(\Project $project) : void
setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
setSecret( $secret)
throws | |
---|---|
setTarget( $target)
throws | |
---|---|
setTaskName(string $name) : string
string
string
A string representing the name of this task for log
setTaskType( $name)
_target : mixed
(default value: null)
var |
---|
mixed
_object : mixed
(default value: null)
var |
---|
mixed
_client : \Services_Amazon_S3
(default value: null)
var | |
---|---|
see |
\Services_Amazon_S3
description : string
var |
---|
string
taskType : string
var |
---|
string
taskName : string
var |
---|
string
project : \Project