@fleetbase/storefront-engine 0.2.4 → 0.2.6

package/server/src/Models/Gateway.php

@@ -3,20 +3,22 @@
 namespace Fleetbase\Storefront\Models;
 
 use Fleetbase\Casts\Json;
-use Fleetbase\Models\User;
+use Fleetbase\FleetOps\Support\Utils;
 use Fleetbase\Models\Company;
 use Fleetbase\Models\File;
-use Fleetbase\FleetOps\Support\Utils;
-use Fleetbase\Traits\HasUuid;
+use Fleetbase\Models\User;
 use Fleetbase\Traits\HasApiModelBehavior;
 use Fleetbase\Traits\HasPublicid;
+use Fleetbase\Traits\HasUuid;
 
 class Gateway extends StorefrontModel
 {
-    use HasUuid, HasPublicid, HasApiModelBehavior;
+    use HasUuid;
+    use HasPublicid;
+    use HasApiModelBehavior;
 
     /**
-     * The type of public Id to generate
+     * The type of public Id to generate.
      *
      * @var string
      */
@@ -30,7 +32,7 @@ class Gateway extends StorefrontModel
     protected $table = 'gateways';
 
     /**
-     * These attributes that can be queried
+     * These attributes that can be queried.
      *
      * @var array
      */
@@ -50,12 +52,12 @@ class Gateway extends StorefrontModel
      */
     protected $casts = [
         'sandbox' => 'boolean',
-        'meta' => Json::class,
-        'config' => Json::class
+        'meta'    => Json::class,
+        'config'  => Json::class,
     ];
 
     /**
-     * Dynamic attributes that are appended to object
+     * Dynamic attributes that are appended to object.
      *
      * @var array
      */
@@ -106,13 +108,13 @@ class Gateway extends StorefrontModel
     public function getLogoUrlAttribute()
     {
         $default = $this->logoFile->url ?? null;
-        $backup = 'https://flb-assets.s3.ap-southeast-1.amazonaws.com/static/image-file-icon.png';
+        $backup  = 'https://flb-assets.s3.ap-southeast-1.amazonaws.com/static/image-file-icon.png';
 
         return $default ?? $backup;
     }
 
     /**
-     * Sets the owner type
+     * Sets the owner type.
      */
     public function setOwnerTypeAttribute($type)
     {
@@ -121,7 +123,7 @@ class Gateway extends StorefrontModel
 
     public function getConfigAttribute($config)
     {
-        $config = Json::decode($config);
+        $config     = Json::decode($config);
         $sortedKeys = collect($config)->keys()->sort(function ($key) use ($config) {
             return Utils::isBooleanValue($config[$key]) ? 1 : 0;
         });
@@ -145,21 +147,19 @@ class Gateway extends StorefrontModel
     }
 
     /**
-     * Generates a new cash/cash on delivery gateway
-     *
-     * @return Gateway
+     * Generates a new cash/cash on delivery gateway.
      */
     public static function cash($attributes = ['sandbox' => 0]): Gateway
     {
         return new static([
-            'public_id' => 'gateway_cash',
-            'name' => 'Cash',
-            'code' => 'cash',
-            'type' => 'cash',
-            'sandbox' => $attributes['sandbox'],
-            'return_url' => null,
+            'public_id'    => 'gateway_cash',
+            'name'         => 'Cash',
+            'code'         => 'cash',
+            'type'         => 'cash',
+            'sandbox'      => $attributes['sandbox'],
+            'return_url'   => null,
             'callback_url' => null,
-            ...$attributes
+            ...$attributes,
         ]);
     }
 }

package/server/src/Models/Network.php

@@ -3,16 +3,16 @@
 namespace Fleetbase\Storefront\Models;
 
 use Fleetbase\Casts\Json;
+use Fleetbase\FleetOps\Support\Utils;
 use Fleetbase\Models\Category;
-use Fleetbase\Models\User;
 use Fleetbase\Models\Company;
 use Fleetbase\Models\File;
 use Fleetbase\Models\Invite;
-use Fleetbase\FleetOps\Support\Utils;
-use Fleetbase\Traits\HasOptionsAttributes;
-use Fleetbase\Traits\HasUuid;
+use Fleetbase\Models\User;
 use Fleetbase\Traits\HasApiModelBehavior;
+use Fleetbase\Traits\HasOptionsAttributes;
 use Fleetbase\Traits\HasPublicid;
+use Fleetbase\Traits\HasUuid;
 use Fleetbase\Traits\Searchable;
 use Illuminate\Support\Str;
 use Spatie\Sluggable\HasSlug;
@@ -20,10 +20,15 @@ use Spatie\Sluggable\SlugOptions;
 
 class Network extends StorefrontModel
 {
-    use HasUuid, HasPublicId, HasApiModelBehavior, HasOptionsAttributes, HasSlug, Searchable;
+    use HasUuid;
+    use HasPublicId;
+    use HasApiModelBehavior;
+    use HasOptionsAttributes;
+    use HasSlug;
+    use Searchable;
 
     /**
-     * The type of public Id to generate
+     * The type of public Id to generate.
      *
      * @var string
      */
@@ -37,7 +42,7 @@ class Network extends StorefrontModel
     protected $table = 'networks';
 
     /**
-     * These attributes that can be queried
+     * These attributes that can be queried.
      *
      * @var array
      */
@@ -56,15 +61,15 @@ class Network extends StorefrontModel
      * @var array
      */
     protected $casts = [
-        'options' => Json::class,
+        'options'      => Json::class,
         'translations' => Json::class,
-        'alertable' => Json::class,
-        'tags' => 'array',
-        'online' => 'boolean'
+        'alertable'    => Json::class,
+        'tags'         => 'array',
+        'online'       => 'boolean',
     ];
 
     /**
-     * Dynamic attributes that are appended to object
+     * Dynamic attributes that are appended to object.
      *
      * @var array
      */
@@ -205,7 +210,7 @@ class Network extends StorefrontModel
     }
 
     /**
-     * @var integer
+     * @var int
      */
     public function getStoresCountAttribute()
     {
@@ -213,40 +218,30 @@ class Network extends StorefrontModel
     }
 
     /**
-     * Adds a new store to the network
-     *
-     * @param Store $store
-     * @param Category|null $category
-     * @return NetworkStore
+     * Adds a new store to the network.
      */
-    public function addStore(Store $store, ?Category $category = null): NetworkStore
+    public function addStore(Store $store, Category $category = null): NetworkStore
     {
         return NetworkStore::updateOrCreate(
             [
                 'network_uuid' => $this->uuid,
-                'store_uuid' => $store->uuid
+                'store_uuid'   => $store->uuid,
             ],
             [
-                'network_uuid' => $this->uuid,
-                'store_uuid' => $store->uuid,
-                'category_uuid' => $category instanceof Category ? $category->uuid : null
+                'network_uuid'  => $this->uuid,
+                'store_uuid'    => $store->uuid,
+                'category_uuid' => $category instanceof Category ? $category->uuid : null,
             ]
         );
     }
 
     /**
-     *'Create a new network store category for this store record
+     *'Create a new network store category for this store record.
      *
-     * @param string $name
-     * @param string $description
-     * @param array|null $meta
-     * @param array|null $translations
-     * @param Category|null $parent
      * @param File|string|null $icon
-     * @param string $iconColor
-     * @return Category
+     * @param string           $iconColor
      */
-    public function createCategory(string $name, string $description = '', ?array $meta = [],  ?array $translations = [], ?Category $parent = null, $icon = null, $iconColor = '#000000'): Category
+    public function createCategory(string $name, string $description = '', ?array $meta = [], ?array $translations = [], Category $parent = null, $icon = null, $iconColor = '#000000'): Category
     {
         $iconFile = null;
         $iconName = null;
@@ -260,34 +255,28 @@ class Network extends StorefrontModel
         }
 
         return Category::create([
-            'company_uuid' => $this->company_uuid,
-            'owner_uuid' => $this->uuid,
-            'owner_type' => Utils::getMutationType('network:storefront'),
-            'parent_uuid' => $parent instanceof Category ? $parent->uuid : null,
+            'company_uuid'   => $this->company_uuid,
+            'owner_uuid'     => $this->uuid,
+            'owner_type'     => Utils::getMutationType('network:storefront'),
+            'parent_uuid'    => $parent instanceof Category ? $parent->uuid : null,
             'icon_file_uuid' => $iconFile->uuid,
-            'for' => 'storefront_network',
-            'name' => $name,
-            'description' => $description,
-            'translations' => $translations,
-            'meta' => $meta,
-            'icon' => $iconName,
-            'icon_color' => $iconColor
+            'for'            => 'storefront_network',
+            'name'           => $name,
+            'description'    => $description,
+            'translations'   => $translations,
+            'meta'           => $meta,
+            'icon'           => $iconName,
+            'icon_color'     => $iconColor,
         ]);
     }
 
     /**
-     * Create a new network store category if it doesn't already exists for this store record
+     * Create a new network store category if it doesn't already exists for this store record.
      *
-     * @param string $name
-     * @param string $description
-     * @param array|null $meta
-     * @param array|null $translations
-     * @param Category|null $parent
      * @param File|string|null $icon
-     * @param string $iconColor
-     * @return Category
+     * @param string           $iconColor
      */
-    public function createCategoryStrict(string $name, string $description = '', ?array $meta = [],  ?array $translations = [], ?Category $parent = null, $icon = null, $iconColor = '#000000'): Category
+    public function createCategoryStrict(string $name, string $description = '', ?array $meta = [], ?array $translations = [], Category $parent = null, $icon = null, $iconColor = '#000000'): Category
     {
         $existingCategory = Category::where(['company_uuid' => $this->company_uuid, 'owner_uuid' => $this->uuid, 'name' => $name])->first();
 

package/server/src/Models/NetworkStore.php

@@ -3,13 +3,14 @@
 namespace Fleetbase\Storefront\Models;
 
 use Fleetbase\Models\Category;
-use Fleetbase\Traits\HasUuid;
 use Fleetbase\Traits\HasApiModelBehavior;
+use Fleetbase\Traits\HasUuid;
 use Illuminate\Database\Eloquent\Relations\Pivot;
 
 class NetworkStore extends Pivot
 {
-    use HasUuid, HasApiModelBehavior;
+    use HasUuid;
+    use HasApiModelBehavior;
 
     /**
      * The database table used by the model.
@@ -19,7 +20,7 @@ class NetworkStore extends Pivot
     protected $table = 'network_stores';
 
     /**
-     * These attributes that can be queried
+     * These attributes that can be queried.
      *
      * @var array
      */
@@ -40,7 +41,7 @@ class NetworkStore extends Pivot
     protected $casts = [];
 
     /**
-     * Dynamic attributes that are appended to object
+     * Dynamic attributes that are appended to object.
      *
      * @var array
      */
@@ -49,7 +50,7 @@ class NetworkStore extends Pivot
     /**
      * Create a new instance of the model.
      *
-     * @param array $attributes The attributes to set on the model.
+     * @param array $attributes the attributes to set on the model
      *
      * @return void
      */

package/server/src/Models/NotificationChannel.php

@@ -4,17 +4,19 @@ namespace Fleetbase\Storefront\Models;
 
 use Fleetbase\Casts\Json;
 use Fleetbase\Casts\PolymorphicType;
-use Fleetbase\Models\User;
-use Fleetbase\Models\Company;
 use Fleetbase\FleetOps\Support\Utils;
+use Fleetbase\Models\Company;
+use Fleetbase\Models\User;
+use Fleetbase\Traits\HasApiModelBehavior;
 use Fleetbase\Traits\HasOptionsAttributes;
 use Fleetbase\Traits\HasUuid;
-use Fleetbase\Traits\HasApiModelBehavior;
 use Illuminate\Support\Str;
 
 class NotificationChannel extends StorefrontModel
 {
-    use HasUuid, HasApiModelBehavior, HasOptionsAttributes;
+    use HasUuid;
+    use HasApiModelBehavior;
+    use HasOptionsAttributes;
 
     /**
      * The database table used by the model.
@@ -24,7 +26,7 @@ class NotificationChannel extends StorefrontModel
     protected $table = 'notification_channels';
 
     /**
-     * These attributes that can be queried
+     * These attributes that can be queried.
      *
      * @var array
      */
@@ -44,12 +46,12 @@ class NotificationChannel extends StorefrontModel
      */
     protected $casts = [
         // 'config' => Json::class,
-        'options' => Json::class,
-        'owner_type' => PolymorphicType::class
+        'options'    => Json::class,
+        'owner_type' => PolymorphicType::class,
     ];
 
     /**
-     * Dynamic attributes that are appended to object
+     * Dynamic attributes that are appended to object.
      *
      * @var array
      */
@@ -97,7 +99,7 @@ class NotificationChannel extends StorefrontModel
     }
 
     /**
-     * Sets the owner type
+     * Sets the owner type.
      */
     public function setOwnerTypeAttribute($type)
     {

package/server/src/Models/PaymentMethod.php

@@ -3,18 +3,20 @@
 namespace Fleetbase\Storefront\Models;
 
 use Fleetbase\Casts\Json;
-use Fleetbase\Models\User;
 use Fleetbase\Models\Company;
-use Fleetbase\Traits\HasUuid;
+use Fleetbase\Models\User;
 use Fleetbase\Traits\HasApiModelBehavior;
 use Fleetbase\Traits\HasPublicid;
+use Fleetbase\Traits\HasUuid;
 
 class PaymentMethod extends StorefrontModel
 {
-    use HasUuid, HasPublicid, HasApiModelBehavior;
+    use HasUuid;
+    use HasPublicid;
+    use HasApiModelBehavior;
 
     /**
-     * The type of public Id to generate
+     * The type of public Id to generate.
      *
      * @var string
      */
@@ -28,7 +30,7 @@ class PaymentMethod extends StorefrontModel
     protected $table = 'payment_methods';
 
     /**
-     * These attributes that can be queried
+     * These attributes that can be queried.
      *
      * @var array
      */
@@ -47,11 +49,11 @@ class PaymentMethod extends StorefrontModel
      * @var array
      */
     protected $casts = [
-        'meta' => Json::class
+        'meta' => Json::class,
     ];
 
     /**
-     * Dynamic attributes that are appended to object
+     * Dynamic attributes that are appended to object.
      *
      * @var array
      */