Line::getValuesByLocaleAndPage() - Code Metrics - Inspection of "[Feature] allow to fetch entire translation arrays" - thinktomorrow/squanto - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 8c886d...91409e )

by Ben

created 2017-03-29 12:23 UTC

Line::getValuesByLocaleAndPage() B

↳ Parent: Line

Complexity

Conditions	4
Paths	8

Size

Total Lines	25
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	12
CRAP Score	4

Importance

Changes

Metric	Value
cc	4
eloc	13
nc	8
nop	2
dl	0
loc	25
ccs	12
cts	12
cp	1
crap	4
rs	8.5806
c	0
b	0
f	0

<?php

namespace Thinktomorrow\Squanto\Domain;

use Illuminate\Database\Eloquent\Model;
use Dimsav\Translatable\Translatable as BaseTranslatable;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\DB;

/**
 * Class Line
 *
 * @package Thinktomorrow\Squanto\Domain
 */
class Line extends Model
{
    use BaseTranslatable, Translatable;

    public $table = 'squanto_lines';
    public $translatedAttributes = ['value'];

    /**
     * @param $key
     * @return Line
     */
    public static function make($key)
    {
        $linekey = new LineKey($key);

        $line = new self;
        $line->key = $linekey->get();
<?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.");
        }
    }

}
        $line->label = $linekey->getAsLabel();
<?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.");
        }
    }

}
        $line->page_id = Page::findOrCreateByKey($linekey->getPageKey())->id;
<?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.");
        }
    }

}

        $line->save();

        return $line;
    }

    /**
     * @param $key
     * @return Line
     */
    public static function findOrCreateByKey($key)
    {
        if ($line = self::findByKey($key)) {
            return $line;
        }

        return self::make($key);
    }

    /**
     * Save a translated value
     *
     * @param $locale
     * @param $value
     * @return $this
     */
    public function saveValue($locale, $value)
    {
        $this->saveTranslation($locale, 'value', $value);

        return $this;
    }

    /**
     * Save a translated value
     *
     * @param $locale
     * @return $this
     */
    public function removeValue($locale)
    {
        $this->removeTranslation($locale);

        return $this;
    }

    /**
     * @param null $locale
     * @param bool $fallback
     * @return string
     */
    public function getValue($locale = null, $fallback = true)
    {
        return $this->getTranslationFor('value', $locale, $fallback);
    }

    public static function findValue($key, $locale)
    {
        if (!$line = self::findByKey($key)) {
            return null;
        }

        return $line->getValue($locale, false);
    }

    /**
     * @param $key
     * @return mixed
     */
    public static function findByKey($key)
    {
        return self::where('key', $key)->first();
    }

    public function saveSuggestedType()
    {
        // Based on first value found we will suggest a type
        if (!$value = $this->getValue()) {
            return;
        }

        $this->type = (new LineType($value))->suggest();
<?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.");
        }
    }

}
        $this->save();
    }

    public function editInEditor()
    {
        return $this->type == LineType::EDITOR;
<?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.");
        }
    }

}
    }

    public function editInTextarea()
    {
        return $this->type == LineType::TEXTAREA;
<?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.");
        }
    }

}
    }

    public function editInTextinput()
    {
        return (!$this->type || $this->type == LineType::TEXT);
<?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.");
        }
    }

}
    }

    public function areParagraphsAllowed()
    {
        return (false !== strpos($this->allowed_html,'<p>'));
<?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.");
        }
    }

}
    }

    /**
     * Get key - value pairs for all lines per locale
     *
     * @param $locale
     * @return mixed
     */
    public static function getValuesByLocale($locale)
    {
        return self::getValuesByLocaleAndPage($locale);
    }

    public static function getValuesByLocaleAndPage($locale, $pagekey = null)
    {
        $locale = $locale?: app()->getLocale();

        // Since the dimsav translatable model trait injects its behaviour and overwrites our results
        // with the current locale, we will need to fetch results straight from the db instead.
        $lines = DB::table('squanto_lines')
            ->join('squanto_line_translations', 'squanto_lines.id', '=', 'squanto_line_translations.line_id')
            ->select(['squanto_lines.*','squanto_line_translations.locale','squanto_line_translations.value'])
            ->where('squanto_line_translations.locale', $locale);

        if($pagekey)
        {
            $lines = $lines
                ->join('squanto_pages', 'squanto_lines.page_id', '=', 'squanto_pages.id')
                ->where('squanto_pages.key', $pagekey);
        }

        $lines = $lines->get();

        // Assert we have a collection
        $lines = $lines instanceof Collection ? $lines : collect($lines);

        return $lines->pluck('value', 'key')->toArray();
    }
}


1		<?php
2
3		namespace Thinktomorrow\Squanto\Domain;
4
5		use Illuminate\Database\Eloquent\Model;
6		use Dimsav\Translatable\Translatable as BaseTranslatable;
7		use Illuminate\Support\Collection;
8		use Illuminate\Support\Facades\DB;
9
10		/**
11		* Class Line
12		*
13		* @package Thinktomorrow\Squanto\Domain
14		*/
15		class Line extends Model
16		{
17		use BaseTranslatable, Translatable;
18
19	24	public $table = 'squanto_lines';
20		public $translatedAttributes = ['value'];
21	24
22		/**
23	24	* @param $key
24	24	* @return Line
25	24	*/
26	41	public static function make($key)
27		{
28	41	$linekey = new LineKey($key);
29
30	41	$line = new self;
31	17	$line->key = $linekey->get();
		0 ignored issues – show Documentation introduced 2016-10-13 18:48 UTC by Report Bug Copy Issue Report The property `key` does not exist on `object<Thinktomorrow\Squanto\Domain\Line>`. 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...
32	17	$line->label = $linekey->getAsLabel();
		0 ignored issues – show Documentation introduced 2016-10-13 18:48 UTC by Report Bug Copy Issue Report The property `label` does not exist on `object<Thinktomorrow\Squanto\Domain\Line>`. 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...
33	17	$line->page_id = Page::findOrCreateByKey($linekey->getPageKey())->id;
		0 ignored issues – show Documentation introduced 2016-10-13 18:48 UTC by Report Bug Copy Issue Report The property `page_id` does not exist on `object<Thinktomorrow\Squanto\Domain\Line>`. 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...
34
35	17	$line->save();
36
37	25	return $line;
38		}
39	8
40	2	/**
41		* @param $key
42		* @return Line
43	8	*/
44	4	public static function findOrCreateByKey($key)
45		{
46	4	if ($line = self::findByKey($key)) {
47	1	return $line;
48		}
49
50	4	return self::make($key);
51		}
52
53	20	/**
54		* Save a translated value
55	20	*
56		* @param $locale
57	20	* @param $value
58		* @return $this
59		*/
60	15	public function saveValue($locale, $value)
61		{
62	15	$this->saveTranslation($locale, 'value', $value);
63
64	15	return $this;
65		}
66
67		/**
68		* Save a translated value
69		*
70		* @param $locale
71		* @return $this
72		*/
73		public function removeValue($locale)
74		{
75		$this->removeTranslation($locale);
76
77		return $this;
78	16	}
79
80	16	/**
81		* @param null $locale
82		* @param bool $fallback
83		* @return string
84		*/
85	8	public function getValue($locale = null, $fallback = true)
86		{
87	8	return $this->getTranslationFor('value', $locale, $fallback);
88		}
89
90		public static function findValue($key, $locale)
91		{
92		if (!$line = self::findByKey($key)) {
93		return null;
94		}
95
96	26	return $line->getValue($locale, false);
97		}
98	26
99		/**
100		* @param $key
101	8	* @return mixed
102		*/
103	14	public static function findByKey($key)
104	8	{
105	14	return self::where('key', $key)->first();
106		}
107
108	12	public function saveSuggestedType()
109	8	{
110	8	// Based on first value found we will suggest a type
111	4	if (!$value = $this->getValue()) {
112		return;
113		}
114
115	4	$this->type = (new LineType($value))->suggest();
		0 ignored issues – show Documentation introduced 2016-10-13 18:48 UTC by Report Bug Copy Issue Report The property `type` does not exist on `object<Thinktomorrow\Squanto\Domain\Line>`. 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...
116	4	$this->save();
117	4	}
118
119		public function editInEditor()
120		{
121		return $this->type == LineType::EDITOR;
		0 ignored issues – show Documentation introduced 2016-10-13 18:48 UTC by Report Bug Copy Issue Report The property `type` does not exist on `object<Thinktomorrow\Squanto\Domain\Line>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read 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."); } } } If the property has read access only, you can use the @property-read 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...
122		}
123
124		public function editInTextarea()
125		{
126		return $this->type == LineType::TEXTAREA;
		0 ignored issues – show Documentation introduced 2016-10-13 18:48 UTC by Report Bug Copy Issue Report The property `type` does not exist on `object<Thinktomorrow\Squanto\Domain\Line>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read 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."); } } } If the property has read access only, you can use the @property-read 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...
127		}
128
129		public function editInTextinput()
130		{
131		return (!$this->type \|\| $this->type == LineType::TEXT);
		0 ignored issues – show Documentation introduced 2016-10-13 18:48 UTC by Report Bug Copy Issue Report The property `type` does not exist on `object<Thinktomorrow\Squanto\Domain\Line>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read 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."); } } } If the property has read access only, you can use the @property-read 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...
132		}
133
134		public function areParagraphsAllowed()
135		{
136		return (false !== strpos($this->allowed_html,'<p>'));
		0 ignored issues – show Documentation introduced 2016-12-12 13:21 UTC by Report Bug Copy Issue Report The property `allowed_html` does not exist on `object<Thinktomorrow\Squanto\Domain\Line>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read 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."); } } } If the property has read access only, you can use the @property-read 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...
137		}
138
139		/**
140		* Get key - value pairs for all lines per locale
141		*
142		* @param $locale
143		* @return mixed
144		*/
145	4	public static function getValuesByLocale($locale)
146		{
147	4	return self::getValuesByLocaleAndPage($locale);
148		}
149
150	5	public static function getValuesByLocaleAndPage($locale, $pagekey = null)
151		{
152	5	$locale = $locale?: app()->getLocale();
153
154		// Since the dimsav translatable model trait injects its behaviour and overwrites our results
155		// with the current locale, we will need to fetch results straight from the db instead.
156	5	$lines = DB::table('squanto_lines')
157	5	->join('squanto_line_translations', 'squanto_lines.id', '=', 'squanto_line_translations.line_id')
158	5	->select(['squanto_lines.*','squanto_line_translations.locale','squanto_line_translations.value'])
159	5	->where('squanto_line_translations.locale', $locale);
160
161	5	if($pagekey)
162		{
163		$lines = $lines
164	1	->join('squanto_pages', 'squanto_lines.page_id', '=', 'squanto_pages.id')
165	1	->where('squanto_pages.key', $pagekey);
166		}
167
168	5	$lines = $lines->get();
169
170		// Assert we have a collection
171	5	$lines = $lines instanceof Collection ? $lines : collect($lines);
172
173	5	return $lines->pluck('value', 'key')->toArray();
174		}
175		}
176

thinktomorrow / squanto

Push — master ( 8c886d...91409e )

Line::getValuesByLocaleAndPage() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like