yrc\components\YRC

Complexity

Total Complexity

5

Size/Duplication

Total Lines	66
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	getUserClass()	0	4	1
A	checkAccessHeader()	0	18	4

<?php

namespace yrc\components;

use Yii;
use yii\base\Object;

/**
 * Yii2 Rest Component 
 * @class YRC
 */
class YRC extends Object
{
    /**
     * The user class
     * @var string
     */
    public $userClass;

    /**
     * The email address that emails should be sent from
     * @var string
     */
    public $fromEmail;
    
    /**
     * The name to associate with the origin email
     * @var string
     */
    public $fromName;

    /**
     * The access header
     * If set access to controller actions is granted if and only if the HTTP header value
     * identified by this parameters equals the $accessHeaderSecret property
     * @return mixed
     */
    public $accessHeader;

    /**
     * The access header secret value
     * @return mixed
     */
    public $accessHeaderSecret;

    /**
     * Helper method to get the user class
     * @return string
     */
    public function getUserClass()
    {
        return $this->userClass;
    }

    /**
     * Helper method to check the access header
     * @return boolean
     */
    public function checkAccessHeader($request)
    {
        // Both the access header and access header secret must be set for this check to validate
        if ($this->accessHeader === null || $this->accessHeaderSecret === null) {
            return true;
        }

        // Fetch the access header from the request
        $header = $request->getHeaders()->get($this->accessHeader);

        // Allow if the header values match
        if (\hash_equals($this->accessHeaderSecret, $header)) {
            return true;
        }
        
        // Deny by default
        return false;
    }
}