Zend Framework API Documentation
Back to top  

Zend_Tool_Framework_Client_Console - the CLI Client implementation for Zend_Tool_Framework

category Zend
package Zend_Tool
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License
todo methods need more API documentation.
inherited_from \Zend_Tool_Framework_Client_Abstract

 Methods

__construct() 

__construct($options = array()) 
Inherited

Parameters

$options

convertFromClientNaming()

convertFromClientNaming(string $string) : string

Convert words from client specific naming to code naming - camelcased

Filters are lazy-loaded.

inherited_from \Zend_Tool_Framework_Client_Abstract::convertFromClientNaming()

Parameters

$string

string

Returns

string

convertFromClientNaming() 

convertFromClientNaming($string) 
Inherited

Parameters

$string

convertToClientNaming()

convertToClientNaming(string $string) : string

Convert words to client specific naming, in this case is lower, dash separated

Filters are lazy-loaded.

inherited_from \Zend_Tool_Framework_Client_Abstract::convertToClientNaming()

Parameters

$string

string

Returns

string

convertToClientNaming() 

convertToClientNaming($string) 
Inherited

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() 
Inherited

getMissingParameterPromptString()

getMissingParameterPromptString(\Zend_Tool_Framework_Provider_Interface $provider, \Zend_Tool_Framework_Action_Interface $actionInterface, string $missingParameterName) : string
inherited_from \Zend_Tool_Framework_Client_Interactive_InputInterface::getMissingParameterPromptString()

Parameters

$provider

\Zend_Tool_Framework_Provider_Interface

$actionInterface

\Zend_Tool_Framework_Action_Interface

$missingParameterName

string

Returns

string

getName() - return the name of the client, in this case 'console'

getName() : string
inherited_from \Zend_Tool_Framework_Client_Abstract::getName()

Returns

string

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

getName() : string
Inherited

Returns

stringThe client name

getRegistry();

getRegistry() : \Zend_Tool_Framework_Registry_Interface
Inherited

Returns

\Zend_Tool_Framework_Registry_Interface

handleInteractiveInputRequest() is required by the Interactive InputInterface

handleInteractiveInputRequest(\Zend_Tool_Framework_Client_Interactive_InputRequest $inputRequest) : string
inherited_from \Zend_Tool_Framework_Client_Interactive_InputInterface::handleInteractiveInputRequest()

Parameters

$inputRequest

\Zend_Tool_Framework_Client_Interactive_InputRequest

Returns

string

handleInteractiveOutput() is required by the Interactive OutputInterface

handleInteractiveOutput(string $output) 

This allows us to display output immediately from providers, rather than displaying it after the provider is done.

inherited_from \Zend_Tool_Framework_Client_Interactive_OutputInterface::handleInteractiveOutput()

Parameters

$output

string

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

hasInteractiveInput() : boolean
Inherited

Returns

boolean

initialized() - This will initialize the client for use

initialize() 
Inherited

main() - This is typically called from zf.php. This method is a self contained main() function.

main($options = array()) 
Static

Parameters

$options

promptInteractiveInput() 

promptInteractiveInput($inputRequest) 
Inherited

Parameters

$inputRequest

setClassesToLoad() 

setClassesToLoad(array $classesToLoad) 

Parameters

$classesToLoad

array

setConfigOptions()

setConfigOptions(array $configOptions) 

Parameters

$configOptions

array

setOptions() 

setOptions(array $options) 
Inherited

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
inherited_from \Zend_Tool_Framework_Registry_EnabledInterface::setRegistry()

Parameters

$registry

\Zend_Tool_Framework_Registry_Interface

Returns

\Zend_Tool_Framework_Client_Abstract

setStorageOptions()

setStorageOptions(array $storageOptions) 

Parameters

$storageOptions

array

_handleDispatch() 

_handleDispatch() 
Inherited

_handleDispatchExecution() 

_handleDispatchExecution($class, $methodName, $callParameters) 
Inherited

Parameters

$class

$methodName

$callParameters

_postDispatch() - Tasks handled after dispatching

_postDispatch() 
inherited_from \Zend_Tool_Framework_Client_Abstract::_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.

_postDispatch() 
Inherited

_preDispatch() - Tasks handed after initialization but before dispatching

_preDispatch() 
inherited_from \Zend_Tool_Framework_Client_Abstract::_preDispatch()

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

_preDispatch() 
Inherited

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

_preInit() 
inherited_from \Zend_Tool_Framework_Client_Abstract::_preInit()

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

_preInit() 
Inherited

 Properties

 

$_classesToLoad

$_classesToLoad : array

Default

array()
 

$_configOptions

$_configOptions : array

Default

null
 

$_debugLogger

$_debugLogger : \Zend_Log

Default

null
 

$_filterFromClientNaming

$_filterFromClientNaming : \Zend_Filter_Word_DashToCamelCase

Default

null
 

$_filterToClientNaming

$_filterToClientNaming : \Zend_Filter_Word_CamelCaseToDash

Default

null
 

$_interactiveCallback

$_interactiveCallback : callback | null

Default

null
 

$_isInitialized

$_isInitialized : boolean

Default

false
 

$_registry

$_registry : \Zend_Tool_Framework_Registry

Default

null
 

$_storageOptions

$_storageOptions : array

Default

null