Arcanedev\Localization\Entities\Locale

Complexity

Total Complexity

22

Size/Duplication

Total Lines	330
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

98.44%

Importance

Changes

0

19 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	key()	0	4	1
A	setKey()	0	7	1
A	name()	0	4	1
A	setName()	0	6	1
A	script()	0	4	1
A	setScript()	0	6	1
A	direction()	0	14	3
A	setDirection()	0	7	2
A	native()	0	4	1
A	setNative()	0	6	1
A	regional()	0	4	1
A	setRegional()	0	6	1
A	isDefault()	0	4	1
A	setDefault()	0	6	1
A	make()	0	4	1
A	toArray()	0	11	1
A	toJson()	0	4	1
A	jsonSerialize()	0	4	1

<?php namespace Arcanedev\Localization\Entities;

use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Contracts\Support\Jsonable;
use JsonSerializable;

/**
 * Class     Locale
 *
 * @package  Arcanedev\Localization\Entities
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 */
class Locale implements Arrayable, Jsonable, JsonSerializable
{
    /* -----------------------------------------------------------------
     |  Constants
     | -----------------------------------------------------------------
     */

    const DIRECTION_LEFT_TO_RIGHT = 'ltr';
    const DIRECTION_RIGHT_TO_LEFT = 'rtl';

    /* -----------------------------------------------------------------
     |  Properties
     | -----------------------------------------------------------------
     */

    /**
     * Locale key.
     *
     * @var string
     */
    private $key;

    /**
     * Locale name.
     *
     * @var string
     */
    private $name;

    /**
     * Locale script.
     *
     * @var string
     */
    private $script;

    /**
     * Locale direction.
     *
     * @var string
     */
    private $direction;

    /**
     * Locale native.
     *
     * @var string
     */
    private $native;

    /**
     * Locale regional.
     *
     * @var string
     */
    private $regional;

    /**
     * Default locale.
     *
     * @var bool
     */
    private $default = false;

    /* -----------------------------------------------------------------
     |  Constructor
     | -----------------------------------------------------------------
     */

    /**
     * Create Locale instance.
     *
     * @param  string  $key
     * @param  array   $data
     */
    public function __construct($key, array $data)
    {
        $this->setKey($key);
        $this->setName($data['name']);
        $this->setScript($data['script']);
        $this->setDirection($data['dir']);
        $this->setNative($data['native']);
        $this->setRegional($data['regional'] ?? '');
    }

    /* -----------------------------------------------------------------
     |  Getters & Setters
     | -----------------------------------------------------------------
     */

    /**
     * Get local key.
     *
     * @return string
     */
    public function key()
    {
        return $this->key;
    }

    /**
     * Set locale key.
     *
     * @param  string  $key
     *
     * @return self
     */
    private function setKey($key)
    {
        $this->key = $key;
        $this->setDefault();

        return $this;
    }

    /**
     * Get locale name.
     *
     * @return string
     */
    public function name()
    {
        return $this->name;
    }

    /**
     * Set name.
     *
     * @param  string  $name
     *
     * @return self
     */
    private function setName($name)
    {
        $this->name = $name;

        return $this;
    }

    /**
     * Get locale Script.
     *
     * @return string
     */
    public function script()
    {
        return $this->script;
    }

    /**
     * Set Script.
     *
     * @param  string  $script
     *
     * @return self
     */
    private function setScript($script)
    {
        $this->script = $script;

        return $this;
    }

    /**
     * Get locale direction.
     *
     * @return string
     */
    public function direction()
    {
        if (empty($this->direction)) {
            $rtlScripts = ['Arab', 'Hebr', 'Mong', 'Tfng', 'Thaa'];

            $this->setDirection(
                in_array($this->script, $rtlScripts)
                    ? self::DIRECTION_RIGHT_TO_LEFT
                    : self::DIRECTION_LEFT_TO_RIGHT
            );
        }

        return $this->direction;
    }

    /**
     * Set Direction.
     *
     * @param  string  $direction
     *
     * @return self
     */
    private function setDirection($direction)
    {
        if ( ! empty($direction))
            $this->direction = strtolower($direction);

        return $this;
    }

    /**
     * Get locale native.
     *
     * @return string
     */
    public function native()
    {
        return $this->native;
    }

    /**
     * Set Native.
     *
     * @param  string  $native
     *
     * @return self
     */
    private function setNative($native)
    {
        $this->native = $native;

        return $this;
    }

    /**
     * Get locale regional.
     *
     * @return string
     */
    public function regional()
    {
        return $this->regional;
    }

    /**
     * Set Regional.
     *
     * @param  string  $regional
     *
     * @return self
     */
    private function setRegional($regional)
    {
        $this->regional = $regional;

        return $this;
    }

    /**
     * Check if it is a default locale.
     *
     * @return bool
     */
    public function isDefault()
    {
        return $this->default;
    }

    /**
     * Set locale default.
     *
     * @return self
     */
    private function setDefault()
    {
        $this->default = ($this->key === config('app.locale'));

        return $this;
    }

    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

    /**
     * Create Locale instance.
     *
     * @param  string  $key
     * @param  array   $data
     *
     * @return self
     */
    public static function make($key, array $data)
    {
        return new self($key, $data);
    }

    /* -----------------------------------------------------------------
     |  Other Methods
     | -----------------------------------------------------------------
     */

    /**
     * Get the locale entity as an array.
     *
     * @return array
     */
    public function toArray()
    {
        return [
            'key'      => $this->key(),
            'name'     => $this->name(),
            'script'   => $this->script(),
            'dir'      => $this->direction(),
            'native'   => $this->native(),
            'regional' => $this->regional(),
        ];
    }

    /**
     * Convert the object to its JSON representation.
     *
     * @param  int  $options
     *
     * @return string
     */
    public function toJson($options = 0)
    {
        return json_encode($this->toArray(), $options);
    }

    /**
     * Specify data which should be serialized to JSON.
     *
     * @return array
     */
    public function jsonSerialize()
    {
        return $this->toArray();
    }
}