Longman\LaravelMultiLang\Repository

Complexity

Total Complexity

20

Size/Duplication

Total Lines	210
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

92.75%

Importance

Changes	7
Bugs	2	Features	5

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	loadFromCache()	0	6	1
A	storeInCache()	0	5	1
A	existsInCache()	0	4	1
A	getDb()	0	8	2
A	getCache()	0	8	2
A	getTableName()	0	5	1
A	getCacheName()	0	8	2
A	loadFromDatabase()	0	22	3
B	save()	0	38	6

<?php
/*
 * This file is part of the Laravel MultiLang package.
 *
 * (c) Avtandil Kikabidze aka LONGMAN <akalongman@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Longman\LaravelMultiLang;

use Illuminate\Cache\CacheManager as Cache;
use Illuminate\Database\DatabaseManager as Database;
use Longman\LaravelMultiLang\Config;

class Repository
{

    /**
     * The instance of the config.
     *
     * @var \Longman\LaravelMultiLang\Config
     */
    protected $config;

    /**
     * The instance of the cache.
     *
     * @var \Illuminate\Cache\CacheManager
     */
    protected $cache;

    /**
     * The instance of the database.
     *
     * @var \Illuminate\Database\DatabaseManager
     */
    protected $db;

    /**
     * Create a new MultiLang instance.
     *
     * @param string                               $environment

There is no parameter named $environment. Was it maybe removed?

     * @param array                                $config
     * @param \Illuminate\Cache\CacheManager       $cache
     * @param \Illuminate\Database\DatabaseManager $db
     */
    public function __construct(Config $config, Cache $cache, Database $db)
    {
        $this->config = $config;
        $this->cache  = $cache;
        $this->db     = $db;
    }

    /**
     * Get cache key name based on lang and scope
     *
     * @param string $lang
     * @param string $scope
     * @return string
     */
    public function getCacheName($lang, $scope = null)
    {
        $key = $this->config->get('db.texts_table', 'texts') . '_' . $lang;
        if (!is_null($scope)) {
            $key .= '_' . $scope;
        }
        return $key;
    }

    /**
     * Load texts from database storage
     *
     * @param string $lang
     * @param string $scope
     * @return array
     */
    public function loadFromDatabase($lang, $scope = null)
    {
        $query = $this->getDb()->table($this->getTableName())
            ->where('lang', $lang);

        if (!is_null($scope)) {
            $query = $query->whereNested(function ($query) use ($scope) {
                $query->where('scope', 'global');
                $query->orWhere('scope', $scope);
            });
        } else {
            $query = $query->where('scope', 'global');
        }

        $texts = $query->get(['key', 'value', 'lang', 'scope']);

        $array = [];
        foreach ($texts as $row) {
            $array[$row->key] = $row->value;
        }
        return $array;
    }

    /**
     * Load texts from cache storage
     *
     * @param string $lang
     * @param string $scope
     * @return mixed
     */
    public function loadFromCache($lang, $scope = null)
    {
        $texts = $this->getCache()->get($this->getCacheName($lang, $scope));

        return $texts;
    }

    /**
     * Store texts in cache
     *
     * @param string $lang
     * @param array  $texts
     * @param string $scope
     * @return $this
     */
    public function storeInCache($lang, array $texts, $scope = null)
    {
        $this->getCache()->put($this->getCacheName($lang, $scope), $texts, $this->config->get('cache.lifetime', 1440));
        return $this;
    }

    /**
     * Check if we must load texts from cache
     *
     * @param string $lang
     * @param string $scope
     * @return bool
     */
    public function existsInCache($lang, $scope = null)
    {
        return $this->getCache()->has($this->getCacheName($lang, $scope));
    }

    /**
     * Get a database connection instance.
     *
     * @return \Illuminate\Database\Connection
     */
    protected function getDb()
    {
        $connection = $this->config->get('db.connection');
        if ($connection == 'default') {
            return $this->db->connection();
        }
        return $this->db->connection($connection);
    }

    /**
     * Get a cache driver instance.
     *
     * @return \Illuminate\Contracts\Cache\Repository
     */
    protected function getCache()
    {
        $store = $this->config->get('cache.store', 'default');
        if ($store == 'default') {
            return $this->cache->store();
        }
        return $this->cache->store($store);
    }

    /**
     * Save missing texts in database
     *
     * @param string $texts
     * @param string $scope
     * @return bool
     */
    public function save($texts, $scope = null)
    {
        if (empty($texts)) {
            return false;
        }

        $table   = $this->getTableName();
        $locales = $this->config->get('locales', []);
        if (!$scope) {

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

            $scope = 'global';
        }

        foreach ($texts as $k => $v) {

The expression $texts of type string is not traversable.

            foreach ($locales as $lang => $locale_data) {
                $exists = $this->getDb()
                    ->table($table)
                    ->where([
                                'key'   => $k,
                                'lang'  => $lang,
                                'scope' => $scope,
                            ])->first();

                if ($exists) {
                    continue;
                }

                $this->getDb()
                    ->table($table)
                    ->insert([
                                 'key'   => $k,
                                 'lang'  => $lang,
                                 'scope' => $scope,
                                 'value' => $v,
                             ]);
            }
        }
        return true;
    }

    /**
     * Get texts table name
     *
     * @return string
     */
    public function getTableName()
    {
        $table = $this->config->get('db.texts_table', 'texts');
        return $table;
    }
}