tasks/ext/HttpRequestTask.php
inherited
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.
- Parent(s)
- \Task < \ProjectComponent
- Author
- Benjamin Schultz
- Since
- 2.4.1
- Version
- $Id: HttpRequestTask.php 764 2010-04-11 18:18:51Z bschultz $
Properties
string
$_authPassword= ''''
Holds the authentication password
''Details- 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
array()Details- Type
- \array<Parameter>
\array<Parameter>
$_headers= 'array()'
Holds additional header data
array()Details- Type
- \array<Parameter>
\array<string>
$_observerEvents= 'array(
'connect''
Holds the events that will be logged
array(
'connect'Details- Type
- \array<string>
string
$_responseRegex= ''''
Holds the regular expression that should match the response
''Details- 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 | The created parameter |
createHeader(
)
:
\ParameterCreates an additional header for this task
| Type | Description |
|---|---|
| \Parameter | The created header |
getDescription(
)
:
voidgetLocation(
)
:
voidgetOwningTarget(
)
:
voidgetProject(
)
:
voidgetRegisterSlot(
)
:
voidgetRuntimeConfigurableWrapper(
)
:
voidgetTaskName(
)
:
voidgetTaskType(
)
:
voidinit(
)
:
voidLoad the necessary environment for running this task.
| Exception | Description |
|---|---|
| \BuildException |
log(
)
:
voidmain(
)
:
voidMake the http request
maybeConfigure(
)
:
voidperform(
)
:
voidsetAuthPassword(
string $password
)
:
voidSets the authentication password
| Name | Type | Description |
|---|---|---|
| $password | string |
setAuthScheme(
string $scheme
)
:
voidSets the authentication scheme
| Name | Type | Description |
|---|---|---|
| $scheme | string |
setAuthUser(
string $user
)
:
voidSets the authentication user name
| Name | Type | Description |
|---|---|---|
| $user | string |
setDescription(
)
:
voidsetLocation(
)
:
voidsetObserverEvents(
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 |
setOwningTarget(
)
:
voidsetProject(
)
:
voidsetResponseRegex(
string $regex
)
:
voidSets the response regex
| Name | Type | Description |
|---|---|---|
| $regex | string |
setRuntimeConfigurableWrapper(
)
:
voidsetTaskName(
)
:
voidsetTaskType(
)
:
voidsetUrl(
string $url
)
:
voidSets the request URL
| Name | Type | Description |
|---|---|---|
| $url | string |
setVerbose(
boolean $verbose
)
:
voidSets whether to enable detailed logging
| Name | Type | Description |
|---|---|---|
| $verbose | boolean |