Repository::existsInCache() - Code Metrics - Inspection of "Fixed issues" - akalongman/laravel-multilang - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c83b47...38acfc )

by Avtandil

created 2016-07-04 13:18 UTC

Repository::existsInCache() A

↳ Parent: Repository

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	2
Bugs	0	Features	2

Metric	Value
cc	1
eloc	2
c	2
b	0
f	2
nc	1
nop	2
dl	0
loc	4
ccs	2
cts	2
cp	1
crap	1
rs	10

<?php
/*
 * This file is part of the Laravel MultiLang package.
 *
 * (c) Avtandil Kikabidze aka LONGMAN <[email protected]>
 *
 * 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
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @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) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $scope = 'global';
        }

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

            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;
    }
}


1		<?php
2		/*
3		* This file is part of the Laravel MultiLang package.
4		*
5		* (c) Avtandil Kikabidze aka LONGMAN <[email protected]>
6		*
7		* For the full copyright and license information, please view the LICENSE
8		* file that was distributed with this source code.
9		*/
10
11		namespace Longman\LaravelMultiLang;
12
13		use Illuminate\Cache\CacheManager as Cache;
14		use Illuminate\Database\DatabaseManager as Database;
15		use Longman\LaravelMultiLang\Config;
16
17		class Repository
18		{
19
20		/**
21		* The instance of the config.
22		*
23		* @var \Longman\LaravelMultiLang\Config
24		*/
25		protected $config;
26
27		/**
28		* The instance of the cache.
29		*
30		* @var \Illuminate\Cache\CacheManager
31		*/
32		protected $cache;
33
34		/**
35		* The instance of the database.
36		*
37		* @var \Illuminate\Database\DatabaseManager
38		*/
39		protected $db;
40
41		/**
42		* Create a new MultiLang instance.
43		*
44		* @param string $environment
		0 ignored issues – show Bug introduced 2016-04-25 14:46 UTC by Report Bug Copy Issue Report There is no parameter named `$environment`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
45		* @param array $config
46		* @param \Illuminate\Cache\CacheManager $cache
47		* @param \Illuminate\Database\DatabaseManager $db
48		*/
49	27	public function __construct(Config $config, Cache $cache, Database $db)
50		{
51	27	$this->config = $config;
52	27	$this->cache = $cache;
53	27	$this->db = $db;
54	27	}
55
56		/**
57		* Get cache key name based on lang and scope
58		*
59		* @param string $lang
60		* @param string $scope
61		* @return string
62		*/
63	5	public function getCacheName($lang, $scope = null)
64		{
65	5	$key = $this->config->get('db.texts_table', 'texts') . '_' . $lang;
66	5	if (!is_null($scope)) {
67		$key .= '_' . $scope;
68		}
69	5	return $key;
70		}
71
72		/**
73		* Load texts from database storage
74		*
75		* @param string $lang
76		* @param string $scope
77		* @return array
78		*/
79	18	public function loadFromDatabase($lang, $scope = null)
80		{
81	18	$query = $this->getDb()->table($this->getTableName())
82	18	->where('lang', $lang);
83
84	18	if (!is_null($scope)) {
85		$query = $query->whereNested(function ($query) use ($scope) {
86		$query->where('scope', 'global');
87		$query->orWhere('scope', $scope);
88		});
89		} else {
90	18	$query = $query->where('scope', 'global');
91		}
92
93	18	$texts = $query->get(['key', 'value', 'lang', 'scope']);
94
95	18	$array = [];
96	18	foreach ($texts as $row) {
97	12	$array[$row->key] = $row->value;
98		}
99	18	return $array;
100		}
101
102		/**
103		* Load texts from cache storage
104		*
105		* @param string $lang
106		* @param string $scope
107		* @return mixed
108		*/
109	2	public function loadFromCache($lang, $scope = null)
110		{
111	2	$texts = $this->getCache()->get($this->getCacheName($lang, $scope));
112
113	2	return $texts;
114		}
115
116		/**
117		* Store texts in cache
118		*
119		* @param string $lang
120		* @param array $texts
121		* @param string $scope
122		* @return $this
123		*/
124	4	public function storeInCache($lang, array $texts, $scope = null)
125		{
126	4	$this->getCache()->put($this->getCacheName($lang, $scope), $texts, $this->config->get('cache.lifetime', 1440));
127	4	return $this;
128		}
129
130		/**
131		* Check if we must load texts from cache
132		*
133		* @param string $lang
134		* @param string $scope
135		* @return bool
136		*/
137	4	public function existsInCache($lang, $scope = null)
138		{
139	4	return $this->getCache()->has($this->getCacheName($lang, $scope));
140		}
141
142		/**
143		* Get a database connection instance.
144		*
145		* @return \Illuminate\Database\Connection
146		*/
147	18	protected function getDb()
148		{
149	18	$connection = $this->config->get('db.connection');
150	18	if ($connection == 'default') {
151	18	return $this->db->connection();
152		}
153		return $this->db->connection($connection);
154		}
155
156		/**
157		* Get a cache driver instance.
158		*
159		* @return \Illuminate\Contracts\Cache\Repository
160		*/
161	4	protected function getCache()
162		{
163	4	$store = $this->config->get('cache.store', 'default');
164	4	if ($store == 'default') {
165		return $this->cache->store();
166		}
167	4	return $this->cache->store($store);
168		}
169
170		/**
171		* Save missing texts in database
172		*
173		* @param string $texts
174		* @param string $scope
175		* @return bool
176		*/
177	4	public function save($texts, $scope = null)
178		{
179	4	if (empty($texts)) {
180	1	return false;
181		}
182
183	4	$table = $this->getTableName();
184	4	$locales = $this->config->get('locales', []);
185	4	if (!$scope) {
		0 ignored issues – show Bug Best Practice introduced 2016-07-04 13:23 UTC by Report Bug Copy Issue Report 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. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
186	4	$scope = 'global';
187		}
188
189	4	foreach ($texts as $k => $v) {
		0 ignored issues – show Bug introduced 2016-07-04 13:23 UTC by Report Bug Copy Issue Report The expression `$texts` of type `string` is not traversable. Loading history...
190	4	foreach ($locales as $lang => $locale_data) {
191	4	$exists = $this->getDb()
192	4	->table($table)
193	4	->where([
194	4	'key' => $k,
195	4	'lang' => $lang,
196	4	'scope' => $scope,
197	4	])->first();
198
199	4	if ($exists) {
200	1	continue;
201		}
202
203	4	$this->getDb()
204	4	->table($table)
205	4	->insert([
206	4	'key' => $k,
207	4	'lang' => $lang,
208	4	'scope' => $scope,
209	4	'value' => $v,
210		]);
211		}
212		}
213	4	return true;
214		}
215
216		/**
217		* Get texts table name
218		*
219		* @return string
220		*/
221	19	public function getTableName()
222		{
223	19	$table = $this->config->get('db.texts_table', 'texts');
224	19	return $table;
225		}
226		}
227

akalongman / laravel-multilang

Push — master ( c83b47...38acfc )

Repository::existsInCache() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like