Image::generateProps() - Code Metrics - Inspection of "Issue #69. Remove model getters." - zachleigh/larafolio - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — dev ( 40c7a5...93901c )

by Zach

created 2017-02-13 01:53 UTC

Image::generateProps() A

↳ Parent: Image

Complexity

Conditions	1
Paths	1

Size

Total Lines	13
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	10
nc	1
nop	0
dl	0
loc	13
rs	9.4285
c	0
b	0
f	0

<?php

namespace Larafolio\Models;

use Illuminate\Database\Eloquent\Model;

class Image extends Model
{
    /**
     * The table associated with the model.
     *
     * @var string
     */
    protected $table = 'images';

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = ['path', 'name', 'caption', 'alt'];

    /**
     * Get route for thumbnail version of image.
     *
     * @return string
     */
    public function thumbnail()
    {
        return $this->imageRoute('thumbnail');
    }

    /**
     * Get route for small version of image.
     *
     * @return string
     */
    public function small()
    {
        return $this->imageRoute('small');
    }

    /**
     * Get route for medium version of image.
     *
     * @return string
     */
    public function medium()
    {
        return $this->imageRoute('medium');
    }

    /**
     * Get route for full size version of image.
     *
     * @return string
     */
    public function full()
    {
        return $this->imageRoute('full');
    }

    /**
     * Get route for given template image.
     *
     * @param string $templateName Name of image cache template.
     *
     * @return string
     */
    public function imageRoute($templateName)
    {
        return "/manager/images/{$templateName}/{$this->fileName()}";
    }

    /**
     * Get the file name of the image.
     *
     * @return string
     */
    public function fileName()
    {
        return collect(explode('/', $this->path))->last();
<?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.");
        }
    }

}
    }

    /**
     * Return image properties to be passed to js.
     *
     * @return array
     */
    public function generateProps()
    {
        return [
            'thumbnail' => $this->thumbnail(),
            'small'     => $this->small(),
            'medium'    => $this->medium(),
            'full'      => $this->full(),
            'name'      => $this->name,
<?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.");
        }
    }

}
            'caption'   => $this->caption,
<?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.");
        }
    }

}
            'alt'       => $this->alt,
<?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.");
        }
    }

}
            'id'        => $this->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.");
        }
    }

}
        ];
    }
}


1			<?php
2
3			namespace Larafolio\Models;
4
5			use Illuminate\Database\Eloquent\Model;
6
7			class Image extends Model
8			{
9			/**
10			* The table associated with the model.
11			*
12			* @var string
13			*/
14			protected $table = 'images';
15
16			/**
17			* The attributes that are mass assignable.
18			*
19			* @var array
20			*/
21			protected $fillable = ['path', 'name', 'caption', 'alt'];
22
23			/**
24			* Get route for thumbnail version of image.
25			*
26			* @return string
27			*/
28			public function thumbnail()
29			{
30			return $this->imageRoute('thumbnail');
31			}
32
33			/**
34			* Get route for small version of image.
35			*
36			* @return string
37			*/
38			public function small()
39			{
40			return $this->imageRoute('small');
41			}
42
43			/**
44			* Get route for medium version of image.
45			*
46			* @return string
47			*/
48			public function medium()
49			{
50			return $this->imageRoute('medium');
51			}
52
53			/**
54			* Get route for full size version of image.
55			*
56			* @return string
57			*/
58			public function full()
59			{
60			return $this->imageRoute('full');
61			}
62
63			/**
64			* Get route for given template image.
65			*
66			* @param string $templateName Name of image cache template.
67			*
68			* @return string
69			*/
70			public function imageRoute($templateName)
71			{
72			return "/manager/images/{$templateName}/{$this->fileName()}";
73			}
74
75			/**
76			* Get the file name of the image.
77			*
78			* @return string
79			*/
80			public function fileName()
81			{
82			return collect(explode('/', $this->path))->last();
			1 ignored issue – show Documentation introduced 2017-02-13 01:57 UTC by Report Bug Copy Issue Report The property `path` does not exist on `object<Larafolio\Models\Image>`. 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...
83			}
84
85			/**
86			* Return image properties to be passed to js.
87			*
88			* @return array
89			*/
90			public function generateProps()
91			{
92			return [
93			'thumbnail' => $this->thumbnail(),
94			'small' => $this->small(),
95			'medium' => $this->medium(),
96			'full' => $this->full(),
97			'name' => $this->name,
			1 ignored issue – show Documentation introduced 2017-02-13 01:57 UTC by Report Bug Copy Issue Report The property `name` does not exist on `object<Larafolio\Models\Image>`. 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...
98			'caption' => $this->caption,
			1 ignored issue – show Documentation introduced 2017-02-13 01:57 UTC by Report Bug Copy Issue Report The property `caption` does not exist on `object<Larafolio\Models\Image>`. 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...
99			'alt' => $this->alt,
			1 ignored issue – show Documentation introduced 2017-02-13 01:57 UTC by Report Bug Copy Issue Report The property `alt` does not exist on `object<Larafolio\Models\Image>`. 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...
100			'id' => $this->id,
			1 ignored issue – show Documentation introduced 2017-02-13 01:57 UTC by Report Bug Copy Issue Report The property `id` does not exist on `object<Larafolio\Models\Image>`. 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...
101			];
102			}
103			}
104

zachleigh / larafolio

Push — dev ( 40c7a5...93901c )

Image::generateProps() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like