PHP Class mageekguy\atoum\script

Datei anzeigen Open project: atoum/atoum Class Usage Examples

Protected Properties

Property Type Description
$adapter
$argumentsParser
$cli
$errorWriter
$helpWriter
$infoWriter
$locale
$name
$outputWriter
$prompt
$verbosityLevel
$warningWriter

Public Methods

Method Description
__construct ( $name, mageekguy\atoum\adapter $adapter = null )
addArgumentHandler ( closure $handler, array $arguments, $values = null, $help = null, $priority )
clearMessage ( )
decreaseVerbosityLevel ( )
getAdapter ( )
getArgumentsParser ( )
getCli ( )
getDirectory ( )
getErrorWriter ( )
getHelp ( )
getHelpWriter ( )
getInfoWriter ( )
getLocale ( )
getName ( )
getOutputWriter ( )
getPrompt ( )
getVerbosityLevel ( )
getWarningWriter ( )
hasArguments ( )
help ( )
increaseVerbosityLevel ( )
prompt ( $message )
resetVerbosityLevel ( )
run ( array $arguments = [] )
setAdapter ( mageekguy\atoum\adapter $adapter = null )
setArgumentsParser ( script\arguments\parser $parser = null )
setCli ( cli $cli = null )
setDefaultArgumentHandler ( closure $handler )
setErrorWriter ( mageekguy\atoum\writer $writer = null )
setHelpWriter ( mageekguy\atoum\writer $writer = null )
setInfoWriter ( mageekguy\atoum\writer $writer = null )
setLocale ( mageekguy\atoum\locale $locale = null )
setOutputWriter ( mageekguy\atoum\writer $writer = null )
setPrompt ( script\prompt $prompt = null )
setWarningWriter ( mageekguy\atoum\writer $writer = null )
verbose ( $message, $verbosityLevel = 1 )
writeError ( $message )
writeHelp ( $message )
writeInfo ( $info )
writeLabel ( $label, $value, $level )
writeLabels ( array $labels, $level = 1 )
writeMessage ( $message )
writeWarning ( $warning )

Protected Methods

Method Description
canRun ( )
doRun ( )
parseArguments ( array $arguments )
setArgumentHandlers ( )
stopRun ( )
writeHelpOptions ( )
writeHelpUsage ( )
writeLabelWithWriter ( $label, $value, $level, mageekguy\atoum\writer $writer )
writeLabelsWithWriter ( $labels, $level, mageekguy\atoum\writer $writer )

Method Details

__construct() public method

public __construct ( $name, mageekguy\atoum\adapter $adapter = null )
$adapter mageekguy\atoum\adapter

addArgumentHandler() public method

public addArgumentHandler ( closure $handler, array $arguments, $values = null, $help = null, $priority )
$handler closure
$arguments array

canRun() protected method

protected canRun ( )

clearMessage() public method

public clearMessage ( )

decreaseVerbosityLevel() public method

doRun() protected method

protected doRun ( )

getAdapter() public method

public getAdapter ( )

getArgumentsParser() public method

public getArgumentsParser ( )

getCli() public method

public getCli ( )

getDirectory() public method

public getDirectory ( )

getErrorWriter() public method

public getErrorWriter ( )

getHelp() public method

public getHelp ( )

getHelpWriter() public method

public getHelpWriter ( )

getInfoWriter() public method

public getInfoWriter ( )

getLocale() public method

public getLocale ( )

getName() public method

public getName ( )

getOutputWriter() public method

public getOutputWriter ( )

getPrompt() public method

public getPrompt ( )

getVerbosityLevel() public method

public getVerbosityLevel ( )

getWarningWriter() public method

public getWarningWriter ( )

hasArguments() public method

public hasArguments ( )

help() public method

public help ( )

increaseVerbosityLevel() public method

parseArguments() protected method

protected parseArguments ( array $arguments )
$arguments array

prompt() public method

public prompt ( $message )

resetVerbosityLevel() public method

public resetVerbosityLevel ( )

run() public method

public run ( array $arguments = [] )
$arguments array

setAdapter() public method

public setAdapter ( mageekguy\atoum\adapter $adapter = null )
$adapter mageekguy\atoum\adapter

setArgumentHandlers() protected method

protected setArgumentHandlers ( )

setArgumentsParser() public method

public setArgumentsParser ( script\arguments\parser $parser = null )
$parser script\arguments\parser

setCli() public method

public setCli ( cli $cli = null )
$cli cli

setDefaultArgumentHandler() public method

public setDefaultArgumentHandler ( closure $handler )
$handler closure

setErrorWriter() public method

public setErrorWriter ( mageekguy\atoum\writer $writer = null )
$writer mageekguy\atoum\writer

setHelpWriter() public method

public setHelpWriter ( mageekguy\atoum\writer $writer = null )
$writer mageekguy\atoum\writer

setInfoWriter() public method

public setInfoWriter ( mageekguy\atoum\writer $writer = null )
$writer mageekguy\atoum\writer

setLocale() public method

public setLocale ( mageekguy\atoum\locale $locale = null )
$locale mageekguy\atoum\locale

setOutputWriter() public method

public setOutputWriter ( mageekguy\atoum\writer $writer = null )
$writer mageekguy\atoum\writer

setPrompt() public method

public setPrompt ( script\prompt $prompt = null )
$prompt script\prompt

setWarningWriter() public method

public setWarningWriter ( mageekguy\atoum\writer $writer = null )
$writer mageekguy\atoum\writer

stopRun() protected method

protected stopRun ( )

verbose() public method

public verbose ( $message, $verbosityLevel = 1 )

writeError() public method

public writeError ( $message )

writeHelp() public method

public writeHelp ( $message )

writeHelpOptions() protected method

protected writeHelpOptions ( )

writeHelpUsage() protected method

protected writeHelpUsage ( )

writeInfo() public method

public writeInfo ( $info )

writeLabel() public method

public writeLabel ( $label, $value, $level )

writeLabelWithWriter() protected static method

protected static writeLabelWithWriter ( $label, $value, $level, mageekguy\atoum\writer $writer )
$writer mageekguy\atoum\writer

writeLabels() public method

public writeLabels ( array $labels, $level = 1 )
$labels array

writeLabelsWithWriter() protected static method

protected static writeLabelsWithWriter ( $labels, $level, mageekguy\atoum\writer $writer )
$writer mageekguy\atoum\writer

writeMessage() public method

public writeMessage ( $message )

writeWarning() public method

public writeWarning ( $warning )

Property Details

$adapter protected_oe property

protected $adapter

$argumentsParser protected_oe property

protected $argumentsParser

$cli protected_oe property

protected $cli

$errorWriter protected_oe property

protected $errorWriter

$helpWriter protected_oe property

protected $helpWriter

$infoWriter protected_oe property

protected $infoWriter

$locale protected_oe property

protected $locale

$name protected_oe property

protected $name

$outputWriter protected_oe property

protected $outputWriter

$prompt protected_oe property

protected $prompt

$verbosityLevel protected_oe property

protected $verbosityLevel

$warningWriter protected_oe property

protected $warningWriter