Purchase::notifications() - Code Metrics - Inspection of "Add Guitar Feature" - nikhil-pandey/guitar-shop - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (57668c)

by Nikhil

created 2016-03-27 17:00 UTC

Purchase::notifications() A

↳ Parent: Purchase

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	1
Bugs	0	Features	1

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

<?php

namespace App;

use Carbon\Carbon;
use Illuminate\Database\Eloquent;
use Illuminate\Support\Facades\DB;

class Purchase extends Eloquent\Model
{
    const UPCOMING = 'upcoming';
    const DELIVERED = 'delivered';
    const COMPLETED = 'completed';

    /**
     * We do not want any timestamps.
     *
     * @var bool
     */
    public $timestamps = false;

    /**
     * The attributes that are not mass assignable.
     *
     * @var array
     */
    protected $guarded = [];

    /**
     * Date mutators.
     *
     * @var array
     */
    protected $dates = ['date_purchased', 'delivery_date'];

    /**
     * Default date format.
     *
     * @var string
     */
    protected $dateFormat = 'Y-m-d';

    /**
     * Delivered Scope.
     *
     * @param $query
     *
     * @return Eloquent\Builder
     */
    public function scopeDelivered($query)
    {
        return $query->where('delivery_date', '<=', Carbon::today());
    }

    /**
     * Stored Scope.
     *
     * @param $query
     *
     * @return Eloquent\Builder
     */
    public function scopeStored($query)
    {
        return $query->has('guitars', '=', DB::raw('quantity'));
    }

    /**
     * Pending Storage scope.
     *
     * @param $query
     *
     * @return Eloquent\Builder
     */
    public function scopePendingStorage($query)
    {
        return $query->has('guitars', '<', DB::raw('quantity'));
    }

    /**
     * Get status attribute.
     *
     * @return string
     */
    public function getStatusAttribute()
    {
        if ($this->delivery_date->isFuture()) {
<?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 self::UPCOMING;
        }
        if ( ! $this->isPendingStorage()) {
            return self::COMPLETED;
        }

        return self::DELIVERED;
    }

    /**
     * Has Guitars Pending Storage?
     *
     * @return bool
     */
    public function isPendingStorage()
    {
        return $this->guitars()->count() < $this->quantity;
<?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.");
        }
    }

}
    }

    /**
     * Guitars bought.
     *
     * @return Eloquent\Relations\HasMany
     */
    public function guitars()
    {
        return $this->hasMany(Guitar::class);
    }

    /**
     * Storage attribute.
     *
     * @return int
     */
    public function getStoredAttribute()
    {
        return $this->guitars()->count();
    }

    /**
     * Pending Storage attribute.
     *
     * @return int
     */
    public function getPendingStorageAttribute()
    {
        return $this->quantity - $this->stored;
<?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.");
        }
    }

}
    }

    /**
     * Number of Guitars Sold.
     *
     * @return int
     */
    public function getSoldAttribute()
    {
        return $this->guitars()->unsold()->count();
    }

    /**
     * Whether the purchase has arrived.
     *
     * @return bool
     */
    public function hasArrived()
    {
        return $this->isStatus(self::DELIVERED);
    }

    /**
     * Verify the status.
     *
     * @param $status
     *
     * @return bool
     */
    public function isStatus($status)
    {
        return $this->status == $status;
<?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.");
        }
    }

}
    }

    /**
     * Supplier from which guitars were bought.
     *
     * @return Eloquent\Relations\BelongsTo
     */
    public function supplier()
    {
        return $this->belongsTo(Supplier::class);
    }

    /**
     * Make of the guitars.
     *
     * @return Eloquent\Relations\BelongsTo
     */
    public function make()
    {
        return $this->belongsTo(Make::class);
    }

    /**
     * Notifications about the purchase.
     *
     * @return Eloquent\Relations\MorphMany
     */
    public function notifications()
    {
        return $this->morphMany(Notification::class, 'notifiable');
    }

    /**
     * Create a new notification.
     *
     * @param Notification $notification
     *
     * @return Notification
     */
    public function makeNotification(Notification $notification)
    {
        return $this->notifications()->save($notification);
    }
}


1		<?php
2
3		namespace App;
4
5		use Carbon\Carbon;
6		use Illuminate\Database\Eloquent;
7		use Illuminate\Support\Facades\DB;
8
9		class Purchase extends Eloquent\Model
10		{
11		const UPCOMING = 'upcoming';
12		const DELIVERED = 'delivered';
13		const COMPLETED = 'completed';
14
15		/**
16		* We do not want any timestamps.
17		*
18		* @var bool
19		*/
20		public $timestamps = false;
21
22		/**
23		* The attributes that are not mass assignable.
24		*
25		* @var array
26		*/
27		protected $guarded = [];
28
29		/**
30		* Date mutators.
31		*
32		* @var array
33		*/
34		protected $dates = ['date_purchased', 'delivery_date'];
35
36		/**
37		* Default date format.
38		*
39		* @var string
40		*/
41		protected $dateFormat = 'Y-m-d';
42
43		/**
44		* Delivered Scope.
45		*
46		* @param $query
47		*
48		* @return Eloquent\Builder
49		*/
50		public function scopeDelivered($query)
51		{
52		return $query->where('delivery_date', '<=', Carbon::today());
53		}
54
55		/**
56		* Stored Scope.
57		*
58		* @param $query
59		*
60		* @return Eloquent\Builder
61		*/
62		public function scopeStored($query)
63		{
64		return $query->has('guitars', '=', DB::raw('quantity'));
65		}
66
67		/**
68		* Pending Storage scope.
69		*
70		* @param $query
71		*
72		* @return Eloquent\Builder
73		*/
74		public function scopePendingStorage($query)
75		{
76		return $query->has('guitars', '<', DB::raw('quantity'));
77		}
78
79		/**
80		* Get status attribute.
81		*
82		* @return string
83		*/
84	2	public function getStatusAttribute()
85		{
86	2	if ($this->delivery_date->isFuture()) {
		0 ignored issues – show Documentation introduced 2016-03-20 02:32 UTC by Report Bug Copy Issue Report The property `delivery_date` does not exist on `object<App\Purchase>`. 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...
87	2	return self::UPCOMING;
88		}
89		if ( ! $this->isPendingStorage()) {
90		return self::COMPLETED;
91		}
92
93		return self::DELIVERED;
94		}
95
96		/**
97		* Has Guitars Pending Storage?
98		*
99		* @return bool
100		*/
101		public function isPendingStorage()
102		{
103		return $this->guitars()->count() < $this->quantity;
		0 ignored issues – show Documentation introduced 2016-03-20 02:32 UTC by Report Bug Copy Issue Report The property `quantity` does not exist on `object<App\Purchase>`. 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...
104		}
105
106		/**
107		* Guitars bought.
108		*
109		* @return Eloquent\Relations\HasMany
110		*/
111	1	public function guitars()
112		{
113	1	return $this->hasMany(Guitar::class);
114		}
115
116		/**
117		* Storage attribute.
118		*
119		* @return int
120		*/
121	1	public function getStoredAttribute()
122		{
123	1	return $this->guitars()->count();
124		}
125
126		/**
127		* Pending Storage attribute.
128		*
129		* @return int
130		*/
131		public function getPendingStorageAttribute()
132		{
133		return $this->quantity - $this->stored;
		0 ignored issues – show Documentation introduced 2016-03-27 17:05 UTC by Report Bug Copy Issue Report The property `quantity` does not exist on `object<App\Purchase>`. 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-03-27 17:05 UTC by Report Bug Copy Issue Report The property `stored` does not exist on `object<App\Purchase>`. 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...
134		}
135
136		/**
137		* Number of Guitars Sold.
138		*
139		* @return int
140		*/
141	1	public function getSoldAttribute()
142		{
143	1	return $this->guitars()->unsold()->count();
144		}
145
146		/**
147		* Whether the purchase has arrived.
148		*
149		* @return bool
150		*/
151	1	public function hasArrived()
152		{
153	1	return $this->isStatus(self::DELIVERED);
154		}
155
156		/**
157		* Verify the status.
158		*
159		* @param $status
160		*
161		* @return bool
162		*/
163	1	public function isStatus($status)
164		{
165	1	return $this->status == $status;
		0 ignored issues – show Documentation introduced 2016-03-20 02:32 UTC by Report Bug Copy Issue Report The property `status` does not exist on `object<App\Purchase>`. 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...
166		}
167
168		/**
169		* Supplier from which guitars were bought.
170		*
171		* @return Eloquent\Relations\BelongsTo
172		*/
173		public function supplier()
174		{
175		return $this->belongsTo(Supplier::class);
176		}
177
178		/**
179		* Make of the guitars.
180		*
181		* @return Eloquent\Relations\BelongsTo
182		*/
183	1	public function make()
184		{
185	1	return $this->belongsTo(Make::class);
186		}
187
188		/**
189		* Notifications about the purchase.
190		*
191		* @return Eloquent\Relations\MorphMany
192		*/
193		public function notifications()
194		{
195		return $this->morphMany(Notification::class, 'notifiable');
196		}
197
198		/**
199		* Create a new notification.
200		*
201		* @param Notification $notification
202		*
203		* @return Notification
204		*/
205		public function makeNotification(Notification $notification)
206		{
207		return $this->notifications()->save($notification);
208		}
209		}
210

nikhil-pandey / guitar-shop

GitHub Access Token became invalid

Branch — master (57668c)

Purchase::notifications() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like