API Documentation

Tool/Framework/Client/Console/HelpSystem.php

Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Tool
subpackage
Framework
version
$Id: HelpSystem.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Tool_Framework_Client_Console_HelpSystem

Description

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.

Zend_Tool_Framework_Client_Console_HelpSystem

category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Tool
Properties
$_registry
$_response
Methods
setRegistry
respondWithErrorMessage
respondWithGeneralHelp
respondWithActionHelp
respondWithSpecialtyAndParamHelp
respondWithProviderHelp
_respondWithHeader
_respondWithSystemInformation
_respondWithProviderName
_respondWithCommand

Description

Properties

$_registry

Zend_Tool_Framework_Registry_Interface $_registry = 'null'

Details

$_registry
Zend_Tool_Framework_Registry_Interface
visibility
protected
default
null
final
false
static
false

$_response

Zend_Tool_Framework_Client_Response $_response = 'null'

Details

$_response
Zend_Tool_Framework_Client_Response
visibility
protected
default
null
final
false
static
false

Methods

_respondWithCommand

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

Arguments
$providerMetadata
Zend_Tool_Framework_Metadata_Tool
$actionMetadata
Zend_Tool_Framework_Metadata_Tool
$specialtyMetadata
Zend_Tool_Framework_Metadata_Tool
$parameterLongMetadata
Zend_Tool_Framework_Metadata_Tool
Details
visibility
protected
final
false
static
false

_respondWithHeader

_respondWithHeader( ) : Zend_Tool_Framework_Client_Console_HelpSystem

_respondWithHeader()

Details
visibility
protected
final
false
static
false

_respondWithProviderName

_respondWithProviderName( Zend_Tool_Framework_Metadata_Tool $providerMetadata ) : Zend_Tool_Framework_Client_Console_HelpSystem

_respondWithProviderName()

Arguments
$providerMetadata
Zend_Tool_Framework_Metadata_Tool
Details
visibility
protected
final
false
static
false

_respondWithSystemInformation

_respondWithSystemInformation( string $providerNameFilter = null, string $actionNameFilter = null, bool $includeAllSpecialties = false ) : Zend_Tool_Framework_Client_Console_HelpSystem

_respondWithSystemInformation()

Arguments
$providerNameFilter
string
$actionNameFilter
string
$includeAllSpecialties
bool
Details
visibility
protected
final
false
static
false

respondWithActionHelp

respondWithActionHelp( string $actionName ) : Zend_Tool_Framework_Client_Console_HelpSystem

respondWithActionHelp()

Arguments
$actionName
string
Details
visibility
public
final
false
static
false

respondWithErrorMessage

respondWithErrorMessage( string $errorMessage, Exception $exception = null ) :

respondWithErrorMessage()

Arguments
$errorMessage
string
$exception
Exception
Details
visibility
public
final
false
static
false

respondWithGeneralHelp

respondWithGeneralHelp( ) : Zend_Tool_Framework_Client_Console_HelpSystem

respondWithGeneralHelp()

Details
visibility
public
final
false
static
false

respondWithProviderHelp

respondWithProviderHelp( string $providerName ) : Zend_Tool_Framework_Client_Console_HelpSystem

respondWithProviderHelp()

Arguments
$providerName
string
Details
visibility
public
final
false
static
false

respondWithSpecialtyAndParamHelp

respondWithSpecialtyAndParamHelp( string $providerName, string $actionName ) : Zend_Tool_Framework_Client_Console_HelpSystem

respondWithSpecialtyAndParamHelp()

Arguments
$providerName
string
$actionName
string
Details
visibility
public
final
false
static
false

setRegistry

setRegistry( Zend_Tool_Framework_Registry_Interface $registry ) : Zend_Tool_Framework_Client_Console_HelpSystem

setRegistry()

Arguments
$registry
Zend_Tool_Framework_Registry_Interface
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.