Abstract Service_Amazon_S3 class.
Provides common methods and properties to all of the S3 tasks
| extends | Service_Amazon |
|---|---|
| version | $ID$ |
| package | phing.tasks.ext |
| author | Andrei Serdeliuc |
| abstract | |
| 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() |
mixed
__isset($var)
| inherited_from | \Service_Amazon::__isset() |
|---|
__set($var, $val)
| inherited_from | \Service_Amazon::__set() |
|---|
createBucket() : void
| access | public |
|---|
execute() : void
| access | public |
|---|---|
| abstract |
getBucket()
getBucketInstance() : \Services_Amazon_S3_Resource_Bucket
| access | public |
|---|
\Services_Amazon_S3_Resource_BucketgetClient() : \Services_Amazon_S3
| access | public |
|---|
\Services_Amazon_S3getDescription() : string
| inherited_from | \Task::getDescription() |
|---|---|
| inherited_from | \Service_Amazon::getDescription() |
stringThe text description of the taskgetKey()
| inherited_from | \Service_Amazon::getKey() |
|---|
getLocation() : \Location
Used by BuildException to give detailed error messages.
| inherited_from | \Task::getLocation() |
|---|---|
| inherited_from | \Service_Amazon::getLocation() |
\LocationThe location object describing the position of this
task within the buildfile.getObjectContents(string $object) : mixed
| access | public |
|---|
string
mixedgetObjectInstance(mixed $object) : \Services_Amazon_S3_Resource_Object
| access | public |
|---|
mixed
\Services_Amazon_S3_Resource_ObjectgetOwningTarget() : \Target
| inherited_from | \Task::getOwningTarget() |
|---|---|
| inherited_from | \Service_Amazon::getOwningTarget() |
\TargetThe target object that owns this taskgetProject() : \Project
| inherited_from | \ProjectComponent::getProject() |
|---|---|
| inherited_from | \Task::getProject() |
| inherited_from | \Service_Amazon::getProject() |
\ProjectReference to current porject objectgetRuntimeConfigurableWrapper() : \RuntimeConfigurable
| inherited_from | \Task::getRuntimeConfigurableWrapper() |
|---|---|
| inherited_from | \Service_Amazon::getRuntimeConfigurableWrapper() |
\RuntimeConfigurableThe wrapper object used by this taskgetSecret()
| inherited_from | \Service_Amazon::getSecret() |
|---|
getTaskName() : string
| inherited_from | \Task::getTaskName() |
|---|---|
| inherited_from | \Service_Amazon::getTaskName() |
stringName of this taskgetTaskType() : string
| inherited_from | \Task::getTaskType() |
|---|---|
| inherited_from | \Service_Amazon::getTaskType() |
stringThe 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() |
\BuildException |
|---|
isBucketAvailable() : bool
| access | public |
|---|
boolisObjectAvailable(mixed $object) : bool
| access | public |
|---|
mixed
boollog(string $msg, integer $level)
| see | \BuildEvent |
|---|---|
| see | \BuildListener |
| inherited_from | \Task::log() |
| inherited_from | \Service_Amazon::log() |
stringThe message to log
integerThe 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 |
maybeConfigure()
| inherited_from | \Task::maybeConfigure() |
|---|---|
| inherited_from | \Service_Amazon::maybeConfigure() |
perform()
| inherited_from | \Task::perform() |
|---|---|
| inherited_from | \Service_Amazon::perform() |
setBucket($bucket)
setDescription(string $desc)
| inherited_from | \Task::setDescription() |
|---|---|
| inherited_from | \Service_Amazon::setDescription() |
stringThe text describing the task
setKey($key)
| inherited_from | \Service_Amazon::setKey() |
|---|
setLocation(\Location $location)
Called by the parser to set location information.
| inherited_from | \Task::setLocation() |
|---|---|
| inherited_from | \Service_Amazon::setLocation() |
setOwningTarget(\Target $target)
| inherited_from | \Task::setOwningTarget() |
|---|---|
| inherited_from | \Service_Amazon::setOwningTarget() |
setProject(\Project $project)
| inherited_from | \ProjectComponent::setProject() |
|---|---|
| inherited_from | \Task::setProject() |
| inherited_from | \Service_Amazon::setProject() |
setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
| inherited_from | \Task::setRuntimeConfigurableWrapper() |
|---|---|
| inherited_from | \Service_Amazon::setRuntimeConfigurableWrapper() |
setSecret($secret)
| inherited_from | \Service_Amazon::setSecret() |
|---|
setTaskName(string $name) : string
| inherited_from | \Task::setTaskName() |
|---|---|
| inherited_from | \Service_Amazon::setTaskName() |
string
stringA 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() |
stringThe type of this task (XML Tag)
getRegisterSlot(string $slotName)
| inherited_from | \Task::getRegisterSlot() |
|---|---|
| inherited_from | \Service_Amazon::getRegisterSlot() |
string
$_client : \Services_Amazon_S3
(default value: null)
| see | \Services_Amazon_S3 |
|---|---|
| access | protected |
$description : string
| inherited_from | \Task::$$description |
|---|---|
| inherited_from | \Service_Amazon::$$description |
$location : \Location
| inherited_from | \Task::$$location |
|---|---|
| inherited_from | \Service_Amazon::$$location |
$project : \Project
| inherited_from | \ProjectComponent::$$project |
|---|---|
| inherited_from | \Task::$$project |
| inherited_from | \Service_Amazon::$$project |
$taskName : string
| inherited_from | \Task::$$taskName |
|---|---|
| inherited_from | \Service_Amazon::$$taskName |
$taskType : string
| inherited_from | \Task::$$taskType |
|---|---|
| inherited_from | \Service_Amazon::$$taskType |
$wrapper : \RuntimeConfigurable
| inherited_from | \Task::$$wrapper |
|---|---|
| inherited_from | \Service_Amazon::$$wrapper |