Thinktomorrow\Locale\Scope

Complexity

Total Complexity

17

Size/Duplication

Total Lines	102
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	2
A	setCustomRoot()	0	6	1
A	customRoot()	0	4	1
A	findLocale()	0	4	2
A	locales()	0	4	1
A	defaultLocale()	0	4	1
A	activeLocale()	0	4	1
A	segment()	0	6	3
A	activeSegment()	0	4	1
A	validateLocale()	0	6	2
A	validateSegment()	0	6	2

<?php

namespace Thinktomorrow\Locale;

use Thinktomorrow\Locale\Exceptions\InvalidScope;
use Thinktomorrow\Locale\Values\Locale;
use Thinktomorrow\Locale\Values\Root;

class Scope
{
    /**
     * @var array
     */
    private $locales;

    /**
     * The default locale. In the request path
     * it's the hidden segment, e.g. /
     *
     * @var Locale
     */
    private $default;

    /**
     * When the canonical scope has a root set to be
     * other than the current, that specific root is defined here
     * By default the current request root is of use (NULL)
     *
     * @var null|Root
     */
    private $customRoot = null;

    public function __construct(array $locales)
    {
        if(!isset($locales['/'])) throw new InvalidScope('Default locale is required for scope.');

        $this->locales = $locales;
        $this->default = Locale::from($this->locales['/']);
    }

    public function setCustomRoot(Root $customRoot)
    {
        $this->customRoot = $customRoot;

        return $this;
    }

    public function customRoot(): ?Root
    {
        return $this->customRoot;
    }

    /**
     * Get the locale by segment identifier
     *
     * @param $segment
     * @return null|Locale
     */
    public function findLocale($segment): ?Locale
    {
        return isset($this->locales[$segment]) ? Locale::from($this->locales[$segment]) : null;
    }

    public function locales(): array
    {
        return $this->locales;
    }

    public function defaultLocale(): Locale
    {
        return $this->default;
    }

    public function activeLocale(): string
    {
        return app()->getLocale();
    }

    /**
     * Get the url segment which corresponds with the passed locale
     *
     * @param null $locale
     * @return null|string
     */
    public function segment($locale = null): ?string
    {
        if(is_null($locale)) return $this->activeSegment();

        return ($key = array_search($locale, $this->locales)) ? $key : null;
    }

    public function activeSegment(): ?string
    {
        return $this->segment($this->activeLocale());
    }

    public function validateLocale(string $locale = null): bool
    {
        if(!$locale) return false;

The expression $locale of type null|string is loosely compared to false; this is ambiguous if the string can be empty. You might want to explicitly use === null instead.

        return (in_array($locale, $this->locales));
    }

    public function validateSegment(string $segment = null): bool
    {
        if(!$segment) return false;

The expression $segment of type null|string is loosely compared to false; this is ambiguous if the string can be empty. You might want to explicitly use === null instead.

        return isset($this->locales[$segment]);
    }
}