tasks/ext/HttpRequestTask.php

Show:

inherited

Classes
- \HttpRequestTask

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
jump to top

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

string
                 $_authPassword= ''''

Holds the authentication password

Default value''Details

Type: string

string
                 $_authScheme= ''

Holds the authentication scheme

Details

Type: string

string
                 $_authUser= 'null'

Holds the authentication user name

Default valuenullDetails

Type: string

\array<Parameter>
                 $_configData= 'array()'

Holds additional config data for HTTP_Request2

Default valuearray()Details

Type: \array<Parameter>

\array<Parameter>
                 $_headers= 'array()'

Holds additional header data

Default valuearray()Details

Type: \array<Parameter>

\array<string>
                 $_observerEvents= 'array(
        'connect',
        'sentHeaders',
        'sentBodyPart',
        'receivedHeaders',
        'receivedBody',
        'disconnect',
    )'

Holds the events that will be logged

Default value

array(
        'connect',
        'sentHeaders',
        'sentBodyPart',
        'receivedHeaders',
        'receivedBody',
        'disconnect',
    )

Details

Type: \array<string>

string
                 $_responseRegex= ''''

Holds the regular expression that should match the response

Default value''Details

Type: string

string
                 $_url= 'null'

Holds the request URL

Default valuenullDetails

Type: string

boolean
                 $_verbose= 'false'

Whether to enable detailed logging

Default valuefalseDetails

Type: boolean

string
                 $description= ''

inherited

Description of the task

Inherited from: \Task::$$description

Details

Type: string
Inherited_from: \Task::$$description

\Location
                 $location= ''

inherited

Stored buildfile location

Inherited from: \Task::$$location

Details

Type: \Location
Inherited_from: \Task::$$location

\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

\Target
                 $target= ''

inherited

Owning Target object

Inherited from: \Task::$$target

Details

Type: \Target
Inherited_from: \Task::$$target

string
                 $taskName= ''

inherited

Taskname for logger

Inherited from: \Task::$$taskName

Details

Type: string
Inherited_from: \Task::$$taskName

string
                 $taskType= ''

inherited

Internal taskname (req)

Inherited from: \Task::$$taskType

Details

Type: string
Inherited_from: \Task::$$taskType

\RuntimeConfigurable
                 $wrapper= ''

inherited

Wrapper of the task

Inherited from: \Task::$$wrapper

Details

Type: \RuntimeConfigurable
Inherited_from: \Task::$$wrapper

Methods

createConfig(
          
          )
        
        :
          \Parameter

Creates a config parameter for this task

Returns

Type	Description
\Parameter	The created parameter

createHeader(
          
          )
        
        :
          \Parameter

Creates an additional header for this task

Returns

Type	Description
\Parameter	The created header

getDescription(
          
          )
        
        :
          string

inherited

Returns the textual description of the task

Inherited from: \Task::getDescription()

Returns

Type	Description
string	The text description of the task

getLocation(
          
          )
        
        :
          \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.

getOwningTarget(
          
          )
        
        :
          \Target

inherited

Returns the owning target of this task.

Inherited from: \Task::getOwningTarget()

Returns

Type	Description
\Target	The target object that owns this task

getProject(
          
          )
        
        :
          \Project

inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()\Task::getProject()

Returns

Type	Description
\Project	Reference to current porject object

getRegisterSlot(
          string $slotName
          )
        
        :
          void

inherited

Returns a name

Inherited from: \Task::getRegisterSlot()

Parameters

Name	Type	Description
$slotName	string

getRuntimeConfigurableWrapper(
          
          )
        
        :
          \RuntimeConfigurable

inherited

Returns the wrapper object for runtime configuration

Inherited from: \Task::getRuntimeConfigurableWrapper()

Returns

Type	Description
\RuntimeConfigurable	The wrapper object used by this task

getTaskName(
          
          )
        
        :
          string

inherited

Returns the name of task, used only for log messages

Inherited from: \Task::getTaskName()

Returns

Type	Description
string	Name of this task

getTaskType(
          
          )
        
        :
          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)

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

log(
          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

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

inherited

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

Inherited from: \Task::maybeConfigure()

perform(
          
          )
        
        :
          void

inherited

Perfrom this task

Inherited from: \Task::perform()

setAuthPassword(
          string $password
          )
        
        :
          void

Sets the authentication password

Parameters

Name	Type	Description
$password	string

setAuthScheme(
          string $scheme
          )
        
        :
          void

Sets the authentication scheme

Parameters

Name	Type	Description
$scheme	string

setAuthUser(
          string $user
          )
        
        :
          void

Sets the authentication user name

Parameters

Name	Type	Description
$user	string

setDescription(
          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

setLocation(
          \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.

setObserverEvents(
          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

setOwningTarget(
          \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

setProject(
          \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

setResponseRegex(
          string $regex
          )
        
        :
          void

Sets the response regex

Parameters

Name	Type	Description
$regex	string

setRuntimeConfigurableWrapper(
          \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

setTaskName(
          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

setTaskType(
          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)

setUrl(
          string $url
          )
        
        :
          void

Sets the request URL

Parameters

Name	Type	Description
$url	string

setVerbose(
          boolean $verbose
          )
        
        :
          void

Sets whether to enable detailed logging

Parameters

Name	Type	Description
$verbose	boolean

tasks/ext/HttpRequestTask.php

\HttpRequestTaskjump to top

Properties

Methods

\HttpRequestTask
jump to top