HttpGetTask

Extends \HttpTask

A HTTP download task.

Downloads a file via HTTP GET method and saves it to a specified directory

package

phing.tasks.ext

author

Ole Markus With [email protected]

version

$Id: ea850f72d86404b12342f74372d992cec2e3a4b7 $

Methods

__construct

__construct() 
inherited

Creates a config parameter for this task

createConfig() : \Parameter
inherited

Response

\Parameter

The created config parameter

Creates an additional header for this task

createHeader() : \Parameter
inherited

Response

\Parameter

The created header

Creates and configures an instance of HTTP_Request2

createRequest() : \HTTP_Request2
inherited

Response

\HTTP_Request2

Returns the description of the current action.

getDescription() : string
inherited

Response

string

the description of the current action, or null if no description is available.

Returns the file/location where this task was defined.

getLocation() : \Location
inherited

Response

\Location

the file/location where this task was defined. Should not return null.

Returns the owning target of this task.

getOwningTarget() : \Target
inherited

Response

\Target

The target object that owns this task

Returns a reference to current project

getProject() : \Project
inherited

Response

\Project

Reference to current porject object

Returns a name

getRegisterSlot(string $slotName) : \RegisterSlot
inherited

Arguments

$slotName

string

Response

\RegisterSlot

Returns the wrapper object for runtime configuration

getRuntimeConfigurableWrapper() : \RuntimeConfigurable
inherited

Response

\RuntimeConfigurable

The wrapper object used by this task

Returns the name of task, used only for log messages

getTaskName() : string
inherited

Response

string

Name of this task

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)

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
\BuildException

Logs a message with the given priority.

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

Arguments

$msg

string

The message to be logged.

$level

integer

The message's priority at this message should have

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.

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

maybeConfigure() 
inherited

Perfrom this task

perform() : void
inherited
Throws
\BuildException
\Error

Processes the server's response

processResponse(\HTTP_Request2_Response $response) : void
inherited abstract
Throws
\BuildException

Arguments

$response

\HTTP_Request2_Response

Sets the authentication password

setAuthPassword(string $password) 
inherited

Arguments

$password

string

Sets the authentication scheme

setAuthScheme(string $scheme) 
inherited

Arguments

$scheme

string

Sets the authentication user name

setAuthUser(string $user) 
inherited

Arguments

$user

string

Sets a description of the current action. This may be used for logging purposes.

setDescription(string $desc) 
inherited

Arguments

$desc

string

Description of the current action. May be null, indicating that no description is available.

Sets the save location

setDir(string $dir) 

Arguments

$dir

string

Sets the filename to store the output in

setFilename(string $filename) 

Arguments

$filename

string

Sets the follow_redirects option

setFollowRedirects(boolean $value) 

Arguments

$value

boolean

Sets the file/location where this task was defined.

setLocation(\Location $location) 
inherited

Arguments

$location

\Location

The file/location where this task was defined. Should not be null

Sets the owning target this task belongs to.

setOwningTarget(\Target $target) 
inherited

Arguments

$target

\Target

References the project to the current component.

setProject(\Project $project) : void
inherited

Arguments

$project

\Project

The reference to the current project

Sets the proxy

setProxy(string $proxy) 

Arguments

$proxy

string

If true, set default log level to Project.MSG_ERR.

setQuiet(boolean $v) 

Arguments

$v

boolean

if "true" then be quiet

Sets the prototype object that will be cloned in createRequest()

setRequestPrototype(\HTTP_Request2 $request) 
inherited

Used in tests to inject an instance of HTTP_Request2 containing a custom adapter

Arguments

$request

\HTTP_Request2

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

Sets the ssl_verify_peer option

setSslVerifyPeer(boolean $value) 

Arguments

$value

boolean

Sets the name of this task for log messages

setTaskName(string $name) 
inherited

Arguments

$name

string

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

setTaskType(string $name) 
inherited

Arguments

$name

string

The type of this task (XML Tag)

Sets the request URL

setUrl(string $url) 
inherited

Arguments

$url

string

Properties

Holds the filename to store the output in

filename : string
var

Type(s)

string

Holds the save location

dir : string
var

Type(s)

string

Holds value for "ssl_verify_peer" option

sslVerifyPeer : boolean
var

Type(s)

boolean

Holds value for "follow_redirects" option

followRedirects : null|boolean
var

Type(s)

null|boolean

Holds the proxy

proxy : string
var

Type(s)

string

quiet

quiet : 

Type(s)

Holds the request URL

url : string
inherited
var

Type(s)

string

Prototype HTTP_Request2 object, cloned in createRequest()

requestPrototype : \HTTP_Request2
inherited
var

Type(s)

\HTTP_Request2

Holds additional header data

headers : array<mixed,\Parameter>
inherited
var

Type(s)

array<mixed,\Parameter>

Holds additional config data for HTTP_Request2

configData : array<mixed,\Parameter>
inherited
var

Type(s)

array<mixed,\Parameter>

Holds the authentication user name

authUser : string
inherited
var

Type(s)

string

Holds the authentication password

authPassword : string
inherited
var

Type(s)

string

Holds the authentication scheme

authScheme : string
inherited
var

Type(s)

string

Owning Target object

target : \Target
inherited
var

Type(s)

\Target

Internal taskname (req)

taskType : string
inherited
var

Type(s)

string

Taskname for logger

taskName : string
inherited
var

Type(s)

string

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

location

location : \Location
inherited
var

Type(s)

\Location

description

description : string
inherited
var

Type(s)

string