Tool/Framework/Client/Abstract.php
inherited
Classes
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 [email protected] 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: Abstract.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Tool_Framework_Client_Abstract
- Implements
- \Zend_Tool_Framework_Registry_EnabledInterface
- Children
- \Zend_Tool_Framework_Client_Console
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
callback|null $_interactiveCallback = nullnullDetails- Type
- callback | null
bool $_isInitialized = falsefalseDetails- Type
- bool
\Zend_Tool_Framework_Registry $_registry = nullnullDetails
Methods
__construct( $options = array()) : void| Name | Type | Description |
|---|---|---|
| $options |
_handleDispatch() : void_handleDispatchExecution( $class, $methodName, $callParameters) : void| Name | Type | Description |
|---|---|---|
| $class | ||
| $methodName | ||
| $callParameters |
_postDispatch() : voidThis 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() : voidThis method *must* be implemented by the client implementation to parse out and setup the request objects action, provider and parameter information.
_preInit() : voidThis method should be implemented by the client implementation to construct and set custom inflectors, request and response objects.
convertFromClientNaming( $string) : void| Name | Type | Description |
|---|---|---|
| $string |
convertToClientNaming( $string) : void| Name | Type | Description |
|---|---|---|
| $string |
dispatch() : voidThis method should be called in order to "handle" a Tooling Client request that has come to the client that has been implemented.
getName() : stringgetName() - Return the client name which can be used to query the manifest if need be.
| Type | Description |
|---|---|
| string | The client name |
getRegistry() : \Zend_Tool_Framework_Registry_InterfacegetRegistry();
| Type | Description |
|---|---|
| \Zend_Tool_Framework_Registry_Interface |
hasInteractiveInput() : boolhasInteractiveInput() - Convienence method for determining if this client can handle interactive input, and thus be able to run the promptInteractiveInput
| Type | Description |
|---|---|
| bool |
initialize() : voidinitialized() - This will initialize the client for use
promptInteractiveInput( $inputRequest) : void| Name | Type | Description |
|---|---|---|
| $inputRequest |
setOptions( $options) : void| Name | Type | Description |
|---|---|---|
| $options |
setRegistry(\Zend_Tool_Framework_Registry_Interface $registry) : \Zend_Tool_Framework_Client_AbstractsetRegistry() - Required by the Zend_Tool_Framework_Registry_EnabledInterface interface which ensures proper registry dependency resolution
| Name | Type | Description |
|---|---|---|
| $registry | \Zend_Tool_Framework_Registry_Interface |
| Type | Description |
|---|---|
| \Zend_Tool_Framework_Client_Abstract |