Tool/Framework/Client/Console.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_Console
jump to top

Package: Zend_Tool
Zend_Tool_Framework_Client_Console - the CLI Client implementation for Zend_Tool_Framework
Implements
Parent(s)
\Zend_Tool_Framework_Client_Abstract
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Todo
methods need more API documentation.  

Properties

>VPropertyprotectedarray $_classesToLoad = array()
Default valuearray()Details
Type
array
>VPropertyprotectedarray $_configOptions = null
Default valuenullDetails
Type
array
>VPropertyprotected\Zend_Filter_Word_DashToCamelCase $_filterFromClientNaming = null
Default valuenullDetails
Type
\Zend_Filter_Word_DashToCamelCase
>VPropertyprotected\Zend_Filter_Word_CamelCaseToDash $_filterToClientNaming = null
Default valuenullDetails
Type
\Zend_Filter_Word_CamelCaseToDash
>VPropertyprotectedarray $_storageOptions = null
Default valuenullDetails
Type
array

Methods

methodprotected_postDispatch() : void

_postDispatch() - Tasks handled after dispatching

methodprotected_preDispatch() : void

_preDispatch() - Tasks handed after initialization but before dispatching

methodprotected_preInit() : void

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

methodpublicconvertFromClientNaming(string $string) : string

convertFromClientNaming()

Convert words from client specific naming to code naming - camelcased Filters are lazy-loaded.
Parameters
NameTypeDescription
$stringstring
Returns
TypeDescription
string
methodpublicconvertToClientNaming(string $string) : string

convertToClientNaming()

Convert words to client specific naming, in this case is lower, dash separated Filters are lazy-loaded.
Parameters
NameTypeDescription
$stringstring
Returns
TypeDescription
string
methodpublicgetMissingParameterPromptString(\Zend_Tool_Framework_Provider_Interface $provider, \Zend_Tool_Framework_Action_Interface $actionInterface, string $missingParameterName) : string

getMissingParameterPromptString()

Parameters
NameTypeDescription
$provider\Zend_Tool_Framework_Provider_Interface
$actionInterface\Zend_Tool_Framework_Action_Interface
$missingParameterNamestring
Returns
TypeDescription
string
methodpublicgetName() : string

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

Returns
TypeDescription
string
methodpublichandleInteractiveInputRequest(\Zend_Tool_Framework_Client_Interactive_InputRequest $inputRequest) : string

handleInteractiveInputRequest() is required by the Interactive InputInterface

Parameters
NameTypeDescription
$inputRequest\Zend_Tool_Framework_Client_Interactive_InputRequest
Returns
TypeDescription
string
methodpublichandleInteractiveOutput(string $output) : void

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.
Parameters
NameTypeDescription
$outputstring
methodpublicmain( $options = array()) : void
static

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

Parameters
NameTypeDescription
$options
methodpublicsetClassesToLoad(array $classesToLoad) : void

Parameters
NameTypeDescription
$classesToLoadarray
methodpublicsetConfigOptions(array $configOptions) : void

setConfigOptions()

Parameters
NameTypeDescription
$configOptionsarray
methodpublicsetStorageOptions(array $storageOptions) : void

setStorageOptions()

Parameters
NameTypeDescription
$storageOptionsarray
Documentation was generated by phpDocumentor 2.2.0 .