\mageekguy\atoum\scriptconfigurable

Summary

Methods

Properties

Constants

__construct()
getDirectory()
setAdapter()
getAdapter()
setLocale()
getLocale()
setArgumentsParser()
getArgumentsParser()
setCli()
getCli()
hasArguments()
setOutputWriter()
getOutputWriter()
setInfoWriter()
getInfoWriter()
setWarningWriter()
getWarningWriter()
setErrorWriter()
getErrorWriter()
setHelpWriter()
getHelpWriter()
setPrompt()
getPrompt()
getName()
getHelp()
help()
addArgumentHandler()
setDefaultArgumentHandler()
run()
prompt()
writeLabel()
writeLabels()
clearMessage()
writeMessage()
writeInfo()
writeHelp()
writeWarning()
writeError()
verbose()
increaseVerbosityLevel()
decreaseVerbosityLevel()
getVerbosityLevel()
resetVerbosityLevel()
setIncluder()
getIncluder()
getConfigFiles()
useConfigFile()
useDefaultConfigFiles()
getSubDirectoryPath()

No public properties found

padding
defaultConfigFile

setArgumentHandlers()
canRun()
stopRun()
writeHelpUsage()
writeHelpOptions()
parseArguments()
doRun()
writeLabelWithWriter()
writeLabelsWithWriter()
includeConfigFile()

$name
$locale
$adapter
$prompt
$cli
$verbosityLevel
$outputWriter
$infoWriter
$warningWriter
$errorWriter
$helpWriter
$argumentsParser
$includer
$configFiles

N/A

No private methods found

$doRun
$help

N/A

abstract

File: lib/plugin/webauth/vendor/atoum/atoum/classes/script/configurable.php
Package: Default
Class hierarchy: \mageekguy\atoum\script

\mageekguy\atoum\script\configurable

Constants

padding

padding

defaultConfigFile

defaultConfigFile

Properties

$name

$name :

Type

$locale

$locale :

Type

$adapter

$adapter :

Type

$prompt

$prompt :

Type

$cli

$cli :

Type

$verbosityLevel

$verbosityLevel :

Type

$outputWriter

$outputWriter :

Type

$infoWriter

$infoWriter :

Type

$warningWriter

$warningWriter :

Type

$errorWriter

$errorWriter :

Type

$helpWriter

$helpWriter :

Type

$argumentsParser

$argumentsParser :

Type

$includer

$includer :

Type

$configFiles

$configFiles :

Type

$doRun

$doRun :

Type

$help

$help :

Type

Methods

__construct()

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

Parameters

	$name
\mageekguy\atoum\adapter	$adapter

getDirectory()

getDirectory()

setAdapter()

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

Parameters

\mageekguy\atoum\adapter

$adapter

getAdapter()

getAdapter()

setLocale()

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

Parameters

\mageekguy\atoum\locale

$locale

getLocale()

getLocale()

setArgumentsParser()

setArgumentsParser(\mageekguy\atoum\script\arguments\parser  $parser = null)

Parameters

\mageekguy\atoum\script\arguments\parser

$parser

getArgumentsParser()

getArgumentsParser()

setCli()

setCli(\mageekguy\atoum\cli  $cli = null)

Parameters

\mageekguy\atoum\cli

$cli

getCli()

getCli()

hasArguments()

hasArguments()

setOutputWriter()

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

Parameters

\mageekguy\atoum\writer

$writer

getOutputWriter()

getOutputWriter()

setInfoWriter()

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

Parameters

\mageekguy\atoum\writer

$writer

getInfoWriter()

getInfoWriter()

setWarningWriter()

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

Parameters

\mageekguy\atoum\writer

$writer

getWarningWriter()

getWarningWriter()

setErrorWriter()

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

Parameters

\mageekguy\atoum\writer

$writer

getErrorWriter()

getErrorWriter()

setHelpWriter()

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

Parameters

\mageekguy\atoum\writer

$writer

getHelpWriter()

getHelpWriter()

setPrompt()

setPrompt(\mageekguy\atoum\script\prompt  $prompt = null)

Parameters

\mageekguy\atoum\script\prompt

$prompt

getPrompt()

getPrompt()

getName()

getName()

getHelp()

getHelp()

help()

help()

addArgumentHandler()

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

Parameters

\closure	$handler
array	$arguments
	$values
	$help
	$priority

setDefaultArgumentHandler()

setDefaultArgumentHandler(\closure  $handler)

Parameters

\closure

$handler

run()

run(array  $arguments = array())

Parameters

array

$arguments

prompt()

prompt(  $message)

Parameters

$message

writeLabel()

writeLabel(  $label,   $value,   $level)

Parameters

	$label
	$value
	$level

writeLabels()

writeLabels(array  $labels,   $level = 1)

Parameters

array	$labels
	$level

clearMessage()

clearMessage()

writeMessage()

writeMessage(  $message)

Parameters

$message

writeInfo()

writeInfo(  $info)

Parameters

$info

writeHelp()

writeHelp(  $message)

Parameters

$message

writeWarning()

writeWarning(  $warning)

Parameters

$warning

writeError()

writeError(  $message)

Parameters

$message

verbose()

verbose(  $message,   $verbosityLevel = 1)

Parameters

	$message
	$verbosityLevel

increaseVerbosityLevel()

increaseVerbosityLevel()

decreaseVerbosityLevel()

decreaseVerbosityLevel()

getVerbosityLevel()

getVerbosityLevel()

resetVerbosityLevel()

resetVerbosityLevel()

setIncluder()

setIncluder(\mageekguy\atoum\includer  $includer = null)

Parameters

\mageekguy\atoum\includer

$includer

getIncluder()

getIncluder()

getConfigFiles()

getConfigFiles()

useConfigFile()

useConfigFile(  $path)

Parameters

$path

useDefaultConfigFiles()

useDefaultConfigFiles(  $startDirectory = null)

Parameters

$startDirectory

getSubDirectoryPath()

getSubDirectoryPath(  $directory,   $directorySeparator = null)

Parameters

	$directory
	$directorySeparator

setArgumentHandlers()

setArgumentHandlers()

canRun()

canRun()

stopRun()

stopRun()

writeHelpUsage()

writeHelpUsage()

writeHelpOptions()

writeHelpOptions()

parseArguments()

parseArguments(array  $arguments)

Parameters

array

$arguments

doRun()

doRun()

writeLabelWithWriter()

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

Parameters

	$label
	$value
	$level
\mageekguy\atoum\writer	$writer

writeLabelsWithWriter()

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

Parameters

	$labels
	$level
\mageekguy\atoum\writer	$writer

includeConfigFile()

includeConfigFile(  $path, \closure  $callback = null)

Parameters

	$path
\closure	$callback