Categories

Shopper\Core\Models\Category

use Shopper\Core\Models\Category;

// The model implements
- Shopper\Core\Models\Contracts\Category
- Spatie\MediaLibrary\HasMedia

// Uses traits
- HasRecursiveRelationships // (from laravel-adjacency-list)

namespace App\Models;

use Shopper\Core\Models\Category as BaseCategory;

class Category extends BaseCategory
{
    // Add your customizations here
}

return [
    'category' => \App\Models\Category::class,
];

Electronics (parent_id: null)
├── Computers (parent_id: 1)
│   ├── Laptops (parent_id: 2)
│   └── Desktops (parent_id: 2)
├── Phones (parent_id: 1)
│   ├── Smartphones (parent_id: 5)
│   └── Accessories (parent_id: 5)
└── Audio (parent_id: 1)

// Get parent category
$category->parent; // Returns Category model or null

// Check if has parent
if ($category->parent_id) {
    // This is a subcategory
}

// Get direct children
$category->children;

// Get all descendants (recursive)
$category->descendants;

// Get all ancestors
$category->ancestors;

// Get descendants with depth info
$category->descendantsAndSelf;

// Get all descendant categories
$category->descendantCategories;

// Useful for getting all subcategories at any depth

// Get all products in this category
$category->products;

// Get products count
$category->products()->count();

// Get published products only
$category->products()
    ->where('is_visible', true)
    ->whereDate('published_at', '<=', now())
    ->get();

$ancestors = Category::query()->find($id)->ancestors;
$categories = Category::with('descendants')->get();
$total = Category::query()->find($id)->descendants()->count();
Category::query()->find($id)->descendants()->update(['is_enabled' => false]);

use Shopper\Core\Models\Category;

// Get only enabled categories
Category::query()->enabled()->get();

// Get only top-level categories (no parent)
Category::query()->whereNull('parent_id')->get();

// Using the tree structure
Category::tree()->get();

// The model defines custom paths
public function getCustomPaths(): array
{
    return [
        [
            'name' => 'slug_path',
            'column' => 'slug',
            'separator' => '/',
        ],
    ];
}

// Example: electronics/computers/laptops
$category->slug_path;

// Enable a category
$category->updateStatus(true);

// Disable a category
$category->updateStatus(false);

// Get full path name for select options
$category->getLabelOptionName();

// Returns: "Electronics / Computers / Laptops"

use Shopper\Core\Models\Category;

// Create a root category
$electronics = Category::query()->create([
    'name' => 'Electronics',
    'slug' => 'electronics',
    'is_enabled' => true,
    'position' => 1,
]);

// Create a subcategory
$computers = Category::query()->create([
    'name' => 'Computers',
    'slug' => 'computers',
    'parent_id' => $electronics->id,
    'is_enabled' => true,
]);

// Slug auto-generation with parent prefix
$laptops = Category::query()->create([
    'name' => 'Laptops',
    'slug' => $computers->slug . '-laptops', // computers-laptops
    'parent_id' => $computers->id,
    'is_enabled' => true,
]);

// Get all root categories with children
$categories = Category::query()
    ->whereNull('parent_id')
    ->enabled()
    ->with('children')
    ->orderBy('position')
    ->get();

// Get category tree (all levels)
$tree = Category::query()
    ->enabled()
    ->tree()
    ->get()
    ->toTree();

// Get category with all descendants
$category = Category::query()
    ->where('slug', 'electronics')
    ->with('descendants')
    ->first();

// Get category breadcrumb (ancestors)
$breadcrumb = $category->ancestors;

// Get categories for navigation
$navCategories = Category::query()
    ->whereNull('parent_id')
    ->enabled()
    ->with(['children' => fn ($q) => $q->enabled()])
    ->orderBy('position')
    ->get();

// Get products in category and all subcategories
$category = Category::query()->find($id);

// Products in this category only
$products = $category->products;

// Products in category and all descendants
$categoryIds = $category->descendants->pluck('id')->push($category->id);

$products = Product::query()
    ->publish()
    ->whereHas('categories', fn ($q) => $q->whereIn('id', $categoryIds))
    ->get();

// config/shopper/features.php
use Shopper\Enum\FeatureState;

return [
    'category' => FeatureState::Disabled,
];

php artisan shopper:component:publish category

use Shopper\Livewire;

return [
    'pages' => [
        'category-index' => Livewire\Pages\Category\Index::class,
    ],
    'components' => [
        'slide-overs.category-form' => Livewire\SlideOvers\CategoryForm::class,
        'slide-overs.re-order-categories' => Livewire\SlideOvers\ReOrderCategories::class,
    ],
];

namespace App\Http\Controllers;

use Shopper\Core\Models\Category;
use Shopper\Core\Models\Product;

class CategoryController extends Controller
{
    public function index()
    {
        $categories = Category::query()
            ->whereNull('parent_id')
            ->enabled()
            ->with(['children' => fn ($q) => $q->enabled()])
            ->withCount('products')
            ->orderBy('position')
            ->get();

        return view('categories.index', compact('categories'));
    }

    public function show(string $slug)
    {
        $category = Category::query()
            ->where('slug', $slug)
            ->enabled()
            ->with('ancestors')
            ->firstOrFail();

        // Get products from category and descendants
        $categoryIds = $category->descendants
            ->pluck('id')
            ->push($category->id);

        $products = Product::query()
            ->publish()
            ->whereHas('categories', fn ($q) => $q->whereIn('id', $categoryIds))
            ->paginate(12);

        return view('categories.show', compact('category', 'products'));
    }
}