API Documentation

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

\Zend_Tool_Framework_Client_Console

Package: Zend\Tool

Zend_Tool_Framework_Client_Console - the CLI Client implementation for Zend_Tool_Framework

Implements
\Zend_Tool_Framework_Client_Interactive_InputInterface
\Zend_Tool_Framework_Client_Interactive_OutputInterface
Parent(s)
\Zend_Tool_Framework_Client_Abstract
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Todo
methods need more API documentation.  

Properties

Propertyprotectedarray  $_classesToLoad= 'array()'

Default valuearray()Details
Type
array
Propertyprotectedarray  $_configOptions= 'null'

Default valuenullDetails
Type
array
Propertyprotected\Zend_Filter_Word_DashToCamelCase  $_filterFromClientNaming= 'null'

Default valuenullDetails
Type
\Zend_Filter_Word_DashToCamelCase
Propertyprotected\Zend_Filter_Word_CamelCaseToDash  $_filterToClientNaming= 'null'

Default valuenullDetails
Type
\Zend_Filter_Word_CamelCaseToDash
Propertyprotectedarray  $_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
Name Type Description
$string string
Returns
Type Description
string
methodpublicconvertToClientNaming( string $string ) : string

convertToClientNaming()

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

Filters are lazy-loaded.

Parameters
Name Type Description
$string string
Returns
Type Description
string
methodpublicgetMissingParameterPromptString( \Zend_Tool_Framework_Provider_Interface $provider, \Zend_Tool_Framework_Action_Interface $actionInterface, string $missingParameterName ) : string

getMissingParameterPromptString()

Parameters
Name Type Description
$provider \Zend_Tool_Framework_Provider_Interface
$actionInterface \Zend_Tool_Framework_Action_Interface
$missingParameterName string
Returns
Type Description
string
methodpublicgetName( ) : string

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

Returns
Type Description
string
methodpublichandleInteractiveInputRequest( \Zend_Tool_Framework_Client_Interactive_InputRequest $inputRequest ) : string

handleInteractiveInputRequest() is required by the Interactive InputInterface

Parameters
Name Type Description
$inputRequest \Zend_Tool_Framework_Client_Interactive_InputRequest
Returns
Type Description
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
Name Type Description
$output string
methodpublicmain(  $options = array() ) : void
static

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

Parameters
Name Type Description
$options
methodpublicsetClassesToLoad( array $classesToLoad ) : void

Parameters
Name Type Description
$classesToLoad array
methodpublicsetConfigOptions( array $configOptions ) : void

setConfigOptions()

Parameters
Name Type Description
$configOptions array
methodpublicsetStorageOptions( array $storageOptions ) : void

setStorageOptions()

Parameters
Name Type Description
$storageOptions array
Documentation was generated by DocBlox 0.15.1.