kernel/classes/ezscript.php

Show: inherited

• Classes
  • \eZScript

Table of Contents

Copyright

Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.  

License

eZ Business Use License Agreement Version 2.0  

Package

kernel  

Version

4.6.0  

Functions

eZDBCleanup( ) : void

eZFatalError( ) : void

eZUpdateDebugSettings(  $useDebug = null ) : void

Parameters

Name	Type	Description
$useDebug

eZUpdateTextCodecSettings( ) : void

\eZScript

jump to top

Package: kernel

File containing the eZScript class.

Copyright

Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.  

License

eZ Business Use License Agreement Version 2.0  

Version

4.6.0  

Properties

 $DebugMessage= ''

Details

Type

n/a

 $ExitCode= ''

Details

Type

n/a

 $InitializationErrorMessage= ''

Details

Type

n/a

 $IsQuiet= ''

Details

Type

n/a

 $ShowVerbose= ''

Details

Type

n/a

 $SiteAccess= ''

Details

Type

n/a

 $UseDebugOutput= ''

Details

Type

n/a

 $UseExtensions= ''

Details

Type

n/a

 $UseModules= ''

Details

Type

n/a

 $UseSession= ''

Details

Type

n/a

 $User= ''

Details

Type

n/a

Methods

currentOptionConfig( ) : void

currentOptions( ) : void

eZScript(  $settings = array() ) : void

Parameters

Name	Type	Description
$settings

exitCode( ) : void

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

Parameters

Name	Type	Description
$config
$argumentConfig
$optionHelp
$arguments
$useStandardOptions

initializationError( ) : void

initialize( ) : void

instance( array $settings = array() ) : \eZScript

static

Returns a shared instance of the eZScript class.

Parameters

Name	Type	Description
$settings	array	Used by the first generated instance, but ignored for subsequent calls.

Returns

Type	Description
\eZScript

isInitialized( ) : void

isLoud( ) : void

isQuiet( ) : void

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

Parameters

Name	Type	Description
$cli
$status
$text

resetIteration(  $iterationMax = false,  $startIndex = 0 ) : void

Parameters

Name	Type	Description
$iterationMax
$startIndex

setAllowedDebugLevels(  $allowedDebugLevels ) : void

Parameters

Name	Type	Description
$allowedDebugLevels

setDebugMessage(  $message ) : void

Parameters

Name	Type	Description
$message

setExitCode(  $code = false ) : void

Parameters

Name	Type	Description
$code

setIsQuiet(  $isQuiet ) : void

Parameters

Name	Type	Description
$isQuiet

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

Parameters

Name	Type	Description
$trueString
$falseString
$numericStrings
$wrapNumeric

setShowVerboseOutput(  $verbose ) : void

Parameters

Name	Type	Description
$verbose

setUseDebugAccumulators(  $useAccumulators ) : void

Parameters

Name	Type	Description
$useAccumulators

setUseDebugOutput(  $useDebug ) : void

Parameters

Name	Type	Description
$useDebug

setUseDebugTimingPoints(  $useTimingPoints ) : void

Parameters

Name	Type	Description
$useTimingPoints

setUseExtensions(  $useExtensions ) : void

Parameters

Name	Type	Description
$useExtensions

setUseIncludeFiles(  $useIncludeFiles ) : void

Parameters

Name	Type	Description
$useIncludeFiles

setUseModules(  $useModules ) : void

Parameters

Name	Type	Description
$useModules

setUseSession(  $useSession ) : void

Parameters

Name	Type	Description
$useSession

setUseSiteAccess(  $siteAccess ) : void

Parameters

Name	Type	Description
$siteAccess

setUser(  $userLogin,  $userPassword ) : void

Parameters

Name	Type	Description
$userLogin
$userPassword

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

Parameters

Name	Type	Description
$useStandardOptions
$optionConfig
$optionHelp
$argumentConfig
$arguments

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

Parameters

Name	Type	Description
$exitCode
$exitText

startup( ) : void

updateDebugSettings(  $useDebug = null ) : void

Parameters

Name	Type	Description
$useDebug

updateTextCodecSettings( ) : void

usedSiteAccess( ) : void

validateVersion( ) : void

verboseOutputLevel( ) : void