Tool/Framework/Client/Console.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: Console.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Tool_Framework_Client_Console

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

Extends from: Zend_Tool_Framework_Client_Abstract
Implements: Zend_Tool_Framework_Client_Interactive_InputInterface; Zend_Tool_Framework_Client_Interactive_OutputInterface
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: $_configOptions; $_storageOptions; $_filterToClientNaming; $_filterFromClientNaming; $_classesToLoad
Methods: main; getName; setConfigOptions; setStorageOptions; setClassesToLoad; _preInit; _preDispatch; _postDispatch; handleInteractiveInputRequest; handleInteractiveOutput; getMissingParameterPromptString; convertToClientNaming; convertFromClientNaming

Description

Zend_Tool_Framework_Client_Console - the CLI Client implementation for Zend_Tool_Framework

Properties

$_classesToLoad
jump to class

array $_classesToLoad = 'array'

Details

$_classesToLoad: array
visibility: protected
default: array
final: false
static: false

$_configOptions
jump to class

array $_configOptions = 'null'

Details

$_configOptions: array
visibility: protected
default: null
final: false
static: false

$_filterFromClientNaming
jump to class

Zend_Filter_Word_DashToCamelCase $_filterFromClientNaming = 'null'

Details

$_filterFromClientNaming: Zend_Filter_Word_DashToCamelCase
visibility: protected
default: null
final: false
static: false

$_filterToClientNaming
jump to class

Zend_Filter_Word_CamelCaseToDash $_filterToClientNaming = 'null'

Details

$_filterToClientNaming: Zend_Filter_Word_CamelCaseToDash
visibility: protected
default: null
final: false
static: false

$_storageOptions
jump to class

array $_storageOptions = 'null'

Details

$_storageOptions: array
visibility: protected
default: null
final: false
static: false

Methods

_postDispatch
jump to class

_postDispatch(
          
          )
        
        :

_postDispatch() - Tasks handled after dispatching

Details

visibility: protected
final: false
static: false

_preDispatch
jump to class

_preDispatch(
          
          )
        
        :

_preDispatch() - Tasks handed after initialization but before dispatching

Details

visibility: protected
final: false
static: false

_preInit
jump to class

_preInit(
          
          )
        
        :

_init() - Tasks processed before the constructor, generally setting up objects to use

Details

visibility: protected
final: false
static: false

convertFromClientNaming
jump to class

convertFromClientNaming(
          string $string
          )
        
        :
        string

convertFromClientNaming()

Convert words from client specific naming to code naming - camelcased

Filters are lazy-loaded.

Arguments

$string: string

Output

string

Details

visibility: public
final: false
static: false

convertToClientNaming
jump to class

convertToClientNaming(
          string $string
          )
        
        :
        string

convertToClientNaming()

Convert words to client specific naming, in this case is lower, dash separated

Filters are lazy-loaded.

Arguments

$string: string

Output

string

Details

visibility: public
final: false
static: false

getMissingParameterPromptString
jump to class

getMissingParameterPromptString(
          Zend_Tool_Framework_Provider_Interface $provider, Zend_Tool_Framework_Action_Interface $actionInterface, string $missingParameterName
          )
        
        :
        string

getMissingParameterPromptString()

Arguments

$provider: Zend_Tool_Framework_Provider_Interface
$actionInterface: Zend_Tool_Framework_Action_Interface
$missingParameterName: string

Output

string

Details

visibility: public
final: false
static: false

getName
jump to class

getName(
          
          )
        
        :
        string

getName() - return the name of the client, in this case 'console'

Output

string

Details

visibility: public
final: false
static: false

handleInteractiveInputRequest
jump to class

handleInteractiveInputRequest(
          Zend_Tool_Framework_Client_Interactive_InputRequest $inputRequest
          )
        
        :
        string

handleInteractiveInputRequest() is required by the Interactive InputInterface

Arguments

$inputRequest: Zend_Tool_Framework_Client_Interactive_InputRequest

Output

string

Details

visibility: public
final: false
static: false

handleInteractiveOutput
jump to class

handleInteractiveOutput(
          string $output
          )
        
        :

handleInteractiveOutput() is required by the Interactive OutputInterface

This allows us to display output immediately from providers, rather than displaying it after the provider is done.

Arguments

$output: string

Details

visibility: public
final: false
static: false

main
jump to class

main(
           $options
              =
              array
          )
        
        :

main() - This is typically called from zf.php. This method is a self contained main() function.

Arguments

$options

Details

visibility: public
final: false
static: true

setClassesToLoad
jump to class

setClassesToLoad(
           $classesToLoad
          )
        
        :

Arguments

$classesToLoad

Details

visibility: public
final: false
static: false

setConfigOptions
jump to class

setConfigOptions(
           $configOptions
          )
        
        :

setConfigOptions()

Arguments

$configOptions

Details

visibility: public
final: false
static: false

setStorageOptions
jump to class

setStorageOptions(
           $storageOptions
          )
        
        :

setStorageOptions()

Arguments

$storageOptions

Details

visibility: public
final: false
static: false

API Documentation

Tool/Framework/Client/Console.php

Description

Zend_Tool_Framework_Client_Consolejump to top

Description

Properties

$_classesToLoadjump to class

Details

$_configOptionsjump to class

Details

$_filterFromClientNamingjump to class

Details

$_filterToClientNamingjump to class

Details

$_storageOptionsjump to class

Details

Methods

_postDispatchjump to class

Details

_preDispatchjump to class

Details

_preInitjump to class

Details

convertFromClientNamingjump to class

Arguments

Output

Details

convertToClientNamingjump to class

Arguments

Output

Details

getMissingParameterPromptStringjump to class

Arguments

Output

Details

getNamejump to class

Output

Details

handleInteractiveInputRequestjump to class

Arguments

Output

Details

handleInteractiveOutputjump to class

Arguments

Details

mainjump to class

Arguments

Details

setClassesToLoadjump to class

Arguments

Details

setConfigOptionsjump to class

Arguments

Details

setStorageOptionsjump to class

Arguments

Details

Zend_Tool_Framework_Client_Console
jump to top

$_classesToLoad
jump to class

$_configOptions
jump to class

$_filterFromClientNaming
jump to class

$_filterToClientNaming
jump to class

$_storageOptions
jump to class

_postDispatch
jump to class

_preDispatch
jump to class

_preInit
jump to class

convertFromClientNaming
jump to class

convertToClientNaming
jump to class

getMissingParameterPromptString
jump to class

getName
jump to class

handleInteractiveInputRequest
jump to class

handleInteractiveOutput
jump to class

main
jump to class

setClassesToLoad
jump to class

setConfigOptions
jump to class

setStorageOptions
jump to class