API Documentation
\
Neuron
Data
Filter
Validation
H
Log
Destination
Format
Parser
Setting
Source
Util

\NeuronApplicationBase

Defines base functionality for applications.

Summary

Methods
Properties
Constants
getSetting()
setSetting()
getParameter()
getLogger()
log()
isCommandLine()
__construct()
getVersion()
run()
debug()
info()
warning()
error()
fatal()
No public properties found
No constants found
getParameters()
onStart()
onFinish()
onError()
onRun()
$_aParameters
$_aSettings
N/A
No private methods found
$_Logger
N/A

Properties

$_aParameters

$_aParameters

$_aSettings

$_aSettings

$_Logger

$_Logger

Methods

getSetting()

getSetting( $sName,  $sSection)

Parameters

$sName
$sSection

setSetting()

setSetting( $sName,  $sValue,  $sSection)

Parameters

$sName
$sValue
$sSection

getParameter()

getParameter(mixed $s) : mixed

Parameters

mixed $s

Returns

mixed

log()

log(mixed $s, int $iLevel)

Parameters

mixed $s
int $iLevel

isCommandLine()

isCommandLine() : bool

Returns

bool

__construct()

__construct(\Neuron\Log\ILogger $Logger)

Parameters

\Neuron\Log\ILogger $Logger

getVersion()

getVersion() : string

Returns

string —

Application version number. Must be implemented by derived classes.

run()

run(array|null $aArgv)

Parameters

array|null $aArgv

debug()

debug( $s)

Parameters

$s

info()

info( $s)

Parameters

$s

warning()

warning( $s)

Parameters

$s

error()

error( $s)

Parameters

$s

fatal()

fatal( $s)

Parameters

$s

getParameters()

getParameters() : array

Returns

array —

returns parameters passed to the run method.

onStart()

onStart() : bool

Returns

bool —

Called before onRun. If false is returned, application terminates without executing onRun.

onFinish()

onFinish()

Called immediately after onRun.

onError()

onError(\Exception $ex) : bool

Parameters

\Exception $ex

Returns

bool —

Called for any unhandled exceptions.

onRun()

onRun() : mixed

Returns

mixed —

Must be implemented by derived classes.