Translation::load() - Code Metrics - Inspection of "Minor fixes and allow use without database" - 24aitor/Laralang - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 33de19...385318 )

by Aitor Riba

created 2017-02-08 12:07 UTC

Translation::load() A

↳ Parent: Translation

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	1

<?php

namespace Aitor24\Laralang\Builder;

use Aitor24\Laralang\Models\DB_Translation;
use App;

class Translation
{
    /**
     * Setup public vars.
     */
    public $translation;
    public $translator;
    public $string;
    public $debug;
    public $from;
    public $to;
    public $save;
    public $vars;
    public $load;

    /**
     * Setup default values.
     *
     * @param string $string
     */
    public function __construct($string, $vars = [])
    {
        $this->translator = config('laralang.default.translator');
        $this->debug = config('laralang.default.debug');
        $this->save = config('laralang.default.autosave');
        $this->load = config('laralang.default.autoload');
        $this->from = config('laralang.default.from_lang');
        $this->to = config('laralang.default.to_lang');
        $this->string = $string;
        $this->translation = $string;
        $this->vars = $vars;

        // Checking whether from_lang or to_lang are set as app_locale.

        if ($this->from == 'app_locale') {
            $this->from = App::getLocale();
        }

        if ($this->to == 'app_locale') {
            $this->to = App::getLocale();
        }
    }

    /**
     * Setup debug value.
     *
     * @param bool $debug
     */
    public function debug($debug)
    {
        $this->debug = $debug;

        return $this;
    }

    /**
     * Setup fromLang value.
     *
     * @param string $lang
     */
    public function from($lang)
    {
        $this->from = $lang;

        return $this;
    }

    /**
     * Setup tolang value.
     *
     * @param string $lang
     */
    public function to($lang)
    {
        $this->to = $lang;

        return $this;
    }

    /**
     * Setup translator.
     *
     * @param string $translator
     */
    public function translator($translator)
    {
        $this->translator = $translator;

        return $this;
    }

    /**
     * Setup save option.
     *
     * @param bool $save
     */
    public function Save($save)
    {
        $this->save = $save;

        return $this;
    }

    /**
     * Setup load option.
     *
     * @param bool $load
     */
    public function load($load)
    {
        $this->load = $load;

        return $this;
    }

    public function loadIfExists()
    {
        $existing = DB_Translation::where([
            'string'     => $this->string,
            'from_lang'  => $this->from,
            'to_lang'    => $this->to,
            'translator' => $this->translator,
        ])->get();

        if (count($existing) == 0) {
            return false;
        }
        if ($this->debug === true) {
            $this->translation = "<font style='color:#00CC00;'>Translation loaded from DB</font>";
        } else {
            $this->translation = ($existing[0]->translation);
        }

        return true;
    }

    /**
     * Function to save translations to DB.
     */
    public function checkSave()
    {
        if ($this->save === true) {
            $trans = new DB_Translation();
            $trans->string = $this->string;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $trans->from_lang = $this->from;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $trans->to_lang = $this->to;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $trans->translator = $this->translator;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $trans->translation = $this->translation;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $trans->save();

            // Checking debug setting to determinate how to output translation

            if ($this->debug === true) {
                $this->translation = "<font style='color:#00CC00;'> Translation saved on DB </font>";
            }
        } else {
            if ($this->debug === true) {
                $this->translation = "<font style='color:orange;'> Translation not saved on DB </font>";
            }
        }
    }

    /**
     * This fuction is called to know the status of host, and it would set translation if debug is true.
     *
     * @param string $host
     */
    public function checkHost($host)
    {
        $socket = @fsockopen($host, 80, $errno, $errstr, 30);

        if ($socket) {
            return true;
            fclose($socket);
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
        } else {
            if ($this->debug === true) {
                $this->translation = "<font style='color:red;'>$this->translator host is down! </font>";
            }
        }
    }

    private function replaceVars()
    {
        foreach ($this->vars as $key => $var) {
            $this->translation = str_replace('VAR_'.$key, $var, $this->translation);
        }
    }

    /**
     * This fuction is called by trans() function of Fadade Laralang
     * It would call run() function of this class and returns the translation.
     */
    public function __toString()
    {
        if ($this->from == $this->to) {
            if ($this->debug) {
                return "<font style='color:orange;'>Same in <> out language</font>";
            }

            return $this->string;
        } elseif (!$this->load || !$this->loadIfExists()) {
            $this->main();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        }
        $this->replaceVars();

        return $this->translation;
    }
}


1			<?php
2
3			namespace Aitor24\Laralang\Builder;
4
5			use Aitor24\Laralang\Models\DB_Translation;
6			use App;
7
8			class Translation
9			{
10			/**
11			* Setup public vars.
12			*/
13			public $translation;
14			public $translator;
15			public $string;
16			public $debug;
17			public $from;
18			public $to;
19			public $save;
20			public $vars;
21			public $load;
22
23			/**
24			* Setup default values.
25			*
26			* @param string $string
27			*/
28			public function __construct($string, $vars = [])
29			{
30			$this->translator = config('laralang.default.translator');
31			$this->debug = config('laralang.default.debug');
32			$this->save = config('laralang.default.autosave');
33			$this->load = config('laralang.default.autoload');
34			$this->from = config('laralang.default.from_lang');
35			$this->to = config('laralang.default.to_lang');
36			$this->string = $string;
37			$this->translation = $string;
38			$this->vars = $vars;
39
40			// Checking whether from_lang or to_lang are set as app_locale.
41
42			if ($this->from == 'app_locale') {
43			$this->from = App::getLocale();
44			}
45
46			if ($this->to == 'app_locale') {
47			$this->to = App::getLocale();
48			}
49			}
50
51			/**
52			* Setup debug value.
53			*
54			* @param bool $debug
55			*/
56			public function debug($debug)
57			{
58			$this->debug = $debug;
59
60			return $this;
61			}
62
63			/**
64			* Setup fromLang value.
65			*
66			* @param string $lang
67			*/
68			public function from($lang)
69			{
70			$this->from = $lang;
71
72			return $this;
73			}
74
75			/**
76			* Setup tolang value.
77			*
78			* @param string $lang
79			*/
80			public function to($lang)
81			{
82			$this->to = $lang;
83
84			return $this;
85			}
86
87			/**
88			* Setup translator.
89			*
90			* @param string $translator
91			*/
92			public function translator($translator)
93			{
94			$this->translator = $translator;
95
96			return $this;
97			}
98
99			/**
100			* Setup save option.
101			*
102			* @param bool $save
103			*/
104			public function Save($save)
105			{
106			$this->save = $save;
107
108			return $this;
109			}
110
111			/**
112			* Setup load option.
113			*
114			* @param bool $load
115			*/
116			public function load($load)
117			{
118			$this->load = $load;
119
120			return $this;
121			}
122
123			public function loadIfExists()
124			{
125			$existing = DB_Translation::where([
126			'string' => $this->string,
127			'from_lang' => $this->from,
128			'to_lang' => $this->to,
129			'translator' => $this->translator,
130			])->get();
131
132			if (count($existing) == 0) {
133			return false;
134			}
135			if ($this->debug === true) {
136			$this->translation = "<font style='color:#00CC00;'>Translation loaded from DB</font>";
137			} else {
138			$this->translation = ($existing[0]->translation);
139			}
140
141			return true;
142			}
143
144			/**
145			* Function to save translations to DB.
146			*/
147			public function checkSave()
148			{
149			if ($this->save === true) {
150			$trans = new DB_Translation();
151			$trans->string = $this->string;
			0 ignored issues – show Documentation introduced 2016-12-19 13:49 UTC by Report Bug Copy Issue Report The property `string` does not exist on `object<Aitor24\Laralang\Models\DB_Translation>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
152			$trans->from_lang = $this->from;
			0 ignored issues – show Documentation introduced 2016-12-19 13:49 UTC by Report Bug Copy Issue Report The property `from_lang` does not exist on `object<Aitor24\Laralang\Models\DB_Translation>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
153			$trans->to_lang = $this->to;
			0 ignored issues – show Documentation introduced 2016-12-19 13:49 UTC by Report Bug Copy Issue Report The property `to_lang` does not exist on `object<Aitor24\Laralang\Models\DB_Translation>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
154			$trans->translator = $this->translator;
			0 ignored issues – show Documentation introduced 2016-12-19 13:49 UTC by Report Bug Copy Issue Report The property `translator` does not exist on `object<Aitor24\Laralang\Models\DB_Translation>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
155			$trans->translation = $this->translation;
			0 ignored issues – show Documentation introduced 2016-12-19 13:49 UTC by Report Bug Copy Issue Report The property `translation` does not exist on `object<Aitor24\Laralang\Models\DB_Translation>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
156			$trans->save();
157
158			// Checking debug setting to determinate how to output translation
159
160			if ($this->debug === true) {
161			$this->translation = "<font style='color:#00CC00;'> Translation saved on DB </font>";
162			}
163			} else {
164			if ($this->debug === true) {
165			$this->translation = "<font style='color:orange;'> Translation not saved on DB </font>";
166			}
167			}
168			}
169
170			/**
171			* This fuction is called to know the status of host, and it would set translation if debug is true.
172			*
173			* @param string $host
174			*/
175			public function checkHost($host)
176			{
177			$socket = @fsockopen($host, 80, $errno, $errstr, 30);
178
179			if ($socket) {
180			return true;
181			fclose($socket);
			0 ignored issues – show Unused Code introduced 2016-11-26 20:56 UTC by Report Bug Copy Issue Report `fclose($socket);` does not seem to be reachable. This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed. Unreachable code is most often the result of `return`, `die` or `exit` statements that have been added for debug purposes. function fx() { try { doSomething(); return true; } catch (\Exception $e) { return false; } return false; } In the above example, the last `return false` will never be executed, because a return statement has already been met in every possible execution path. Loading history...
182			} else {
183			if ($this->debug === true) {
184			$this->translation = "<font style='color:red;'>$this->translator host is down! </font>";
185			}
186			}
187			}
188
189			private function replaceVars()
190			{
191			foreach ($this->vars as $key => $var) {
192			$this->translation = str_replace('VAR_'.$key, $var, $this->translation);
193			}
194			}
195
196			/**
197			* This fuction is called by trans() function of Fadade Laralang
198			* It would call run() function of this class and returns the translation.
199			*/
200			public function __toString()
201			{
202			if ($this->from == $this->to) {
203			if ($this->debug) {
204			return "<font style='color:orange;'>Same in <> out language</font>";
205			}
206
207			return $this->string;
208			} elseif (!$this->load \|\| !$this->loadIfExists()) {
209			$this->main();
			0 ignored issues – show Bug introduced 2016-12-11 13:10 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Aitor24\Laralang\Builder\Translation` as the method `main()` does only exist in the following sub-classes of `Aitor24\Laralang\Builder\Translation`: `Aitor24\Laralang\Builder\ApertiumTrans`, `Aitor24\Laralang\Builder\GoogleTrans`, `Aitor24\Laralang\Builder\MymemoryTrans`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
210			}
211			$this->replaceVars();
212
213			return $this->translation;
214			}
215			}
216

24aitor / Laralang

Push — master ( 33de19...385318 )

Translation::load() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like