Downloads an object off S3
Provides common methods and properties to all of the S3 tasks
version |
$Id: 214ed107be71d8dbc0f68ffc90bfd8b11a76b36d $ |
---|---|
package |
phing.tasks.ext |
author |
Andrei Serdeliuc andrei@serdeliuc.ro |
extends |
Service_Amazon_S3 |
__get(mixed $var) : void
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
access |
public |
---|
mixed
__isset( $var)
__set( $var, $val)
createBucket() : void
access |
public |
---|---|
execute() : void
access |
public |
---|---|
abstract | |
getBucket()
getBucketInstance() : \Services_Amazon_S3_Resource_Bucket
access |
public |
---|---|
\Services_Amazon_S3_Resource_Bucket
getClient() : \Services_Amazon_S3
access |
public |
---|---|
\Services_Amazon_S3
getDescription() : string
string
The text description of the task
getKey()
getLocation() : \Location
getObject()
getObjectContents(string $object) : mixed
access |
public |
---|
string
mixed
getObjectInstance(mixed $object) : \Services_Amazon_S3_Resource_Object
access |
public |
---|
mixed
\Services_Amazon_S3_Resource_Object
getOwningTarget() : \Target
getProject() : \Project
getRegisterSlot(string $slotName)
string
getRuntimeConfigurableWrapper() : \RuntimeConfigurable
getSecret()
getTarget()
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
access |
public |
---|---|
boolean
isObjectAvailable(mixed $object) : boolean
access |
public |
---|
mixed
boolean
log(string $msg, integer $level = \Project::MSG_INFO)
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()
setBucket( $bucket)
setDescription(string $desc)
string
The text describing the task
setKey( $key)
setLocation(\Location $location)
setObject( $object)
setOwningTarget(\Target $target)
setProject(\Project $project)
setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
setSecret( $secret)
setTarget( $target)
setTaskName(string $name) : string
string
string
A string representing the name of this task for log
setTaskType( $name)
_target : mixed
(default value: null)
var | |
---|---|
access |
protected |
mixed
_object : mixed
(default value: null)
var | |
---|---|
access |
protected |
mixed
_client : \Services_Amazon_S3
(default value: null)
var | |
---|---|
see | |
access |
protected |
\Services_Amazon_S3
description : string
var |
---|
string
taskType : string
var |
---|
string
taskName : string
var |
---|
string
project : \Project