Preference::__toString() - Code Metrics - Inspection of "Remove deprecated method" - timegridio/concierge - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e7ba61...b98dcf )

by Ariel

created 2016-02-11 17:37 UTC

Preference::__toString() A

↳ Parent: Preference

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	2
Bugs	0	Features	0

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

<?php

namespace Timegridio\Concierge\Models;

use Illuminate\Database\Eloquent\Model as EloquentModel;

class Preference extends EloquentModel
{
    /**
     * [$fillable description].
     *
     * @var [type]
     */
    protected $fillable = ['key', 'value', 'type'];

    /**
     * [getDefault description].
     *
     * @param \Timegridio\Concierge\Traits\Preferenceable $model [description]

     * @param [type] $key   [description]

     *
     * @return [type] [description]

     */
    public static function getDefault($model, $key)
    {
        $class = get_class($model);
        $value = config("preferences.{$class}.{$key}.value");
        $type = config("preferences.{$class}.{$key}.type");

        return new self([
            'key'                 => $key,
            'value'               => $value,
            'type'                => $type,
            'preferenceable_type' => $class,
            'preferenceable_id'   => $model,
            ]);
    }

    /**
     * [question description].
     *
     * @return [type] [description]

     */
    public function question()
    {
        return trans("preferences.{$this->preferenceable_type}.question.{$this->key}");
<?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.");
        }
    }

}
    }

    /**
     * [help description].
     *
     * @return [type] [description]

     */
    public function help()
    {
        return trans("preferences.{$this->preferenceable_type}.help.{$this->key}");
<?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.");
        }
    }

}
    }

    /**
     * [scopeForKey description].
     *
     * @param [type] $query [description]

     * @param [type] $key   [description]

     *
     * @return [type] [description]

     */
    public function scopeForKey($query, $key)
    {
        return $query->where('key', $key);
    }

    /**
     * Value getter.
     *
     * @return mixed
     */
    public function value()
    {
        return $this->value;
<?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.");
        }
    }

}
    }

    /**
     * Type getter.
     *
     * @return string
     */
    public function type()
    {
        return $this->type;
<?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.");
        }
    }

}
    }
}


1		<?php
2
3		namespace Timegridio\Concierge\Models;
4
5		use Illuminate\Database\Eloquent\Model as EloquentModel;
6
7		class Preference extends EloquentModel
8		{
9		/**
10		* [$fillable description].
11		*
12		* @var [type]
13		*/
14		protected $fillable = ['key', 'value', 'type'];
15
16		/**
17		* [getDefault description].
18		*
19		* @param \Timegridio\Concierge\Traits\Preferenceable $model [description]
		0 ignored issues – show introduced 2016-02-06 12:21 UTC by Report Bug Copy Issue Report The type `\Timegridio\Concierge\Traits\Preferenceable` for parameter `$model` is a trait, and thus cannot be used for type-hinting in PHP. Maybe consider adding an interface and use that for type-hinting? Loading history...
20		* @param [type] $key [description]
		0 ignored issues – show Documentation introduced 2016-02-03 04:24 UTC by Report Bug Copy Issue Report The doc-type `[type]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
21		*
22		* @return [type] [description]
		0 ignored issues – show Documentation introduced 2016-02-11 17:52 UTC by Report Bug Copy Issue Report The doc-type `[type]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
23		*/
24	1	public static function getDefault($model, $key)
25		{
26	1	$class = get_class($model);
27	1	$value = config("preferences.{$class}.{$key}.value");
28	1	$type = config("preferences.{$class}.{$key}.type");
29
30	1	return new self([
31	1	'key' => $key,
32	1	'value' => $value,
33	1	'type' => $type,
34	1	'preferenceable_type' => $class,
35	1	'preferenceable_id' => $model,
36	1	]);
37		}
38
39		/**
40		* [question description].
41		*
42		* @return [type] [description]
		0 ignored issues – show Documentation introduced 2016-02-03 04:24 UTC by Report Bug Copy Issue Report The doc-type `[type]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
43		*/
44		public function question()
45		{
46		return trans("preferences.{$this->preferenceable_type}.question.{$this->key}");
		0 ignored issues – show Documentation introduced 2016-02-03 04:24 UTC by Report Bug Copy Issue Report The property `preferenceable_type` does not exist on `object<Timegridio\Concierge\Models\Preference>`. 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... Documentation introduced 2016-02-03 04:24 UTC by Report Bug Copy Issue Report The property `key` does not exist on `object<Timegridio\Concierge\Models\Preference>`. 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...
47		}
48
49		/**
50		* [help description].
51		*
52		* @return [type] [description]
		0 ignored issues – show Documentation introduced 2016-02-11 17:31 UTC by Report Bug Copy Issue Report The doc-type `[type]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
53		*/
54		public function help()
55		{
56		return trans("preferences.{$this->preferenceable_type}.help.{$this->key}");
		0 ignored issues – show Documentation introduced 2016-02-03 04:24 UTC by Report Bug Copy Issue Report The property `preferenceable_type` does not exist on `object<Timegridio\Concierge\Models\Preference>`. 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... Documentation introduced 2016-02-03 04:24 UTC by Report Bug Copy Issue Report The property `key` does not exist on `object<Timegridio\Concierge\Models\Preference>`. 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...
57		}
58
59		/**
60		* [scopeForKey description].
61		*
62		* @param [type] $query [description]
		0 ignored issues – show Documentation introduced 2016-02-03 04:24 UTC by Report Bug Copy Issue Report The doc-type `[type]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
63		* @param [type] $key [description]
		0 ignored issues – show Documentation introduced 2016-02-03 04:24 UTC by Report Bug Copy Issue Report The doc-type `[type]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
64		*
65		* @return [type] [description]
		0 ignored issues – show Documentation introduced 2016-02-03 04:24 UTC by Report Bug Copy Issue Report The doc-type `[type]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
66		*/
67	7	public function scopeForKey($query, $key)
68		{
69	7	return $query->where('key', $key);
70		}
71
72		/**
73		* Value getter.
74		*
75		* @return mixed
76		*/
77	7	public function value()
78		{
79	7	return $this->value;
		0 ignored issues – show Documentation introduced 2016-02-03 04:24 UTC by Report Bug Copy Issue Report The property `value` does not exist on `object<Timegridio\Concierge\Models\Preference>`. 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...
80		}
81
82		/**
83		* Type getter.
84		*
85		* @return string
86		*/
87	7	public function type()
88		{
89	7	return $this->type;
		0 ignored issues – show Documentation introduced 2016-02-03 04:24 UTC by Report Bug Copy Issue Report The property `type` does not exist on `object<Timegridio\Concierge\Models\Preference>`. 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...
90		}
91		}
92

timegridio / concierge

Push — master ( e7ba61...b98dcf )

Preference::__toString() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like