Kaliop\eZWorkflowEngineBundle\API\Value\WorkflowDefinition

Complexity

Total Complexity

4

Size/Duplication

Total Lines	62
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__set_state()	0	13	1
A	__construct()	0	14	3

<?php

namespace Kaliop\eZWorkflowEngineBundle\API\Value;

use Kaliop\eZMigrationBundle\API\Value\MigrationDefinition;

/**
 * @property-read string $signalName
 * @property-read string $runAs use false for 'current user'
 * @property-read bool $useTransaction
 * @property-read bool $avoidRecursion
 */
class WorkflowDefinition extends MigrationDefinition
{
    const MANIFEST_STEP_TYPE= 'workflow';
    const MANIFEST_SIGNAL_ELEMENT= 'signal';
    const MANIFEST_RUNAS_ELEMENT= 'run_as';
    const MANIFEST_USETRANSACTION_ELEMENT= 'transaction';
    const MANIFEST_AVOIDRECURSION_ELEMENT= 'avoid_recursion';

    protected $signalName;
    // unlike migrations, workflows default to run as current user
    protected $runAs = false;
    protected $useTransaction = false;
    protected $avoidRecursion;

    /**
     * WorkflowDefinition constructor.
     * @param string $name
     * @param string $path
     * @param string $rawDefinition
     * @param int $status
     * @param \Kaliop\eZMigrationBundle\API\Value\MigrationStep[]|\Kaliop\eZMigrationBundle\API\Collection\MigrationStepsCollection $steps
     * @param string $parsingError
     * @param string $signalName
     * @param string|int|false|null $runAs if false will use the current user; if null will use hardcoded 14; string for login or user id
     * @param bool $useTransaction
     * @throws \Exception
     */
    public function __construct($name, $path, $rawDefinition, $status = 0, $steps = array(), $parsingError = null,
        $signalName = null, $runAs = false, $useTransaction = false, $avoidRecursion = false)
    {
        if ($status == MigrationDefinition::STATUS_PARSED && $signalName == null) {

It seems like you are loosely comparing $signalName of type null|string against null; this is ambiguous if the string can be empty. Consider using a strict comparison === instead.

            throw new \Exception("Can not create a parsed Workflow definition without a corresponding signal");
        }

        $this->signalName = $signalName;

The property signalName is declared read-only in Kaliop\eZWorkflowEngineBundle\API\Value\WorkflowDefinition.

        $this->runAs = $runAs;

It seems like $runAs can also be of type false. However, the property $runAs is declared as type string. Maybe add an additional type check?

The property runAs is declared read-only in Kaliop\eZWorkflowEngineBundle\API\Value\WorkflowDefinition.

        $this->useTransaction = $useTransaction;

The property useTransaction is declared read-only in Kaliop\eZWorkflowEngineBundle\API\Value\WorkflowDefinition.

        $this->avoidRecursion = $avoidRecursion;

The property avoidRecursion is declared read-only in Kaliop\eZWorkflowEngineBundle\API\Value\WorkflowDefinition.

        parent::__construct(
            $name, $path, $rawDefinition, $status, $steps, $parsingError
        );
    }

    /**
     * Allow the class to be serialized to php using var_export
     * @param array $data
     * @return static
     */
    public static function __set_state(array $data)
    {
        return new static(
            $data['name'],
            $data['path'],
            $data['rawDefinition'],
            $data['status'],
            $data['steps'],
            $data['parsingError'],
            $data['signalName'],
            $data['runAs'],
            $data['useTransaction'],
            $data['avoidRecursion']
        );
    }
}