Zend_Tool_Framework_Client_Console_HelpSystem Class Reference

Public Member Functions
	setRegistry (Zend_Tool_Framework_Registry_Interface $registry)
	setRegistry()
	respondWithErrorMessage ($errorMessage, Exception $exception=null)
	respondWithErrorMessage()
	respondWithGeneralHelp ()
	respondWithGeneralHelp()
	respondWithActionHelp ($actionName)
	respondWithActionHelp()
	respondWithSpecialtyAndParamHelp ($providerName, $actionName)
	respondWithSpecialtyAndParamHelp()
	respondWithProviderHelp ($providerName)
	respondWithProviderHelp()

Protected Member Functions
	_respondWithHeader ()
	_respondWithHeader()
	_respondWithSystemInformation ($providerNameFilter=null, $actionNameFilter=null, $includeAllSpecialties=false)
	_respondWithSystemInformation()
	_respondWithProviderName (Zend_Tool_Framework_Metadata_Tool $providerMetadata)
	_respondWithProviderName()
	_respondWithCommand (Zend_Tool_Framework_Metadata_Tool $providerMetadata, Zend_Tool_Framework_Metadata_Tool $actionMetadata, Zend_Tool_Framework_Metadata_Tool $specialtyMetadata, Zend_Tool_Framework_Metadata_Tool $parameterLongMetadata)
	_respondWithCommand()

Protected Attributes
	$_registry = null
	$_response = null

Member Function Documentation

_respondWithCommand ( Zend_Tool_Framework_Metadata_Tool  $providerMetadata, Zend_Tool_Framework_Metadata_Tool  $actionMetadata, Zend_Tool_Framework_Metadata_Tool  $specialtyMetadata, Zend_Tool_Framework_Metadata_Tool  $parameterLongMetadata  )

protected

_respondWithCommand()

Parameters

Zend_Tool_Framework_Metadata_Tool	$providerMetadata
Zend_Tool_Framework_Metadata_Tool	$actionMetadata
Zend_Tool_Framework_Metadata_Tool	$specialtyMetadata
Zend_Tool_Framework_Metadata_Tool	$parameterLongMetadata

Returns

Zend_Tool_Framework_Client_Console_HelpSystem

_respondWithHeader ( )

protected

_respondWithHeader()

Returns

Zend_Tool_Framework_Client_Console_HelpSystem

See Also

Zend_Version

_respondWithProviderName ( Zend_Tool_Framework_Metadata_Tool  $providerMetadata )

protected

_respondWithProviderName()

Parameters

Zend_Tool_Framework_Metadata_Tool

$providerMetadata

Returns

Zend_Tool_Framework_Client_Console_HelpSystem

_respondWithSystemInformation (   $providerNameFilter = null,   $actionNameFilter = null,   $includeAllSpecialties = false  )

protected

_respondWithSystemInformation()

Parameters

string	$providerNameFilter
string	$actionNameFilter
bool	$includeAllSpecialties

Returns

Zend_Tool_Framework_Client_Console_HelpSystem

respondWithActionHelp

(

$actionName

)

respondWithActionHelp()

Parameters

string

$actionName

Returns

Zend_Tool_Framework_Client_Console_HelpSystem

respondWithErrorMessage	(		$errorMessage,
		Exception	$exception = null
	)

respondWithErrorMessage()

Parameters

string	$errorMessage
Exception	$exception

respondWithGeneralHelp

(

)

respondWithGeneralHelp()

Returns

Zend_Tool_Framework_Client_Console_HelpSystem

respondWithProviderHelp

(

$providerName

)

respondWithProviderHelp()

Parameters

string

$providerName

Returns

Zend_Tool_Framework_Client_Console_HelpSystem

respondWithSpecialtyAndParamHelp	(		$providerName,
			$actionName
	)

respondWithSpecialtyAndParamHelp()

Parameters

string	$providerName
string	$actionName

Returns

Zend_Tool_Framework_Client_Console_HelpSystem

setRegistry

(

Zend_Tool_Framework_Registry_Interface

$registry

)

setRegistry()

Parameters

Zend_Tool_Framework_Registry_Interface

$registry

Returns

Zend_Tool_Framework_Client_Console_HelpSystem

Member Data Documentation

$_registry = null

protected

$_response = null

protected