veiliglanceren/laravel-webshop-product

Collection of resources for implementing a product structure in Laravel e-commerce projects

0.0.2 2025-07-17 23:22 UTC

Requires

• php: ^8.1
• ext-dom: *
• ext-simplexml: *
• laravel/framework: ^10.0|^11.0|^12.0
• spatie/laravel-sluggable: ^3.7

Requires (Dev)

• orchestra/testbench: ^8.0 || ^9.0 || ^10.0
• pestphp/pest: ^2.0 || ^3.0
• pestphp/pest-plugin-laravel: ^2.0 || ^3.0

MIT

• Niels Hamelink

README

This package provides a modular way to manage products for your Laravel webshop. It is designed to be simple, extendable, and easily integrated into existing Laravel projects.

Features

• Product model with Eloquent support
• Easy CRUD operations for products
• Migration and configuration publishing
• Extendable for custom features

Installation

Require the package via Composer:

composer require veiliglanceren/laravel-webshop-product

Publish Assets

To publish configuration, migrations, and other assets:

php artisan vendor:publish --provider="VeiligLanceren\LaravelWebshopProduct\ProductServiceProvider"

Database Migration

Run the migrations to create the necessary tables:

php artisan migrate

Usage

Product Model

Use the provided Product model directly or extend it:

use VeiligLanceren\LaravelWebshopProduct\Models\Product;

$products = Product::all();

CRUD Example

// Create
$product = Product::create([
    'name' => 'Example Product',
    'price' => 99.99,
    'sku' => 'example-product'
]);

// Read
$product = Product::find(1);

// Update
$product->update([
    'price' => 89.99,
]);

// Delete
$product->delete();

Database Structure

Table	Columns
products	id, name, slug, sku, price, description, is_visible, order, timestamps
product_images	id, product_id, url, alt_text, is_primary, order, timestamps
product_variants	id, product_id, name, sku, price, stock, is_default, order, timestamps
categories	id, name, slug, timestamps
categoryables	id, category_id, categoryable_id, categoryable_type, timestamps

These tables support full product management, media handling, variant selection, and categorization using a polymorphic relationship.

HasCategory Trait

To make a model categorizable, use the HasCategory trait:

use VeiligLanceren\LaravelWebshopProduct\Traits\HasCategory;

class MyModel extends Model
{
    use HasCategory;
}

This trait provides a polymorphic morphToMany relationship with the categories table. Inspired by Spatie's Sluggable and Taggable packages.

Available methods

$model->attachCategories([1, 2]);   // Attach by ID or model
$model->detachCategories([1]);      // Detach by ID
$model->syncCategories([1, 3]);     // Replace existing list
$model->categories;                 // Retrieve related categories
$model->hasCategory('slug');        // Check by slug
$model->hasCategory(5);             // Check by ID
$model->hasCategory($category);     // Check by Category model

By default the Trait sets the route key name, this makes {category} usage possible in the routes. This would be {category:slug} without.

public function getRouteKeyName(): string
{
    return 'slug';
}

Extending Functionality

You can extend the Product model or override views, controllers, and routes to fit your webshop needs.

Configuration

If you published the config file, you can customize package settings in:

config/product.php

Testing

Run tests with PHPUnit:

php artisan test

Contributing

Contributions, issues, and feature requests are welcome. Please follow the repository guidelines.

License

This package is open-sourced software licensed under the MIT license.

Links

• Initial structure pull request