Tool/Framework/Client/Abstract.php

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: Abstract.php 20967 2010-02-07 18:17:49Z ralph $
Classes: Zend_Tool_Framework_Client_Abstract

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_Abstract
jump to top

Implements: Zend_Tool_Framework_Registry_EnabledInterface
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; $_interactiveCallback; $_isInitialized; $_debugLogger
Methods: __construct; setOptions; getName; initialize; _preInit; _preDispatch; _postDispatch; setRegistry; getRegistry; hasInteractiveInput; promptInteractiveInput; dispatch; convertToClientNaming; convertFromClientNaming; _handleDispatch; _handleDispatchExecution

Description

Properties

$_debugLogger
jump to class

Zend_Log $_debugLogger = 'null'

Details

$_debugLogger: Zend_Log
visibility: protected
default: null
final: false
static: false

$_interactiveCallback
jump to class

callback|null $_interactiveCallback = 'null'

Details

$_interactiveCallback: callback|null
visibility: protected
default: null
final: false
static: false

$_isInitialized
jump to class

bool $_isInitialized = 'false'

Details

$_isInitialized: bool
visibility: protected
default: false
final: false
static: false

$_registry
jump to class

Zend_Tool_Framework_Registry $_registry = 'null'

Details

$_registry: Zend_Tool_Framework_Registry
visibility: protected
default: null
final: false
static: false

Methods

__construct
jump to class

__construct(
           $options
              =
              array
          )
        
        :

Arguments

$options

Details

visibility: public
final: false
static: false

_handleDispatch
jump to class

_handleDispatch(
          
          )
        
        :

Details

visibility: protected
final: false
static: false

_handleDispatchExecution
jump to class

_handleDispatchExecution(
           $class,  $methodName,  $callParameters
          )
        
        :

Arguments

$class
$methodName
$callParameters

Details

visibility: protected
final: false
static: false

_postDispatch
jump to class

_postDispatch(
          
          )
        
        :

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.

Details

visibility: protected
final: false
static: false

_preDispatch
jump to class

_preDispatch(
          
          )
        
        :

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

Details

visibility: protected
final: false
static: false

_preInit
jump to class

_preInit(
          
          )
        
        :

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

Details

visibility: protected
final: false
static: false

convertFromClientNaming
jump to class

convertFromClientNaming(
           $string
          )
        
        :

Arguments

$string

Details

visibility: public
final: false
static: false

convertToClientNaming
jump to class

convertToClientNaming(
           $string
          )
        
        :

Arguments

$string

Details

visibility: public
final: false
static: false

dispatch
jump to class

dispatch(
          
          )
        
        :

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

Details

visibility: public
final: false
static: false

getName
jump to class

getName(
          
          )
        
        :
        string

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

Output

string: The client name

Details

visibility: public
final: false
static: false

getRegistry
jump to class

getRegistry(
          
          )
        
        :
        Zend_Tool_Framework_Registry_Interface

getRegistry();

Output

Zend_Tool_Framework_Registry_Interface

Details

visibility: public
final: false
static: false

hasInteractiveInput
jump to class

hasInteractiveInput(
          
          )
        
        :
        bool

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

Output

bool

Details

visibility: public
final: false
static: false

initialize
jump to class

initialize(
          
          )
        
        :

initialized() - This will initialize the client for use

Details

visibility: public
final: false
static: false

promptInteractiveInput
jump to class

promptInteractiveInput(
           $inputRequest
          )
        
        :

Arguments

$inputRequest

Details

visibility: public
final: false
static: false

setOptions
jump to class

setOptions(
           $options
          )
        
        :

Arguments

$options

Details

visibility: public
final: false
static: false

setRegistry
jump to class

setRegistry(
          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

Arguments

$registry: Zend_Tool_Framework_Registry_Interface

Output

Zend_Tool_Framework_Client_Abstract

Details

visibility: public
final: false
static: false

API Documentation

Tool/Framework/Client/Abstract.php

Description

Zend_Tool_Framework_Client_Abstractjump to top

Description

Properties

$_debugLoggerjump to class

Details

$_interactiveCallbackjump to class

Details

$_isInitializedjump to class

Details

$_registryjump to class

Details

Methods

__constructjump to class

Arguments

Details

_handleDispatchjump to class

Details

_handleDispatchExecutionjump to class

Arguments

Details

_postDispatchjump to class

Details

_preDispatchjump to class

Details

_preInitjump to class

Details

convertFromClientNamingjump to class

Arguments

Details

convertToClientNamingjump to class

Arguments

Details

dispatchjump to class

Details

getNamejump to class

Output

Details

getRegistryjump to class

Output

Details

hasInteractiveInputjump to class

Output

Details

initializejump to class

Details

promptInteractiveInputjump to class

Arguments

Details

setOptionsjump to class

Arguments

Details

setRegistryjump to class

Arguments

Output

Details

Zend_Tool_Framework_Client_Abstract
jump to top

$_debugLogger
jump to class

$_interactiveCallback
jump to class

$_isInitialized
jump to class

$_registry
jump to class

__construct
jump to class

_handleDispatch
jump to class

_handleDispatchExecution
jump to class

_postDispatch
jump to class

_preDispatch
jump to class

_preInit
jump to class

convertFromClientNaming
jump to class

convertToClientNaming
jump to class

dispatch
jump to class

getName
jump to class

getRegistry
jump to class

hasInteractiveInput
jump to class

initialize
jump to class

promptInteractiveInput
jump to class

setOptions
jump to class

setRegistry
jump to class