Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lacodix/laravel-global-or-scope
A Laravel package to add possibility to use global scopes with an or operation in Eloquent models
https://github.com/lacodix/laravel-global-or-scope
eloquent laravel laravel-package query scopes
Last synced: about 1 month ago
JSON representation
A Laravel package to add possibility to use global scopes with an or operation in Eloquent models
- Host: GitHub
- URL: https://github.com/lacodix/laravel-global-or-scope
- Owner: lacodix
- License: mit
- Created: 2024-02-19T19:01:30.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2024-09-15T14:57:38.000Z (4 months ago)
- Last Synced: 2024-12-02T08:13:29.936Z (about 2 months ago)
- Topics: eloquent, laravel, laravel-package, query, scopes
- Language: PHP
- Homepage:
- Size: 84 KB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# laravel-global-or-scope
[](https://packagist.org/packages/lacodix/laravel-global-or-scope)
[](https://github.com/lacodix/laravel-global-or-scope/actions?query=workflow%3Atest+branch%3Amaster)
[](https://github.com/lacodix/laravel-global-or-scope/actions?query=workflow%3Astyle+branch%3Amaster)
[](https://packagist.org/packages/lacodix/laravel-global-or-scope)
This package allows you to add global scopes to models combined with an or condition.
It contains additional functionality to disable some or all or-scopes on the fly.
## Documentation
You can find the entire documentation for this package on [our documentation site](https://www.lacodix.de/docs/laravel-global-or-scope)
## Installation
```bash
composer require lacodix/laravel-global-or-scope
```
## Basic Usage
Just add the trait to your eloquent model and then you can use the addGlobalOrScopes method when booting.
```php
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Scope;
use Lacodix\LaravelGlobalOrScope\Traits\GlobalOrScope;
class Post extends Model
{
use GlobalOrScope;
public static function booting(): void
{
static::addGlobalOrScopes([Scope1::class, Scope2::class]);
}
}
class Scope1 implements Scope
{
public function apply(Builder $builder, Model $model)
{
return $builder->whereNull('col1')->where('col2', 1);
}
}
class Scope2 implements Scope
{
public function apply(Builder $builder, Model $model)
{
return $builder->where('col3', 2);
}
}
...
Post::query()->where('user_id', 1000)->get();
```
This results in running the following SQL Query
```sql
select * from "posts" where "user_id" = 1000 and (("col1" is null and "col2" = 1) or ("col3" = 2))
```
For temporary disabling you can use
```php
Post::query()->withoutGlobalOrScopes()->where('user_id', 1000)->get();
```
what results in a simple
```sql
select * from "posts" where "user_id" = 1000
```
## Testing
```bash
composer test
```
## Contributing
Please run the following commands and solve potential problems before committing
and think about adding tests for new functionality.
```bash
composer rector:test
composer insights
composer csfixer:test
composer phpstan:test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Credits
- [lacodix](https://github.com/lacodix)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.