tasks/ext/HttpRequestTask.php
A HTTP request task.
Making an HTTP request and try to match the response against an provided regular expression.
- Author
- Benjamin Schultz
- Package
- phing.tasks.ext
- Since
- 2.4.1
- Version
- $Id: 495c02bc3a90d24694d8a4bf2d43ac077e0f9ec6 $
\HttpRequestTask
A HTTP request task.
Making an HTTP request and try to match the response against an provided regular expression.
- Parent(s)
- \Task < \ProjectComponent
- Author
- Benjamin Schultz
- Copyright
- 2001,2002 THYRELL. All rights reserved
- Since
- 2.4.1
- Version
- $Id: 495c02bc3a90d24694d8a4bf2d43ac077e0f9ec6 $
Properties


\array<Parameter>
$_configData= 'array()'
Holds additional config data for HTTP_Request2
array()
Details- Type
- \array<Parameter>


\array<Parameter>
$_headers= 'array()'
Holds additional header data
array()
Details- Type
- \array<Parameter>


\array<string>
$_observerEvents= 'array(
'connect',
'sentHeaders',
'sentBodyPart',
'receivedHeaders',
'receivedBody',
'disconnect',
)'
Holds the events that will be logged
array(
'connect',
'sentHeaders',
'sentBodyPart',
'receivedHeaders',
'receivedBody',
'disconnect',
)
Details- Type
- \array<string>


string
$_responseRegex= ''''
Holds the regular expression that should match the response
''
Details- Type
- string


boolean
$_verbose= 'false'
Whether to enable detailed logging
false
Details- Type
- boolean


\Project
$project= 'null'
Holds a reference to the project that a project component (a task, a target, etc.) belongs to
A reference to the current project instanceInherited from: \ProjectComponent::$$project\Task::$$projectnull
Details- Type
- \Project
- Inherited_from
- \ProjectComponent::$$project
- Inherited_from
- \Task::$$project
Methods


createConfig(
)
:
\Parameter
Creates a config parameter for this task
Type | Description |
---|---|
\Parameter | The created parameter |


createHeader(
)
:
\Parameter
Creates an additional header for this task
Type | Description |
---|---|
\Parameter | The created header |


getLocation(
)
:
\Location
Returns the location within the buildfile this task occurs. Used by {@link BuildException} to give detailed error messages.
Inherited from: \Task::getLocation()Type | Description |
---|---|
\Location | The location object describing the position of this task within the buildfile. |


getProject(
)
:
\Project
Returns a reference to current project
Inherited from: \ProjectComponent::getProject()\Task::getProject()Type | Description |
---|---|
\Project | Reference to current porject object |


getRuntimeConfigurableWrapper(
)
:
\RuntimeConfigurable
Returns the wrapper object for runtime configuration
Inherited from: \Task::getRuntimeConfigurableWrapper()Type | Description |
---|---|
\RuntimeConfigurable | The wrapper object used by this task |


getTaskType(
)
:
string
Returns the name of the task under which it was invoked, usually the XML tagname
Inherited from: \Task::getTaskType()Type | Description |
---|---|
string | The type of this task (XML Tag) |


init(
)
:
void
Load the necessary environment for running this task.
Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
Exception | Description |
---|---|
\BuildException |


log(
string $msg, integer $level
=
Project::MSG_INFO
)
:
void
Name | Type | Description |
---|---|---|
$msg | string | The message to log |
$level | integer | The priority of the message |
- See
- \BuildEvent
- See
- \BuildListener


main(
)
:
void
Make the http request
Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.


maybeConfigure(
)
:
void
Configure this task if it hasn't been done already.
Inherited from: \Task::maybeConfigure()

setAuthPassword(
string $password
)
:
void
Sets the authentication password
Name | Type | Description |
---|---|---|
$password | string |


setAuthScheme(
string $scheme
)
:
void
Sets the authentication scheme
Name | Type | Description |
---|---|---|
$scheme | string |


setAuthUser(
string $user
)
:
void
Sets the authentication user name
Name | Type | Description |
---|---|---|
$user | string |


setDescription(
string $desc
)
:
void
Name | Type | Description |
---|---|---|
$desc | string | The text describing the task |


setLocation(
\Location $location
)
:
void
Sets the location within the buildfile this task occurs. Called by the parser to set location information.
Inherited from: \Task::setLocation()Name | Type | Description |
---|---|---|
$location | \Location | The location object describing the position of this task within the buildfile. |


setObserverEvents(
string $observerEvents
)
:
void
Sets a list of observer events that will be logged if verbose output is enabled.
Name | Type | Description |
---|---|---|
$observerEvents | string | List of observer events |


setOwningTarget(
\Target $target
)
:
void
Name | Type | Description |
---|---|---|
$target | \Target | Reference to owning target |


setProject(
\Project $project
)
:
void
References the project to the current component.
Inherited from: \ProjectComponent::setProject()\Task::setProject()Name | Type | Description |
---|---|---|
$project | \Project | The reference to the current project |


setResponseRegex(
string $regex
)
:
void
Sets the response regex
Name | Type | Description |
---|---|---|
$regex | string |


setRuntimeConfigurableWrapper(
\RuntimeConfigurable $wrapper
)
:
void
Sets the wrapper object this task should use for runtime configurable elements.
Inherited from: \Task::setRuntimeConfigurableWrapper()Name | Type | Description |
---|---|---|
$wrapper | \RuntimeConfigurable | The wrapper object this task should use |


setTaskName(
string $name
)
:
string
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
string | A string representing the name of this task for log |


setTaskType(
string $name
)
:
void
Sets the type of the task. Usually this is the name of the XML tag
Inherited from: \Task::setTaskType()Name | Type | Description |
---|---|---|
$name | string | The type of this task (XML Tag) |