tasks/ext/HttpRequestTask.php

Show: inherited
Table of Contents

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

Package: phing\tasks\ext

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

Propertyprotectedstring  $_authPassword= ''''

Holds the authentication password

Default value''Details
Type
string
Propertyprotectedstring  $_authScheme= ''

Holds the authentication scheme

Details
Type
string
Propertyprotectedstring  $_authUser= 'null'

Holds the authentication user name

Default valuenullDetails
Type
string
Propertyprotected\array<Parameter>  $_configData= 'array()'

Holds additional config data for HTTP_Request2

Default valuearray()Details
Type
\array<Parameter>
Propertyprotected\array<Parameter>  $_headers= 'array()'

Holds additional header data

Default valuearray()Details
Type
\array<Parameter>
Propertyprotected\array<string>  $_observerEvents= 'array( 'connect', 'sentHeaders', 'sentBodyPart', 'receivedHeaders', 'receivedBody', 'disconnect', )'

Holds the events that will be logged

Default valuearray( 'connect', 'sentHeaders', 'sentBodyPart', 'receivedHeaders', 'receivedBody', 'disconnect', )Details
Type
\array<string>
Propertyprotectedstring  $_responseRegex= ''''

Holds the regular expression that should match the response

Default value''Details
Type
string
Propertyprotectedstring  $_url= 'null'

Holds the request URL

Default valuenullDetails
Type
string
Propertyprotectedboolean  $_verbose= 'false'

Whether to enable detailed logging

Default valuefalseDetails
Type
boolean
Propertyprotectedstring  $description= ''
inherited

Description of the task

Inherited from: \Task::$$description
Details
Type
string
Inherited_from
\Task::$$description  
Propertyprotected\Location  $location= ''
inherited

Stored buildfile location

Inherited from: \Task::$$location
Details
Type
\Location
Inherited_from
\Task::$$location  
Propertyprotected\Project  $project= 'null'
inherited

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::$$project
Default valuenullDetails
Type
\Project
Inherited_from
\ProjectComponent::$$project  
Inherited_from
\Task::$$project  
Propertyprotected\Target  $target= ''
inherited

Owning Target object

Inherited from: \Task::$$target
Details
Type
\Target
Inherited_from
\Task::$$target  
Propertyprotectedstring  $taskName= ''
inherited

Taskname for logger

Inherited from: \Task::$$taskName
Details
Type
string
Inherited_from
\Task::$$taskName  
Propertyprotectedstring  $taskType= ''
inherited

Internal taskname (req)

Inherited from: \Task::$$taskType
Details
Type
string
Inherited_from
\Task::$$taskType  
Propertyprotected\RuntimeConfigurable  $wrapper= ''
inherited

Wrapper of the task

Inherited from: \Task::$$wrapper
Details
Type
\RuntimeConfigurable
Inherited_from
\Task::$$wrapper  

Methods

methodpubliccreateConfig( ) : \Parameter

Creates a config parameter for this task

Returns
Type Description
\Parameter The created parameter
methodpubliccreateHeader( ) : \Parameter

Creates an additional header for this task

Returns
Type Description
\Parameter The created header
methodpublicgetDescription( ) : string
inherited

Returns the textual description of the task

Inherited from: \Task::getDescription()
Returns
Type Description
string The text description of the task
methodpublicgetLocation( ) : \Location
inherited

Returns the location within the buildfile this task occurs. Used by {@link BuildException} to give detailed error messages.

Inherited from: \Task::getLocation()
Returns
Type Description
\Location The location object describing the position of this task within the buildfile.
methodpublicgetOwningTarget( ) : \Target
inherited

Returns the owning target of this task.

Inherited from: \Task::getOwningTarget()
Returns
Type Description
\Target The target object that owns this task
methodpublicgetProject( ) : \Project
inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()\Task::getProject()
Returns
Type Description
\Project Reference to current porject object
methodprotectedgetRegisterSlot( string $slotName ) : void
inherited

Returns a name

Inherited from: \Task::getRegisterSlot()
Parameters
Name Type Description
$slotName string
methodpublicgetRuntimeConfigurableWrapper( ) : \RuntimeConfigurable
inherited

Returns the wrapper object for runtime configuration

Inherited from: \Task::getRuntimeConfigurableWrapper()
Returns
Type Description
\RuntimeConfigurable The wrapper object used by this task
methodpublicgetTaskName( ) : string
inherited

Returns the name of task, used only for log messages

Inherited from: \Task::getTaskName()
Returns
Type Description
string Name of this task
methodpublicgetTaskType( ) : string
inherited

Returns the name of the task under which it was invoked, usually the XML tagname

Inherited from: \Task::getTaskType()
Returns
Type Description
string The type of this task (XML Tag)
methodpublicinit( ) : 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.

Throws
Exception Description
\BuildException
methodpubliclog( string $msg, integer $level = Project::MSG_INFO ) : void
inherited

Provides a project level log event to the task.

Inherited from: \Task::log()
Parameters
Name Type Description
$msg string

The message to log

$level integer

The priority of the message

Details
See
\BuildEvent  
See
\BuildListener  
methodpublicmain( ) : 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.

methodpublicmaybeConfigure( ) : void
inherited

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

Inherited from: \Task::maybeConfigure()
methodpublicperform( ) : void
inherited

Perfrom this task

Inherited from: \Task::perform()
methodpublicsetAuthPassword( string $password ) : void

Sets the authentication password

Parameters
Name Type Description
$password string
methodpublicsetAuthScheme( string $scheme ) : void

Sets the authentication scheme

Parameters
Name Type Description
$scheme string
methodpublicsetAuthUser( string $user ) : void

Sets the authentication user name

Parameters
Name Type Description
$user string
methodpublicsetDescription( string $desc ) : void
inherited

Sets a textual description of the task

Inherited from: \Task::setDescription()
Parameters
Name Type Description
$desc string

The text describing the task

methodpublicsetLocation( \Location $location ) : void
inherited

Sets the location within the buildfile this task occurs. Called by the parser to set location information.

Inherited from: \Task::setLocation()
Parameters
Name Type Description
$location \Location

The location object describing the position of this task within the buildfile.

methodpublicsetObserverEvents( string $observerEvents ) : void

Sets a list of observer events that will be logged if verbose output is enabled.

Parameters
Name Type Description
$observerEvents string

List of observer events

methodpublicsetOwningTarget( \Target $target ) : void
inherited

Sets the owning target this task belongs to.

Inherited from: \Task::setOwningTarget()
Parameters
Name Type Description
$target \Target

Reference to owning target

methodpublicsetProject( \Project $project ) : void
inherited

References the project to the current component.

Inherited from: \ProjectComponent::setProject()\Task::setProject()
Parameters
Name Type Description
$project \Project

The reference to the current project

methodpublicsetResponseRegex( string $regex ) : void

Sets the response regex

Parameters
Name Type Description
$regex string
methodpublicsetRuntimeConfigurableWrapper( \RuntimeConfigurable $wrapper ) : void
inherited

Sets the wrapper object this task should use for runtime configurable elements.

Inherited from: \Task::setRuntimeConfigurableWrapper()
Parameters
Name Type Description
$wrapper \RuntimeConfigurable

The wrapper object this task should use

methodpublicsetTaskName( string $name ) : string
inherited

Sets the name of this task for log messages

Inherited from: \Task::setTaskName()
Parameters
Name Type Description
$name string
Returns
Type Description
string A string representing the name of this task for log
methodpublicsetTaskType( string $name ) : void
inherited

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

Inherited from: \Task::setTaskType()
Parameters
Name Type Description
$name string

The type of this task (XML Tag)

methodpublicsetUrl( string $url ) : void

Sets the request URL

Parameters
Name Type Description
$url string
methodpublicsetVerbose( boolean $verbose ) : void

Sets whether to enable detailed logging

Parameters
Name Type Description
$verbose boolean
Documentation was generated by DocBlox 0.18.1.