Tool/Framework/Client/Console.php
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: Console.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Tool_Framework_Client_Console
- Implements
- \Zend_Tool_Framework_Client_Interactive_InputInterface
- \Zend_Tool_Framework_Client_Interactive_OutputInterface
- Parent(s)
- \Zend_Tool_Framework_Client_Abstract
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Todo
- methods need more API documentation.
Properties


\Zend_Log $_debugLogger = null
null
Details- Type
- \Zend_Log
- Inherited_from
- \Zend_Tool_Framework_Client_Abstract::$$_debugLogger


callback|null $_interactiveCallback = null
null
Details- Type
- callback | null
- Inherited_from
- \Zend_Tool_Framework_Client_Abstract::$$_interactiveCallback


bool $_isInitialized = false
false
Details- Type
- bool
- Inherited_from
- \Zend_Tool_Framework_Client_Abstract::$$_isInitialized


\Zend_Tool_Framework_Registry $_registry = null
null
DetailsMethods


__construct( $options = array()) : void
Name | Type | Description |
---|---|---|
$options |


_handleDispatch() : void


_handleDispatchExecution( $class, $methodName, $callParameters) : void
Name | Type | Description |
---|---|---|
$class | ||
$methodName | ||
$callParameters |


_preInit() : void
_init() - Tasks processed before the constructor, generally setting up objects to use


convertFromClientNaming(string $string) : string
convertFromClientNaming()
Convert words from client specific naming to code naming - camelcased
Filters are lazy-loaded.
Name | Type | Description |
---|---|---|
$string | string |
Type | Description |
---|---|
string |


convertToClientNaming(string $string) : string
convertToClientNaming()
Convert words to client specific naming, in this case is lower, dash separated
Filters are lazy-loaded.
Name | Type | Description |
---|---|---|
$string | string |
Type | Description |
---|---|
string |


dispatch() : void
This method should be called in order to "handle" a Tooling Client request that has come to the client that has been implemented.
Inherited from: \Zend_Tool_Framework_Client_Abstract::dispatch()

getMissingParameterPromptString(\Zend_Tool_Framework_Provider_Interface $provider, \Zend_Tool_Framework_Action_Interface $actionInterface, string $missingParameterName) : string
getMissingParameterPromptString()
Name | Type | Description |
---|---|---|
$provider | \Zend_Tool_Framework_Provider_Interface | |
$actionInterface | \Zend_Tool_Framework_Action_Interface | |
$missingParameterName | string |
Type | Description |
---|---|
string |


getName() : string
getName() - return the name of the client, in this case 'console'
Type | Description |
---|---|
string |


getRegistry() : \Zend_Tool_Framework_Registry_Interface
Type | Description |
---|---|
\Zend_Tool_Framework_Registry_Interface |


handleInteractiveInputRequest(\Zend_Tool_Framework_Client_Interactive_InputRequest $inputRequest) : string
handleInteractiveInputRequest() is required by the Interactive InputInterface
Name | Type | Description |
---|---|---|
$inputRequest | \Zend_Tool_Framework_Client_Interactive_InputRequest |
Type | Description |
---|---|
string |


handleInteractiveOutput(string $output) : void
handleInteractiveOutput() is required by the Interactive OutputInterface
This allows us to display output immediately from providers, rather than displaying it after the provider is done.
Name | Type | Description |
---|---|---|
$output | string |


hasInteractiveInput() : bool
hasInteractiveInput() - Convienence method for determining if this client can handle interactive input, and thus be able to run the promptInteractiveInput
Inherited from: \Zend_Tool_Framework_Client_Abstract::hasInteractiveInput()Type | Description |
---|---|
bool |


initialize() : void
initialized() - This will initialize the client for use
Inherited from: \Zend_Tool_Framework_Client_Abstract::initialize()

main( $options = array()) : void
main() - This is typically called from zf.php.
This method is a self contained main() function.
Name | Type | Description |
---|---|---|
$options |


promptInteractiveInput( $inputRequest) : void
Name | Type | Description |
---|---|---|
$inputRequest |


setConfigOptions(array $configOptions) : void
setConfigOptions()
Name | Type | Description |
---|---|---|
$configOptions | array |


setOptions( $options) : void
Name | Type | Description |
---|---|---|
$options |


setRegistry(\Zend_Tool_Framework_Registry_Interface $registry) : \Zend_Tool_Framework_Client_Abstract
setRegistry() - Required by the Zend_Tool_Framework_Registry_EnabledInterface interface which ensures proper registry dependency resolution
Inherited from: \Zend_Tool_Framework_Client_Abstract::setRegistry()Name | Type | Description |
---|---|---|
$registry | \Zend_Tool_Framework_Registry_Interface |
Type | Description |
---|---|
\Zend_Tool_Framework_Client_Abstract |