roaresearch\yii2\workflow\models\WorkLog

Complexity

Total Complexity

13

Size/Duplication

Total Lines	131
Duplicated Lines	0 %

Test Coverage

Coverage

87.27%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
B	beforeSave()	0	35	7
A	attributeLabels()	0	7	1
A	getProcess()	0	3	1
A	init()	0	9	2
A	rules()	0	42	2

<?php

namespace roaresearch\yii2\workflow\models;

use roaresearch\yii2\rmdb\models\Pivot;
use Yii;
use yii\{
    db\ActiveQuery,
    web\ForbiddenHttpException,
    web\BadRequestHttpException
};

/**
 * @property int $id
 * @property int $process_id
 * @property int $stage_id
 * @property string $comment
 *
 * @property Process $process
 */
abstract class WorkLog extends Pivot
{
    public const SCENARIO_INITIAL = 'initial';
    public const SCENARIO_FLOW = 'flow';

    /**
     * @return string class name for the process this worklog is attached to.
     */
    abstract protected function processClass(): string;

    /**
     * @inheritdoc
     */
    public function rules()
    {
        return [
            [['process_id'], 'required', 'except' => [self::SCENARIO_INITIAL]],
            [['stage_id'], 'required'],
            [['process_id', 'stage_id'], 'integer'],
            [['comment'], 'string', 'max' => 1024],
            [
                ['process_id'],
                'exist',
                'targetAttribute' => ['process_id' => 'id'],
                'targetClass' => $this->processClass(),
                'except' => [self::SCENARIO_INITIAL],
            ],
            [
                ['stage_id'],
                'exist',
                'targetAttribute' => ['stage_id' => 'id'],
                'targetClass' => Stage::class,
                'filter' => function ($query) {
                    $query->andWhere(['initial' => true]);
                },
                'on' => [self::SCENARIO_INITIAL],
                'message' => 'Not an initial stage for the workflow.'
            ],
            [
                ['stage_id'],
                'exist',
                'targetAttribute' => ['stage_id' => 'target_stage_id'],
                'targetClass' => Transition::class,
                'filter' => function ($query) {
                    $query->andWhere([
                        'source_stage_id' => $this->process->activeWorkLog
                            ->stage_id
                    ]);
                },
                'when' => function () {
                    return !$this->hasErrors('process_id')
                        && null !== $this->process->activeWorkLog;
                },
                'on' => [self::SCENARIO_FLOW],
                'message' => 'There is no transition for the current stage'
            ],
        ];
    }

    /**
     * @inheritdoc
     */
    public function beforeSave($insert)
    {
        if (!parent::beforeSave($insert)) {
            return false;
        }

        if (!$insert || $this->scenario == self::SCENARIO_INITIAL) {
            // editing a worklog or creating initial worklog
            return true;
        }

        $transition = Transition::find()->andWhere([
            'source_stage_id' => $this->process->activeWorkLog->stage_id,
            'target_stage_id' => $this->stage_id,
        ])->one();

        if (!isset($transition)) {
            throw new BadRequestHttpException('Stage not transitionable.');
        }

        if (!$this->process->userAssigned(Yii::$app->user->id)) {

It seems like Yii::app->user->id can also be of type string; however, parameter $userId of roaresearch\yii2\workflow\models\Process::userAssigned() does only seem to accept integer|null, maybe add an additional type check?

            throw new ForbiddenHttpException(
                'You are not assigned to move this process.'
            );
        }

        if (!$transition->userCan(Yii::$app->user->id, $this->process)) {
            throw new ForbiddenHttpException(
                'You dont have permission for the transition.'
            );
        }

        unset($this->process->activeWorkLog);

        return true;
    }

    /**
     * @inheritdoc
     */
    public function attributeLabels()
    {
        return array_merge([
            'id' => 'ID',
            'process_id' => 'Process ID',
            'stage_id' => 'Stage ID',
        ], parent::attributeLabels());
    }

    /**
     * @inheritdoc
     */
    public function init()
    {
        if (!is_subclass_of($this->processClass(), Process::class)) {
            throw new InvalidConfigException(

The type roaresearch\yii2\workflow\models\InvalidConfigException was not found. Maybe you did not declare it correctly or list all dependencies?

                static::class . '::processClass() must extend '
                    . Process::class
            );
        }
        parent::init();
    }

    /**
     * @return ActiveQuery
     */
    public function getProcess(): ActiveQuery
    {
        return $this->hasOne($this->processClass(), ['id' => 'process_id']);
    }
}