Vperyod\AuthHandler\AuthRequestAwareTrait

Complexity

Total Complexity

5

Size/Duplication

Total Lines	74
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	setAuthAttribute()	0	4	1
A	getAuth()	0	10	2
A	getAuthStatus()	0	4	1
A	isAuthValid()	0	4	1

<?php
/**
 * Authentication Handler
 *
 * PHP version 7
 *
 * Copyright (C) 2019 Jake Johns
 *
 * This software may be modified and distributed under the terms
 * of the MIT license.  See the LICENSE file for details.
 *
 * @category  Trait
 * @package   Vperyod\AuthHandler
 * @author    Jake Johns <jake@jakejohns.net>
 * @copyright 2019 Jake Johns
 * @license   http://jnj.mit-license.org/2019 MIT License
 * @link      https://github.com/vperyod/vperyod.auth-handler
 */

namespace Vperyod\AuthHandler;

use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request;

use Aura\Auth\Auth;

/**
 * Auth Request aware trait
 *
 * Trait for objects which need to know where the auth attribute is stored in
 * the request.
 *
 * @category Trait
 * @package  Vperyod\AuthHandler
 * @author   Jake Johns <jake@jakejohns.net>
 * @license  http://jnj.mit-license.org/2019 MIT License
 * @link     https://github.com/vperyod/vperyod.auth-handler
 */
trait AuthRequestAwareTrait
{
    /**
     * Attribute on request where auth is stored
     *
     * @var string
     *
     * @access protected
     */
    protected $authAttribute = Auth::class;

    /**
     * Set auth attribute
     *
     * @param string $attr attribute on request where auth is stored
     *
     * @return void
     *
     * @access public
     */
    public function setAuthAttribute($attr)
    {
        $this->authAttribute = $attr;
    }

    /**
     * Get auth from request
     *
     * @param Request $request PSR7 Request
     *
     * @return Auth
     * @throws \InvalidArgumentException if auth attribute is not an `Auth`
     *
     * @access protected
     */
    protected function getAuth(Request $request) : Auth
    {
        $auth = $request->getAttribute($this->authAttribute);
        if (! $auth instanceof Auth) {
            throw new \InvalidArgumentException(
                'Auth attribute not available in request'
            );
        }
        return $auth;
    }

    /**
     * Get auth status from request
     *
     * @param Request $request PSR7 Request
     *
     * @return string
     *
     * @access protected
     */
    protected function getAuthStatus(Request $request) : string
    {
        return $this->getAuth($request)->getStatus();
    }

    /**
     * Is auth status valid?
     *
     * @param Request $request PSR7 Request
     *
     * @return bool
     *
     * @access protected
     */
    protected function isAuthValid(Request $request) : bool
    {
        return $this->getAuth($request)->isValid();
    }
}