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 |
extends | Service_Amazon_S3 |
copyright | 2001,2002 THYRELL. All rights reserved |
__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 |
---|---|
inherited_from | \Service_Amazon::__get() |
inherited_from | \Service_Amazon_S3::__get() |
mixed
__isset($var)
inherited_from | \Service_Amazon::__isset() |
---|---|
inherited_from | \Service_Amazon_S3::__isset() |
__set($var, $val)
inherited_from | \Service_Amazon::__set() |
---|---|
inherited_from | \Service_Amazon_S3::__set() |
createBucket() : void
access | public |
---|---|
inherited_from | \Service_Amazon_S3::createBucket() |
execute() : void
getBucket()
inherited_from | \Service_Amazon_S3::getBucket() |
---|
getBucketInstance() : \Services_Amazon_S3_Resource_Bucket
access | public |
---|---|
inherited_from | \Service_Amazon_S3::getBucketInstance() |
\Services_Amazon_S3_Resource_Bucket
getClient() : \Services_Amazon_S3
access | public |
---|---|
inherited_from | \Service_Amazon_S3::getClient() |
\Services_Amazon_S3
getDescription() : string
inherited_from | \Task::getDescription() |
---|---|
inherited_from | \Service_Amazon::getDescription() |
inherited_from | \Service_Amazon_S3::getDescription() |
string
The text description of the taskgetKey()
inherited_from | \Service_Amazon::getKey() |
---|---|
inherited_from | \Service_Amazon_S3::getKey() |
getLocation() : \Location
Used by BuildException to give detailed error messages.
inherited_from | \Task::getLocation() |
---|---|
inherited_from | \Service_Amazon::getLocation() |
inherited_from | \Service_Amazon_S3::getLocation() |
\Location
The location object describing the position of this
task within the buildfile.getObject()
getObjectContents(string $object) : mixed
access | public |
---|---|
inherited_from | \Service_Amazon_S3::getObjectContents() |
string
mixed
getObjectInstance(mixed $object) : \Services_Amazon_S3_Resource_Object
access | public |
---|---|
inherited_from | \Service_Amazon_S3::getObjectInstance() |
mixed
\Services_Amazon_S3_Resource_Object
getOwningTarget() : \Target
inherited_from | \Task::getOwningTarget() |
---|---|
inherited_from | \Service_Amazon::getOwningTarget() |
inherited_from | \Service_Amazon_S3::getOwningTarget() |
\Target
The target object that owns this taskgetProject() : \Project
inherited_from | \ProjectComponent::getProject() |
---|---|
inherited_from | \Task::getProject() |
inherited_from | \Service_Amazon::getProject() |
inherited_from | \Service_Amazon_S3::getProject() |
\Project
Reference to current porject objectgetRuntimeConfigurableWrapper() : \RuntimeConfigurable
inherited_from | \Task::getRuntimeConfigurableWrapper() |
---|---|
inherited_from | \Service_Amazon::getRuntimeConfigurableWrapper() |
inherited_from | \Service_Amazon_S3::getRuntimeConfigurableWrapper() |
\RuntimeConfigurable
The wrapper object used by this taskgetSecret()
inherited_from | \Service_Amazon::getSecret() |
---|---|
inherited_from | \Service_Amazon_S3::getSecret() |
getTarget()
getTaskName() : string
inherited_from | \Task::getTaskName() |
---|---|
inherited_from | \Service_Amazon::getTaskName() |
inherited_from | \Service_Amazon_S3::getTaskName() |
string
Name of this taskgetTaskType() : string
inherited_from | \Task::getTaskType() |
---|---|
inherited_from | \Service_Amazon::getTaskType() |
inherited_from | \Service_Amazon_S3::getTaskType() |
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.
inherited_from | \Task::init() |
---|---|
inherited_from | \Service_Amazon::init() |
inherited_from | \Service_Amazon_S3::init() |
\BuildException |
---|
isBucketAvailable() : bool
access | public |
---|---|
inherited_from | \Service_Amazon_S3::isBucketAvailable() |
bool
isObjectAvailable(mixed $object) : bool
access | public |
---|---|
inherited_from | \Service_Amazon_S3::isObjectAvailable() |
mixed
bool
log(string $msg, integer $level)
see | \global\BuildEvent |
---|---|
see | \global\BuildListener |
inherited_from | \Task::log() |
inherited_from | \Service_Amazon::log() |
inherited_from | \Service_Amazon_S3::log() |
string
The message to log
integer
The priority of the message
main() : void
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 phing target1 target2 will run all tasks in target3 twice.
Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.
access | public |
---|---|
final | |
inherited_from | \Service_Amazon_S3::main() |
maybeConfigure()
inherited_from | \Task::maybeConfigure() |
---|---|
inherited_from | \Service_Amazon::maybeConfigure() |
inherited_from | \Service_Amazon_S3::maybeConfigure() |
perform()
inherited_from | \Task::perform() |
---|---|
inherited_from | \Service_Amazon::perform() |
inherited_from | \Service_Amazon_S3::perform() |
setBucket($bucket)
inherited_from | \Service_Amazon_S3::setBucket() |
---|
setDescription(string $desc)
inherited_from | \Task::setDescription() |
---|---|
inherited_from | \Service_Amazon::setDescription() |
inherited_from | \Service_Amazon_S3::setDescription() |
string
The text describing the task
setKey($key)
inherited_from | \Service_Amazon::setKey() |
---|---|
inherited_from | \Service_Amazon_S3::setKey() |
setLocation(\Location $location)
Called by the parser to set location information.
inherited_from | \Task::setLocation() |
---|---|
inherited_from | \Service_Amazon::setLocation() |
inherited_from | \Service_Amazon_S3::setLocation() |
setObject($object)
setOwningTarget(\Target $target)
inherited_from | \Task::setOwningTarget() |
---|---|
inherited_from | \Service_Amazon::setOwningTarget() |
inherited_from | \Service_Amazon_S3::setOwningTarget() |
setProject(\Project $project)
inherited_from | \ProjectComponent::setProject() |
---|---|
inherited_from | \Task::setProject() |
inherited_from | \Service_Amazon::setProject() |
inherited_from | \Service_Amazon_S3::setProject() |
setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
inherited_from | \Task::setRuntimeConfigurableWrapper() |
---|---|
inherited_from | \Service_Amazon::setRuntimeConfigurableWrapper() |
inherited_from | \Service_Amazon_S3::setRuntimeConfigurableWrapper() |
setSecret($secret)
inherited_from | \Service_Amazon::setSecret() |
---|---|
inherited_from | \Service_Amazon_S3::setSecret() |
setTarget($target)
setTaskName(string $name) : string
inherited_from | \Task::setTaskName() |
---|---|
inherited_from | \Service_Amazon::setTaskName() |
inherited_from | \Service_Amazon_S3::setTaskName() |
string
string
A string representing the name of this task for logsetTaskType(string $name)
Usually this is the name of the XML tag
inherited_from | \Task::setTaskType() |
---|---|
inherited_from | \Service_Amazon::setTaskType() |
inherited_from | \Service_Amazon_S3::setTaskType() |
string
The type of this task (XML Tag)
getRegisterSlot(string $slotName)
inherited_from | \Task::getRegisterSlot() |
---|---|
inherited_from | \Service_Amazon::getRegisterSlot() |
inherited_from | \Service_Amazon_S3::getRegisterSlot() |
string
$_client : \Services_Amazon_S3
(default value: null)
see | \global\Services_Amazon_S3 |
---|---|
access | protected |
inherited_from | \Service_Amazon_S3::$$_client |
$_object : mixed
(default value: null)
access | protected |
---|
$_target : mixed
(default value: null)
access | protected |
---|
$description : string
inherited_from | \Task::$$description |
---|---|
inherited_from | \Service_Amazon::$$description |
inherited_from | \Service_Amazon_S3::$$description |
$location : \Location
inherited_from | \Task::$$location |
---|---|
inherited_from | \Service_Amazon::$$location |
inherited_from | \Service_Amazon_S3::$$location |
$project : \Project
inherited_from | \ProjectComponent::$$project |
---|---|
inherited_from | \Task::$$project |
inherited_from | \Service_Amazon::$$project |
inherited_from | \Service_Amazon_S3::$$project |
$target : \Target
inherited_from | \Task::$$target |
---|---|
inherited_from | \Service_Amazon::$$target |
inherited_from | \Service_Amazon_S3::$$target |
$taskName : string
inherited_from | \Task::$$taskName |
---|---|
inherited_from | \Service_Amazon::$$taskName |
inherited_from | \Service_Amazon_S3::$$taskName |
$taskType : string
inherited_from | \Task::$$taskType |
---|---|
inherited_from | \Service_Amazon::$$taskType |
inherited_from | \Service_Amazon_S3::$$taskType |
$wrapper : \RuntimeConfigurable
inherited_from | \Task::$$wrapper |
---|---|
inherited_from | \Service_Amazon::$$wrapper |
inherited_from | \Service_Amazon_S3::$$wrapper |