flipbox\craft\ember\actions\CurrentUserTrait

Complexity

Total Complexity

6

Size/Duplication

Total Lines	53
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

0%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	findUser()	0	4	1
A	getUser()	0	8	2
A	statusCodeUserNotFound()	0	4	1
A	messageUserNotFound()	0	4	1
A	handleUserNotFoundResponse()	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 Craft;
use craft\elements\User as UserElement;
use yii\web\HttpException;

/**
 * @author Flipbox Factory <hello@flipboxfactory.com>
 * @since 2.0.0
 *
 * @property int $statusCodeUserNotFound
 * @property string $messageUserNotFound
 */
trait CurrentUserTrait
{
    /**
     * @return UserElement|null
     */
    protected function findUser()
    {
        return Craft::$app->getUser()->getIdentity();
    }

    /**
     * @return UserElement
     * @throws HttpException
     */
    protected function getUser()
    {
        if (($currentUser = $this->findUser()) === null) {
            return $this->handleUserNotFoundResponse();
        };

        return $currentUser;
    }

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

    /**
     * @return string
     */
    protected function messageUserNotFound(): string
    {
        return $this->messageUserNotFound ?? 'Unable to establish identity.';
    }

    /**
     * @throws HttpException
     * @return mixed
     */
    protected function handleUserNotFoundResponse()
    {
        throw new HttpException(
            $this->statusCodeUserNotFound(),
            $this->messageUserNotFound()
        );
    }
}