Jabe\Impl\Persistence\Entity\VariableInstanceEntity

Complexity

Total Complexity

108

Size/Duplication

Total Lines	741
Duplicated Lines	0 %

Importance

Changes

0

74 Methods

Rating	Name	Duplication	Size	Complexity
A	getTask()	0	6	2
A	setExecutionId()	0	3	1
A	getProcessInstanceId()	0	3	1
A	setBatchId()	0	3	1
A	insert()	0	6	2
A	setProcessInstanceId()	0	3	1
A	__toString()	0	23	1
B	equals()	0	19	7
A	setByteArrayValue()	0	3	1
A	setId()	0	3	1
A	setProcessDefinitionId()	0	3	1
A	getProcessDefinitionId()	0	3	1
A	setConcurrentLocal()	0	3	1
A	delete()	0	13	3
A	getTypeName()	0	3	1
A	clearValueFields()	0	11	2
A	serialize()	0	19	1
A	getTenantId()	0	3	1
A	postLoad()	0	4	1
A	getErrorMessage()	0	3	1
A	getRevision()	0	3	1
A	getReferencedEntitiesIdAndClass()	0	21	4
A	isConcurrentLocal()	0	3	1
A	createAndInsert()	0	5	1
B	getPersistentState()	0	33	7
A	getActivityInstanceId()	0	3	1
A	unserialize()	0	19	1
A	onImplicitValueUpdate()	0	20	3
A	getTextValue()	0	3	1
A	getId()	0	3	1
A	getLongValue()	0	3	1
A	setTransient()	0	3	1
A	setLongValue()	0	3	1
A	getVariableScope()	0	8	3
A	setTask()	0	16	3
A	setActivityInstanceId()	0	3	1
A	getContextProcessApplication()	0	8	3
A	getTaskId()	0	3	1
A	getByteArrayValue()	0	3	1
A	setSequenceCounter()	0	3	1
A	setVariableScopeId()	0	3	1
A	getSequenceCounter()	0	3	1
A	getVariableScopeId()	0	12	4
A	ensureExecutionInitialized()	0	6	3
A	setTextValue()	0	3	1
A	getSerializerName()	0	3	1
A	getRevisionNext()	0	3	1
A	getByteArrayValueId()	0	3	1
A	setSerializerName()	0	3	1
A	setSerializer()	0	3	1
A	setRevision()	0	3	1
A	getReferencedEntityIds()	0	4	1
A	getDoubleValue()	0	3	1
A	getName()	0	3	1
A	setByteArrayValueId()	0	3	1
A	getExecutionId()	0	3	1
A	__construct()	0	9	1
A	setTextValue2()	0	3	1
A	isTransient()	0	3	1
A	getExecution()	0	4	1
A	incrementSequenceCounter()	0	3	1
A	setTenantId()	0	3	1
A	getTextValue2()	0	3	1
A	getBatchId()	0	3	1
A	setDoubleValue()	0	3	1
A	setExecution()	0	13	2
A	setName()	0	3	1
A	getTypedValue()	0	3	1
A	setTaskId()	0	3	1
A	getSerializer()	0	3	1
A	deleteByteArrayValue()	0	3	1
A	setValue()	0	6	1
A	create()	0	3	1
A	getValue()	0	3	1

<?php

namespace Jabe\Impl\Persistence\Entity;

use Jabe\Application\{
    InvocationContext,
    ProcessApplicationReferenceInterface
};
use Jabe\Delegate\VariableScopeInterface;
use Jabe\Impl\ProcessEngineLogger;
use Jabe\Impl\Context\{
    Context,
    ProcessApplicationContextUtil
};
use Jabe\Impl\Core\Variable\CoreVariableInstanceInterface;
use Jabe\Impl\Db\{
    DbEntityInterface,
    DbEntityLifecycleAwareInterface,
    EnginePersistenceLogger,
    HasDbReferencesInterface,
    HasDbRevisionInterface
};
use Jabe\Impl\Persistence\Entity\Util\{
    ByteArrayField,
    TypedValueField,
    TypedValueUpdateListenerInterface
};
use Jabe\Impl\Variable\Serializer\{
    TypedValueSerializerInterface,
    ValueFieldsInterface
};
use Jabe\Repository\ResourceTypes;
use Jabe\Runtime\VariableInstanceInterface;
use Jabe\Variable\Value\TypedValueInterface;
use Jabe\Impl\Util\ClassNameUtil;

class VariableInstanceEntity implements VariableInstanceInterface, CoreVariableInstanceInterface, ValueFieldsInterface, DbEntityInterface, DbEntityLifecycleAwareInterface, TypedValueUpdateListenerInterface, HasDbRevisionInterface, HasDbReferencesInterface, \Serializable
{
    //protected static final EnginePersistenceLogger LOG = ProcessEngineLogger.PERSISTENCE_LOGGER;

    protected $id;
    protected $revision;

    protected $name;

    protected $processDefinitionId;
    protected $processInstanceId;
    protected $executionId;
    protected $taskId;
    protected $batchId;
    /*protected $caseInstanceId;
    protected $caseExecutionId;*/
    protected $activityInstanceId;
    protected $tenantId;

    protected $longValue;
    protected $doubleValue;
    protected $textValue;
    protected $textValue2;
    protected $variableScopeId;

    protected $byteArrayField;

    protected $typedValueField;

    protected $forcedUpdate;

    protected $configuration;

    protected $sequenceCounter = 1;

    /**
     * <p>Determines whether this variable is supposed to be a local variable
     * in case of concurrency in its scope. This affects
     * </p>
     *
     * <ul>
     * <li>tree expansion (not evaluated yet by the engine)
     * <li>activity instance IDs of variable instances: concurrentLocal
     *   variables always receive the activity instance id of their execution
     *   (which may not be the scope execution), while non-concurrentLocal variables
     *   always receive the activity instance id of their scope (which is set in the
     *   parent execution)
     * </ul>
     *
     * <p>
     *   In the future, this field could be used for restoring the variable distribution
     *   when the tree is expanded/compacted multiple times.
     *   On expansion, the goal would be to keep concurrentLocal variables always with
     *   their concurrent replacing executions while non-concurrentLocal variables
     *   stay in the scope execution
     * </p>
     */
    protected $isConcurrentLocal = false;

    /**
     * Determines whether this variable is stored in the data base.
     */
    protected $isTransient = false;

    // transient properties
    protected $execution;

    public function __construct(string $name, TypedValueInterface $value, bool $isTransient)
    {
        $this->byteArrayField = new ByteArrayField($this, ResourceTypes::runtime());
        $this->typedValueField = new TypedValueField($this, true);

        $this->typedValueField->addImplicitUpdateListener($this);
        $this->name = $name;
        $this->isTransient = $isTransient;
        $this->typedValueField->setValue($value);
    }

    public static function createAndInsert(string $name, TypedValueInterface $value): VariableInstanceEntity
    {
        $variableInstance = self::create($name, $value, $value->isTransient());
        self::insert($variableInstance);
        return $variableInstance;
    }

    public static function insert(VariableInstanceEntity $variableInstance): void
    {
        if (!$variableInstance->isTransient()) {
            Context::getCommandContext()
            ->getDbEntityManager()
            ->insert($variableInstance);
        }
    }

    public static function create(string $name, TypedValueInterface $value, bool $isTransient): VariableInstanceEntity
    {
        return new VariableInstanceEntity($name, $value, $isTransient);
    }

    public function delete(): void
    {

        if (!$this->isTransient()) {
            $this->typedValueField->notifyImplicitValueUpdate();
        }

        // clear value
        $this->clearValueFields();

        if (!$this->isTransient) {
            // delete variable
            Context::getCommandContext()->getDbEntityManager()->delete($this);
        }
    }

    public function getPersistentState()
    {
        $persistentState = [];
        if ($this->typedValueField->getSerializerName() !== null) {

The condition $this->typedValueField->getSerializerName() !== null is always true.

            $persistentState["serializerName"] = $this->typedValueField->getSerializerName();
        }
        if ($this->longValue !== null) {
            $persistentState["longValue"] = $this->longValue;
        }
        if ($this->doubleValue !== null) {
            $persistentState["doubleValue"] = $this->doubleValue;
        }
        if ($this->textValue !== null) {
            $persistentState["textValue"] = $this->textValue;
        }
        if ($this->textValue2 !== null) {
            $persistentState["textValue2"] = $this->textValue2;
        }
        if ($this->byteArrayField->getByteArrayId() !== null) {

The condition $this->byteArrayField->getByteArrayId() !== null is always true.

            $persistentState["byteArrayValueId"] = $this->byteArrayField->getByteArrayId();
        }

        $persistentState["sequenceCounter"] = $this->getSequenceCounter();
        $persistentState["concurrentLocal"] = $this->isConcurrentLocal;
        $persistentState["executionId"] = $this->executionId;
        $persistentState["taskId"] = $this->taskId;
        //$persistentState["caseExecutionId", caseExecutionId);
        //$persistentState["caseInstanceId", caseInstanceId);
        $persistentState["tenantId"] = $this->tenantId;
        $persistentState["processInstanceId"] = $this->processInstanceId;
        $persistentState["processDefinitionId"] = $this->processDefinitionId;

        return $persistentState;
    }

    public function getRevisionNext(): int
    {
        return $this->revision + 1;
    }

    // lazy initialized relations ///////////////////////////////////////////////

    public function setProcessInstanceId(string $processInstanceId): void
    {
        $this->processInstanceId = $processInstanceId;
    }

    public function setProcessDefinitionId(string $processDefinitionId): void
    {
        $this->processDefinitionId = $processDefinitionId;
    }

    public function setExecutionId(string $executionId): void
    {
        $this->executionId = $executionId;
    }

    /*public void setCaseInstanceId(string $caseInstanceId) {
        $this->caseInstanceId = caseInstanceId;
    }

    public void setCaseExecutionId(string $caseExecutionId) {
        $this->caseExecutionId = caseExecutionId;
    }

    public void setCaseExecution(CaseExecutionEntity caseExecution) {
        if (caseExecution !== null) {
            $this->caseInstanceId = caseExecution->getCaseInstanceId();
            $this->caseExecutionId = caseExecution->getId();
            $this->tenantId = caseExecution->getTenantId();
        } else {
            $this->caseInstanceId = null;
            $this->caseExecutionId = null;
            $this->tenantId = null;
        }
    }*/

    // byte array value /////////////////////////////////////////////////////////

    // i couldn't find a easy readable way to extract the common byte array value logic
    // into a common class.  therefor it's duplicated in VariableInstanceEntity,
    // HistoricVariableInstance and HistoricDetailVariableInstanceUpdateEntity

    public function getByteArrayValueId(): string
    {
        return $this->byteArrayField->getByteArrayId();
    }

    public function setByteArrayValueId(string $byteArrayValueId): void
    {
        $this->byteArrayField->setByteArrayId($byteArrayValueId);
    }

    public function getByteArrayValue(): string
    {
        return $this->byteArrayField->getByteArrayValue();

The expression return $this->byteArrayField->getByteArrayValue() could return the type null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    public function setByteArrayValue(string $bytes): void
    {
        $this->byteArrayField->setByteArrayValue($bytes, $this->isTransient);
    }

    protected function deleteByteArrayValue(): void
    {
        $this->byteArrayField->deleteByteArrayValue();
    }

    // type /////////////////////////////////////////////////////////////////////

    public function getValue()
    {
        return $this->typedValueField->getValue();
    }

    public function getTypedValue(?bool $deserializeValue = null): TypedValueInterface
    {
        return $this->typedValueField->getTypedValue($deserializeValue ?? true, $this->isTransient);
    }

    public function setValue(TypedValueInterface $value): void
    {
        // clear value fields
        $this->clearValueFields();

        $this->typedValueField->setValue($value);
    }

    public function clearValueFields(): void
    {
        $this->longValue = null;
        $this->doubleValue = null;
        $this->textValue = null;
        $this->textValue2 = null;
        $this->typedValueField->clear();

        if ($this->byteArrayField->getByteArrayId() !== null) {

The condition $this->byteArrayField->getByteArrayId() !== null is always true.

            $this->deleteByteArrayValue();
            $this->setByteArrayValueId(null);

null of type null is incompatible with the type string expected by parameter $byteArrayValueId of Jabe\Impl\Persistence\Entity\VariableInstanceEntity::setByteArrayValueId().

        }
    }

    public function getTypeName(): string
    {
        return $this->typedValueField->getTypeName();
    }

    // entity lifecycle /////////////////////////////////////////////////////////

    public function postLoad(): void
    {
        // make sure the serializer is initialized
        $this->typedValueField->postLoad();
    }

    // execution ////////////////////////////////////////////////////////////////

    protected function ensureExecutionInitialized(): void
    {
        if ($this->execution === null && $this->executionId !== null) {
            $this->execution = Context::getCommandContext()
                ->getExecutionManager()
                ->findExecutionById($this->executionId);
        }
    }

    public function getExecution(): ExecutionEntity
    {
        $this->ensureExecutionInitialized();
        return $this->execution;
    }

    public function setExecution(ExecutionEntity $execution): void
    {
        $this->execution = $execution;
        if ($this->execution === null) {
            $this->executionId = null;
            $this->processInstanceId = null;
            $this->processDefinitionId = null;
            $this->tenantId = null;
        } else {
            $this->setExecutionId($execution->getId());
            $this->processDefinitionId = $execution->getProcessDefinitionId();
            $this->processInstanceId = $execution->getProcessInstanceId();
            $this->tenantId = $execution->getTenantId();
        }
    }

    // case execution ///////////////////////////////////////////////////////////

    /*public CaseExecutionEntity getCaseExecution() {
        if (caseExecutionId !== null) {
            return Context
                ->getCommandContext()
                ->getCaseExecutionManager()
                .findCaseExecutionById(caseExecutionId);
        }
        return null;
    }*/

    // getters and setters //////////////////////////////////////////////////////

    public function getId(): ?string
    {
        return $this->id;
    }

    public function setId(string $id): void
    {
        $this->id = $id;
    }

    public function getTextValue(): string
    {
        return $this->textValue;
    }

    public function getProcessInstanceId(): string
    {
        return $this->processInstanceId;
    }

    public function getProcessDefinitionId(): string
    {
        return $this->processDefinitionId;
    }

    public function getExecutionId(): string
    {
        return $this->executionId;
    }

    /*public String getCaseInstanceId() {
        return caseInstanceId;
    }

    public String getCaseExecutionId() {
        return caseExecutionId;
    }*/

    public function getLongValue(): int
    {
        return $this->longValue;
    }

    public function setLongValue(int $longValue): void
    {
        $this->longValue = $longValue;
    }

    public function getDoubleValue(): float
    {
        return $this->doubleValue;
    }

    public function setDoubleValue(float $doubleValue): void
    {
        $this->doubleValue = $doubleValue;
    }

    public function setName(string $name): void
    {
        $this->name = $name;
    }

    public function setTextValue(string $textValue): void
    {
        $this->textValue = $textValue;
    }

    public function getName(): string
    {
        return $this->name;
    }

    public function getRevision(): int
    {
        return $this->revision;
    }

    public function setRevision(int $revision): void
    {
        $this->revision = $revision;
    }

    public function setSerializer(TypedValueSerializerInterface $serializer): void
    {
        $this->typedValueField->setSerializerName($serializer->getName());
    }

    public function setSerializerName(string $type): void
    {
        $this->typedValueField->setSerializerName($type);
    }

    public function getSerializer(): TypedValueSerializerInterface
    {
        return $this->typedValueField->getSerializer();
    }

    public function getTextValue2(): string
    {
        return $this->textValue2;
    }

    public function setTextValue2(string $textValue2): void
    {
        $this->textValue2 = $textValue2;
    }

    public function getTaskId(): string
    {
        return $this->taskId;
    }

    public function setTaskId(string $taskId): void
    {
        $this->taskId = $taskId;
    }

    public function getBatchId(): string
    {
        return $this->batchId;
    }

    public function setBatchId(string $batchId): void
    {
        $this->batchId = $batchId;
    }

    public function setTask(TaskEntity $task): void
    {
        if ($task !== null) {
            $this->taskId = $task->getId();
            $this->tenantId = $task->getTenantId();

            if ($task->getExecution() !== null) {
                $this->setExecution($task->getExecution());
            }
            /*if ($task->getCaseExecution() !== null) {
                setCaseExecution(task->getCaseExecution());
            }*/
        } else {
            $this->taskId = null;
            $this->tenantId = null;
            $this->setExecution(null);

null of type null is incompatible with the type Jabe\Impl\Persistence\Entity\ExecutionEntity expected by parameter $execution of Jabe\Impl\Persistence\Entity\VariableInstanceEntity::setExecution().

            //setCaseExecution(null);
        }
    }

    public function getActivityInstanceId(): string
    {
        return $this->activityInstanceId;
    }

    public function setActivityInstanceId(string $activityInstanceId): void
    {
        $this->activityInstanceId = $activityInstanceId;
    }

    public function getSerializerName(): string
    {
        return $this->typedValueField->getSerializerName();
    }

    public function getErrorMessage(): string
    {
        return $this->typedValueField->getErrorMessage();
    }

    public function getVariableScopeId(): ?string
    {
        if ($this->variableScopeId !== null) {
            return $this->variableScopeId;
        }

        if ($this->taskId !== null) {
            return $this->taskId;
        }

        if ($this->executionId !== null) {
            return $this->executionId;
        }

        //return caseExecutionId;
    }

    public function setVariableScopeId(string $variableScopeId): void
    {
        $this->variableScopeId = $variableScopeId;
    }

    protected function getVariableScope(): ?VariableScopeInterface
    {
        if ($this->taskId !== null) {
            return $this->getTask();
        } elseif ($this->executionId !== null) {
            return $this->getExecution();
        } else {
            return null;
        }
        /*elseif (caseExecutionId !== null) {
            return getCaseExecution();
        }*/
    }

    protected function getTask(): ?TaskEntity
    {
        if ($this->taskId !== null) {
            return Context::getCommandContext()->getTaskManager()->findTaskById($this->taskId);
        } else {
            return null;
        }
    }

    //sequence counter ///////////////////////////////////////////////////////////

    public function getSequenceCounter(): int
    {
        return $this->sequenceCounter;
    }

    public function setSequenceCounter(int $sequenceCounter): void
    {
        $this->sequenceCounter = $sequenceCounter;
    }

    public function incrementSequenceCounter(): void
    {
        $this->sequenceCounter += 1;
    }


    public function isConcurrentLocal(): bool
    {
        return $this->isConcurrentLocal;
    }

    public function setConcurrentLocal(bool $isConcurrentLocal): void
    {
        $this->isConcurrentLocal = $isConcurrentLocal;
    }

    public function onImplicitValueUpdate(TypedValueInterface $updatedValue): void
    {
        // note: this implementation relies on the
        //   behavior that the variable scope
        //   of variable value can never become null

        $targetProcessApplication = getContextProcessApplication();

The function getContextProcessApplication was not found. Maybe you did not declare it correctly or list all dependencies?

        if ($targetProcessApplication !== null) {
            $scope = $this;
            Context::executeWithinProcessApplication(
                function () use ($scope, $updatedValue) {
                    $scope->getVariableScope()->setVariableLocal($scope->name, $updatedValue);
                    return null;
                },
                $targetProcessApplication,
                new InvocationContext($this->getExecution())
            );
        } else {
            if (!$this->isTransient) {
                $this->getVariableScope()->setVariableLocal($this->name, $updatedValue);
            }
        }
    }

    protected function getContextProcessApplication(): ?ProcessApplicationReferenceInterface
    {
        if ($this->taskId !== null) {
            return ProcessApplicationContextUtil::getTargetProcessApplication($this->getTask());
        } elseif ($this->executionId !== null) {
            return ProcessApplicationContextUtil::getTargetProcessApplication($this->getExecution());
        } else {
            return null;
        }
        /*elseif (caseExecutionId !== null) {
            return ProcessApplicationContextUtil->getTargetProcessApplication(getCaseExecution());
        } */
    }

    public function serialize()
    {
        return json_encode([
            'id' => $this->id,
            'revision' => $this->revision,
            'name' => $this->name,
            'processDefinitionId' => $this->processDefinitionId,
            'processInstanceId' => $this->processInstanceId,
            'executionId' => $this->executionId,
            'taskId' => $this->taskId,
            'activityInstanceId' => $this->activityInstanceId,
            'tenantId' => $this->tenantId,
            'longValue' => $this->longValue,
            'doubleValue' => $this->doubleValue,
            'textValue' => $this->textValue,
            'textValue2' => $this->textValue2,
            'byteArrayValueId' => $this->byteArrayValueId,
            'configuration' => $this->configuration,
            'isConcurrentLocal' => $this->isConcurrentLocal
        ]);
    }

    public function unserialize($data)
    {
        $json = json_decode($data);
        $this->id = $json->id;
        $this->revision = $json->revision;
        $this->name = $json->name;
        $this->processDefinitionId = $json->processDefinitionId;
        $this->processInstanceId = $json->processInstanceId;
        $this->executionId = $json->executionId;
        $this->taskId = $json->taskId;
        $this->activityInstanceId = $json->activityInstanceId;
        $this->tenantId = $json->tenantId;
        $this->longValue = $json->longValue;
        $this->doubleValue = $json->doubleValue;
        $this->textValue = $json->textValue;
        $this->textValue2 = $json->textValue2;
        $this->byteArrayValueId = $json->byteArrayValueId;

The property byteArrayValueId does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->configuration = $json->configuration;
        $this->isConcurrentLocal = $json->isConcurrentLocal;
    }

    public function __toString()
    {
        $className = ClassNameUtil::getClassNameWithoutPackage(get_class($this));
        return $className
        . "[id=" . $this->id
        . ", revision=" . $this->revision
        . ", name=" . $this->name
        . ", processDefinitionId=" . $this->processDefinitionId
        . ", processInstanceId=" . $this->processInstanceId
        . ", executionId=" . $this->executionId
        //. ", caseInstanceId=" . caseInstanceId
        //. ", caseExecutionId=" . caseExecutionId
        . ", taskId=" . $this->taskId
        . ", activityInstanceId=" . $this->activityInstanceId
        . ", tenantId=" . $this->tenantId
        . ", longValue=" . $this->longValue
        . ", doubleValue=" . $this->doubleValue
        . ", textValue=" . $this->textValue
        . ", textValue2=" . $this->textValue2
        . ", byteArrayValueId=" . $this->getByteArrayValueId()
        . ", configuration=" . $this->configuration
        . ", isConcurrentLocal=" . $this->isConcurrentLocal
        . "]";
    }

    public function equals($obj): bool
    {
        if ($this == $obj) {
            return true;
        }
        if ($obj === null) {
            return false;
        }
        if (get_class($this) != get_class($obj)) {
            return false;
        }
        if ($this->id === null) {
            if ($obj->id !== null) {
                return false;
            }
        } elseif ($this->id != $obj->id) {
            return false;
        }
        return true;
    }

    /**
     * @param isTransient
     *          <code>true</code>, if the variable is not stored in the data base.
     *          Default is <code>false</code>.
     */
    public function setTransient(bool $isTransient): void
    {
        $this->isTransient = $isTransient;
    }

    /**
     * @return bool true, if the variable is transient. A transient
     *         variable is not stored in the data base.
     */
    public function isTransient(): bool
    {
        return $this->isTransient;
    }

    public function getTenantId(): ?string
    {
        return $this->tenantId;
    }

    public function setTenantId(?string $tenantId): void
    {
        $this->tenantId = $tenantId;
    }

    public function getReferencedEntityIds(): array
    {
        $referencedEntityIds = [];
        return $referencedEntityIds;
    }

    public function getReferencedEntitiesIdAndClass(): array
    {
        $referenceIdAndClass = [];

        if ($this->processInstanceId !== null) {
            $referenceIdAndClass[$this->processInstanceId] = ExecutionEntity::class;
        }
        if ($this->executionId !== null) {
            $referenceIdAndClass[$this->executionId] = ExecutionEntity::class;
        }
        /*if (caseInstanceId !== null){
            referenceIdAndClass.put(caseInstanceId, CaseExecutionEntity::class);
        }
        if (caseExecutionId !== null){
            referenceIdAndClass.put(caseExecutionId, CaseExecutionEntity::class);
        }*/
        if ($this->getByteArrayValueId() !== null) {

The condition $this->getByteArrayValueId() !== null is always true.

            $referenceIdAndClass[$this->getByteArrayValueId()] = ByteArrayEntity::class;
        }

        return $referenceIdAndClass;
    }
}