fluentcart-developer 2.3.0 → 2.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +59 -59
- package/dist/cards/fluentcart/tools.d.ts.map +1 -1
- package/dist/cards/fluentcart/tools.js +160 -12
- package/dist/cards/fluentcart/tools.js.map +1 -1
- package/dist/skills/fluentcart-developer/.claude-plugin/plugin.json +12 -12
- package/dist/skills/fluentcart-developer/.mcp.json +11 -11
- package/dist/skills/fluentcart-developer/examples/fluentcart-starter-child-theme/fluent-cart/checkout.php +32 -32
- package/dist/skills/fluentcart-developer/examples/fluentcart-starter-child-theme/functions.php +40 -40
- package/dist/skills/fluentcart-developer/examples/sample-fee-surcharge-plugin/fluentcart-fee-surcharge.php +38 -38
- package/dist/skills/fluentcart-developer/references/action-hooks-cart-checkout.md +1355 -1355
- package/dist/skills/fluentcart-developer/references/action-hooks-customers-users.md +266 -266
- package/dist/skills/fluentcart-developer/references/action-hooks-licenses.md +855 -855
- package/dist/skills/fluentcart-developer/references/action-hooks-orders.md +631 -631
- package/dist/skills/fluentcart-developer/references/action-hooks-payments-integrations.md +963 -963
- package/dist/skills/fluentcart-developer/references/action-hooks-products-coupons.md +585 -585
- package/dist/skills/fluentcart-developer/references/action-hooks-subscriptions.md +661 -661
- package/dist/skills/fluentcart-developer/references/database-models-query-builder.md +194 -194
- package/dist/skills/fluentcart-developer/references/database-models-reference.md +604 -604
- package/dist/skills/fluentcart-developer/references/engineering-notes.md +154 -154
- package/dist/skills/fluentcart-developer/references/fee-system-guide.md +449 -449
- package/dist/skills/fluentcart-developer/references/filter-hooks-cart-checkout.md +1202 -1202
- package/dist/skills/fluentcart-developer/references/filter-hooks-integrations-advanced.md +1598 -1598
- package/dist/skills/fluentcart-developer/references/filter-hooks-products-pricing.md +628 -628
- package/dist/skills/fluentcart-developer/references/filter-hooks-settings-configuration.md +1177 -1177
- package/dist/skills/fluentcart-developer/references/fluentcart-developer-guide.md +154 -154
- package/dist/skills/fluentcart-developer/references/ghost-product-selling.md +458 -458
- package/dist/skills/fluentcart-developer/references/modules-and-extensions-reference.md +224 -224
- package/dist/skills/fluentcart-developer/references/payment-gateway-integration.md +761 -761
- package/dist/skills/fluentcart-developer/references/rest-api-customer-profile.md +190 -190
- package/dist/skills/fluentcart-developer/references/rest-api-customers.md +1121 -1121
- package/dist/skills/fluentcart-developer/references/rest-api-dashboard-utilities.md +219 -219
- package/dist/skills/fluentcart-developer/references/rest-api-email-notifications.md +619 -619
- package/dist/skills/fluentcart-developer/references/rest-api-files.md +290 -290
- package/dist/skills/fluentcart-developer/references/rest-api-integrations.md +324 -324
- package/dist/skills/fluentcart-developer/references/rest-api-labels-attributes.md +321 -321
- package/dist/skills/fluentcart-developer/references/rest-api-order-bumps.md +200 -200
- package/dist/skills/fluentcart-developer/references/rest-api-overview.md +131 -131
- package/dist/skills/fluentcart-developer/references/rest-api-public-shop.md +172 -172
- package/dist/skills/fluentcart-developer/references/rest-api-reference.md +552 -552
- package/dist/skills/fluentcart-developer/references/rest-api-reports.md +377 -377
- package/dist/skills/fluentcart-developer/references/rest-api-roles-permissions.md +147 -147
- package/dist/skills/fluentcart-developer/references/rest-api-settings.md +528 -528
- package/dist/skills/fluentcart-developer/references/rest-api-shipping.md +799 -799
- package/dist/skills/fluentcart-developer/references/rest-api-tax.md +356 -356
- package/dist/skills/fluentcart-developer/references/subscription-customization.md +197 -197
- package/dist/skills/fluentcart-developer/scripts/cli.js +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +65 -65
|
@@ -1,194 +1,194 @@
|
|
|
1
|
-
# FluentCart Eloquent Models & Query Builder Reference
|
|
2
|
-
|
|
3
|
-
> Source: Official FluentCart Developer Documentation
|
|
4
|
-
|
|
5
|
-
FluentCart provides an ActiveRecord implementation built on Eloquent ORM for interacting with database tables. Each database table corresponds to a dedicated Model class located under:
|
|
6
|
-
|
|
7
|
-
- **Core Models:** `\FluentCart\App\Models\*`
|
|
8
|
-
- **Pro Models:** `\FluentCartPro\App\Models\*`
|
|
9
|
-
|
|
10
|
-
---
|
|
11
|
-
|
|
12
|
-
## 💡 Core Architecture Principles
|
|
13
|
-
|
|
14
|
-
1. **Monetary Values in Cents:** All financial attributes (`total_amount`, `subtotal`, `unit_price`, `tax_total`, `discount_total`) are stored as **integer cents** (e.g., `$19.99` = `1999`).
|
|
15
|
-
2. **Helper Functions:** Use `\FluentCart\App\Helpers\Helper::toDecimal($cents)` to convert cents to decimal for display, and `\FluentCart\App\Helpers\Helper::toCent($decimal)` when inserting user inputs.
|
|
16
|
-
3. **Database Tables Prefix:** Table names resolve automatically using the WordPress prefix (e.g., `wp_fct_orders`).
|
|
17
|
-
|
|
18
|
-
---
|
|
19
|
-
|
|
20
|
-
## 🔍 Querying Models
|
|
21
|
-
|
|
22
|
-
### 1. Retrieving All Records
|
|
23
|
-
```php
|
|
24
|
-
// Retrieve all orders from wp_fct_orders table
|
|
25
|
-
$orders = \FluentCart\App\Models\Order::all();
|
|
26
|
-
|
|
27
|
-
foreach ($orders as $order) {
|
|
28
|
-
// Access order total amount attribute in cents
|
|
29
|
-
$cents = $order->total_amount;
|
|
30
|
-
}
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
### 2. Constraints & Filtering
|
|
34
|
-
```php
|
|
35
|
-
// Filter completed orders with ordering and pagination limit
|
|
36
|
-
$orders = \FluentCart\App\Models\Order::where('status', 'completed')
|
|
37
|
-
->orderBy('created_at', 'DESC')
|
|
38
|
-
->limit(10)
|
|
39
|
-
->skip(5)
|
|
40
|
-
->get();
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
### 3. Finding Single Models
|
|
44
|
-
```php
|
|
45
|
-
// Retrieve single order record by primary key ID
|
|
46
|
-
$order = \FluentCart\App\Models\Order::find(101);
|
|
47
|
-
|
|
48
|
-
// Find first matching order record by custom query constraint
|
|
49
|
-
$pendingOrder = \FluentCart\App\Models\Order::where('status', 'pending')->first();
|
|
50
|
-
|
|
51
|
-
// Find multiple models by array of primary key IDs
|
|
52
|
-
$selectedOrders = \FluentCart\App\Models\Order::find([101, 102, 103]);
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
### 4. Aggregate Functions
|
|
56
|
-
```php
|
|
57
|
-
// Count total completed orders
|
|
58
|
-
$totalCompleted = \FluentCart\App\Models\Order::where('status', 'completed')->count();
|
|
59
|
-
|
|
60
|
-
// Calculate maximum total amount in cents for completed orders
|
|
61
|
-
$maxOrderValue = \FluentCart\App\Models\Order::where('status', 'completed')->max('total_amount');
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
---
|
|
65
|
-
|
|
66
|
-
## ✏️ Inserting, Updating & Deleting
|
|
67
|
-
|
|
68
|
-
### 1. Creating New Records
|
|
69
|
-
```php
|
|
70
|
-
// Create a new order record using mass assignment
|
|
71
|
-
$order = \FluentCart\App\Models\Order::create([
|
|
72
|
-
'customer_id' => 42, // Reference to customer ID
|
|
73
|
-
'status' => 'pending', // Order status slug
|
|
74
|
-
'payment_method' => 'stripe', // Gateway key
|
|
75
|
-
'currency' => 'USD', // Currency ISO code
|
|
76
|
-
'total_amount' => \FluentCart\App\Helpers\Helper::toCent(49.99) // Convert $49.99 to 4999 cents
|
|
77
|
-
]);
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
### 2. Updating Existing Models
|
|
81
|
-
```php
|
|
82
|
-
// Find order model by primary key ID
|
|
83
|
-
$order = \FluentCart\App\Models\Order::find(101);
|
|
84
|
-
|
|
85
|
-
// Modify properties directly on model instance
|
|
86
|
-
$order->status = 'completed'; // Update order status
|
|
87
|
-
$order->completed_at = date('Y-m-d H:i:s'); // Set completion timestamp
|
|
88
|
-
$order->save(); // Save changes to database
|
|
89
|
-
|
|
90
|
-
// Alternatively update attributes via array mass assignment
|
|
91
|
-
$order->update([
|
|
92
|
-
'status' => 'completed', // New status
|
|
93
|
-
'completed_at' => date('Y-m-d H:i:s') // Updated timestamp
|
|
94
|
-
]);
|
|
95
|
-
```
|
|
96
|
-
|
|
97
|
-
### 3. Deleting Models
|
|
98
|
-
```php
|
|
99
|
-
// Find and delete a single model instance
|
|
100
|
-
$order = \FluentCart\App\Models\Order::find(101);
|
|
101
|
-
$order->delete(); // Delete record from database
|
|
102
|
-
|
|
103
|
-
// Delete records in bulk matching query constraints
|
|
104
|
-
\FluentCart\App\Models\Order::where('status', 'draft')->delete();
|
|
105
|
-
```
|
|
106
|
-
|
|
107
|
-
---
|
|
108
|
-
|
|
109
|
-
## 🎯 Query Scopes & Relationships
|
|
110
|
-
|
|
111
|
-
### Local Query Scopes
|
|
112
|
-
Models include predefined query scopes. For instance, the `Order` model defines `scopeOfStatus`:
|
|
113
|
-
|
|
114
|
-
```php
|
|
115
|
-
// Use ofStatus query scope to filter completed orders
|
|
116
|
-
$completedOrders = \FluentCart\App\Models\Order::ofStatus('completed')->get();
|
|
117
|
-
```
|
|
118
|
-
|
|
119
|
-
### Relationships & Eager Loading
|
|
120
|
-
```php
|
|
121
|
-
// Find customer model by ID
|
|
122
|
-
$customer = \FluentCart\App\Models\Customer::find(15);
|
|
123
|
-
|
|
124
|
-
// Access hasMany orders relationship collection
|
|
125
|
-
$customerOrders = $customer->orders;
|
|
126
|
-
|
|
127
|
-
// Access hasMany subscriptions relationship collection
|
|
128
|
-
$customerSubscriptions = $customer->subscriptions;
|
|
129
|
-
|
|
130
|
-
// Eager load customer and item relationships to prevent N+1 query overhead
|
|
131
|
-
$orders = \FluentCart\App\Models\Order::with(['customer', 'items'])
|
|
132
|
-
->where('status', 'completed')
|
|
133
|
-
->get();
|
|
134
|
-
```
|
|
135
|
-
|
|
136
|
-
---
|
|
137
|
-
|
|
138
|
-
## 📋 Comprehensive Model Index
|
|
139
|
-
|
|
140
|
-
### Core Models (`\FluentCart\App\Models\*`)
|
|
141
|
-
|
|
142
|
-
| Domain | Model Name | Description & Table |
|
|
143
|
-
|---|---|---|
|
|
144
|
-
| **Orders** | `Order` | Central order record (`wp_fct_orders`) |
|
|
145
|
-
| | `OrderItem` | Individual line item in an order (`wp_fct_order_items`) |
|
|
146
|
-
| | `OrderTransaction` | Payment transactions and refunds (`wp_fct_order_transactions`) |
|
|
147
|
-
| | `OrderAddress` | Order billing & shipping addresses (`wp_fct_order_addresses`) |
|
|
148
|
-
| | `OrderMeta` | Custom key-value order metadata (`wp_fct_order_meta`) |
|
|
149
|
-
| | `OrderOperation` | UTM tracking and operation logs (`wp_fct_order_operations`) |
|
|
150
|
-
| | `OrderTaxRate` | Applied tax rates per order (`wp_fct_order_tax_rate`) |
|
|
151
|
-
| | `OrderDownloadPermission` | Customer digital file access permissions (`wp_fct_order_download_permissions`) |
|
|
152
|
-
| **Customers** | `Customer` | Customer profile & lifetime statistics (`wp_fct_customers`) |
|
|
153
|
-
| | `CustomerAddress` | Saved customer addresses (`wp_fct_customer_addresses`) |
|
|
154
|
-
| | `CustomerMeta` | Customer metadata storage (`wp_fct_customer_meta`) |
|
|
155
|
-
| **Products** | `Product` | Product post object wrapper |
|
|
156
|
-
| | `ProductDetail` | Inventory and fulfillment details (`wp_fct_product_details`) |
|
|
157
|
-
| | `ProductVariation` | Product SKUs, attributes & prices (`wp_fct_product_variations`) |
|
|
158
|
-
| | `ProductMeta` | Product metadata (`wp_fct_product_meta`) |
|
|
159
|
-
| | `ProductDownload` | Downloadable files attached to products (`wp_fct_product_downloads`) |
|
|
160
|
-
| **Subscriptions** | `Subscription` | Recurring subscription billing (`wp_fct_subscriptions`) |
|
|
161
|
-
| | `SubscriptionMeta` | Subscription metadata (`wp_fct_subscription_meta`) |
|
|
162
|
-
| **Cart & Coupons** | `Cart` | Customer shopping cart sessions (`wp_fct_carts`) |
|
|
163
|
-
| | `Coupon` | Coupon codes and condition rules (`wp_fct_coupons`) |
|
|
164
|
-
| | `AppliedCoupon` | Applied discounts on orders (`wp_fct_applied_coupons`) |
|
|
165
|
-
| **System** | `Activity` | System activity logs (`wp_fct_activity`) |
|
|
166
|
-
| | `ScheduledAction` | Background Action Scheduler jobs (`wp_fct_scheduled_actions`) |
|
|
167
|
-
| | `Meta` | Generic key-value store (`wp_fct_meta`) |
|
|
168
|
-
| | `User` | WordPress user integration |
|
|
169
|
-
| | `DynamicModel` | Flexible dynamic model instance |
|
|
170
|
-
|
|
171
|
-
### Attribute System Models (`\FluentCart\App\Models\*`)
|
|
172
|
-
- `AttributeGroup`: Attribute groups (e.g., Color, Size) (`wp_fct_atts_groups`)
|
|
173
|
-
- `AttributeTerm`: Attribute terms within groups (`wp_fct_atts_terms`)
|
|
174
|
-
- `AttributeRelation`: Object attribute relationships (`wp_fct_atts_relations`)
|
|
175
|
-
|
|
176
|
-
### Shipping & Tax Models (`\FluentCart\App\Models\*`)
|
|
177
|
-
- `ShippingZone`: Shipping zones (`wp_fct_shipping_zones`)
|
|
178
|
-
- `ShippingMethod`: Methods within zones (`wp_fct_shipping_methods`)
|
|
179
|
-
- `ShippingClass`: Shipping classes (`wp_fct_shipping_classes`)
|
|
180
|
-
- `TaxClass`: Tax classes (`wp_fct_tax_classes`)
|
|
181
|
-
- `TaxRate`: Tax rate rules per region (`wp_fct_tax_rates`)
|
|
182
|
-
|
|
183
|
-
### Label System Models (`\FluentCart\App\Models\*`)
|
|
184
|
-
- `Label`: Tagging and labeling system (`wp_fct_label`)
|
|
185
|
-
- `LabelRelationship`: Polymorphic label relations (`wp_fct_label_relationships`)
|
|
186
|
-
|
|
187
|
-
### Pro Plugin Models (`\FluentCartPro\App\Models\*`)
|
|
188
|
-
- `License`: License key management (`wp_fct_licenses`)
|
|
189
|
-
- `LicenseMeta`: License metadata (`wp_fct_license_meta`)
|
|
190
|
-
- `LicenseActivation`: Activation counts & hashes (`wp_fct_license_activations`)
|
|
191
|
-
- `LicenseSite`: Licensed domain URLs (`wp_fct_license_sites`)
|
|
192
|
-
- `OrderPromotion`: Order bump & promotional rules (`wp_fct_order_promotions`)
|
|
193
|
-
- `OrderPromotionStat`: Promotion conversion statistics (`wp_fct_order_promotion_stats`)
|
|
194
|
-
- `UserMeta`: Extended user metadata
|
|
1
|
+
# FluentCart Eloquent Models & Query Builder Reference
|
|
2
|
+
|
|
3
|
+
> Source: Official FluentCart Developer Documentation
|
|
4
|
+
|
|
5
|
+
FluentCart provides an ActiveRecord implementation built on Eloquent ORM for interacting with database tables. Each database table corresponds to a dedicated Model class located under:
|
|
6
|
+
|
|
7
|
+
- **Core Models:** `\FluentCart\App\Models\*`
|
|
8
|
+
- **Pro Models:** `\FluentCartPro\App\Models\*`
|
|
9
|
+
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
## 💡 Core Architecture Principles
|
|
13
|
+
|
|
14
|
+
1. **Monetary Values in Cents:** All financial attributes (`total_amount`, `subtotal`, `unit_price`, `tax_total`, `discount_total`) are stored as **integer cents** (e.g., `$19.99` = `1999`).
|
|
15
|
+
2. **Helper Functions:** Use `\FluentCart\App\Helpers\Helper::toDecimal($cents)` to convert cents to decimal for display, and `\FluentCart\App\Helpers\Helper::toCent($decimal)` when inserting user inputs.
|
|
16
|
+
3. **Database Tables Prefix:** Table names resolve automatically using the WordPress prefix (e.g., `wp_fct_orders`).
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## 🔍 Querying Models
|
|
21
|
+
|
|
22
|
+
### 1. Retrieving All Records
|
|
23
|
+
```php
|
|
24
|
+
// Retrieve all orders from wp_fct_orders table
|
|
25
|
+
$orders = \FluentCart\App\Models\Order::all();
|
|
26
|
+
|
|
27
|
+
foreach ($orders as $order) {
|
|
28
|
+
// Access order total amount attribute in cents
|
|
29
|
+
$cents = $order->total_amount;
|
|
30
|
+
}
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### 2. Constraints & Filtering
|
|
34
|
+
```php
|
|
35
|
+
// Filter completed orders with ordering and pagination limit
|
|
36
|
+
$orders = \FluentCart\App\Models\Order::where('status', 'completed')
|
|
37
|
+
->orderBy('created_at', 'DESC')
|
|
38
|
+
->limit(10)
|
|
39
|
+
->skip(5)
|
|
40
|
+
->get();
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### 3. Finding Single Models
|
|
44
|
+
```php
|
|
45
|
+
// Retrieve single order record by primary key ID
|
|
46
|
+
$order = \FluentCart\App\Models\Order::find(101);
|
|
47
|
+
|
|
48
|
+
// Find first matching order record by custom query constraint
|
|
49
|
+
$pendingOrder = \FluentCart\App\Models\Order::where('status', 'pending')->first();
|
|
50
|
+
|
|
51
|
+
// Find multiple models by array of primary key IDs
|
|
52
|
+
$selectedOrders = \FluentCart\App\Models\Order::find([101, 102, 103]);
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### 4. Aggregate Functions
|
|
56
|
+
```php
|
|
57
|
+
// Count total completed orders
|
|
58
|
+
$totalCompleted = \FluentCart\App\Models\Order::where('status', 'completed')->count();
|
|
59
|
+
|
|
60
|
+
// Calculate maximum total amount in cents for completed orders
|
|
61
|
+
$maxOrderValue = \FluentCart\App\Models\Order::where('status', 'completed')->max('total_amount');
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
|
|
66
|
+
## ✏️ Inserting, Updating & Deleting
|
|
67
|
+
|
|
68
|
+
### 1. Creating New Records
|
|
69
|
+
```php
|
|
70
|
+
// Create a new order record using mass assignment
|
|
71
|
+
$order = \FluentCart\App\Models\Order::create([
|
|
72
|
+
'customer_id' => 42, // Reference to customer ID
|
|
73
|
+
'status' => 'pending', // Order status slug
|
|
74
|
+
'payment_method' => 'stripe', // Gateway key
|
|
75
|
+
'currency' => 'USD', // Currency ISO code
|
|
76
|
+
'total_amount' => \FluentCart\App\Helpers\Helper::toCent(49.99) // Convert $49.99 to 4999 cents
|
|
77
|
+
]);
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
### 2. Updating Existing Models
|
|
81
|
+
```php
|
|
82
|
+
// Find order model by primary key ID
|
|
83
|
+
$order = \FluentCart\App\Models\Order::find(101);
|
|
84
|
+
|
|
85
|
+
// Modify properties directly on model instance
|
|
86
|
+
$order->status = 'completed'; // Update order status
|
|
87
|
+
$order->completed_at = date('Y-m-d H:i:s'); // Set completion timestamp
|
|
88
|
+
$order->save(); // Save changes to database
|
|
89
|
+
|
|
90
|
+
// Alternatively update attributes via array mass assignment
|
|
91
|
+
$order->update([
|
|
92
|
+
'status' => 'completed', // New status
|
|
93
|
+
'completed_at' => date('Y-m-d H:i:s') // Updated timestamp
|
|
94
|
+
]);
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
### 3. Deleting Models
|
|
98
|
+
```php
|
|
99
|
+
// Find and delete a single model instance
|
|
100
|
+
$order = \FluentCart\App\Models\Order::find(101);
|
|
101
|
+
$order->delete(); // Delete record from database
|
|
102
|
+
|
|
103
|
+
// Delete records in bulk matching query constraints
|
|
104
|
+
\FluentCart\App\Models\Order::where('status', 'draft')->delete();
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
---
|
|
108
|
+
|
|
109
|
+
## 🎯 Query Scopes & Relationships
|
|
110
|
+
|
|
111
|
+
### Local Query Scopes
|
|
112
|
+
Models include predefined query scopes. For instance, the `Order` model defines `scopeOfStatus`:
|
|
113
|
+
|
|
114
|
+
```php
|
|
115
|
+
// Use ofStatus query scope to filter completed orders
|
|
116
|
+
$completedOrders = \FluentCart\App\Models\Order::ofStatus('completed')->get();
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
### Relationships & Eager Loading
|
|
120
|
+
```php
|
|
121
|
+
// Find customer model by ID
|
|
122
|
+
$customer = \FluentCart\App\Models\Customer::find(15);
|
|
123
|
+
|
|
124
|
+
// Access hasMany orders relationship collection
|
|
125
|
+
$customerOrders = $customer->orders;
|
|
126
|
+
|
|
127
|
+
// Access hasMany subscriptions relationship collection
|
|
128
|
+
$customerSubscriptions = $customer->subscriptions;
|
|
129
|
+
|
|
130
|
+
// Eager load customer and item relationships to prevent N+1 query overhead
|
|
131
|
+
$orders = \FluentCart\App\Models\Order::with(['customer', 'items'])
|
|
132
|
+
->where('status', 'completed')
|
|
133
|
+
->get();
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
---
|
|
137
|
+
|
|
138
|
+
## 📋 Comprehensive Model Index
|
|
139
|
+
|
|
140
|
+
### Core Models (`\FluentCart\App\Models\*`)
|
|
141
|
+
|
|
142
|
+
| Domain | Model Name | Description & Table |
|
|
143
|
+
|---|---|---|
|
|
144
|
+
| **Orders** | `Order` | Central order record (`wp_fct_orders`) |
|
|
145
|
+
| | `OrderItem` | Individual line item in an order (`wp_fct_order_items`) |
|
|
146
|
+
| | `OrderTransaction` | Payment transactions and refunds (`wp_fct_order_transactions`) |
|
|
147
|
+
| | `OrderAddress` | Order billing & shipping addresses (`wp_fct_order_addresses`) |
|
|
148
|
+
| | `OrderMeta` | Custom key-value order metadata (`wp_fct_order_meta`) |
|
|
149
|
+
| | `OrderOperation` | UTM tracking and operation logs (`wp_fct_order_operations`) |
|
|
150
|
+
| | `OrderTaxRate` | Applied tax rates per order (`wp_fct_order_tax_rate`) |
|
|
151
|
+
| | `OrderDownloadPermission` | Customer digital file access permissions (`wp_fct_order_download_permissions`) |
|
|
152
|
+
| **Customers** | `Customer` | Customer profile & lifetime statistics (`wp_fct_customers`) |
|
|
153
|
+
| | `CustomerAddress` | Saved customer addresses (`wp_fct_customer_addresses`) |
|
|
154
|
+
| | `CustomerMeta` | Customer metadata storage (`wp_fct_customer_meta`) |
|
|
155
|
+
| **Products** | `Product` | Product post object wrapper |
|
|
156
|
+
| | `ProductDetail` | Inventory and fulfillment details (`wp_fct_product_details`) |
|
|
157
|
+
| | `ProductVariation` | Product SKUs, attributes & prices (`wp_fct_product_variations`) |
|
|
158
|
+
| | `ProductMeta` | Product metadata (`wp_fct_product_meta`) |
|
|
159
|
+
| | `ProductDownload` | Downloadable files attached to products (`wp_fct_product_downloads`) |
|
|
160
|
+
| **Subscriptions** | `Subscription` | Recurring subscription billing (`wp_fct_subscriptions`) |
|
|
161
|
+
| | `SubscriptionMeta` | Subscription metadata (`wp_fct_subscription_meta`) |
|
|
162
|
+
| **Cart & Coupons** | `Cart` | Customer shopping cart sessions (`wp_fct_carts`) |
|
|
163
|
+
| | `Coupon` | Coupon codes and condition rules (`wp_fct_coupons`) |
|
|
164
|
+
| | `AppliedCoupon` | Applied discounts on orders (`wp_fct_applied_coupons`) |
|
|
165
|
+
| **System** | `Activity` | System activity logs (`wp_fct_activity`) |
|
|
166
|
+
| | `ScheduledAction` | Background Action Scheduler jobs (`wp_fct_scheduled_actions`) |
|
|
167
|
+
| | `Meta` | Generic key-value store (`wp_fct_meta`) |
|
|
168
|
+
| | `User` | WordPress user integration |
|
|
169
|
+
| | `DynamicModel` | Flexible dynamic model instance |
|
|
170
|
+
|
|
171
|
+
### Attribute System Models (`\FluentCart\App\Models\*`)
|
|
172
|
+
- `AttributeGroup`: Attribute groups (e.g., Color, Size) (`wp_fct_atts_groups`)
|
|
173
|
+
- `AttributeTerm`: Attribute terms within groups (`wp_fct_atts_terms`)
|
|
174
|
+
- `AttributeRelation`: Object attribute relationships (`wp_fct_atts_relations`)
|
|
175
|
+
|
|
176
|
+
### Shipping & Tax Models (`\FluentCart\App\Models\*`)
|
|
177
|
+
- `ShippingZone`: Shipping zones (`wp_fct_shipping_zones`)
|
|
178
|
+
- `ShippingMethod`: Methods within zones (`wp_fct_shipping_methods`)
|
|
179
|
+
- `ShippingClass`: Shipping classes (`wp_fct_shipping_classes`)
|
|
180
|
+
- `TaxClass`: Tax classes (`wp_fct_tax_classes`)
|
|
181
|
+
- `TaxRate`: Tax rate rules per region (`wp_fct_tax_rates`)
|
|
182
|
+
|
|
183
|
+
### Label System Models (`\FluentCart\App\Models\*`)
|
|
184
|
+
- `Label`: Tagging and labeling system (`wp_fct_label`)
|
|
185
|
+
- `LabelRelationship`: Polymorphic label relations (`wp_fct_label_relationships`)
|
|
186
|
+
|
|
187
|
+
### Pro Plugin Models (`\FluentCartPro\App\Models\*`)
|
|
188
|
+
- `License`: License key management (`wp_fct_licenses`)
|
|
189
|
+
- `LicenseMeta`: License metadata (`wp_fct_license_meta`)
|
|
190
|
+
- `LicenseActivation`: Activation counts & hashes (`wp_fct_license_activations`)
|
|
191
|
+
- `LicenseSite`: Licensed domain URLs (`wp_fct_license_sites`)
|
|
192
|
+
- `OrderPromotion`: Order bump & promotional rules (`wp_fct_order_promotions`)
|
|
193
|
+
- `OrderPromotionStat`: Promotion conversion statistics (`wp_fct_order_promotion_stats`)
|
|
194
|
+
- `UserMeta`: Extended user metadata
|