API Documentation

Zend/Tool/Framework/Client/Abstract.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: Abstract.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Tool_Framework_Client_Abstract

Package: Zend\Tool

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

Properties

Propertyprotected\Zend_Log  $_debugLogger= 'null'

Default valuenullDetails
Type
\Zend_Log
Propertyprotectedcallback|null  $_interactiveCallback= 'null'

Default valuenullDetails
Type
callbacknull
Propertyprotectedbool  $_isInitialized= 'false'

Default valuefalseDetails
Type
bool
Propertyprotected\Zend_Tool_Framework_Registry  $_registry= 'null'

Default valuenullDetails
Type
\Zend_Tool_Framework_Registry

Methods

methodpublic__construct(  $options = array() ) : void

Parameters
Name Type Description
$options
methodprotected_handleDispatch( ) : void

methodprotected_handleDispatchExecution(  $class,  $methodName,  $callParameters ) : void

Parameters
Name Type Description
$class
$methodName
$callParameters
methodprotected_postDispatch( ) : void

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.

methodprotected_preDispatch( ) : void
abstract

This method *must* be implemented by the client implementation to parse out and setup the request objects action, provider and parameter information.

methodprotected_preInit( ) : void

This method should be implemented by the client implementation to construct and set custom inflectors, request and response objects.

methodpublicconvertFromClientNaming(  $string ) : void

Parameters
Name Type Description
$string
methodpublicconvertToClientNaming(  $string ) : void

Parameters
Name Type Description
$string
methodpublicdispatch( ) : void

This method should be called in order to "handle" a Tooling Client request that has come to the client that has been implemented.

methodpublicgetName( ) : string
abstract

getName() - Return the client name which can be used to query the manifest if need be.

Returns
Type Description
string The client name
methodpublicgetRegistry( ) : \Zend_Tool_Framework_Registry_Interface

getRegistry();

Returns
Type Description
\Zend_Tool_Framework_Registry_Interface
methodpublichasInteractiveInput( ) : bool

hasInteractiveInput() - Convienence method for determining if this client can handle interactive input, and thus be able to run the promptInteractiveInput

Returns
Type Description
bool
methodpublicinitialize( ) : void

initialized() - This will initialize the client for use

methodpublicpromptInteractiveInput(  $inputRequest ) : void

Parameters
Name Type Description
$inputRequest
methodpublicsetOptions(  $options ) : void

Parameters
Name Type Description
$options
methodpublicsetRegistry( \Zend_Tool_Framework_Registry_Interface $registry ) : \Zend_Tool_Framework_Client_Abstract

setRegistry() - Required by the Zend_Tool_Framework_Registry_EnabledInterface interface which ensures proper registry dependency resolution

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