chore: add property annotations to models

Signed-off-by: Sam Poyigi <[email protected]>
tastyigniter · Jan 3, 2025 · ed80200 · ed80200
1 parent 4073de4
commit ed80200
Show file tree

Hide file tree

Showing 22 changed files with 279 additions and 317 deletions.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
diff --git a/src/Classes/CartManager.php b/src/Classes/CartManager.php
@@ -434,7 +434,7 @@ public function validateMenuItemOption(MenuItemOption $menuOption, $selectedValu
         }
 
         if ($menuOption->display_type == 'quantity') {
-            $countSelected = array_reduce($selectedValues, function($qty, $selectedValue) {
+            $countSelected = (int)array_reduce($selectedValues, function($qty, $selectedValue) {
                 return $qty + $selectedValue['qty'];
             });
         } else {

diff --git a/src/Models/Cart.php b/src/Models/Cart.php
@@ -4,6 +4,16 @@
 
 use Igniter\Flame\Database\Model;
 
+/**
+ * Cart Model Class
+ *
+ * @property string $identifier
+ * @property string $instance
+ * @property string $data
+ * @property \Illuminate\Support\Carbon|null $created_at
+ * @property \Illuminate\Support\Carbon|null $updated_at
+ * @mixin \Igniter\Flame\Database\Model
+ */
 class Cart extends Model
 {
     protected $table = 'igniter_cart_cart';

diff --git a/src/Models/CartSettings.php b/src/Models/CartSettings.php
@@ -6,7 +6,7 @@
 use Igniter\Flame\Database\Model;
 
 /**
- * @method static instance()
+ * @method static CartSettings instance()
  */
 class CartSettings extends Model
 {

diff --git a/src/Models/Category.php b/src/Models/Category.php
@@ -13,6 +13,25 @@
 
 /**
  * Category Model Class
+ *
+ * @property int $category_id
+ * @property string $name
+ * @property string|null $description
+ * @property int|null $parent_id
+ * @property int $priority
+ * @property bool $status
+ * @property int|null $nest_left
+ * @property int|null $nest_right
+ * @property string|null $permalink_slug
+ * @property \Illuminate\Support\Carbon|null $created_at
+ * @property \Illuminate\Support\Carbon|null $updated_at
+ * @property-read \Kalnoy\Nestedset\Collection<int, Category> $children
+ * @property-read int|null $children_count
+ * @property-read mixed $count_menus
+ * @property-read \Illuminate\Database\Eloquent\Collection<int, \Igniter\Flame\Database\Attach\Media> $media
+ * @property-read int|null $media_count
+ * @property-read Category|null $parent
+ * @mixin \Igniter\Flame\Database\Model
  */
 class Category extends Model
 {

diff --git a/src/Models/Ingredient.php b/src/Models/Ingredient.php
@@ -9,6 +9,18 @@
 
 /**
  * Ingredients Model Class
+ *
+ * @property int $ingredient_id
+ * @property string $name
+ * @property string $description
+ * @property bool $status
+ * @property \Illuminate\Support\Carbon|null $created_at
+ * @property \Illuminate\Support\Carbon|null $updated_at
+ * @property bool $is_allergen
+ * @property-read mixed $count_menus
+ * @property-read \Illuminate\Database\Eloquent\Collection<int, \Igniter\Flame\Database\Attach\Media> $media
+ * @property-read int|null $media_count
+ * @mixin \Igniter\Flame\Database\Model
  */
 class Ingredient extends Model
 {

diff --git a/src/Models/Mealtime.php b/src/Models/Mealtime.php
@@ -10,6 +10,15 @@
 
 /**
  * Mealtime Model Class
+ *
+ * @property int $mealtime_id
+ * @property string $mealtime_name
+ * @property mixed $start_time
+ * @property mixed $end_time
+ * @property bool $mealtime_status
+ * @property \Illuminate\Support\Carbon|null $created_at
+ * @property \Illuminate\Support\Carbon|null $updated_at
+ * @mixin \Igniter\Flame\Database\Model
  */
 class Mealtime extends Model
 {
@@ -61,7 +70,7 @@ public function isAvailable($datetime = null)
 
         return $datetime->between(
             $datetime->setTimeFromTimeString($this->start_time),
-            $datetime->setTimeFromTimeString($this->end_time)
+            $datetime->setTimeFromTimeString($this->end_time),
         );
     }
 

diff --git a/src/Models/Menu.php b/src/Models/Menu.php
@@ -14,6 +14,22 @@
 
 /**
  * Menu Model Class
+ *
+ * @property int $menu_id
+ * @property string $menu_name
+ * @property string $menu_description
+ * @property float $menu_price
+ * @property int $minimum_qty
+ * @property boolean $menu_status
+ * @property int $menu_priority
+ * @property array|null $order_restriction
+ * @property \Illuminate\Support\Carbon|null $created_at
+ * @property \Illuminate\Support\Carbon|null $updated_at
+ * @property-read mixed $menu_price_from
+ * @property-read mixed $stock_qty
+ * @property-read \Illuminate\Database\Eloquent\Collection<int, \Igniter\Flame\Database\Attach\Media> $media
+ * @property-read int|null $media_count
+ * @mixin \Igniter\Flame\Database\Model
  */
 class Menu extends Model implements Buyable
 {

diff --git a/src/Models/MenuCategory.php b/src/Models/MenuCategory.php
@@ -6,6 +6,10 @@
 
 /**
  * MenuCategory Model Class
+ *
+ * @property int $menu_id
+ * @property int $category_id
+ * @mixin \Igniter\Flame\Database\Model
  */
 class MenuCategory extends Model
 {

diff --git a/src/Models/MenuExport.php b/src/Models/MenuExport.php
@@ -4,6 +4,22 @@
 
 use IgniterLabs\ImportExport\Models\ExportModel;
 
+/**
+ * MenuExport Model Class
+ *
+ * @property int $menu_id
+ * @property string $menu_name
+ * @property string $menu_description
+ * @property string $menu_price
+ * @property int $minimum_qty
+ * @property boolean $menu_status
+ * @property int $menu_priority
+ * @property string|null $order_restriction
+ * @property string|null $created_at
+ * @property string|null $updated_at
+ * @property-read mixed $categories
+ * @mixin \Igniter\Flame\Database\Model
+ */
 class MenuExport extends ExportModel
 {
     protected $table = 'menus';

diff --git a/src/Models/MenuImport.php b/src/Models/MenuImport.php
@@ -5,6 +5,21 @@
 use Exception;
 use IgniterLabs\ImportExport\Models\ImportModel;
 
+/**
+ * MenuImport Model Class
+ *
+ * @property int $menu_id
+ * @property string $menu_name
+ * @property string $menu_description
+ * @property string $menu_price
+ * @property int $minimum_qty
+ * @property boolean $menu_status
+ * @property int $menu_priority
+ * @property string|null $order_restriction
+ * @property string|null $created_at
+ * @property string|null $updated_at
+ * @mixin \Igniter\Flame\Database\Model
+ */
 class MenuImport extends ImportModel
 {
     protected $table = 'menus';

diff --git a/src/Models/MenuItemOption.php b/src/Models/MenuItemOption.php
@@ -7,6 +7,23 @@
 use Igniter\Flame\Database\Traits\Purgeable;
 use Igniter\Flame\Database\Traits\Validation;
 
+/**
+ * MenuItemOption Model Class
+ *
+ * @property int $menu_option_id
+ * @property int $option_id
+ * @property int $menu_id
+ * @property bool $is_required
+ * @property int $priority
+ * @property int $min_selected
+ * @property int $max_selected
+ * @property \Illuminate\Support\Carbon|null $created_at
+ * @property \Illuminate\Support\Carbon|null $updated_at
+ * @property-read mixed $display_type
+ * @property-read mixed $option_name
+ * @property-read mixed $option_values
+ * @mixin \Igniter\Flame\Database\Model
+ */
 class MenuItemOption extends Model
 {
     use HasFactory;

diff --git a/src/Models/MenuItemOptionValue.php b/src/Models/MenuItemOptionValue.php
@@ -8,6 +8,18 @@
 
 /**
  * MenuItemOptionValue Model Class
+ *
+ * @property int $menu_option_value_id
+ * @property int $menu_option_id
+ * @property int $option_value_id
+ * @property float|null $override_price
+ * @property int $priority
+ * @property bool|null $is_default
+ * @property \Illuminate\Support\Carbon|null $created_at
+ * @property \Illuminate\Support\Carbon|null $updated_at
+ * @property-read mixed $name
+ * @property-read mixed $price
+ * @mixin \Igniter\Flame\Database\Model
  */
 class MenuItemOptionValue extends Model
 {

diff --git a/src/Models/MenuOption.php b/src/Models/MenuOption.php
@@ -10,6 +10,14 @@
 
 /**
  * MenuOption Model Class
+ *
+ * @property int $option_id
+ * @property string $option_name
+ * @property string $display_type
+ * @property int $priority
+ * @property \Illuminate\Support\Carbon|null $created_at
+ * @property \Illuminate\Support\Carbon|null $updated_at
+ * @mixin \Igniter\Flame\Database\Model
  */
 class MenuOption extends Model
 {

diff --git a/src/Models/MenuOptionValue.php b/src/Models/MenuOptionValue.php
@@ -9,6 +9,14 @@
 
 /**
  * MenuOptionValue Model Class
+ *
+ * @property int $option_value_id
+ * @property int $option_id
+ * @property string $name
+ * @property float|null $price
+ * @property int $priority
+ * @property-read mixed $stock_qty
+ * @mixin \Igniter\Flame\Database\Model
  */
 class MenuOptionValue extends Model
 {

diff --git a/src/Models/MenuSpecial.php b/src/Models/MenuSpecial.php
@@ -9,6 +9,22 @@
 
 /**
  * MenuSpecial Model Class
+ *
+ * @property int $special_id
+ * @property int $menu_id
+ * @property \Illuminate\Support\Carbon|null $start_date
+ * @property \Illuminate\Support\Carbon|null $end_date
+ * @property float|null $special_price
+ * @property bool $special_status
+ * @property string $type
+ * @property string $validity
+ * @property array|null $recurring_every
+ * @property mixed|null $recurring_from
+ * @property mixed|null $recurring_to
+ * @property string|null $created_at
+ * @property string|null $updated_at
+ * @property-read mixed $pretty_end_date
+ * @mixin \Igniter\Flame\Database\Model
  */
 class MenuSpecial extends Model
 {

diff --git a/src/Models/Order.php b/src/Models/Order.php
@@ -24,6 +24,49 @@
 
 /**
  * Order Model Class
+ *
+ * @property int $order_id
+ * @property int|null $customer_id
+ * @property string $first_name
+ * @property string $last_name
+ * @property string $email
+ * @property string $telephone
+ * @property int $location_id
+ * @property int|null $address_id
+ * @property mixed $cart
+ * @property int $total_items
+ * @property string|null $comment
+ * @property string $payment
+ * @property string $order_type
+ * @property \Illuminate\Support\Carbon $created_at
+ * @property \Illuminate\Support\Carbon $updated_at
+ * @property mixed $order_time
+ * @property \Illuminate\Support\Carbon $order_date
+ * @property float|null $order_total
+ * @property int $status_id
+ * @property string $ip_address
+ * @property string $user_agent
+ * @property int|null $assignee_id
+ * @property int|null $assignee_group_id
+ * @property string|null $invoice_prefix
+ * @property \Illuminate\Support\Carbon|null $invoice_date
+ * @property string|null $hash
+ * @property bool|null $processed
+ * @property \Illuminate\Support\Carbon|null $status_updated_at
+ * @property \Illuminate\Support\Carbon|null $assignee_updated_at
+ * @property bool $order_time_is_asap
+ * @property string|null $delivery_comment
+ * @property-read mixed $customer_name
+ * @property-read mixed $formatted_address
+ * @property-read mixed $invoice_no
+ * @property-read mixed $invoice_number
+ * @property-read mixed $order_datetime
+ * @property-read mixed $order_type_name
+ * @property-read string|null $status_color
+ * @property-read string|null $status_name
+ * @method static \Igniter\Flame\Database\Builder<static>|Order whereHasAutoAssignGroup()
+ * @method static \Igniter\Flame\Database\Builder<static>|Order whereHasStatusInHistory(string|int $statusId)
+ * @mixin \Igniter\Flame\Database\Model
  */
 class Order extends Model
 {
@@ -379,9 +422,10 @@ public function mailGetData()
             $data['location_address'] = format_address($model->location->getAddress());
         }
 
+        /** @var StatusHistory $statusHistory */
         $statusHistory = StatusHistory::applyRelated($model)->whereStatusIsLatest($model->status_id)->first();
-        $data['status_name'] = $statusHistory ? optional($statusHistory->status)->status_name : null;
-        $data['status_comment'] = $statusHistory ? $statusHistory->comment : null;
+        $data['status_name'] = $statusHistory?->status?->status_name;
+        $data['status_comment'] = $statusHistory?->comment;
 
         $controller = MainController::getController();
         $data['order_view_url'] = $controller->pageUrl('account/order', [

diff --git a/src/Models/OrderMenu.php b/src/Models/OrderMenu.php
@@ -4,6 +4,20 @@
 
 use Igniter\Flame\Database\Casts\Serialize;
 
+/**
+ * OrderMenu Model
+ *
+ * @property int $order_menu_id
+ * @property int $order_id
+ * @property int $menu_id
+ * @property string $name
+ * @property int $quantity
+ * @property float|null $price
+ * @property float|null $subtotal
+ * @property mixed|null $option_values
+ * @property string|null $comment
+ * @mixin \Igniter\Flame\Database\Model
+ */
 class OrderMenu extends \Igniter\Flame\Database\Model
 {
     protected $table = 'order_menus';

diff --git a/src/Models/OrderMenuOptionValue.php b/src/Models/OrderMenuOptionValue.php
@@ -2,6 +2,20 @@
 
 namespace Igniter\Cart\Models;
 
+/**
+ * OrderMenuOptionValue Model
+ *
+ * @property int $order_option_id
+ * @property int $order_id
+ * @property string $order_option_name
+ * @property float|null $order_option_price
+ * @property int $order_menu_id
+ * @property int $menu_option_id
+ * @property int $menu_option_value_id
+ * @property int|null $quantity
+ * @property-read mixed $order_option_category
+ * @mixin \Igniter\Flame\Database\Model
+ */
 class OrderMenuOptionValue extends \Igniter\Flame\Database\Model
 {
     protected $table = 'order_menu_options';