Order Promotion Model

DB Table Name	{wp_db_prefix}_fct_order_promotions
Schema	Check Schema
Source File	fluent-cart-pro/app/Modules/Promotional/Models/OrderPromotion.php
Name Space	FluentCartPro\App\Modules\Promotional\Models
Class	FluentCartPro\App\Modules\Promotional\Models\OrderPromotion

Attributes

Attribute	Data Type	Comment
id	Integer	Primary Key
hash	String	Unique promotion hash
parent_id	Integer	Parent promotion ID
type	String	Promotion type
status	String	Promotion status
src_object_id	Integer	Source object ID
src_object_type	String	Source object type
title	String	Promotion title
description	Text	Promotion description
conditions	JSON	Promotion conditions
config	JSON	Promotion configuration
priority	Integer	Promotion priority
created_at	Date Time	Creation timestamp
updated_at	Date Time	Last update timestamp

Usage

Please check Model Basic for Common methods.

Accessing Attributes

$orderPromotion = FluentCartPro\App\Modules\Promotional\Models\OrderPromotion::find(1);

$orderPromotion->id; // returns id
$orderPromotion->hash; // returns hash
$orderPromotion->type; // returns type
$orderPromotion->status; // returns status

Relations

This model has the following relationships that you can use

product_variant

Access the associated product variant

• return FluentCart\App\Models\ProductVariation Model

Example:

// Accessing Product Variant
$productVariant = $orderPromotion->product_variant;

// For Filtering by product variant relationship
$orderPromotions = FluentCartPro\App\Modules\Promotional\Models\OrderPromotion::whereHas('product_variant', function($query) {
    $query->where('status', 'active');
})->get();

Methods

Along with Global Model methods, this model has few helper methods.

setConditionsAttribute($value)

Set conditions with automatic JSON encoding (mutator)

• Parameters
  • $value - mixed (array, object, or string)
• Returns void

Usage

$orderPromotion->conditions = ['min_amount' => 100, 'product_ids' => [1, 2, 3]];
// Automatically JSON encodes arrays and objects

getConditionsAttribute($value)

Get conditions with automatic JSON decoding (accessor)

• Parameters
  • $value - mixed
• Returns mixed

Usage

$conditions = $orderPromotion->conditions; // Returns decoded value (array, object, or string)

setConfigAttribute($value)

Set config with automatic JSON encoding (mutator)

• Parameters
  • $value - mixed (array, object, or string)
• Returns void

Usage

$orderPromotion->config = ['discount_type' => 'percentage', 'discount_value' => 10];
// Automatically JSON encodes arrays and objects

getConfigAttribute($value)

Get config with automatic JSON decoding (accessor)

• Parameters
  • $value - mixed
• Returns mixed

Usage

$config = $orderPromotion->config; // Returns decoded value (array, object, or string)

Usage Examples

Get Order Promotions

$orderPromotion = FluentCartPro\App\Modules\Promotional\Models\OrderPromotion::find(1);
echo "Title: " . $orderPromotion->title;
echo "Type: " . $orderPromotion->type;
echo "Status: " . $orderPromotion->status;
echo "Hash: " . $orderPromotion->hash;

Create Order Promotion

$orderPromotion = FluentCartPro\App\Modules\Promotional\Models\OrderPromotion::create([
    'type' => 'order_bump',
    'status' => 'active',
    'src_object_id' => 123,
    'src_object_type' => 'product_variation',
    'title' => 'Add-on Product',
    'description' => 'Enhance your order with this add-on',
    'conditions' => [
        'min_amount' => 50,
        'product_ids' => [1, 2, 3]
    ],
    'config' => [
        'discount_type' => 'percentage',
        'discount_value' => 15,
        'display_position' => 'checkout'
    ],
    'priority' => 1
]);
// Hash will be automatically generated

Get All Order Promotions

$orderPromotions = FluentCartPro\App\Modules\Promotional\Models\OrderPromotion::all();

foreach ($orderPromotions as $promotion) {
    echo "Promotion: " . $promotion->title;
    echo "Type: " . $promotion->type;
    echo "Status: " . $promotion->status;
}

Get Active Promotions

$activePromotions = FluentCartPro\App\Modules\Promotional\Models\OrderPromotion::where('status', 'active')->get();

Get Promotions by Type

$orderBumps = FluentCartPro\App\Modules\Promotional\Models\OrderPromotion::where('type', 'order_bump')->get();
$upsells = FluentCartPro\App\Modules\Promotional\Models\OrderPromotion::where('type', 'upsell')->get();

Get Promotions with Product Variants

$promotionsWithVariants = FluentCartPro\App\Modules\Promotional\Models\OrderPromotion::with('product_variant')->get();

foreach ($promotionsWithVariants as $promotion) {
    echo "Promotion: " . $promotion->title;
    if ($promotion->product_variant) {
        echo "Product: " . $promotion->product_variant->variation_title;
    }
}

Get Promotions by Priority

$orderedPromotions = FluentCartPro\App\Modules\Promotional\Models\OrderPromotion::orderBy('priority', 'asc')->get();

Update Order Promotion

$orderPromotion = FluentCartPro\App\Modules\Promotional\Models\OrderPromotion::find(1);
$orderPromotion->update([
    'status' => 'inactive',
    'config' => ['discount_value' => 20, 'updated' => true]
]);

Get Promotions by Source Object

$promotions = FluentCartPro\App\Modules\Promotional\Models\OrderPromotion::where('src_object_type', 'product_variation')
    ->where('src_object_id', 123)
    ->get();

Get Promotions by Hash

$promotion = FluentCartPro\App\Modules\Promotional\Models\OrderPromotion::where('hash', 'abc123def456')->first();

Delete Order Promotion

$orderPromotion = FluentCartPro\App\Modules\Promotional\Models\OrderPromotion::find(1);
$orderPromotion->delete();

Get Promotions with Conditions

$promotions = FluentCartPro\App\Modules\Promotional\Models\OrderPromotion::all();

foreach ($promotions as $promotion) {
    $conditions = $promotion->conditions;
    if (isset($conditions['min_amount'])) {
        echo "Min Amount: " . $conditions['min_amount'];
    }
}

---