Attribute Group Model

DB Table Name	{wp_db_prefix}_fct_atts_groups
Schema	Check Schema
Source File	fluent-cart/app/Models/AttributeGroup.php
Name Space	FluentCart\App\Models
Class	FluentCart\App\Models\AttributeGroup

Traits

• CanSearch (FluentCart\App\Models\Concerns\CanSearch) - Provides search(), groupSearch(), whereLike(), whereBeginsWith(), and whereEndsWith() query scopes.

Attributes

Attribute	Data Type	Comment
id	Integer	Primary Key
title	String	Attribute group title (e.g., Color, Size)
slug	String	Attribute group slug
description	Text	Attribute group description
settings	JSON	Attribute group settings
created_at	Date Time	Creation timestamp
updated_at	Date Time	Last update timestamp

Boot Events

The model registers a deleting event in the boot() method that automatically deletes all associated terms when an attribute group is deleted:

static::deleting(function ($model) {
    $model->terms()->delete();
});

Usage

Please check Model Basic for Common methods.

Accessing Attributes

$attributeGroup = FluentCart\App\Models\AttributeGroup::find(1);

$attributeGroup->id; // returns id
$attributeGroup->title; // returns title
$attributeGroup->slug; // returns slug
$attributeGroup->description; // returns description
$attributeGroup->settings; // returns settings (auto-decoded from JSON)

Scopes

This model has the following scopes that you can use

applyCustomFilters($filters)

Apply custom filters to the query. Accepts filters for any fillable attribute plus a special terms_count filter for filtering by the number of associated terms. Supported operators: includes (LIKE), not_includes (NOT LIKE), gt (>), lt (<), and standard SQL comparison operators for terms_count.

• Parameters
  • $filters - array of filter arrays, each with value and operator keys

Usage:

// Apply custom filters
$filteredGroups = FluentCart\App\Models\AttributeGroup::applyCustomFilters([
    'title' => ['value' => 'Color', 'operator' => 'includes'],
    'terms_count' => ['value' => 5, 'operator' => 'gt']
])->get();

Relations

This model has the following relationships that you can use

terms

Access all attribute terms in this group (hasMany)

• return FluentCart\App\Models\AttributeTerm Model Collection

Example:

// Accessing Terms
$terms = $attributeGroup->terms;

// For Filtering by terms relationship
$attributeGroups = FluentCart\App\Models\AttributeGroup::whereHas('terms', function($query) {
    $query->where('title', 'Red');
})->get();

usedTerms

Access all used attribute relations for this group (hasMany). Returns AttributeRelation records linked by group_id.

• return FluentCart\App\Models\AttributeRelation Model Collection

Example:

// Accessing Used Terms
$usedTerms = $attributeGroup->usedTerms;

// For Filtering by used terms relationship
$attributeGroups = FluentCart\App\Models\AttributeGroup::whereHas('usedTerms', function($query) {
    $query->where('term_id', 5);
})->get();

Methods

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

setSettingsAttribute($value)

Set settings with automatic JSON encoding (mutator). If the value is an array, it is JSON-encoded with JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES flags.

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

Usage

$attributeGroup->settings = ['display_type' => 'dropdown', 'required' => true];
// Automatically JSON encodes arrays

getSettingsAttribute($value)

Get settings with automatic JSON decoding (accessor). If the stored value is a string, it attempts to JSON-decode it. Returns the original string if decoding fails.

• Parameters
  • $value - mixed
• Returns mixed

Usage

$settings = $attributeGroup->settings; // Returns decoded value (array or string)

Usage Examples

Get Attribute Groups

$attributeGroup = FluentCart\App\Models\AttributeGroup::find(1);
echo "Title: " . $attributeGroup->title;
echo "Slug: " . $attributeGroup->slug;
echo "Description: " . $attributeGroup->description;

Create Attribute Group

$attributeGroup = FluentCart\App\Models\AttributeGroup::create([
    'title' => 'Color',
    'slug' => 'color',
    'description' => 'Product color variations',
    'settings' => [
        'display_type' => 'dropdown',
        'required' => true,
        'multiple' => false
    ]
]);

Get Attribute Groups with Terms

$attributeGroups = FluentCart\App\Models\AttributeGroup::with('terms')->get();

foreach ($attributeGroups as $group) {
    echo "Group: " . $group->title;
    foreach ($group->terms as $term) {
        echo "  - Term: " . $term->title;
    }
}

Apply Custom Filters

$filters = [
    'title' => ['value' => 'Color', 'operator' => 'includes'],
    'terms_count' => ['value' => 3, 'operator' => 'gt']
];

$filteredGroups = FluentCart\App\Models\AttributeGroup::applyCustomFilters($filters)->get();

Get Groups by Title

$colorGroups = FluentCart\App\Models\AttributeGroup::where('title', 'Color')->get();
$sizeGroups = FluentCart\App\Models\AttributeGroup::where('title', 'Size')->get();

Get Groups with Term Count

$groupsWithCounts = FluentCart\App\Models\AttributeGroup::withCount('terms')->get();

foreach ($groupsWithCounts as $group) {
    echo "Group: " . $group->title . " (" . $group->terms_count . " terms)";
}

Update Attribute Group

$attributeGroup = FluentCart\App\Models\AttributeGroup::find(1);
$attributeGroup->update([
    'description' => 'Updated description',
    'settings' => ['display_type' => 'radio', 'required' => false]
]);

Delete Attribute Group (with Terms)

$attributeGroup = FluentCart\App\Models\AttributeGroup::find(1);
$attributeGroup->delete(); // Automatically deletes associated terms via boot() deleting event

Use CanSearch Trait Scopes

// Search with the search scope (from CanSearch trait)
$groups = FluentCart\App\Models\AttributeGroup::search([
    'title' => ['column' => 'title', 'operator' => 'like_all', 'value' => 'Color']
])->get();

// Use whereLike scope
$groups = FluentCart\App\Models\AttributeGroup::whereLike('title', 'Col')->get();

---