eZ Publish Community Project (Legacy Stack) 2013.4
Class

eZScript

class eZScript

Properties

$IsInitialized
$InitializationErrorMessage
$DebugMessage
$UseDebugOutput
$UseSession
$UseExtensions
$UseModules
$User
$SiteAccess
$ExitCode
$IsQuiet
$ShowVerbose

Methods

__construct($settings = array())

validateVersion()

startup()

initialize()

isInitialized()

setIsInitialized($isInitialized)

initializationError()

shutdown($exitCode = false, $exitText = false)

setDebugMessage($message)

setUseDebugOutput($useDebug)

setUseDebugAccumulators($useAccumulators)

setUseDebugTimingPoints($useTimingPoints)

setUseIncludeFiles($useIncludeFiles)

setAllowedDebugLevels($allowedDebugLevels)

setUseSession($useSession)

setUseExtensions($useExtensions)

setUseSiteAccess($siteAccess)

usedSiteAccess()

setUseModules($useModules)

setUser($userLogin, $userPassword)

setShowVerboseOutput($verbose)

verboseOutputLevel()

currentOptions()

currentOptionConfig()

setExitCode($code = false)

exitCode()

setIsQuiet($isQuiet)

isQuiet()

isLoud()

setIterationData($trueString, $falseString, $numericStrings = false, $wrapNumeric = false)

resetIteration($iterationMax = false, $startIndex)

iterate($cli, $status, $text = false)

showHelp($useStandardOptions = false, $optionConfig = false, $optionHelp = false, $argumentConfig = false, $arguments = false)

getOptions($config = '', $argumentConfig = '', $optionHelp = false, $arguments = false, $useStandardOptions = true)

updateDebugSettings($useDebug = null)

updateTextCodecSettings()

Details

at line 53
public __construct($settings = array())

Parameters

$settings

at line 149
public validateVersion()

at line 186
public startup()

at line 221
public initialize()

at line 331
public isInitialized()

at line 336
public setIsInitialized($isInitialized)

Parameters

$isInitialized

at line 341
public initializationError()

at line 356
public shutdown($exitCode = false, $exitText = false)

Parameters

$exitCode
$exitText

at line 407
public setDebugMessage($message)

Parameters

$message

at line 416
public setUseDebugOutput($useDebug)

Parameters

$useDebug

at line 426
public setUseDebugAccumulators($useAccumulators)

Parameters

$useAccumulators

at line 436
public setUseDebugTimingPoints($useTimingPoints)

Parameters

$useTimingPoints

at line 446
public setUseIncludeFiles($useIncludeFiles)

Parameters

$useIncludeFiles

at line 457
public setAllowedDebugLevels($allowedDebugLevels)

Parameters

$allowedDebugLevels

at line 467
public setUseSession($useSession)

Parameters

$useSession

at line 476
public setUseExtensions($useExtensions)

Parameters

$useExtensions

at line 486
public setUseSiteAccess($siteAccess)

Parameters

$siteAccess

at line 494
public usedSiteAccess()

at line 499
public setUseModules($useModules)

Parameters

$useModules

at line 504
public setUser($userLogin, $userPassword)

Parameters

$userLogin
$userPassword

at line 516
public setShowVerboseOutput($verbose)

Parameters

$verbose

at line 526
public verboseOutputLevel()

at line 534
public currentOptions()

at line 542
public currentOptionConfig()

at line 551
public setExitCode($code = false)

Parameters

$code

at line 556
public exitCode()

at line 566
public setIsQuiet($isQuiet)

Parameters

$isQuiet

at line 577
public isQuiet()

at line 586
public isLoud()

at line 591
public setIterationData($trueString, $falseString, $numericStrings = false, $wrapNumeric = false)

Parameters

$trueString
$falseString
$numericStrings
$wrapNumeric

at line 600
public resetIteration($iterationMax = false, $startIndex)

Parameters

$iterationMax
$startIndex

at line 607
public iterate($cli, $status, $text = false)

Parameters

$cli
$status
$text

at line 684
public showHelp($useStandardOptions = false, $optionConfig = false, $optionHelp = false, $argumentConfig = false, $arguments = false)

Parameters

$useStandardOptions
$optionConfig
$optionHelp
$argumentConfig
$arguments

at line 870
public getOptions($config = '', $argumentConfig = '', $optionHelp = false, $arguments = false, $useStandardOptions = true)

Parameters

$config
$argumentConfig
$optionHelp
$arguments
$useStandardOptions

at line 1105
public updateDebugSettings($useDebug = null)

Parameters

$useDebug

at line 1144
public updateTextCodecSettings()