A HTTP request task.
Making an HTTP request and try to match the response against an provided
regular expression.
| package |
phing.tasks.ext |
| author |
Benjamin Schultz |
| version |
$Id: 495c02bc3a90d24694d8a4bf2d43ac077e0f9ec6 $ |
| since |
2.4.1 |
| copyright |
2001,2002 THYRELL. All rights reserved |
Methods
Creates a config parameter for this task
createConfig() : \Parameter
Returns the textual description of the task
getDescription() : string
Inherited
| inherited_from |
\Task::getDescription() |
Returns
stringThe text description of the task
Returns the location within the buildfile this task occurs.
getLocation() : \Location
Inherited
| inherited_from |
\Task::getLocation() |
Returns
\LocationThe location object describing the position of this
task within the buildfile.
Returns the owning target of this task.
getOwningTarget() : \Target
Inherited
| inherited_from |
\Task::getOwningTarget() |
Returns
\TargetThe target object that owns this task
Returns a reference to current project
getProject() : \Project
Inherited
| inherited_from |
\ProjectComponent::getProject() |
| inherited_from |
\Task::getProject() |
Returns
\ProjectReference to current porject object
Returns the wrapper object for runtime configuration
getRuntimeConfigurableWrapper() : \RuntimeConfigurable
Inherited
| inherited_from |
\Task::getRuntimeConfigurableWrapper() |
Returns
Returns the name of task, used only for log messages
getTaskName() : string
Inherited
| inherited_from |
\Task::getTaskName() |
Returns
stringName of this task
Returns the name of the task under which it was invoked,
usually the XML tagname
getTaskType() : string
Inherited
| inherited_from |
\Task::getTaskType() |
Returns
stringThe type of this task (XML Tag)
Load the necessary environment for running this task.
init()
Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
Exceptions
Provides a project level log event to the task.
log(string $msg, integer $level)
Inherited
Parameters
$msg
stringThe message to log
$level
integerThe priority of the message
Make the http request
main()
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
phing target1 target2 will run all tasks in target3 twice.
Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.
Sets the authentication password
setAuthPassword(string $password)
Parameters
$password
string
Sets the authentication scheme
setAuthScheme(string $scheme)
Parameters
$scheme
string
Sets the authentication user name
setAuthUser(string $user)
Sets a textual description of the task
setDescription(string $desc)
Inherited
| inherited_from |
\Task::setDescription() |
Parameters
$desc
stringThe text describing the task
Sets the location within the buildfile this task occurs.
setLocation(\Location $location)
Inherited
Called by
the parser to set location information.
| inherited_from |
\Task::setLocation() |
Parameters
$location
\LocationThe location object describing the position of this
task within the buildfile.
Sets a list of observer events that will be logged
if verbose output is enabled.
setObserverEvents(string $observerEvents) : void
Parameters
$observerEvents
stringList of observer events
Sets the owning target this task belongs to.
setOwningTarget(\Target $target)
Inherited
| inherited_from |
\Task::setOwningTarget() |
Parameters
$target
\TargetReference to owning target
References the project to the current component.
setProject(\Project $project)
Inherited
| inherited_from |
\ProjectComponent::setProject() |
| inherited_from |
\Task::setProject() |
Parameters
$project
\ProjectThe reference to the current project
Sets the response regex
setResponseRegex(string $regex)
Sets the wrapper object this task should use for runtime
configurable elements.
setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
Inherited
| inherited_from |
\Task::setRuntimeConfigurableWrapper() |
Parameters
Sets the name of this task for log messages
setTaskName(string $name) : string
Inherited
| inherited_from |
\Task::setTaskName() |
Parameters
$name
string
Returns
stringA string representing the name of this task for log
Sets the type of the task.
setTaskType(string $name)
Inherited
Usually this is the name of the XML tag
| inherited_from |
\Task::setTaskType() |
Parameters
$name
stringThe type of this task (XML Tag)
Sets the request URL
setUrl(string $url)
Sets whether to enable detailed logging
setVerbose(boolean $verbose)
Parameters
$verbose
boolean
Returns a name
getRegisterSlot(string $slotName)
Inherited
| inherited_from |
\Task::getRegisterSlot() |
Parameters
$slotName
string
Properties
$_configData : \array<Parameter>
$_observerEvents : \array<string>
$description : string
Inherited
| inherited_from |
\Task::$$description |
$location : \Location
Inherited
| inherited_from |
\Task::$$location |
$project : \Project
Inherited
| inherited_from |
\ProjectComponent::$$project |
| inherited_from |
\Task::$$project |
$target : \Target
Inherited
| inherited_from |
\Task::$$target |
$taskName : string
Inherited
| inherited_from |
\Task::$$taskName |
$taskType : string
Inherited
| inherited_from |
\Task::$$taskType |