Phing API Documentation
Back to top  

S3PutTask

Extends \Service_Amazon_S3

Stores an object on S3

Provides common methods and properties to all of the S3 tasks

version

$Id: 334f64383dde9b06cc259690e391c2b85cc90477 $
package

phing.tasks.ext
author

Andrei Serdeliuc andrei@serdeliuc.ro
extends

Service_Amazon_S3

Methods

setSource

setSource($source)

Arguments

$source

getSource

getSource()

setContent

setContent($content)

Arguments

$content

getContent

getContent()

setObject

setObject($object)

Arguments

$object

getObject

getObject()

setAcl

setAcl($permission)

Arguments

$permission

getAcl

getAcl()

setContentType

setContentType($contentType)

Arguments

$contentType

getContentType

getContentType()

setCreateBuckets

setCreateBuckets($createBuckets)

Arguments

$createBuckets

getCreateBuckets

getCreateBuckets()

setFileNameOnly

setFileNameOnly($fileNameOnly)

Arguments

$fileNameOnly

creator for _filesets

createFileset() : \FileSet
access

public

Response

\FileSet

getter for _filesets

getFilesets() : array
access

public

Response

array

Determines what we're going to store in the object

getObjectData() : string

If _content has been set, this will get stored, otherwise, we read from _source

access

public

Response

string

Entry point to children tasks

execute() : void
inherited abstract
access

public
abstract

saveObject

saveObject($object, $data)

Arguments

$object

$data

We only instantiate the client once per task call

getClient() : \Services_Amazon_S3
inherited
access

public

Response

\Services_Amazon_S3

setBucket

setBucket($bucket)
inherited

Arguments

$bucket

getBucket

getBucket()
inherited

Returns an instance of Services_Amazon_S3_Resource_Object

getObjectInstance(mixed $object) : \Services_Amazon_S3_Resource_Object
inherited
access

public

Arguments

$object

mixed

Response

\Services_Amazon_S3_Resource_Object

Check if the object already exists in the current bucket

isObjectAvailable(mixed $object) : bool
inherited
access

public

Arguments

$object

mixed

Response

bool

Returns an instance of Services_Amazon_S3_Resource_Bucket

getBucketInstance() : \Services_Amazon_S3_Resource_Bucket
inherited
access

public

Response

\Services_Amazon_S3_Resource_Bucket

Check if the current bucket is available

isBucketAvailable() : bool
inherited
access

public

Response

bool

Get the contents of an object (by it's name)

getObjectContents(string $object) : mixed
inherited
access

public

Arguments

$object

string

Response

mixed

Create a bucket

createBucket() : void
inherited
access

public

Called by the project to let the task do it's work. 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 <em>phing target1 target2</em> will run all tasks in target3 twice.

main()
inherited abstract

Should throw a BuildException if someting goes wrong with the build

This is abstract here. Must be overloaded by real tasks.

__set

__set($var, $val)
inherited

Arguments

$var

$val

Property getter

__get(mixed $var) : void
inherited

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

Arguments

$var

mixed

__isset

__isset($var)
inherited

Arguments

$var

setKey

setKey($key)
inherited

Arguments

$key

getKey

getKey()
inherited

setSecret

setSecret($secret)
inherited

Arguments

$secret

getSecret

getSecret()
inherited

Sets the owning target this task belongs to.

setOwningTarget(\Target $target)
inherited

Arguments

$target

\Target

Returns the owning target of this task.

getOwningTarget() : \Target
inherited

Response

\Target

The target object that owns this task

Returns the name of task, used only for log messages

getTaskName() : string
inherited

Response

string

Name of this task

Sets the name of this task for log messages

setTaskName(string $name) : string
inherited

Arguments

$name

string

Response

string

A string representing the name of this task for log

Returns the name of the task under which it was invoked, usually the XML tagname

getTaskType() : string
inherited

Response

string

The type of this task (XML Tag)

Sets the type of the task. Usually this is the name of the XML tag

setTaskType($name)
inherited

Arguments

$name

Returns a name

getRegisterSlot(string $slotName)
inherited

Arguments

$slotName

string

Logs a message with the given priority.

log(string $msg, integer $level = \Project::MSG_INFO)
inherited

Arguments

$msg

string

The message to be logged.

$level

integer

The message's priority at this message should have

Sets a textual description of the task

setDescription(string $desc)
inherited

Arguments

$desc

string

The text describing the task

Returns the textual description of the task

getDescription() : string
inherited

Response

string

The text description of the task

Called by the parser to let the task initialize properly.

init()
inherited

Should throw a BuildException if something goes wrong with the build

This is abstract here, but may not be overloaded by subclasses.

throws

Returns the location within the buildfile this task occurs. Used by {@link BuildException} to give detailed error messages.

getLocation() : \Location
inherited

Response

\Location

The location object describing the position of this task within the buildfile.

Sets the location within the buildfile this task occurs. Called by the parser to set location information.

setLocation(\Location $location)
inherited

Arguments

$location

\Location

The location object describing the position of this task within the buildfile.

Returns the wrapper object for runtime configuration

getRuntimeConfigurableWrapper() : \RuntimeConfigurable
inherited

Response

\RuntimeConfigurable

The wrapper object used by this task

Sets the wrapper object this task should use for runtime configurable elements.

setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
inherited

Arguments

$wrapper

\RuntimeConfigurable

The wrapper object this task should use

Configure this task if it hasn't been done already.

maybeConfigure()
inherited

Perfrom this task

perform()
inherited

References the project to the current component.

setProject(\Project $project)
inherited

Arguments

$project

\Project

The reference to the current project

Returns a reference to current project

getProject() : \Project
inherited

Response

\Project

Reference to current porject object

Properties

File we're trying to upload

_source : string

(default value: null)

var
access

protected

Type(s)

string

Content we're trying to upload

_content : mixed

The user can specify either a file to upload or just a bit of content

(default value: null)

var
access

protected

Type(s)

mixed

Collection of filesets Used for uploading multiple files

_filesets : array

(default value: array())

var
access

protected

Type(s)

array

Whether to try to create buckets or not

_createBuckets : bool

(default value: false)

var
access

protected

Type(s)

bool

File ACL Use to set the permission to the uploaded files

_acl : string

(default value: 'private')

var
access

protected

Type(s)

string

File content type Use this to set the content type of your static files Set contentType to "auto" if you want to autodetect the content type based on the source file extension

_contentType : string

(default value: 'binary/octet-stream')

var
access

protected

Type(s)

string

Extension content type mapper

_extensionContentTypeMapper : array
var
access

protected

Type(s)

array

Whether filenames contain paths

_fileNameOnly : bool

(default value: false)

var
access

protected

Type(s)

bool

Services_Amazon_S3 client

_client : \Services_Amazon_S3
inherited

(default value: null)

var
see
access

protected

Type(s)

\Services_Amazon_S3

Collection of set options

_options : array
inherited

We set these magically so we can also load then from the environment

(default value: array())

var
access

protected

Type(s)

array

Owning Target object

target : \Target
inherited
var

Type(s)

\Target

Description of the task

description : string
inherited
var

Type(s)

string

Internal taskname (req)

taskType : string
inherited
var

Type(s)

string

Taskname for logger

taskName : string
inherited
var

Type(s)

string

Stored buildfile location

location : \Location
inherited
var

Type(s)

\Location

Wrapper of the task

wrapper : \RuntimeConfigurable
inherited
var

Type(s)

\RuntimeConfigurable

Holds a reference to the project that a project component (a task, a target, etc.) belongs to

project : \Project
inherited
var

A reference to the current project instance

Type(s)

\Project