Stores an object on S3
Provides common methods and properties to all of the S3 tasks
version |
$Id: 37e9c57cc495b2eb764a5bbd6221a7d6ad115127 $ |
---|---|
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
getAcl() : string
string
getBucket()
throws | |
---|---|
getBucketInstance() : \Services_Amazon_S3_Resource_Bucket
\Services_Amazon_S3_Resource_Bucket
getClient() : \Services_Amazon_S3
\Services_Amazon_S3
getContent() : mixed
throws | |
---|---|
mixed
getContentType() : string
throws | |
---|---|
string
getCreateBuckets() : boolean
boolean
getDescription() : string
string
The text description of the task
getFilesets() : array
array
getGzip() : \booleand
\booleand
Indicate if content is gzipped.
getHttpHeaders() : array
array
HttpHeader to set in S3 Object.
getKey()
getLocation() : \Location
getMaxage() : integer
integer
Number of seconds in maxage or null.
getObject()
getObjectContents(string $object) : mixed
throws |
---|
string
mixed
getObjectData() : string
If _content has been set, this will get stored, otherwise, we read from _source
throws | |
---|---|
string
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()
getSource() : string
throws | |
---|---|
string
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 | |
---|---|
saveObject( $object, $data)
throws | |
---|---|
setAcl( $permission)
throws | |
---|---|
setBucket( $bucket)
throws | |
---|---|
setContent( $content)
throws | |
---|---|
setContentType( $contentType)
setCreateBuckets( $createBuckets)
setDescription(string $desc)
string
The text describing the task
setFileNameOnly( $fileNameOnly)
setGzip(boolean $gzipped)
boolean
setKey( $key)
throws | |
---|---|
setLocation(\Location $location)
setMaxage(integer $seconds)
integer
setObject( $object)
throws | |
---|---|
setOwningTarget(\Target $target)
setProject(\Project $project) : void
setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
setSecret( $secret)
throws | |
---|---|
setSource( $source)
throws | |
---|---|
setTaskName(string $name) : string
string
string
A string representing the name of this task for log
setTaskType( $name)
_source : string
(default value: null)
var |
---|
string
_content : mixed
The user can specify either a file to upload or just a bit of content
(default value: null)
var |
---|
mixed
_filesets : array
(default value: array())
var |
---|
array
_createBuckets : boolean
(default value: false)
var |
---|
boolean
_acl : string
(default value: 'private')
var |
---|
string
_contentType : string
(default value: 'binary/octet-stream')
var |
---|
string
_maxage : integer
var |
---|
integer
_gzipped : boolean
var |
---|
boolean
_extensionContentTypeMapper : array
var |
---|
array
_fileNameOnly : boolean
(default value: false)
var |
---|
boolean
_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