API Documentation

Zend/Tool/Framework/Client/Request.php

Show: inherited
Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Tool  
Subpackage
Framework  
Version
$Id: Request.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Tool_Framework_Client_Request

Package: Zend\Tool

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedstring  $_actionName= 'null'

Default valuenullDetails
Type
string
Propertyprotectedarray  $_actionParameters= 'array()'

Default valuearray()Details
Type
array
Propertyprotectedbool  $_isDebug= 'false'

Default valuefalseDetails
Type
bool
Propertyprotectedbool  $_isDispatchable= 'true'

Default valuetrueDetails
Type
bool
Propertyprotectedbool  $_isPretend= 'false'

Default valuefalseDetails
Type
bool
Propertyprotectedbool  $_isVerbose= 'false'

Default valuefalseDetails
Type
bool
Propertyprotectedstring  $_providerName= 'null'

Default valuenullDetails
Type
string
Propertyprotectedarray  $_providerParameters= 'array()'

Default valuearray()Details
Type
array
Propertyprotectedstring  $_specialtyName= 'null'

Default valuenullDetails
Type
string

Methods

methodpublicgetActionName( ) : string

getActionName()

Returns
Type Description
string
methodpublicgetActionParameter( string $parameterName ) : string

getActionParameter()

Parameters
Name Type Description
$parameterName string
Returns
Type Description
string
methodpublicgetActionParameters( ) : array

getActionParameters()

Returns
Type Description
array
methodpublicgetProviderName( ) : string

getProviderName()

Returns
Type Description
string
methodpublicgetProviderParameter( string $parameterName ) : string

getProviderParameter()

Parameters
Name Type Description
$parameterName string
Returns
Type Description
string
methodpublicgetProviderParameters( ) : array

getProviderParameters()

Returns
Type Description
array
methodpublicgetSpecialtyName( ) : string

getSpecialtyName()

Returns
Type Description
string
methodpublicisDebug( ) : bool

isDebug() - Whether or not this is a debug enabled request

Returns
Type Description
bool
methodpublicisDispatchable( ) : bool

isDispatchable() Is this request Dispatchable?

Returns
Type Description
bool
methodpublicisPretend( ) : bool

isPretend() - Whether or not this is a pretend request

Returns
Type Description
bool
methodpublicisVerbose( ) : bool

isVerbose() - Whether or not this is a verbose enabled request

Returns
Type Description
bool
methodpublicsetActionName( string $actionName ) : \Zend_Tool_Framework_Client_Request

setActionName()

Parameters
Name Type Description
$actionName string
Returns
Type Description
\Zend_Tool_Framework_Client_Request
methodpublicsetActionParameter( string $parameterName, string $parameterValue ) : \Zend_Tool_Framework_Client_Request

setActionParameter()

Parameters
Name Type Description
$parameterName string
$parameterValue string
Returns
Type Description
\Zend_Tool_Framework_Client_Request
methodpublicsetDebug(  $debug ) : \Zend_Tool_Framework_Client_Request

setDebug()

Parameters
Name Type Description
$debug
Returns
Type Description
\Zend_Tool_Framework_Client_Request
methodpublicsetDispatchable( bool $dispatchable ) : \Zend_Tool_Framework_Client_Request

setDispatchable()

Parameters
Name Type Description
$dispatchable bool
Returns
Type Description
\Zend_Tool_Framework_Client_Request
methodpublicsetPretend( bool $pretend ) : \Zend_Tool_Framework_Client_Request

setPretend()

Parameters
Name Type Description
$pretend bool
Returns
Type Description
\Zend_Tool_Framework_Client_Request
methodpublicsetProviderName( string $providerName ) : \Zend_Tool_Framework_Client_Request

setProviderName()

Parameters
Name Type Description
$providerName string
Returns
Type Description
\Zend_Tool_Framework_Client_Request
methodpublicsetProviderParameter( string $parameterName, string $parameterValue ) : \Zend_Tool_Framework_Client_Request

setProviderParameter()

Parameters
Name Type Description
$parameterName string
$parameterValue string
Returns
Type Description
\Zend_Tool_Framework_Client_Request
methodpublicsetSpecialtyName( string $specialtyName ) : \Zend_Tool_Framework_Client_Request

setSpecialtyName()

Parameters
Name Type Description
$specialtyName string
Returns
Type Description
\Zend_Tool_Framework_Client_Request
methodpublicsetVerbose( bool $verbose ) : \Zend_Tool_Framework_Client_Request

setVerbose()

Parameters
Name Type Description
$verbose bool
Returns
Type Description
\Zend_Tool_Framework_Client_Request
Documentation was generated by DocBlox 0.15.1.