Zend Framework API Documentation
Back to top  

category Zend
package Zend_Tool
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License

 Methods

__construct() 

__construct($options = array()) 

Parameters

$options

convertFromClientNaming() 

convertFromClientNaming($string) 

Parameters

$string

convertToClientNaming() 

convertToClientNaming($string) 

Parameters

$string

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

dispatch() 

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

getName() : string

Returns

stringThe client name

getRegistry();

getRegistry() : \Zend_Tool_Framework_Registry_Interface

Returns

\Zend_Tool_Framework_Registry_Interface

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

hasInteractiveInput() : boolean

Returns

boolean

initialized() - This will initialize the client for use

initialize() 

promptInteractiveInput() 

promptInteractiveInput($inputRequest) 

Parameters

$inputRequest

setOptions() 

setOptions(array $options) 

Parameters

$options

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

setRegistry(\Zend_Tool_Framework_Registry_Interface $registry) : \Zend_Tool_Framework_Client_Abstract
inherited_from \Zend_Tool_Framework_Registry_EnabledInterface::setRegistry()

Parameters

$registry

\Zend_Tool_Framework_Registry_Interface

Returns

\Zend_Tool_Framework_Client_Abstract

_handleDispatch() 

_handleDispatch() 

_handleDispatchExecution() 

_handleDispatchExecution($class, $methodName, $callParameters) 

Parameters

$class

$methodName

$callParameters

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.

_postDispatch() 

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

_preDispatch() 

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

_preInit() 

 Properties

 

$_debugLogger

$_debugLogger : \Zend_Log

Default

null
 

$_interactiveCallback

$_interactiveCallback : callback | null

Default

null
 

$_isInitialized

$_isInitialized : boolean

Default

false
 

$_registry

$_registry : \Zend_Tool_Framework_Registry

Default

null