Zend_Tool_Framework_Client_Console Class Reference

Public Member Functions
	getName ()
	getName() - return the name of the client, in this case 'console'
	setConfigOptions ($configOptions)
	setConfigOptions()
	setStorageOptions ($storageOptions)
	setStorageOptions()
	setClassesToLoad ($classesToLoad)
	handleInteractiveInputRequest (Zend_Tool_Framework_Client_Interactive_InputRequest $inputRequest)
	handleInteractiveInputRequest() is required by the Interactive InputInterface
	handleInteractiveOutput ($output)
	handleInteractiveOutput() is required by the Interactive OutputInterface
	getMissingParameterPromptString (Zend_Tool_Framework_Provider_Interface $provider, Zend_Tool_Framework_Action_Interface $actionInterface, $missingParameterName)
	getMissingParameterPromptString()
	convertToClientNaming ($string)
	convertToClientNaming()
	convertFromClientNaming ($string)
	convertFromClientNaming()
Public Member Functions inherited from Zend_Tool_Framework_Client_Abstract
	__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)

Static Public Member Functions
static	main ($options=array())
	main() - This is typically called from zf.php.

Protected Member Functions
	_preInit ()
	_init() - Tasks processed before the constructor, generally setting up objects to use
	_preDispatch ()
	_preDispatch() - Tasks handed after initialization but before dispatching
	_postDispatch ()
	_postDispatch() - Tasks handled after dispatching
Protected Member Functions 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.
	_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
	$_configOptions = null
	$_storageOptions = null
	$_filterToClientNaming = null
	$_filterFromClientNaming = null
	$_classesToLoad = array()
Protected Attributes inherited from Zend_Tool_Framework_Client_Abstract
	$_registry = null
	$_interactiveCallback = null
	$_isInitialized = false
	$_debugLogger = null

Member Function Documentation

_postDispatch ( )

protected

_postDispatch() - Tasks handled after dispatching

_preDispatch ( )

protected

_preDispatch() - Tasks handed after initialization but before dispatching

_preInit ( )

protected

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

convertFromClientNaming

(

$string

)

convertFromClientNaming()

Convert words from client specific naming to code naming - camelcased

Filters are lazy-loaded.

Parameters

string

$string

Returns

string

convertToClientNaming

(

$string

)

convertToClientNaming()

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

Filters are lazy-loaded.

Parameters

string

$string

Returns

string

getMissingParameterPromptString	(	Zend_Tool_Framework_Provider_Interface	$provider,
		Zend_Tool_Framework_Action_Interface	$actionInterface,
			$missingParameterName
	)

getMissingParameterPromptString()

Parameters

Zend_Tool_Framework_Provider_Interface	$provider
Zend_Tool_Framework_Action_Interface	$actionInterface
string	$missingParameterName

Returns

string

Implements Zend_Tool_Framework_Client_Interactive_InputInterface.

getName

(

)

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

Returns

string

handleInteractiveInputRequest

(

Zend_Tool_Framework_Client_Interactive_InputRequest

$inputRequest

)

handleInteractiveInputRequest() is required by the Interactive InputInterface

Parameters

Zend_Tool_Framework_Client_Interactive_InputRequest

$inputRequest

Returns

string

Implements Zend_Tool_Framework_Client_Interactive_InputInterface.

handleInteractiveOutput

(

$output

)

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.

Parameters

string

$output

Implements Zend_Tool_Framework_Client_Interactive_OutputInterface.

static main (   $options = array() )

static

main() - This is typically called from zf.php.

This method is a self contained main() function.

setClassesToLoad

(

$classesToLoad

)

Parameters

array

$classesToLoad

setConfigOptions

(

$configOptions

)

setConfigOptions()

Parameters

array

$configOptions

setStorageOptions

(

$storageOptions

)

setStorageOptions()

Parameters

array

$storageOptions

Member Data Documentation

$_classesToLoad = array()

protected

$_configOptions = null

protected

$_filterFromClientNaming = null

protected

$_filterToClientNaming = null

protected

$_storageOptions = null

protected