classes/phing/tasks/ext/HttpRequestTask.php
Classes
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: HttpRequestTask.php 764 2010-04-11 18:18:51Z bschultz $
\HttpRequestTask
A HTTP request task.
Making an HTTP request and try to match the response against an provided regular expression.
- Extends from
- \Task
- author
- Benjamin Schultz
- copyright
- 2001,2002 THYRELL. All rights reserved
- package
- phing.tasks.ext
- since
- 2.4.1
- version
- $Id: HttpRequestTask.php 764 2010-04-11 18:18:51Z bschultz $
Properties
string
$_authPassword= ''
Holds the authentication password
- Type
- string
string
$_authScheme= ''
Holds the authentication scheme
- Type
- string
string
$_authUser= 'null'
Holds the authentication user name
nullDetails- Type
- string
\array<Parameter>
$_configData= 'array'
Holds additional config data for HTTP_Request2
arrayDetails- Type
- \array<Parameter>
\array<Parameter>
$_headers= 'array'
Holds additional header data
arrayDetails- Type
- \array<Parameter>
\array<string>
$_observerEvents= 'array'
Holds the events that will be logged
arrayDetails- Type
- \array<string>
string
$_responseRegex= ''
Holds the regular expression that should match the response
- Type
- string
string
$_url= 'null'
Holds the request URL
nullDetails- Type
- string
boolean
$_verbose= 'false'
Whether to enable detailed logging
falseDetails- Type
- boolean
Methods
createConfig(
)
:
\ParameterCreates a config parameter for this task
| Type | Description |
|---|---|
| \Parameter |
createHeader(
)
:
\ParameterCreates an additional header for this task
| Type | Description |
|---|---|
| \Parameter |
init(
)
:
Load the necessary environment for running this task.
- throws
main(
)
:
Make the http request
setAuthPassword(
string $password
)
:
Sets the authentication password
| Name | Type | Description |
|---|---|---|
| $password | string |
setAuthScheme(
string $scheme
)
:
Sets the authentication scheme
| Name | Type | Description |
|---|---|---|
| $scheme | string |
setAuthUser(
string $user
)
:
Sets the authentication user name
| Name | Type | Description |
|---|---|---|
| $user | string |
setObserverEvents(
string $observerEvents
)
:
voidSets a list of observer events that will be logged
if verbose output is enabled.
| Name | Type | Description |
|---|---|---|
| $observerEvents | string | List of observer events |
setResponseRegex(
string $regex
)
:
Sets the response regex
| Name | Type | Description |
|---|---|---|
| $regex | string |
setUrl(
string $url
)
:
Sets the request URL
| Name | Type | Description |
|---|---|---|
| $url | string |
setVerbose(
boolean $verbose
)
:
Sets whether to enable detailed logging
| Name | Type | Description |
|---|---|---|
| $verbose | boolean |