One Hat Cyber Team

View File Name : Proposal.php

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Collection;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Database\Eloquent\Relations\MorphMany;
use Illuminate\Database\Eloquent\Relations\MorphToMany;
use Illuminate\Support\Carbon;
use Illuminate\Support\Str;

/**
 * App\Models\Proposal
 *
 * @property int $id
 * @property string $proposal_number
 * @property string $title
 * @property int $related
 * @property Carbon $date
 * @property Carbon|null $open_till
 * @property int $currency
 * @property int|null $discount_type
 * @property int $status
 * @property int|null $assigned_user_id
 * @property string|null $phone
 * @property float|null $discount
 * @property int $unit
 * @property float|null $sub_total
 * @property float $adjustment
 * @property float|null $total_amount
 * @property int|null $payment_status
 * @property int|null $discount_symbol
 * @property Carbon|null $created_at
 * @property Carbon|null $updated_at
 * @property-read Collection|ProposalAddress[] $proposalAddresses
 * @property-read int|null $proposal_addresses_count
 * @property-read Collection|SalesItem[] $salesItems
 * @property-read int|null $sales_items_count
 * @property-read Collection|SalesTax[] $salesTaxes
 * @property-read int|null $sales_taxes_count
 * @property-read Collection|Tag[] $tags
 * @property-read int|null $tags_count
 * @property-read User|null $user
 *
 * @method static Builder|Proposal newModelQuery()
 * @method static Builder|Proposal newQuery()
 * @method static Builder|Proposal query()
 * @method static Builder|Proposal whereAdjustment($value)
 * @method static Builder|Proposal whereAssignedUserId($value)
 * @method static Builder|Proposal whereCreatedAt($value)
 * @method static Builder|Proposal whereCurrency($value)
 * @method static Builder|Proposal whereDate($value)
 * @method static Builder|Proposal whereDiscount($value)
 * @method static Builder|Proposal whereDiscountType($value)
 * @method static Builder|Proposal whereId($value)
 * @method static Builder|Invoice whereProposalNumber($value)
 * @method static Builder|Proposal whereOpenTill($value)
 * @method static Builder|Proposal wherePaymentStatus($value)
 * @method static Builder|Proposal wherePhone($value)
 * @method static Builder|Proposal whereRelated($value)
 * @method static Builder|Proposal whereStatus($value)
 * @method static Builder|Proposal whereSubTotal($value)
 * @method static Builder|Proposal whereTitle($value)
 * @method static Builder|Proposal whereTotalAmount($value)
 * @method static Builder|Proposal whereUnit($value)
 * @method static Builder|Proposal whereUpdatedAt($value)
 * @method static Builder|Proposal whereOwnerType($value)
 * @method static Builder|Proposal whereOwnerId($value)
 * @mixin Model
 *
 * @property int|null $related_to
 * @property int|null $owner_id
 * @property string|null $owner_type
 *
 * @method static Builder|Proposal whereRelatedTo($value)
 */
class Proposal extends Model implements \App\Models\Contracts\Taggable
{
    const STATUS = [
        5 => 'Accepted',
        4 => 'Declined',
        1 => 'Drafted',
        2 => 'Open',
        3 => 'Revised',
    ];

    const STATUS_COLOR = [
        1 => 'warning',
        2 => 'danger',
        3 => 'primary',
        4 => 'info',
        5 => 'success',
    ];

    const STATUS_DRAFT = 1;

    const STATUS_OPEN = 2;

    const STATUS_REVISED = 3;

    const STATUS_DECLINED = 4;

    const STATUS_ACCEPTED = 5;

    const CLIENT_STATUS = [
        5 => 'Accepted',
        4 => 'Declined',
        2 => 'Open',
        3 => 'Revised',
    ];

    const RELATED_TO = [
        1 => Lead::class,
        2 => Customer::class,
    ];

    const RELATED_TO_array = [
        2 => 'Customer',
        1 => 'Lead',
    ];

    /**
     * Validation rules
     *
     * @var array
     */
    public static $rules = [
        'proposal_number' => 'required|unique:proposals,proposal_number',
        'phone' => 'nullable|unique:proposals,phone',
        'title' => 'required',
        'related_to' => 'required',
        'date' => 'required',
        'currency' => 'required',
        'discount_type' => 'required',
        'unit' => 'required',
        'status' => 'required',
        'assigned_user_id' => 'required',
        'owner_id' => 'required',
        'itemsArr' => 'required|array',
        'itemsArr.*.item' => 'required',
        'itemsArr.*.quantity' => 'required',
        'itemsArr.*.rate' => 'required',
    ];

    /**
     * @var array
     */
    public static $messages = [
        'related_to.required' => 'Related field is required.',
        'assigned_user_id.required' => 'Member field is required',
        'itemsArr.required' => 'Atleast one product is required.',
        'itemsArr.*.item.required' => 'Product field is required.',
        'itemsArr.*.quantity.required' => 'Quantity field is required',
        'itemsArr.*.rate.required' => 'Rate field is required',
    ];

    /**
     * @var string
     */
    protected $table = 'proposals';

    /**
     * @var array
     */
    protected $fillable = [
        'proposal_number',
        'title',
        'related_to',
        'date',
        'open_till',
        'currency',
        'discount_type',
        'status',
        'assigned_user_id',
        'phone',
        'unit',
        'total_amount',
        'sub_total',
        'discount',
        'adjustment',
        'payment_status',
        'owner_id',
        'owner_type',
        'discount_symbol',
        'hsn_tax',
    ];

    /**
     * The attributes that should be casted to native types.
     *
     * @var array
     */
    protected $casts = [
        'id' => 'integer',
        'proposal_number' => 'string',
        'title' => 'string',
        'related_to' => 'integer',
        'date' => 'datetime',
        'open_till' => 'datetime',
        'currency' => 'integer',
        'discount_type' => 'integer',
        'status' => 'integer',
        'user_id' => 'integer',
        'phone' => 'string',
        'admin_text' => 'string',
        'total_amount' => 'double',
        'sub_total' => 'double',
        'discount' => 'double',
        'adjustment' => 'double',
        'owner_id' => 'integer',
        'owner_type' => 'string',
        'discount_symbol' => 'integer',
        'unit' => 'integer',
        'hsn_tax' => 'string',
    ];

    /**
     * @return string
     */
    public static function generateUniqueProposalId(): string
    {
        $proposalId = mb_strtoupper(Str::random(6));

        while (true) {
            $isExist = self::whereProposalNumber($proposalId)->exists();
            if ($isExist) {
                self::generateUniqueProposalId();
            }
            break;
        }

        return $proposalId;
    }

    /**
     * @param  int  $currencyId
     * @return string
     */
    public static function getCurrencyText($currencyId): string
    {
        return Customer::CURRENCIES[$currencyId];
    }

    /**
     * @return HasMany
     */
    public function proposalAddresses(): HasMany
    {
        return $this->hasMany(ProposalAddress::class);
    }

    /**
     * @return MorphToMany
     */
    public function tags(): MorphToMany
    {
        return $this->morphToMany(Tag::class, 'taggable');
    }

    /**
     * @return int
     */
    public function getId(): int
    {
        return $this->id;
    }

    /**
     * @return string
     */
    public function getOwnerType(): string
    {
        return self::class;
    }

    /**
     * @return BelongsTo
     */
    public function user(): BelongsTo
    {
        return $this->belongsTo(User::class, 'assigned_user_id');
    }

    /**
     * @return MorphMany
     */
    public function salesItems(): MorphMany
    {
        return $this->morphMany(SalesItem::class, 'owner');
    }

    /**
     * @return MorphMany
     */
    public function salesTaxes(): MorphMany
    {
        return $this->morphMany(SalesTax::class, 'owner');
    }

    /**
     * @param  int  $discountTypeId
     * @return string
     */
    public function getDiscountTypeText($discountTypeId): string
    {
        return $this->discountType()[$discountTypeId];
    }

    /**
     * @return array
     */
    public static function discountType(): array
    {
        return [
            '0' => 'No Discount',
            '1' => 'Before Tax',
            '2' => 'After Tax',
        ];
    }

    /**
     * @param  int  $relatedId
     * @return string
     */
    public function getRelatedText($relatedId): string
    {
        return self::RELATED_TO_array[$relatedId];
    }

    /**
     * @param  int  $statusId
     * @return string
     */
    public function getStatusText($statusId): string
    {
        return self::STATUS[$statusId];
    }

    /**
     * @return BelongsTo
     */
    public function customer(): BelongsTo
    {
        return $this->belongsTo(Customer::class, 'owner_id');
    }

    /**
     * @return BelongsTo
     */
    public function lead(): BelongsTo
    {
        return $this->belongsTo(Lead::class, 'owner_id');
    }
}