Download the PHP package thefeqy/laravel-model-status without Composer

🔁 Laravel Model Status

A Laravel package that simplifies status management for Eloquent models.

Table of Contents

• Features
• Installation
  • Step 1: Run the Installation Command
• Configuration
  • Using .env Variables

• Usage

  • Using the HasActiveScope Trait
  • Querying Models
  • Using Status Casting
  • Cascade Deactivation
  • Using the Middleware
  • Add Middleware to Routes
• Admin Bypass for Active Scope
• Advanced Configuration
• Testing
• Security
• Contributing
• License

Features

• HasActiveScope Trait: Automatically filters models with active status.
• Admin Bypass: Admin users can see all models, including inactive ones.
• Helper Methods: $model->status->isActive() and $model->status->isInactive().
• Dynamic Configuration: Define custom statuses & column names via .env.
• Installation Command: php artisan model-status:install for easy setup.
• PHP 8.3 Support.

Installation

You can install the package via Composer:

Step 1: Run the Installation Command

This will:

• Publish the config file (config/model-status.php).
• Set up required environment variables in .env and .env.example.
• Ensure your project is ready to use the package.

Configuration

You can customize the package settings in:

config/model-status.php

Using .env Variables

Instead of modifying config/model-status.php, you can override values in .env:

.env

Now, the package will automatically adapt to your setup.

Usage

Using the HasActiveScope Trait

To enable status management in a model:

Now, inactive models are automatically excluded from queries.

Querying Models

Get Active Models (Default Behavior)

Get All Models (Including Inactive)

Manually Activating / Deactivating a Model

Checking a Model's Status

Using Status Casting

To ensure status is always cast to a Status object, use the StatusCast class.

Apply Status Casting in Models

Example Usage

Now, $product->status is an instance of Status, allowing method calls like isActive() and isInactive().

Cascade Deactivation

If a model is deactivated, its related models can also be automatically deactivated.

Example

Now, deactivating a category will also deactivate all products under it:

Using the Middleware

The package includes the EnsureAuthenticatedUserIsActive middleware, which enforces that only users with an active status can access certain routes.

Add Middleware to Routes

Instead of registering a string alias for the middleware, you can reference it by class name in your route definition:

Admin Bypass for Active Scope

By default, admin users can see inactive models.

This behavior is controlled in config/model-status.php:

Advanced Configuration

If you need a different column name or status values, update .env:

Now, models will use:

instead of:

Testing

Run tests using Pest PHP:

Security

If you discover a security vulnerability, please report it via email: 📩 thefeqy@gmail.com

Contributing

Want to improve this package? Check out CONTRIBUTING for contribution guidelines.

License

This package is open-source software licensed under the MIT License.