@fleetbase/storefront-engine 0.1.7 → 0.1.9

package/server/src/Models/Product.php

@@ -0,0 +1,315 @@
+<?php
+
+namespace Fleetbase\Storefront\Models;
+
+use Fleetbase\Casts\Json;
+use Fleetbase\Models\Category;
+use Fleetbase\Models\File;
+use Fleetbase\Models\User;
+use Fleetbase\FleetOps\Support\Utils;
+use Fleetbase\Traits\HasMetaAttributes;
+use Fleetbase\Traits\HasUuid;
+use Fleetbase\Traits\HasApiModelBehavior;
+use Fleetbase\Traits\HasPublicid;
+use Fleetbase\Traits\Searchable;
+use Illuminate\Support\Str;
+use Spatie\Sluggable\HasSlug;
+use Spatie\Sluggable\SlugOptions;
+use Milon\Barcode\Facades\DNS2DFacade as DNS2D;
+
+class ProductStatus
+{
+    public const AVAILABLE = 'available';
+    public const DRAFT = 'draft';
+}
+
+class Product extends StorefrontModel
+{
+    use HasUuid, HasPublicid, HasApiModelBehavior, HasMetaAttributes, HasSlug, Searchable;
+
+    /**
+     * The type of public Id to generate
+     *
+     * @var string
+     */
+    protected $publicIdType = 'product';
+
+    /**
+     * The database table used by the model.
+     *
+     * @var string
+     */
+    protected $table = 'products';
+
+    /**
+     * These attributes that can be queried
+     *
+     * @var array
+     */
+    protected $searchableColumns = ['name', 'description'];
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = [
+        'company_uuid',
+        'primary_image_uuid',
+        'created_by_uuid',
+        'store_uuid',
+        'category_uuid',
+        'name',
+        'description',
+        'tags',
+        'translations',
+        'meta',
+        'qr_code',
+        'barcode',
+        'youtube_urls',
+        'sku',
+        'price',
+        'currency',
+        'sale_price',
+        'is_service',
+        'is_bookable',
+        'is_available',
+        'is_on_sale',
+        'is_recommended',
+        'can_pickup',
+        'status',
+        'slug'
+    ];
+
+    /**
+     * The attributes that should be cast to native types.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'is_service' => 'boolean',
+        'is_bookable' => 'boolean',
+        'is_on_sale' => 'boolean',
+        'is_available' => 'boolean',
+        'is_recommended' => 'boolean',
+        'can_pickup' => 'boolean',
+        'tags' => 'array',
+        'meta' => Json::class,
+        'translations' => Json::class,
+        'youtube_urls' => Json::class
+    ];
+
+    /**
+     * Dynamic attributes that are appended to object
+     *
+     * @var array
+     */
+    protected $appends = ['primary_image_url', 'store_id', 'meta_array'];
+
+    /**
+     * Attributes that is filterable on this model
+     *
+     * @var array
+     */
+    protected $filterParams = ['category_slug', 'category'];
+
+    /**
+     * Generates QR Code & Barcode on creation.
+     *
+     * @return void
+     */
+    public static function boot()
+    {
+        parent::boot();
+        static::creating(function ($model) {
+            $model->qr_code = DNS2D::getBarcodePNG($model->uuid, 'QRCODE');
+            $model->barcode = DNS2D::getBarcodePNG($model->uuid, 'PDF417');
+        });
+    }
+
+    /**
+     * @var \Spatie\Sluggable\SlugOptions
+     */
+    public function getSlugOptions(): SlugOptions
+    {
+        return SlugOptions::create()
+            ->generateSlugsFrom('name')
+            ->saveSlugsTo('slug');
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function createdBy()
+    {
+        return $this->setConnection(config('fleetbase.connection.db'))->belongsTo(User::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function category()
+    {
+        return $this->setConnection(config('fleetbase.connection.db'))->belongsTo(Category::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     */
+    public function addonCategories()
+    {
+        return $this->hasMany(ProductAddonCategory::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     */
+    public function variants()
+    {
+        return $this->hasMany(ProductVariant::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function primaryImage()
+    {
+        return $this->setConnection(config('fleetbase.connection.db'))->belongsTo(File::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     */
+    public function files()
+    {
+        return $this->setConnection(config('fleetbase.connection.db'))->hasMany(File::class, 'subject_uuid');
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     */
+    public function reviews()
+    {
+        return $this->hasMany(Review::class, 'subject_uuid');
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     */
+    public function votes()
+    {
+        return $this->hasMany(Vote::class, 'subject_uuid');
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     */
+    public function hours()
+    {
+        return $this->hasMany(ProductHour::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function store()
+    {
+        return $this->belongsTo(Store::class);
+    }
+
+    /**
+     * @return array
+     */
+    public function getMetaArrayAttribute()
+    {
+        $_meta = [];
+
+        if (empty($this->meta)) {
+            return $_meta;
+        }
+
+        foreach ($this->meta as $key => $value) {
+            $_meta[] = [
+                'key' => Str::snake($key),
+                'label' => Utils::smartHumanize($key),
+                'value' => $value
+            ];
+        }
+
+        return $_meta;
+    }
+
+    /**
+     * @return string
+     */
+    public function getPrimaryImageUrlAttribute()
+    {
+        $default = $this->primaryImage->url ?? null;
+        $secondary = $this->files->first()->url ?? null;
+        $backup = 'https://flb-assets.s3.ap-southeast-1.amazonaws.com/static/image-file-icon.png';
+
+        return $default ?? $secondary ?? $backup;
+    }
+
+    /**
+     * @return string
+     */
+    public function getStoreIdAttribute()
+    {
+        return static::attributeFromCache($this, 'store.public_id', function () {
+            return $this->store()->select(['public_id'])->first()->public_id;
+        });
+    }
+
+    /**
+     * Set the price as only numbers
+     *
+     * @void
+     */
+    public function setPriceAttribute($value)
+    {
+        $this->attributes['price'] = Utils::numbersOnly($value);
+    }
+
+    /**
+     * Set the sale price as only numbers
+     *
+     * @void
+     */
+    public function setSalePriceAttribute($value)
+    {
+        $this->attributes['sale_price'] = Utils::numbersOnly($value);
+    }
+
+    /**
+     * Finds products that match the specified search query, store, and network.
+     *
+     * @param string $search The search query to use to find products.
+     * @param string|null $store The store to search for products in. If null, all stores are searched.
+     * @param int $limit The maximum number of products to return.
+     * @param string|null $network The network to search for products on. If null, the session network is used.
+     *
+     * @return \Illuminate\Database\Eloquent\Collection The collection of products that match the search query, store, and network.
+     */
+    public static function findFromNetwork($search, $store = null, $limit = 20, $network = null): ?\Illuminate\Database\Eloquent\Collection
+    {
+        $network = session('storefront_network', $network);
+
+        $results = static::whereHas('store', function ($query) use ($network, $store) {
+            if ($store) {
+                $query->where('public_id', $store);
+            }
+
+            $query->whereHas('networks', function ($networksQuery) use ($network) {
+                $networksQuery->where('network_uuid', $network);
+            });
+        })
+            ->search($search)
+            ->whereIsAvailable(1)
+            ->whereStatus('published')
+            ->limit($limit)
+            ->get();
+
+        return $results;
+    }
+}

package/server/src/Models/ProductAddon.php

@@ -0,0 +1,128 @@
+<?php
+
+namespace Fleetbase\Storefront\Models;
+
+use Fleetbase\Casts\Json;
+use Fleetbase\Models\Category;
+use Fleetbase\Models\User;
+use Fleetbase\FleetOps\Support\Utils;
+use Fleetbase\Traits\HasUuid;
+use Fleetbase\Traits\HasApiModelBehavior;
+use Fleetbase\Traits\HasPublicid;
+use Spatie\Sluggable\HasSlug;
+use Spatie\Sluggable\SlugOptions;
+
+class ProductAddon extends StorefrontModel
+{
+    use HasUuid, HasPublicid, HasApiModelBehavior, HasSlug;
+
+    /**
+     * The type of public Id to generate
+     *
+     * @var string
+     */
+    protected $publicIdType = 'addon';
+
+    /**
+     * The database table used by the model.
+     *
+     * @var string
+     */
+    protected $table = 'product_addons';
+
+    /**
+     * These attributes that can be queried
+     *
+     * @var array
+     */
+    protected $searchableColumns = ['name', 'description'];
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = [
+        'public_id',
+        'created_by_uuid',
+        'category_uuid',
+        'name',
+        'description',
+        'translations',
+        'price',
+        'sale_price',
+        'is_on_sale',
+        'slug'
+    ];
+
+    /**
+     * The attributes that should be cast to native types.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'is_on_sale' => 'boolean',
+        'translations' => Json::class
+    ];
+
+    /**
+     * Dynamic attributes that are appended to object
+     *
+     * @var array
+     */
+    protected $appends = [];
+
+    /**
+     * @var \Spatie\Sluggable\SlugOptions
+     */
+    public function getSlugOptions(): SlugOptions
+    {
+        return SlugOptions::create()
+            ->generateSlugsFrom('name')
+            ->saveSlugsTo('slug');
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function createdBy()
+    {
+        return $this->setConnection(config('fleetbase.connection.db'))->belongsTo(User::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function category()
+    {
+        return $this->setConnection(config('fleetbase.connection.db'))->belongsTo(Category::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function store()
+    {
+        return $this->belongsTo(Store::class);
+    }
+
+    /**
+     * Set the price as only numbers
+     *
+     * @void
+     */
+    public function setPriceAttribute($value)
+    {
+        $this->attributes['price'] = Utils::numbersOnly($value);
+    }
+
+    /**
+     * Set the sale price as only numbers
+     *
+     * @void
+     */
+    public function setSalePriceAttribute($value)
+    {
+        $this->attributes['sale_price'] = Utils::numbersOnly($value);
+    }
+}

package/server/src/Models/ProductAddonCategory.php

@@ -0,0 +1,90 @@
+<?php
+
+namespace Fleetbase\Storefront\Models;
+
+use Fleetbase\Casts\Json;
+use Fleetbase\Traits\HasUuid;
+use Fleetbase\Traits\HasApiModelBehavior;
+
+class ProductAddonCategory extends StorefrontModel
+{
+    use HasUuid, HasApiModelBehavior;
+
+    /**
+     * The database table used by the model.
+     *
+     * @var string
+     */
+    protected $table = 'product_addon_categories';
+
+    /**
+     * These attributes that can be queried
+     *
+     * @var array
+     */
+    protected $searchableColumns = [];
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = [
+        'product_uuid',
+        'category_uuid',
+        'exluded_addons',
+        'max_selectable'
+    ];
+
+    /**
+     * The attributes that should be cast to native types.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'exluded_addons' => Json::class
+    ];
+
+    /**
+     * Dynamic attributes that are appended to object
+     *
+     * @var array
+     */
+    protected $appends = ['name'];
+
+    /**
+     * Dynamic attributes should be hidden
+     *
+     * @var array
+     */
+    protected $hidden = ['product'];
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function category()
+    {
+        return $this->setConnection(config('fleetbase.connection.db'))->belongsTo(AddonCategory::class)->with(['addons']);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function product()
+    {
+        return $this->belongsTo(Product::class);
+    }
+
+    /**
+     * @var string
+     */
+    public function getNameAttribute()
+    {
+        return static::attributeFromCache($this, 'category.name');
+    }
+
+    public function getExcludedAddonsAttribute($excluded)
+    {
+        return Json::decode($excluded);
+    }
+}

package/server/src/Models/ProductHour.php

@@ -0,0 +1,59 @@
+<?php
+
+namespace Fleetbase\Storefront\Models;
+
+use Fleetbase\Traits\HasUuid;
+use Fleetbase\Traits\HasApiModelBehavior;
+
+class ProductHour extends StorefrontModel
+{
+    use HasUuid, HasApiModelBehavior;
+
+    /**
+     * The database table used by the model.
+     *
+     * @var string
+     */
+    protected $table = 'product_hours';
+
+    /**
+     * These attributes that can be queried
+     *
+     * @var array
+     */
+    protected $searchableColumns = [];
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = [
+        'product_uuid',
+        'day_of_week',
+        'start',
+        'end'
+    ];
+
+    /**
+     * The attributes that should be cast to native types.
+     *
+     * @var array
+     */
+    protected $casts = [];
+
+    /**
+     * Dynamic attributes that are appended to object
+     *
+     * @var array
+     */
+    protected $appends = [];
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function product()
+    {
+        return $this->belongsTo(Product::class);
+    }
+}

package/server/src/Models/ProductStoreLocation.php

@@ -0,0 +1,77 @@
+<?php
+
+namespace Fleetbase\Storefront\Models;
+
+use Fleetbase\Traits\HasUuid;
+use Fleetbase\Traits\HasApiModelBehavior;
+use Spatie\Sluggable\HasSlug;
+use Spatie\Sluggable\SlugOptions;
+
+class ProductStoreLocation extends StorefrontModel
+{
+    use HasUuid, HasApiModelBehavior, HasSlug;
+
+    /**
+     * The database table used by the model.
+     *
+     * @var string
+     */
+    protected $table = 'product_store_locations';
+
+    /**
+     * These attributes that can be queried
+     *
+     * @var array
+     */
+    protected $searchableColumns = [];
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = [
+        'product_uuid',
+        'store_location_uuid'
+    ];
+
+    /**
+     * The attributes that should be cast to native types.
+     *
+     * @var array
+     */
+    protected $casts = [];
+
+    /**
+     * Dynamic attributes that are appended to object
+     *
+     * @var array
+     */
+    protected $appends = [];
+
+    /**
+     * @var \Spatie\Sluggable\SlugOptions
+     */
+    public function getSlugOptions(): SlugOptions
+    {
+        return SlugOptions::create()
+            ->generateSlugsFrom('name')
+            ->saveSlugsTo('slug');
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function product()
+    {
+        return $this->belongsTo(Product::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function storeLocation()
+    {
+        return $this->belongsTo(StoreLocation::class);
+    }
+}