mirror of
https://github.com/invoiceninja/invoiceninja.git
synced 2024-11-10 21:22:58 +01:00
204 lines
8.5 KiB
PHP
204 lines
8.5 KiB
PHP
<?php
|
|
/**
|
|
* Invoice Ninja (https://invoiceninja.com).
|
|
*
|
|
* @link https://github.com/invoiceninja/invoiceninja source repository
|
|
*
|
|
* @copyright Copyright (c) 2023. Invoice Ninja LLC (https://invoiceninja.com)
|
|
*
|
|
* @license https://www.elastic.co/licensing/elastic-license
|
|
*/
|
|
|
|
namespace App\Models;
|
|
|
|
use App\Utils\Traits\MakesHash;
|
|
use Illuminate\Database\Eloquent\SoftDeletes;
|
|
use League\CommonMark\CommonMarkConverter;
|
|
|
|
/**
|
|
* App\Models\Product
|
|
*
|
|
* @property int $id
|
|
* @property int $company_id
|
|
* @property int $user_id
|
|
* @property int|null $assigned_user_id
|
|
* @property int|null $project_id
|
|
* @property int|null $vendor_id
|
|
* @property string|null $custom_value1
|
|
* @property string|null $custom_value2
|
|
* @property string|null $custom_value3
|
|
* @property string|null $custom_value4
|
|
* @property string|null $product_key
|
|
* @property string|null $notes
|
|
* @property string $cost
|
|
* @property string $price
|
|
* @property string $quantity
|
|
* @property string|null $tax_name1
|
|
* @property string $tax_rate1
|
|
* @property string|null $tax_name2
|
|
* @property string $tax_rate2
|
|
* @property string|null $tax_name3
|
|
* @property string $tax_rate3
|
|
* @property int|null $deleted_at
|
|
* @property int|null $created_at
|
|
* @property int|null $updated_at
|
|
* @property int $is_deleted
|
|
* @property int $in_stock_quantity
|
|
* @property int $stock_notification
|
|
* @property int $stock_notification_threshold
|
|
* @property int|null $max_quantity
|
|
* @property string|null $product_image
|
|
* @property-read \App\Models\User|null $assigned_user
|
|
* @property-read \App\Models\Company $company
|
|
* @property-read \Illuminate\Database\Eloquent\Collection<int, \App\Models\Document> $documents
|
|
* @property-read int|null $documents_count
|
|
* @property-read mixed $hashed_id
|
|
* @property-read \App\Models\User $user
|
|
* @property-read \App\Models\Vendor|null $vendor
|
|
* @method static \Illuminate\Database\Eloquent\Builder|BaseModel company()
|
|
* @method static \Illuminate\Database\Eloquent\Builder|BaseModel exclude($columns)
|
|
* @method static \Database\Factories\ProductFactory factory($count = null, $state = [])
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Product filter(\App\Filters\QueryFilters $filters)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Product newModelQuery()
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Product newQuery()
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Product onlyTrashed()
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Product query()
|
|
* @method static \Illuminate\Database\Eloquent\Builder|BaseModel scope()
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Product whereAssignedUserId($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Product whereCompanyId($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Product whereCost($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Product whereCreatedAt($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Product whereCustomValue1($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Product whereCustomValue2($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Product whereCustomValue3($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Product whereCustomValue4($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Product whereDeletedAt($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Product whereId($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Product whereInStockQuantity($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Product whereIsDeleted($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Product whereMaxQuantity($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Product whereNotes($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Product wherePrice($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Product whereProductImage($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Product whereProductKey($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Product whereProjectId($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Product whereQuantity($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Product whereStockNotification($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Product whereStockNotificationThreshold($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Product whereTaxName1($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Product whereTaxName2($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Product whereTaxName3($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Product whereTaxRate1($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Product whereTaxRate2($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Product whereTaxRate3($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Product whereUpdatedAt($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Product whereUserId($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Product whereVendorId($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Product withTrashed()
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Product withoutTrashed()
|
|
* @property-read \Illuminate\Database\Eloquent\Collection<int, \App\Models\Document> $documents
|
|
* @property int|null $tax_id
|
|
* @property-read \Illuminate\Database\Eloquent\Collection<int, \App\Models\Document> $documents
|
|
* @method static \Illuminate\Database\Eloquent\Builder|Product whereTaxId($value)
|
|
* @property-read \Illuminate\Database\Eloquent\Collection<int, \App\Models\Document> $documents
|
|
* @property-read \Illuminate\Database\Eloquent\Collection<int, \App\Models\Document> $documents
|
|
* @property-read \Illuminate\Database\Eloquent\Collection<int, \App\Models\Document> $documents
|
|
* @property-read \Illuminate\Database\Eloquent\Collection<int, \App\Models\Document> $documents
|
|
* @property-read \Illuminate\Database\Eloquent\Collection<int, \App\Models\Document> $documents
|
|
* @property-read \Illuminate\Database\Eloquent\Collection<int, \App\Models\Document> $documents
|
|
* @property-read \Illuminate\Database\Eloquent\Collection<int, \App\Models\Document> $documents
|
|
* @property-read \Illuminate\Database\Eloquent\Collection<int, \App\Models\Document> $documents
|
|
* @property-read \Illuminate\Database\Eloquent\Collection<int, \App\Models\Document> $documents
|
|
* @property-read \Illuminate\Database\Eloquent\Collection<int, \App\Models\Document> $documents
|
|
* @mixin \Eloquent
|
|
*/
|
|
class Product extends BaseModel
|
|
{
|
|
use MakesHash;
|
|
use SoftDeletes;
|
|
use Filterable;
|
|
|
|
public const PRODUCT_TYPE_PHYSICAL = 1;
|
|
public const PRODUCT_TYPE_SERVICE = 2;
|
|
public const PRODUCT_TYPE_DIGITAL = 3;
|
|
public const PRODUCT_TYPE_SHIPPING = 4;
|
|
public const PRODUCT_TYPE_EXEMPT = 5;
|
|
public const PRODUCT_TYPE_REDUCED_TAX = 6;
|
|
public const PRODUCT_TYPE_OVERRIDE_TAX = 7;
|
|
public const PRODUCT_TYPE_ZERO_RATED = 8;
|
|
public const PRODUCT_TYPE_REVERSE_TAX = 9;
|
|
|
|
protected $fillable = [
|
|
'custom_value1',
|
|
'custom_value2',
|
|
'custom_value3',
|
|
'custom_value4',
|
|
'product_key',
|
|
'notes',
|
|
'cost',
|
|
'price',
|
|
'quantity',
|
|
'tax_name1',
|
|
'tax_name2',
|
|
'tax_name3',
|
|
'tax_rate1',
|
|
'tax_rate2',
|
|
'tax_rate3',
|
|
'in_stock_quantity',
|
|
'stock_notification_threshold',
|
|
'stock_notification',
|
|
'max_quantity',
|
|
'product_image',
|
|
'tax_id',
|
|
];
|
|
|
|
protected $touches = [];
|
|
|
|
public function getEntityType()
|
|
{
|
|
return self::class;
|
|
}
|
|
|
|
public function company()
|
|
{
|
|
return $this->belongsTo(Company::class);
|
|
}
|
|
|
|
public function user()
|
|
{
|
|
return $this->belongsTo(User::class)->withTrashed();
|
|
}
|
|
|
|
public function vendor()
|
|
{
|
|
return $this->belongsTo(Vendor::class)->withTrashed();
|
|
}
|
|
|
|
public function assigned_user()
|
|
{
|
|
return $this->belongsTo(User::class, 'assigned_user_id', 'id')->withTrashed();
|
|
}
|
|
|
|
public function documents()
|
|
{
|
|
return $this->morphMany(Document::class, 'documentable');
|
|
}
|
|
|
|
public function translate_entity()
|
|
{
|
|
return ctrans('texts.product');
|
|
}
|
|
|
|
public function markdownNotes()
|
|
{
|
|
$converter = new CommonMarkConverter([
|
|
'allow_unsafe_links' => false,
|
|
'renderer' => [
|
|
'soft_break' => '<br>',
|
|
],
|
|
]);
|
|
|
|
return $converter->convert($this->notes);
|
|
}
|
|
}
|