Zend Framework  1.12
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Zend_Tool_Framework_Client_Abstract Class Reference

Public Member Functions

 __construct ($options=array())
 
 setOptions (Array $options)
 
 getName ()
 getName() - Return the client name which can be used to query the manifest if need be.
 
 initialize ()
 initialized() - This will initialize the client for use
 
 setRegistry (Zend_Tool_Framework_Registry_Interface $registry)
 setRegistry() - Required by the Zend_Tool_Framework_Registry_EnabledInterface interface which ensures proper registry dependency resolution
 
 getRegistry ()
 getRegistry();
 
 hasInteractiveInput ()
 hasInteractiveInput() - Convienence method for determining if this client can handle interactive input, and thus be able to run the promptInteractiveInput
 
 promptInteractiveInput ($inputRequest)
 
 dispatch ()
 This method should be called in order to "handle" a Tooling Client request that has come to the client that has been implemented.
 
 convertToClientNaming ($string)
 
 convertFromClientNaming ($string)
 

Protected Member Functions

 _preInit ()
 This method should be implemented by the client implementation to construct and set custom inflectors, request and response objects.
 
 _preDispatch ()
 This method *must* be implemented by the client implementation to parse out and setup the request objects action, provider and parameter information.
 
 _postDispatch ()
 This method should be implemented by the client implementation to take the output of the response object and return it (in an client specific way) back to the Tooling Client.
 
 _handleDispatch ()
 
 _handleDispatchExecution ($class, $methodName, $callParameters)
 

Protected Attributes

 $_registry = null
 
 $_interactiveCallback = null
 
 $_isInitialized = false
 
 $_debugLogger = null
 

Constructor & Destructor Documentation

__construct (   $options = array())

Member Function Documentation

_handleDispatch ( )
protected
_handleDispatchExecution (   $class,
  $methodName,
  $callParameters 
)
protected
_postDispatch ( )
protected

This method should be implemented by the client implementation to take the output of the response object and return it (in an client specific way) back to the Tooling Client.

_preDispatch ( )
abstractprotected

This method *must* be implemented by the client implementation to parse out and setup the request objects action, provider and parameter information.

_preInit ( )
protected

This method should be implemented by the client implementation to construct and set custom inflectors, request and response objects.

convertFromClientNaming (   $string)
convertToClientNaming (   $string)
dispatch ( )

This method should be called in order to "handle" a Tooling Client request that has come to the client that has been implemented.

getName ( )
abstract

getName() - Return the client name which can be used to query the manifest if need be.

Returns
string The client name
getRegistry ( )
hasInteractiveInput ( )

hasInteractiveInput() - Convienence method for determining if this client can handle interactive input, and thus be able to run the promptInteractiveInput

Returns
bool
initialize ( )

initialized() - This will initialize the client for use

promptInteractiveInput (   $inputRequest)
setOptions ( Array  $options)
setRegistry ( Zend_Tool_Framework_Registry_Interface  $registry)

setRegistry() - Required by the Zend_Tool_Framework_Registry_EnabledInterface interface which ensures proper registry dependency resolution

Parameters
Zend_Tool_Framework_Registry_Interface$registry
Returns
Zend_Tool_Framework_Client_Abstract

Implements Zend_Tool_Framework_Registry_EnabledInterface.

Member Data Documentation

$_debugLogger = null
protected
$_interactiveCallback = null
protected
$_isInitialized = false
protected
$_registry = null
protected