roaresearch\yii2\roa\actions\ProctRecordAction

Complexity

Total Complexity

3

Size/Duplication

Total Lines	37
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	run()	0	9	2
A	errorException()	0	3	1

<?php

namespace roaresearch\yii2\roa\actions;

use roarsearch\yii2\roa\hal\ARContract;

The type roarsearch\yii2\roa\hal\ARContract was not found. Maybe you did not declare it correctly or list all dependencies?

use Yii;
use yii\web\{HttpException, ServerErrorHttpException};

/**
 * Proct a record. Returns the record on success, throws exception on error.
 *
 * @author Angel (Faryshta) Guevara <aguevara@alquimiadigital.mx>
 */
abstract class ProctRecordAction extends Action
{
    /**
     * @var string error message thrown when proct fails.
     */
    protected string $errorMessage = 'Process failed for unknown reasons.';

    /**
     * Procts a record.
     *
     * @param mixed $id the identifier value.
     * @return ARContract the record after successful proct
     */
    public function run($id): ARContract
    {
        $this->checkAccess(
            ($model = $this->findModel($id)),
            ($params = Yii::$app->request->getQueryParams())
        );
        $this->proct($model, $params) ?: throw $this->errorException();

        return $model;

The expression return $model returns the type yii\db\ActiveRecordInterface which is incompatible with the type-hinted return roarsearch\yii2\roa\hal\ARContract.

    }

    /**
     * @param ARContract $model
     * @param array $params the request params
     * @return bool whether the proct was successful
     */
    abstract protected function proct(ARContract $model, array $params): bool;

    /**
     * @return HttpException
     */
    protected function errorException(): HttpException
    {
        return new ServerErrorHttpException($this->errorMessage);
    }
}