Tool/Framework/Client/Abstract.php

Show: PublicProtectedPrivateinherited
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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Tool  
Subpackage
Framework  
Version
$Id$  

\Zend_Tool_Framework_Client_Abstract
jump to top

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

Properties

>VPropertyprotected\Zend_Log $_debugLogger = null
Default valuenullDetails
Type
\Zend_Log
>VPropertyprotectedcallback|null $_interactiveCallback = null
Default valuenullDetails
Type
callback | null
>VPropertyprotectedbool $_isInitialized = false
Default valuefalseDetails
Type
bool
>VPropertyprotected\Zend_Tool_Framework_Registry $_registry = null
Default valuenullDetails
Type
\Zend_Tool_Framework_Registry

Methods

methodpublic__construct( $options = array()) : void

Parameters
NameTypeDescription
$options
methodprotected_handleDispatch() : void

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

Parameters
NameTypeDescription
$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
NameTypeDescription
$string
methodpublicconvertToClientNaming( $string) : void

Parameters
NameTypeDescription
$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
TypeDescription
stringThe client name
methodpublicgetRegistry() : \Zend_Tool_Framework_Registry_Interface

getRegistry();

Returns
TypeDescription
\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
TypeDescription
bool
methodpublicinitialize() : void

initialized() - This will initialize the client for use

methodpublicpromptInteractiveInput( $inputRequest) : void

Parameters
NameTypeDescription
$inputRequest
methodpublicsetOptions( $options) : void

Parameters
NameTypeDescription
$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
NameTypeDescription
$registry\Zend_Tool_Framework_Registry_Interface
Returns
TypeDescription
\Zend_Tool_Framework_Client_Abstract
Documentation was generated by phpDocumentor 2.2.0 .