class BaseController extends Controller

The class BaseController is the heart the simulation engine

Properties

ControllersHelper $helper
Simulator $simu
protected Parser $parser
protected bool $error
protected int $recursion
protected array $simuWidgets
protected array $variables
protected array $memo
protected mixed|null $sources
protected array $log
protected int $script
protected array $sequence
protected string $path
array $uricache
string $databasesDir
string $simulatorsDir
string $publicDir
string $viewsDir

Methods

Response|Step|null
runStep(Request $request, array $form, string $simu, string $view, bool $test)

Run the simulation engine for a step

void
addWidget(string $widget)

Adds a widget to the list of widgets

void
widgetDeps(string $widget, array $widgets, array $availWidgets)

Adds widgets that depend on a widget in the list of widgets

Response
runFields(Request $request, string $simu, bool $test = false)

Returns the simulators attributes in JSON response format

Response
runSource(Request $request, string $simu, bool $test = false)

Returns the requested source attributes in JSON response format

string
getSimuPath(string $simu, bool $test = false)

Get the simulators directory

void
checkField(Field $field, array $form, bool $skipValidation)

Checks the given field

void
processField(Field $field, Step $step, bool $displayable)

Processes the given field for the step

void
replaceFieldNotes(Field $field)

Replaces data values in the notes of a field

string|false
evaluate(string $condition)

Evaluates a condition with the expression parser

void
evaluateDefault(Data $data)

Evaluates the default value of the given data

void
evaluateDefaults()

Evaluates the default value of all data

void
evaluateMin(Data $data)

Evaluates the minimum value of the given data

void
evaluateMax(Data $data)

Evaluates the maximum value of the given data

void
evaluateMinMax()

Evaluates the minimum and the maximum value of all data

void
processData(Data $data, int $istep)

Processes the given data for the step

void
processActions(Action $actions, int $istep)

Executes all the actions of a business rule of the step

void
processRule(BusinessRule $businessrule, int $istep)

Evaluates the conditions of a business rule an executes the suitable actions

void
processRules(int $istep)

Evaluates the conditions of all business rules an executes the suitable actions

void
processDatas(int $istep)

Processes all data for the step

Details

at line 219
protected Response|Step|null runStep(Request $request, array $form, string $simu, string $view, bool $test)

Run the simulation engine for a step

Parameters

Request $request the active request
array $form The form fields
string $simu The simulator name
string $view &$view The view name
bool $test true if it is a test from the administration module, false otherwise

Return Value

Response|Step|null

at line 510
protected void addWidget(string $widget)

Adds a widget to the list of widgets

Parameters

string $widget The widget name

Return Value

void

at line 526
protected void widgetDeps(string $widget, array $widgets, array $availWidgets)

Adds widgets that depend on a widget in the list of widgets

Parameters

string $widget The widget name
array $widgets &$widgets the list of widgets
array $availWidgets &$availWidgets the list of available widgets

Return Value

void

at line 547
protected Response runFields(Request $request, string $simu, bool $test = false)

Returns the simulators attributes in JSON response format

Parameters

Request $request the active request
string $simu The simulator name
bool $test (default: false) true if it is a test from the administration module, false otherwise

Return Value

Response

at line 568
protected Response runSource(Request $request, string $simu, bool $test = false)

Returns the requested source attributes in JSON response format

Parameters

Request $request the active request
string $simu The simulator name
bool $test (default: false) true if it is a test from the administration module, false otherwise

Return Value

Response

at line 614
protected string getSimuPath(string $simu, bool $test = false)

Get the simulators directory

Parameters

string $simu The simulator name
bool $test (default: false) true if it is a test from the administration module, false otherwise

Return Value

string the simulators directory

at line 642
protected void checkField(Field $field, array $form, bool $skipValidation)

Checks the given field

Parameters

Field $field
array $form The form fields
bool $skipValidation

Return Value

void

at line 702
protected void processField(Field $field, Step $step, bool $displayable)

Processes the given field for the step

Parameters

Field $field
Step $step
bool $displayable &$displayable

Return Value

void

at line 752
protected void replaceFieldNotes(Field $field)

Replaces data values in the notes of a field

Parameters

Field $field

Return Value

void

at line 772
protected string|false evaluate(string $condition)

Evaluates a condition with the expression parser

Parameters

string $condition The condition to evaluate

Return Value

string|false Result of the evaluation

at line 788
protected void evaluateDefault(Data $data)

Evaluates the default value of the given data

Parameters

Data $data

Return Value

void

at line 807
protected void evaluateDefaults()

Evaluates the default value of all data

Return Value

void

at line 829
protected void evaluateMin(Data $data)

Evaluates the minimum value of the given data

Parameters

Data $data

Return Value

void

at line 851
protected void evaluateMax(Data $data)

Evaluates the maximum value of the given data

Parameters

Data $data

Return Value

void

at line 872
protected void evaluateMinMax()

Evaluates the minimum and the maximum value of all data

Return Value

void

at line 896
protected void processData(Data $data, int $istep)

Processes the given data for the step

Parameters

Data $data
int $istep The step number

Return Value

void

at line 995
protected void processActions(Action $actions, int $istep)

Executes all the actions of a business rule of the step

Parameters

Action $actions Actions of the business rule
int $istep The step number

Return Value

void

at line 1195
protected void processRule(BusinessRule $businessrule, int $istep)

Evaluates the conditions of a business rule an executes the suitable actions

Parameters

BusinessRule $businessrule The rule to be processed
int $istep The step number

Return Value

void

at line 1214
protected void processRules(int $istep)

Evaluates the conditions of all business rules an executes the suitable actions

Parameters

int $istep The step number

Return Value

void

at line 1230
protected void processDatas(int $istep)

Processes all data for the step

Parameters

int $istep The step number

Return Value

void