API Documentation

Zend/Tool/Framework/Client/Console/HelpSystem.php

Show: inherited
Table of Contents

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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Tool  
Subpackage
Framework  
Version
$Id: HelpSystem.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Tool_Framework_Client_Console_HelpSystem

Package: Zend\Tool

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotected\Zend_Tool_Framework_Registry_Interface  $_registry= 'null'

Default valuenullDetails
Type
\Zend_Tool_Framework_Registry_Interface
Propertyprotected\Zend_Tool_Framework_Client_Response  $_response= 'null'

Default valuenullDetails
Type
\Zend_Tool_Framework_Client_Response

Methods

methodprotected_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
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
Returns
Type Description
\Zend_Tool_Framework_Client_Console_HelpSystem
methodprotected_respondWithHeader( ) : \Zend_Tool_Framework_Client_Console_HelpSystem

_respondWithHeader()

methodprotected_respondWithProviderName( \Zend_Tool_Framework_Metadata_Tool $providerMetadata ) : \Zend_Tool_Framework_Client_Console_HelpSystem

_respondWithProviderName()

Parameters
Name Type Description
$providerMetadata \Zend_Tool_Framework_Metadata_Tool
Returns
Type Description
\Zend_Tool_Framework_Client_Console_HelpSystem
methodprotected_respondWithSystemInformation( string $providerNameFilter = null, string $actionNameFilter = null, bool $includeAllSpecialties = false ) : \Zend_Tool_Framework_Client_Console_HelpSystem

_respondWithSystemInformation()

Parameters
Name Type Description
$providerNameFilter string
$actionNameFilter string
$includeAllSpecialties bool
Returns
Type Description
\Zend_Tool_Framework_Client_Console_HelpSystem
methodpublicrespondWithActionHelp( string $actionName ) : \Zend_Tool_Framework_Client_Console_HelpSystem

respondWithActionHelp()

Parameters
Name Type Description
$actionName string
Returns
Type Description
\Zend_Tool_Framework_Client_Console_HelpSystem
methodpublicrespondWithErrorMessage( string $errorMessage, \Exception $exception = null ) : void

respondWithErrorMessage()

Parameters
Name Type Description
$errorMessage string
$exception \Exception
methodpublicrespondWithGeneralHelp( ) : \Zend_Tool_Framework_Client_Console_HelpSystem

respondWithGeneralHelp()

methodpublicrespondWithProviderHelp( string $providerName ) : \Zend_Tool_Framework_Client_Console_HelpSystem

respondWithProviderHelp()

Parameters
Name Type Description
$providerName string
Returns
Type Description
\Zend_Tool_Framework_Client_Console_HelpSystem
methodpublicrespondWithSpecialtyAndParamHelp( string $providerName, string $actionName ) : \Zend_Tool_Framework_Client_Console_HelpSystem

respondWithSpecialtyAndParamHelp()

Parameters
Name Type Description
$providerName string
$actionName string
Returns
Type Description
\Zend_Tool_Framework_Client_Console_HelpSystem
methodpublicsetRegistry( \Zend_Tool_Framework_Registry_Interface $registry ) : \Zend_Tool_Framework_Client_Console_HelpSystem

setRegistry()

Parameters
Name Type Description
$registry \Zend_Tool_Framework_Registry_Interface
Returns
Type Description
\Zend_Tool_Framework_Client_Console_HelpSystem
Documentation was generated by DocBlox 0.15.1.