ProctRecordAction::successResponse() - Code Metrics - ROAResearch/yii2-roa - Measure and Improve Code Quality continuously with Scrutinizer

ProctRecordAction::successResponse() A
last analyzed 2022-11-23 22:41 UTC

↳ Parent: ProctRecordAction

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	1
nc	1
nop	1
dl	0
loc	3
ccs	2
cts	2
cp	1
crap	1
rs	10
c	1
b	0
f	0

<?php

namespace roaresearch\yii2\roa\actions;

use roaresearch\yii2\roa\hal\ARContract;
use Yii;
use yii\web\{HttpException, ServerErrorHttpException};

/**
 * Proct a record. Returns the record on success, throws exception on error.
 *
 * @author Angel (Faryshta) Guevara <[email protected]>
 */
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 $this->successResponse($model);
    }

    /**
     * @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);
    }

    /**
     * @param ARContract $model
     */
    protected function successResponse(ARContract $model)
    {
        return $model;
    }
}


1		<?php
2
3		namespace roaresearch\yii2\roa\actions;
4
5		use roaresearch\yii2\roa\hal\ARContract;
6		use Yii;
7		use yii\web\{HttpException, ServerErrorHttpException};
8
9		/**
10		* Proct a record. Returns the record on success, throws exception on error.
11		*
12		* @author Angel (Faryshta) Guevara <[email protected]>
13		*/
14		abstract class ProctRecordAction extends Action
15		{
16		/**
17		* @var string error message thrown when proct fails.
18		*/
19		protected string $errorMessage = 'Process failed for unknown reasons.';
20
21		/**
22		* Procts a record.
23		*
24		* @param mixed $id the identifier value.
25		* @return ARContract the record after successful proct
26		*/
27	8	public function run($id): ?ARContract
28		{
29	8	$this->checkAccess(
30	8	($model = $this->findModel($id)),
31	8	($params = Yii::$app->request->getQueryParams())
32		);
33	8	$this->proct($model, $params) ?: throw $this->errorException();
34
35	8	return $this->successResponse($model);
36		}
37
38		/**
39		* @param ARContract $model
40		* @param array $params the request params
41		* @return bool whether the proct was successful
42		*/
43		abstract protected function proct(ARContract $model, array $params): bool;
44
45		/**
46		* @return HttpException
47		*/
48		protected function errorException(): HttpException
49		{
50		return new ServerErrorHttpException($this->errorMessage);
51		}
52
53		/**
54		* @param ARContract $model
55		*/
56	3	protected function successResponse(ARContract $model)
57		{
58	3	return $model;
59		}
60		}
61

ROAResearch / yii2-roa

ProctRecordAction::successResponse() A last analyzed 2022-11-23 22:41 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

ProctRecordAction::successResponse() A
last analyzed 2022-11-23 22:41 UTC