bvkdev/categorizable

Implement the ability to categorize for custom models

dev-master / 1.0.x-dev 2021-12-21 12:54 UTC

Requires

• php: ^7.2|^8.0
• illuminate/database: ^7.0|^8.0
• illuminate/support: ^7.0|^8.0
• kalnoy/nestedset: ^6.0

MIT

• Behrooz

README

This Package enables you to Categorize your Eloquent Models. just use the trait in the model and you're good to go.

Requirements

• PHP 7.2+
• Laravel 7+

Installation

composer require bvkdev/categorizable

Publish and Run the migrations

php artisan vendor:publish --provider="BvkDev\Categorizable\CategorizableServiceProvider"

php artisan migrate

Laravel Categorizable package will be auto-discovered by Laravel. and if not: register the package in config/app.php providers array manually.

'providers' => [
	...
	BvkDev\Categorizable\CategorizableServiceProvider::class,
],

Setup models - just use the Trait in the Model.

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;
use BvkDev\Categorizable\Categorizable;

class Product extends Model
{
	use Categorizable;
}

Usage

first of all we need to create some Category to work with. Laravel Categorizable package relies on another package called laravel-nestedset that is responsible for creating, updating, removing and retrieving single or nested categories. Here i demonstrate how to create categories and assign one as the other's child.. but you can always refer to package's repository for full documentation. https://github.com/lazychaser/laravel-nestedset

use App\Product;
use BvkDev\Categorizable\Category;

// first we create a bunch of categories

// create "BackEnd" category
Category::create([
	'name' => 'BackEnd'
]);

// create "PHP" category
Category::create([
	'name' => 'PHP'
]);

// create "FrontEnd" category
Category::create([
	'name' => 'FrontEnd'
]);

// create "Test" Category (alternative way)
$test = new Category();
$test->name = 'Test';
$test->save();


// assign "PHP" as a child of "BackEnd" category
$parent = Category::findByName('BackEnd');
$child = Category::findByName('PHP');
$parent->appendNode($child);

// delete "Test" Category
$testObj = Category::findByName('Test');
$testObj->delete();



//  assuming that we have these variables
$product = Product::first();

// 3 different ways of getting a category's instance
$backendCategory = Category::findById(1);	// 'BackEnd'
$phpCategory = Category::findByName('PHP');	// 'PHP'
$frontendCategory = Category::find(3);		// 'FrontEnd'

Attach the Product to category

    $product->attachCategory($phpCategory);

Detach the Product from a category

    $product->detachCategory($phpCategory); 

Attach the Product to list of categories

    $product->syncCategories([
	    $phpCategory,
	    $backendCategory
	    ]); 

Detach the Product from all categories

    $product->syncCategories([]); 

Sync the categories attached to a Product

    $product->syncCategories([
	    $frontendCategory
	    ]); 


    // removes attached categories & adds the given categories

Check if Product is attached to categories (boolean)

    // single use case
    $product->hasCategory($phpCategory);

    // multiple use case
    $product->hasCategory([
	    $phpCategory,
	    $backendCategory
	    ]);


    // return boolean

List of categories attached to the Product (array)

    $product->categoriesList();


    // return array [id => name]

List of categories IDs attached to the Product (array)

    $product->categoriesId();


    // return array

Get all Products attached to given category (collection)

    $categoryProducts = Category::find(1)
	    ->entries(Product::class)
	    ->get();


    // return collection

Relationships

categories() Relationship

    $productWithCategories = Product::with('categories')
	    ->get();


     // you have access to categories() relationship in case you need eager loading
    

parent Relationship

    $category = Product::first()->categories()->first();
    
    $category->parent;
    // return the category's parent if available

children Relationship

    $category = Product::first()->categories()->first();
    
    $category->children;
    // return the category's children if any

ancestors Relationship

    $category = Product::first()->categories()->first();
    
    $category->ancestors;
    // return the category's ancestors if any

descendants Relationship

    $category = Product::first()->categories()->first();
    
    $category->descendants;
    // return the category's descendants if any

Credits

• Behrooz Valikhani - [e-mail]