Download the PHP package dibakar/laravel-ownership without Composer

Laravel Ownership

A comprehensive ownership management system for Laravel applications. This package provides an elegant way to handle both single and multiple ownership scenarios with role-based permissions, events, and query scopes.

Features

• Dual Ownership Modes: Support for both single and multiple ownership models
• Role-based Access Control: Define custom roles with specific permissions
• Flexible Configuration: Highly customizable to fit any application needs
• Event-driven Architecture: Built-in events for all ownership changes
• Powerful Query Scopes: Filter models by ownership with ease
• Performance Optimized: Built-in caching for ownership checks
• Type Safety: Strict type declarations and modern PHP features
• Laravel Integration: Seamless integration with Laravel's authentication system
• Morphable Owners: Support for any authenticatable model as an owner
• Bulk Operations: Manage multiple owners at once with sync methods

Installation

1. Install the package via Composer:

2. Publish the configuration file:

3. Publish and run the migrations:

Configuration

The configuration file (config/ownership.php) allows you to customize various aspects of the package. Here are the main configuration options:

Usage

Single Ownership Mode

Add the HasOwnership trait to your model for single ownership:

Basic Operations

Multiple Ownership Mode

First, update your config to use multiple ownership mode:

Then add the HasOwnership trait to your model:

Managing Multiple Owners

php // Get all posts owned by the current user $posts = Post::ownedByCurrent()->get();

// Get all posts owned by a specific user $userPosts = Post::ownedBy($user)->get();

// In multiple ownership mode, get projects where user has a specific role $projects = Project::whereHasOwnerWithRole($user, 'editor')->get();

// Get models where user has specific permission $editablePosts = Post::whereUserHasPermission($user, 'edit')->get(); blade {{-- Check if current user owns the model --}} @owned($post) Edit @endowned

{{-- Check specific user ownership --}} @owned($post, $specificUser) Owned by {{ $specificUser->name }} @endowned

{{-- Check if user has specific permission --}} @can('edit', $post) Edit @endcan

@owned($model, $user = null) This content is only visible to the owner @endowned

@canOwn($model, 'edit', $user = null) This content is only visible to users with edit permission @endCanOwn

@isOwner($model, $user = null) This content is only visible to an owner @endIsOwner bash composer test

## Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

## License

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

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

## Credits

- [Dibakar Mitra](https://github.com/dibakarmitra)
- [All Contributors](../../contributors)