flipbox\craft\ember\actions\CheckAccessTrait

Complexity

Total Complexity

8

Size/Duplication

Total Lines	63
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

0%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	checkAccess()	0	11	3
A	statusCodeUnauthorized()	0	4	2
A	messageUnauthorized()	0	4	2
A	handleUnauthorizedResponse()	0	7	1

<?php

/**
 * @copyright  Copyright (c) Flipbox Digital Limited
 * @license    https://github.com/flipboxfactory/craft-ember/blob/master/LICENSE
 * @link       https://github.com/flipboxfactory/craft-ember/
 */

namespace flipbox\craft\ember\actions;

use yii\web\UnauthorizedHttpException;

/**
 * @author Flipbox Factory <hello@flipboxfactory.com>
 * @since 2.0.0
 */
trait CheckAccessTrait
{
    /**
     * @var int|null
     */
    public $statusCodeUnauthorized;

    /**
     * @var string|null
     */
    public $messageUnauthorized;

    /**
     * @var null|callable
     */
    public $checkAccess = null;

    /**
     * @param mixed ...$params
     * @return mixed
     * @throws UnauthorizedHttpException
     */
    public function checkAccess(...$params)
    {
        if ($this->checkAccess) {
            if (call_user_func_array($this->checkAccess, $params) === false) {
                /** @noinspection PhpVoidFunctionResultUsedInspection */
                return $this->handleUnauthorizedResponse();
            };
        }

        return true;
    }

    /**
     * HTTP forbidden response code
     *
     * @return int
     */
    protected function statusCodeUnauthorized(): int
    {
        return $this->statusCodeUnauthorized ?: 403;
    }

    /**
     * @return string
     */
    protected function messageUnauthorized(): string
    {
        return $this->messageUnauthorized ?: 'Unable to perform action.';
    }

    /**
     * @throws UnauthorizedHttpException
     */
    protected function handleUnauthorizedResponse()
    {
        throw new UnauthorizedHttpException(
            $this->statusCodeUnauthorized(),
            $this->messageUnauthorized()
        );
    }
}