Documentation

RecordFlowUpdater
in package

Class RecordFlowUpdater - Automation of reference fields.

Table of Contents

$currentColumnParentId  : string
The name of the "parent ID" column for the current element.
$currentModuleName  : string
The name of the table in the database for the current element.
$sourceField  : string
The name of the "status" column for the current element.
$sourceTable  : string
The name of the "primary key" column for the current element.
$sourceTableId  : string
The name of the "primary key" column for the current element.
$targetColumnParentId  : string
Name of the module for current elemnt.
$targetField  : string
The name of the "value" column/field for the superior/target element.
$targetModuleName  : string
Name of the module for superior/target elemnt.
$targetTable  : string
The name of the table in the database for the superior/target element.
$targetTableId  : string
The name of the "primary key" column for the superior/target element.
$defaultValue  : bool
The default value is returned if the rules do not specify this case.
$isConfigured  : bool
Is configured.
$rules  : array<string|int, mixed>
Definition of rules for automatic status change.
$sourceModuleName  : string
Source/sub-module module name.
__construct()  : mixed
Construct.
checkIsConfigured()  : bool
Check is configured.
entityAfterDelete()  : void
Method called in Handler during the event "entityAfterDelete".
entityAfterSave()  : void
Method called in Handler during the event "entityAfterSave".
entityChangeState()  : void
Method called in Handler during the event "entityChangeState".
update()  : void
Update the value of the field.
updateFieldValue()  : void
Update field value.
addToQueue()  : void
Add to queue.
addToQueueSubordinateModule()  : void
Add to queue subordinate module.
addToQueueWhenParentHasBeenModified()  : void
Add to the queue when the parent has been modified.
addToQueueWhenSourceFieldHasBeenModified()  : void
Add to the queue when the source field has been modified.
executeRules()  : bool|string
Execute rules and return the processed value.
getChildrenValues()  : array<string|int, mixed>
Get the values of children.
getConfig()  : array<string|int, mixed>|false
Get config.
getStatusFromPicklist()  : array<string|int, mixed>
Get status from picklist.
getValuesFromSource()  : array<string|int, mixed>
Get values from the source.

Properties

$currentColumnParentId

The name of the "parent ID" column for the current element.

protected string $currentColumnParentId

$currentModuleName

The name of the table in the database for the current element.

protected string $currentModuleName

$sourceField

The name of the "status" column for the current element.

protected string $sourceField

$sourceTable

The name of the "primary key" column for the current element.

protected string $sourceTable

$sourceTableId

The name of the "primary key" column for the current element.

protected string $sourceTableId

$targetColumnParentId

Name of the module for current elemnt.

protected string $targetColumnParentId

$targetField

The name of the "value" column/field for the superior/target element.

protected string $targetField

$targetModuleName

Name of the module for superior/target elemnt.

protected string $targetModuleName

$targetTable

The name of the table in the database for the superior/target element.

protected string $targetTable

$targetTableId

The name of the "primary key" column for the superior/target element.

protected string $targetTableId

$defaultValue

The default value is returned if the rules do not specify this case.

private bool $defaultValue = false

$rules

Definition of rules for automatic status change.

private array<string|int, mixed> $rules = []

$sourceModuleName

Source/sub-module module name.

private string $sourceModuleName

Methods

__construct()

Construct.

public __construct(string $sourceModuleName) : mixed
Parameters
$sourceModuleName : string
Return values
mixed

checkIsConfigured()

Check is configured.

public checkIsConfigured() : bool
Return values
bool

update()

Update the value of the field.

public static update(string $sourceModuleName, int $recordId) : void
Parameters
$sourceModuleName : string
$recordId : int
Return values
void

updateFieldValue()

Update field value.

public updateFieldValue(int $recordId) : void
Parameters
$recordId : int
Return values
void

addToQueue()

Add to queue.

private addToQueue(int $recordId) : void
Parameters
$recordId : int
Return values
void

addToQueueSubordinateModule()

Add to queue subordinate module.

private addToQueueSubordinateModule(int $recordId) : void
Parameters
$recordId : int
Return values
void

executeRules()

Execute rules and return the processed value.

private executeRules(int $recordId) : bool|string
Parameters
$recordId : int
Return values
bool|string

getChildrenValues()

Get the values of children.

private getChildrenValues(int $recordId) : array<string|int, mixed>
Parameters
$recordId : int
Return values
array<string|int, mixed>

getConfig()

Get config.

private getConfig([string $column = 'source_module' ]) : array<string|int, mixed>|false
Parameters
$column : string = 'source_module'
Return values
array<string|int, mixed>|false

getStatusFromPicklist()

Get status from picklist.

private getStatusFromPicklist(array<string|int, mixed> $items) : array<string|int, mixed>
Parameters
$items : array<string|int, mixed>
Return values
array<string|int, mixed>

getValuesFromSource()

Get values from the source.

private getValuesFromSource(int $recordId) : array<string|int, mixed>
Parameters
$recordId : int
Return values
array<string|int, mixed>

Search results