README

A simple and straighforward package to categorize models in your Laravel applications.

Installation

You can install the package via composer:

composer require starfolksoftware/pigeonhole
php artisan pigeonhole:install
php artisan migrate

Configuration

This is the contents of the published config file:

return [
    'middleware' => ['web'],

    'redirects' => [
        'store' => null,
        'update' => null,
        'destroy' => '/',
    ],
];

Optionally, you can publish the views using

php artisan vendor:publish --tag="pigeonhole-views"

Usage

<?php

namespace App\Models;

use App\Abstracts\Model;
use StarfolkSoftware\Levy\Taxable;
use StarfolkSoftware\Pigeonhole\Categorizable;

class Product extends Model
{
    use Categorizable;
}

To enable team support:

// this should be in a service provider
/**
 * Bootstrap any application services.
 *
 * @return void
 */
public function boot()
{
    Pigeonhole::supportsTeams();
}

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use StarfolkSoftware\Levy\TeamHasTaxes;
use StarfolkSoftware\Pigeonhole\TeamHasCategories;
use Tithe\HasSubscriptions;

class Team extends JetstreamTeam
{
    use TeamHasCategories;
}

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

starfolksoftware / pigeonhole

Maintainers

Details