nikhil-pandey / guitar-shop

app/Purchase.php

<?php

namespace App;

use App\Events\NotificationWasCreated;
use Carbon\Carbon;
use Illuminate\Database\Eloquent;
use Illuminate\Support\Facades\DB;

/**
 * App\Purchase.
 *
 * @property int $id
 * @property int $supplier_id
 * @property int $make_id
 * @property int $quantity
 * @property float $price
 * @property \Carbon\Carbon $date_purchased
 * @property \Carbon\Carbon $delivery_date
 * @property \Carbon\Carbon $deleted_at
 * @property-read mixed $status
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Guitar[] $guitars
 * @property-read mixed $stored
 * @property-read mixed $pending_storage
 * @property-read mixed $sold
 * @property-read \App\Supplier $supplier
 * @property-read \App\Make $make
 * @property-read \Illuminate\Database\Eloquent\Collection|\App\Notification[] $notifications
 * @method static \Illuminate\Database\Query\Builder|\App\Purchase whereId($value)
 * @method static \Illuminate\Database\Query\Builder|\App\Purchase whereSupplierId($value)
 * @method static \Illuminate\Database\Query\Builder|\App\Purchase whereMakeId($value)
 * @method static \Illuminate\Database\Query\Builder|\App\Purchase whereQuantity($value)
 * @method static \Illuminate\Database\Query\Builder|\App\Purchase wherePrice($value)
 * @method static \Illuminate\Database\Query\Builder|\App\Purchase whereDatePurchased($value)
 * @method static \Illuminate\Database\Query\Builder|\App\Purchase whereDeliveryDate($value)
 * @method static \Illuminate\Database\Query\Builder|\App\Purchase whereDeletedAt($value)
 * @method static \Illuminate\Database\Query\Builder|\App\Purchase delivered()
 * @method static \Illuminate\Database\Query\Builder|\App\Purchase stored()
 * @method static \Illuminate\Database\Query\Builder|\App\Purchase pendingStorage()
 * @mixin \Eloquent
 */
class Purchase extends Eloquent\Model
{
    const UPCOMING = 'upcoming';
    const DELIVERED = 'delivered';
    const COMPLETED = 'completed';

    use Eloquent\SoftDeletes;

    /**
     * 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', 'deleted_at'];

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

    public static function boot()
    {
        parent::boot();

        static::deleting(function (Purchase $purchase) {
            $purchase->guitars()->delete();
            $purchase->notifications()->delete();
        });
    }

    /**
     * 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()) {
            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;
    }

    /**
     * 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;
    }

    /**
     * Number of Guitars Sold.
     *
     * @return int
     */
    public function getSoldAttribute()
    {
        return $this->guitars()->sold()->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;
    }

    /**
     * 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.
     * @return Notification
     */
    public function makeNotification()
    {
        $notification = $this->notifications()->create([
            'icon'    => 'flight_land',
            'link'    => '/purchases/'.$this->id,
            'message' => "Purchase of {$this->quantity} {$this->make->name} has arrived from {$this->supplier->name}, {$this->supplier->location}.",
        ]);

        event(new NotificationWasCreated($notification));

$notification of type object<Illuminate\Database\Eloquent\Model> is not a sub-type of object<App\Notification>. It seems like you assume a child class of the class Illuminate\Database\Eloquent\Model to be always present.

        return $notification;
    }
}