Vivait\TenantBundle\Locator\CookieLocator

Complexity

Total Complexity

9

Size/Duplication

Total Lines	88
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	getTenant()	0	8	1
A	getTenantFromRequest()	0	9	1
A	tenantNameIsValid()	0	4	3
A	checkTenantName()	0	12	3

<?php

namespace Vivait\TenantBundle\Locator;

use Symfony\Component\HttpFoundation\Request;
use Vivait\TenantBundle\Registry\TenantRegistry;

class CookieLocator implements TenantLocator
{

    /**
     * @var Request
     */
    private $request;

    /**
     * @var string
     */
    private $cookieName;

    /**
     * @var TenantRegistry
     */
    private $tenantRegistry;

    /**
     * @param Request        $request
     * @param                $cookieName
     * @param TenantRegistry $tenantRegistry
     */
    public function __construct(Request $request, $cookieName, TenantRegistry $tenantRegistry)

You have injected the Request via parameter $request. This is generally not recommended as there might be multiple instances during a request cycle (f.e. when using sub-requests). Instead, it is recommended to inject the RequestStack and retrieve the current request each time you need it via getCurrentRequest().

    {
        $this->request = $request;
        $this->cookieName = $cookieName;
        $this->tenantRegistry = $tenantRegistry;
    }

    /**
     * @return string
     */
    public function getTenant()
    {
        $tenantName = $this->request->cookies->get($this->cookieName);

        $this->checkTenantName($tenantName);

        return $tenantName;
    }

    /**
     * @param Request        $request
     * @param string         $cookieName
     * @param TenantRegistry $tenantRegistry
     *
     * @return string Tenant key
     */
    public static function getTenantFromRequest(
        Request $request,
        $cookieName = 'tenant',
        TenantRegistry $tenantRegistry
    ) {
        $locator = new self($request, $cookieName, $tenantRegistry);

        return $locator->getTenant();
    }

    /**
     * @param $tenantName
     *
     * @return bool
     */
    private function tenantNameIsValid($tenantName)
    {
        return $this->tenantRegistry->contains($tenantName) && $tenantName !== 'dev' && $tenantName !== 'test';
    }

    /**
     * @throws \RuntimeException
     * @throws \OutOfBoundsException
     *
     * @param $tenantName
     */
    private function checkTenantName($tenantName)
    {
        // if no cookie, throw runtime so it'll continue as prod
        if ($tenantName === null) {
            throw new \RuntimeException;
        }

        // if tenant is set and doesn't exist, throw out of bounds
        if ( ! $this->tenantNameIsValid($tenantName)) {
            throw new \OutOfBoundsException;
        }
    }
}