Tool/Framework/Client/Console/HelpSystem.php
Show:
inherited
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 license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Tool
- Subpackage
- Framework
- Version
- $Id$
\Zend_Tool_Framework_Client_Console_HelpSystem
Package: Zend_Tool
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
\Zend_Tool_Framework_Registry_Interface $_registry = nullDefault value
nullDetails\Zend_Tool_Framework_Client_Response $_response = nullDefault value
nullDetailsMethods
_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) : \Zend_Tool_Framework_Client_Console_HelpSystem_respondWithCommand()
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $providerMetadata | \Zend_Tool_Framework_Metadata_Tool | |
| $actionMetadata | \Zend_Tool_Framework_Metadata_Tool | |
| $specialtyMetadata | \Zend_Tool_Framework_Metadata_Tool | |
| $parameterLongMetadata | \Zend_Tool_Framework_Metadata_Tool |
| Type | Description |
|---|---|
| \Zend_Tool_Framework_Client_Console_HelpSystem |
_respondWithHeader() : \Zend_Tool_Framework_Client_Console_HelpSystem_respondWithHeader()
Returns
| Type | Description |
|---|---|
| \Zend_Tool_Framework_Client_Console_HelpSystem |
_respondWithProviderName(\Zend_Tool_Framework_Metadata_Tool $providerMetadata) : \Zend_Tool_Framework_Client_Console_HelpSystem_respondWithProviderName()
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $providerMetadata | \Zend_Tool_Framework_Metadata_Tool |
| Type | Description |
|---|---|
| \Zend_Tool_Framework_Client_Console_HelpSystem |
_respondWithSystemInformation(string $providerNameFilter = null, string $actionNameFilter = null, bool $includeAllSpecialties = false) : \Zend_Tool_Framework_Client_Console_HelpSystem_respondWithSystemInformation()
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $providerNameFilter | string | |
| $actionNameFilter | string | |
| $includeAllSpecialties | bool |
| Type | Description |
|---|---|
| \Zend_Tool_Framework_Client_Console_HelpSystem |
respondWithActionHelp(string $actionName) : \Zend_Tool_Framework_Client_Console_HelpSystemrespondWithActionHelp()
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $actionName | string |
| Type | Description |
|---|---|
| \Zend_Tool_Framework_Client_Console_HelpSystem |
respondWithErrorMessage(string $errorMessage, \Exception $exception = null) : voidrespondWithErrorMessage()
Parameters
| Name | Type | Description |
|---|---|---|
| $errorMessage | string | |
| $exception | \Exception |
respondWithGeneralHelp() : \Zend_Tool_Framework_Client_Console_HelpSystemrespondWithGeneralHelp()
Returns
| Type | Description |
|---|---|
| \Zend_Tool_Framework_Client_Console_HelpSystem |
respondWithProviderHelp(string $providerName) : \Zend_Tool_Framework_Client_Console_HelpSystemrespondWithProviderHelp()
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $providerName | string |
| Type | Description |
|---|---|
| \Zend_Tool_Framework_Client_Console_HelpSystem |
respondWithSpecialtyAndParamHelp(string $providerName, string $actionName) : \Zend_Tool_Framework_Client_Console_HelpSystemrespondWithSpecialtyAndParamHelp()
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $providerName | string | |
| $actionName | string |
| Type | Description |
|---|---|
| \Zend_Tool_Framework_Client_Console_HelpSystem |
setRegistry(\Zend_Tool_Framework_Registry_Interface $registry) : \Zend_Tool_Framework_Client_Console_HelpSystemsetRegistry()
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $registry | \Zend_Tool_Framework_Registry_Interface |
| Type | Description |
|---|---|
| \Zend_Tool_Framework_Client_Console_HelpSystem |