Language::getLanguageDatabase() - Code Metrics - Inspection of "Refactor(docs): Clear Localization/Language.php" - DanySpin97/PhpBotFramework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 47719d...a5b475 )

unknown

created 2017-02-02 16:39 UTC

Language::getLanguageDatabase() B

↳ Parent: Language

Complexity

Conditions	4
Paths	5

Size

Total Lines	31
Code Lines	18

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	20

Importance

Changes

Metric	Value
dl	0
loc	31
ccs	0
cts	17
cp	0
rs	8.5806
c	0
b	0
f	0
cc	4
eloc	18
nc	5
nop	1
crap	20

<?php

/*
 * This file is part of the PhpBotFramework.
 *
 * PhpBotFramework is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, version 3.
 *
 * PhpBotFramework is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

namespace PhpBotFramework\Localization;

trait Language
{

    /**
     * \addtogroup Localization Localization
     * @{
     */

    /** \brief Stores the language for a multi-language bot */
    public $language;

    /** PDO connection to the database. */
    public $pdo;

    /** \brief Table containing bot users data into database. */
    public $user_table = '"User"';

    /** \brief Name of the column that represents the user ID into database */
    public $id_column = 'chat_id';

    /**
     * \brief Get current user's language from the database, and set it in $language.
     * @param $default_language <i>Optional</i>. Default language to return in case of errors.
     * @return Language set for the current user, $default_language on errors.

     */
    public function getLanguageDatabase($default_language = 'en')
    {
        // If we have no database
        if (!isset($this->_database)) {
            $this->language = $default_language;
            return $default_language;
        }

        // Get the language from the bot
        $sth = $this->pdo->prepare('SELECT language FROM ' . $this->user_table . ' WHERE '
                                                           . $this->id_column . ' = :chat_id');
        $sth->bindParam(':chat_id', $this->_chat_id);
class MyClass { }

$x = new MyClass();
$x->foo = true;

        try {
            $sth->execute();
        } catch (PDOException $e) {

            echo $e->getMessage();
        }

        $row = $sth->fetch();
        $sth = null;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        if (isset($row['language'])) {
            $this->language = $row['language'];
            return $row['language'];
        }

        // If we couldn't get it, set the language to the default one
        $this->language = $default_language;
        return $this->language;
    }

    /**
     * \brief Get current user language from Redis (as a cache) and set it in language.
     * \details Using Redis as cache, check for the language. On failure, get the language
     * from the database and store it (with default expiring time of one day) in Redis.
     *
     * It also change $language parameter of the bot to the language returned.
     * @param $default_language <i>Optional</i>. Default language to return in case of errors.
     * @param $expiring_time <i>Optional</i>. Set the expiring time for the language on
     * redis each time it is took from the sql database.
     * @return Language for the current user, $default_language on errors.

     */
    public function getLanguageRedis($default_language = 'en', $expiring_time = '86400') : string
    {
        if (!isset($this->redis) || !isset($this->pdo)) {
            return $default_language;
        }

        // Check if the language exists on Redis
        if ($this->redis->exists($this->_chat_id . ':language')) {

            $this->language = $this->redis->get($this->_chat_id . ':language');
class MyClass { }

$x = new MyClass();
$x->foo = true;
            return $this->language;
        }

        // Set the value from the database
        $this->redis->setEx($this->_chat_id . ':language', $expiring_time,
                            $this->getLanguageDatabase($default_language));
        return $this->language;
    }

    /**
     * \brief Set the current user language in both Redis, database and internally.
     * \details Save it into database first, then create the expiring key on Redis.
     * @param $language The language to set.
     * @param $expiring_time <i>Optional</i>. Time for the language key in redis to expire.
     * @return On sucess, return true, throws exception otherwise.
     */
    public function setLanguageRedis($language, $expiring_time = '86400')
    {
        if (!isset($this->_database) && !isset($this->redis)) {
            throw new BotException('Database connection not set');
        }

        // Update the language in the database
        $sth = $this->pdo->prepare('UPDATE ' . $this->user_table . ' SET language = :language WHERE ' 
                                             . $this->id_column . ' = :id');
        $sth->bindParam(':language', $language);
        $sth->bindParam(':id', $this->_chat_id);

        try {
            $sth->execute();
        } catch (PDOException $e) {

            throw new BotException($e->getMessage());
        }

        $sth = null;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        // Set the language in Redis
        $this->redis->setEx($this->_chat_id . ':language', $expiring_time, $language);

        // Set language internally
        $this->language = $language;
    }

    /** @} */
}


1		<?php
2
3		/*
4		* This file is part of the PhpBotFramework.
5		*
6		* PhpBotFramework is free software: you can redistribute it and/or modify
7		* it under the terms of the GNU Lesser General Public License as
8		* published by the Free Software Foundation, version 3.
9		*
10		* PhpBotFramework is distributed in the hope that it will be useful, but
11		* WITHOUT ANY WARRANTY; without even the implied warranty of
12		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13		* Lesser General Public License for more details.
14		*
15		* You should have received a copy of the GNU Lesser General Public License
16		* along with this program. If not, see <http://www.gnu.org/licenses/>.
17		*/
18
19		namespace PhpBotFramework\Localization;
20
21		trait Language
22		{
23
24		/**
25		* \addtogroup Localization Localization
26		* @{
27		*/
28
29		/** \brief Stores the language for a multi-language bot */
30		public $language;
31
32		/** PDO connection to the database. */
33		public $pdo;
34
35		/** \brief Table containing bot users data into database. */
36		public $user_table = '"User"';
37
38		/** \brief Name of the column that represents the user ID into database */
39		public $id_column = 'chat_id';
40
41		/**
42		* \brief Get current user's language from the database, and set it in $language.
43		* @param $default_language <i>Optional</i>. Default language to return in case of errors.
44		* @return Language set for the current user, $default_language on errors.
		0 ignored issues – show Comprehensibility Bug introduced 2017-01-28 00:00 UTC by Report Bug Copy Issue Report The return type `Language` is a trait, and thus cannot be used for type-hinting in PHP. Maybe consider adding an interface and use that for type-hinting? In PHP traits cannot be used for type-hinting as they do not define a well-defined structure. This is because any class that uses a trait can rename that trait’s methods. If you would like to return an object that has a guaranteed set of methods, you could create a companion interface that lists these methods explicitly. Loading history...
45		*/
46		public function getLanguageDatabase($default_language = 'en')
47		{
48		// If we have no database
49		if (!isset($this->_database)) {
50		$this->language = $default_language;
51		return $default_language;
52		}
53
54		// Get the language from the bot
55		$sth = $this->pdo->prepare('SELECT language FROM ' . $this->user_table . ' WHERE '
56		. $this->id_column . ' = :chat_id');
57		$sth->bindParam(':chat_id', $this->_chat_id);
		0 ignored issues – show Bug introduced 2017-01-18 12:15 UTC by Report Bug Copy Issue Report The property `_chat_id` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
58
59		try {
60		$sth->execute();
61		} catch (PDOException $e) {
		0 ignored issues – show Bug introduced 2017-01-28 00:00 UTC by Report Bug Copy Issue Report The class `PhpBotFramework\Localization\PDOException` does not exist. Did you forget a USE statement, or did you not list all dependencies? Scrutinizer analyzes your `composer.json`/`composer.lock` file if available to determine the classes, and functions that are defined by your dependencies. It seems like the listed class was neither found in your dependencies, nor was it found in the analyzed files in your repository. If you are using some other form of dependency management, you might want to disable this analysis. Loading history...
62		echo $e->getMessage();
63		}
64
65		$row = $sth->fetch();
66		$sth = null;
		0 ignored issues – show Unused Code introduced 2017-02-02 16:42 UTC by Report Bug Copy Issue Report `$sth` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
67
68		if (isset($row['language'])) {
69		$this->language = $row['language'];
70		return $row['language'];
71		}
72
73		// If we couldn't get it, set the language to the default one
74		$this->language = $default_language;
75		return $this->language;
76		}
77
78		/**
79		* \brief Get current user language from Redis (as a cache) and set it in language.
80		* \details Using Redis as cache, check for the language. On failure, get the language
81		* from the database and store it (with default expiring time of one day) in Redis.
82		*
83		* It also change $language parameter of the bot to the language returned.
84		* @param $default_language <i>Optional</i>. Default language to return in case of errors.
85		* @param $expiring_time <i>Optional</i>. Set the expiring time for the language on
86		* redis each time it is took from the sql database.
87		* @return Language for the current user, $default_language on errors.
		0 ignored issues – show Comprehensibility Bug introduced 2017-01-28 00:00 UTC by Report Bug Copy Issue Report The return type `Language` is a trait, and thus cannot be used for type-hinting in PHP. Maybe consider adding an interface and use that for type-hinting? In PHP traits cannot be used for type-hinting as they do not define a well-defined structure. This is because any class that uses a trait can rename that trait’s methods. If you would like to return an object that has a guaranteed set of methods, you could create a companion interface that lists these methods explicitly. Loading history...
88		*/
89		public function getLanguageRedis($default_language = 'en', $expiring_time = '86400') : string
90		{
91		if (!isset($this->redis) \|\| !isset($this->pdo)) {
92		return $default_language;
93		}
94
95		// Check if the language exists on Redis
96	View Code Duplication	if ($this->redis->exists($this->_chat_id . ':language')) {
		1 ignored issue – show Duplication introduced 2017-01-28 00:00 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
97		$this->language = $this->redis->get($this->_chat_id . ':language');
		0 ignored issues – show Bug introduced 2017-01-18 12:15 UTC by Report Bug Copy Issue Report The property `redis` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
98		return $this->language;
99		}
100
101		// Set the value from the database
102		$this->redis->setEx($this->_chat_id . ':language', $expiring_time,
103		$this->getLanguageDatabase($default_language));
104		return $this->language;
105		}
106
107		/**
108		* \brief Set the current user language in both Redis, database and internally.
109		* \details Save it into database first, then create the expiring key on Redis.
110		* @param $language The language to set.
111		* @param $expiring_time <i>Optional</i>. Time for the language key in redis to expire.
112		* @return On sucess, return true, throws exception otherwise.
113		*/
114		public function setLanguageRedis($language, $expiring_time = '86400')
115		{
116		if (!isset($this->_database) && !isset($this->redis)) {
117		throw new BotException('Database connection not set');
118		}
119
120		// Update the language in the database
121		$sth = $this->pdo->prepare('UPDATE ' . $this->user_table . ' SET language = :language WHERE '
122		. $this->id_column . ' = :id');
123		$sth->bindParam(':language', $language);
124		$sth->bindParam(':id', $this->_chat_id);
125
126		try {
127		$sth->execute();
128		} catch (PDOException $e) {
		0 ignored issues – show Bug introduced 2017-01-28 00:00 UTC by Report Bug Copy Issue Report The class `PhpBotFramework\Localization\PDOException` does not exist. Did you forget a USE statement, or did you not list all dependencies? Scrutinizer analyzes your `composer.json`/`composer.lock` file if available to determine the classes, and functions that are defined by your dependencies. It seems like the listed class was neither found in your dependencies, nor was it found in the analyzed files in your repository. If you are using some other form of dependency management, you might want to disable this analysis. Loading history...
129		throw new BotException($e->getMessage());
130		}
131
132		$sth = null;
		0 ignored issues – show Unused Code introduced 2017-02-02 16:42 UTC by Report Bug Copy Issue Report `$sth` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
133
134		// Set the language in Redis
135		$this->redis->setEx($this->_chat_id . ':language', $expiring_time, $language);
136
137		// Set language internally
138		$this->language = $language;
139		}
140
141		/** @} */
142		}
143

DanySpin97 / PhpBotFramework

Push — master ( 47719d...a5b475 )

Language::getLanguageDatabase() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like