\mageekguy\atoum\scriptsbuilder

Summary

Methods

Properties

Constants

__construct()
setIncluder()
getIncluder()
getConfigFiles()
useConfigFile()
useDefaultConfigFiles()
run()
getSubDirectoryPath()
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()
prompt()
writeLabel()
writeLabels()
clearMessage()
writeMessage()
writeInfo()
writeHelp()
writeWarning()
writeError()
verbose()
increaseVerbosityLevel()
decreaseVerbosityLevel()
getVerbosityLevel()
resetVerbosityLevel()
setVcs()
getVcs()
setTaggerEngine()
getTaggerEngine()
setPhp()
getPhp()
setPhpPath()
getPhpPath()
getRunnerConfigurationFiles()
addRunnerConfigurationFile()
enablePharCreation()
disablePharCreation()
pharCreationIsEnabled()
disableUnitTestChecking()
enableUnitTestChecking()
unitTestCheckingIsEnabled()
setVersion()
getVersion()
setScoreDirectory()
getScoreDirectory()
setErrorsDirectory()
getErrorsDirectory()
setDestinationDirectory()
getDestinationDirectory()
setWorkingDirectory()
getWorkingDirectory()
setRevisionFile()
getRevisionFile()
setReportTitle()
getReportTitle()
setUnitTestRunnerScript()
getUnitTestRunnerScript()
setPharGeneratorScript()
getPharGeneratorScript()
setRunFile()
getRunFile()
checkUnitTests()
createPhar()
writeErrorInErrorsDirectory()

No public properties found

defaultConfigFile
padding
defaultUnitTestRunnerScript
defaultPharGeneratorScript

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

$includer
$configFiles
$name
$locale
$adapter
$prompt
$cli
$verbosityLevel
$outputWriter
$infoWriter
$warningWriter
$errorWriter
$helpWriter
$argumentsParser
$php
$vcs
$taggerEngine
$revision
$version
$unitTestRunnerScript
$pharGeneratorScript
$workingDirectory
$destinationDirectory
$scoreDirectory
$errorsDirectory
$revisionFile
$runFile
$pharCreationEnabled
$checkUnitTests
$reportTitle
$runnerConfigurationFiles

N/A

No private methods found

$doRun
$help
$lockResource

N/A

Constants

defaultConfigFile

defaultConfigFile

padding

padding

defaultUnitTestRunnerScript

defaultUnitTestRunnerScript

defaultPharGeneratorScript

defaultPharGeneratorScript

Properties

$includer

$includer :

Type

$configFiles

$configFiles :

Type

$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

$php

$php :

Type

$vcs

$vcs :

Type

$taggerEngine

$taggerEngine :

Type

$revision

$revision :

Type

$version

$version :

Type

$unitTestRunnerScript

$unitTestRunnerScript :

Type

$pharGeneratorScript

$pharGeneratorScript :

Type

$workingDirectory

$workingDirectory :

Type

$destinationDirectory

$destinationDirectory :

Type

$scoreDirectory

$scoreDirectory :

Type

$errorsDirectory

$errorsDirectory :

Type

$revisionFile

$revisionFile :

Type

$runFile

$runFile :

Type

$pharCreationEnabled

$pharCreationEnabled :

Type

$checkUnitTests

$checkUnitTests :

Type

$reportTitle

$reportTitle :

Type

$runnerConfigurationFiles

$runnerConfigurationFiles :

Type

$doRun

$doRun :

Type

$help

$help :

Type

$lockResource

$lockResource :

Type

Methods

__construct()

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

Parameters

	$name
\mageekguy\atoum\adapter	$adapter

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

run()

run(array  $arguments = array())

Parameters

array

$arguments

getSubDirectoryPath()

getSubDirectoryPath(  $directory,   $directorySeparator = null)

Parameters

	$directory
	$directorySeparator

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

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()

setVcs()

setVcs(\mageekguy\atoum\scripts\builder\vcs  $vcs = null)

Parameters

\mageekguy\atoum\scripts\builder\vcs

$vcs

getVcs()

getVcs()

setTaggerEngine()

setTaggerEngine(\mageekguy\atoum\scripts\tagger\engine  $engine)

Parameters

\mageekguy\atoum\scripts\tagger\engine

$engine

getTaggerEngine()

getTaggerEngine()

setPhp()

setPhp(\mageekguy\atoum\php  $php = null)

Parameters

\mageekguy\atoum\php

$php

getPhp()

getPhp()

setPhpPath()

setPhpPath(  $path)

Parameters

$path

getPhpPath()

getPhpPath()

getRunnerConfigurationFiles()

getRunnerConfigurationFiles()

addRunnerConfigurationFile()

addRunnerConfigurationFile(  $file)

Parameters

$file

enablePharCreation()

enablePharCreation()

disablePharCreation()

disablePharCreation()

pharCreationIsEnabled()

pharCreationIsEnabled()

disableUnitTestChecking()

disableUnitTestChecking()

enableUnitTestChecking()

enableUnitTestChecking()

unitTestCheckingIsEnabled()

unitTestCheckingIsEnabled()

setVersion()

setVersion(  $version)

Parameters

$version

getVersion()

getVersion()

setScoreDirectory()

setScoreDirectory(  $path)

Parameters

$path

getScoreDirectory()

getScoreDirectory()

setErrorsDirectory()

setErrorsDirectory(  $path)

Parameters

$path

getErrorsDirectory()

getErrorsDirectory()

setDestinationDirectory()

setDestinationDirectory(  $path)

Parameters

$path

getDestinationDirectory()

getDestinationDirectory()

setWorkingDirectory()

setWorkingDirectory(  $path)

Parameters

$path

getWorkingDirectory()

getWorkingDirectory()

setRevisionFile()

setRevisionFile(  $path)

Parameters

$path

getRevisionFile()

getRevisionFile()

setReportTitle()

setReportTitle(  $title)

Parameters

$title

getReportTitle()

getReportTitle()

setUnitTestRunnerScript()

setUnitTestRunnerScript(  $path)

Parameters

$path

getUnitTestRunnerScript()

getUnitTestRunnerScript()

setPharGeneratorScript()

setPharGeneratorScript(  $path)

Parameters

$path

getPharGeneratorScript()

getPharGeneratorScript()

setRunFile()

setRunFile(  $path)

Parameters

$path

getRunFile()

getRunFile()

checkUnitTests()

checkUnitTests()

createPhar()

createPhar(  $version = null)

Parameters

$version

writeErrorInErrorsDirectory()

writeErrorInErrorsDirectory(  $error)

Parameters

$error

setArgumentHandlers()

setArgumentHandlers()

includeConfigFile()

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

Parameters

	$path
\closure	$callback

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

lock()

lock()

unlock()

unlock()

cleanDirectoryPath()

cleanDirectoryPath(  $path)

Parameters

$path