-
Notifications
You must be signed in to change notification settings - Fork 11.4k
[12.x] Add NamedScope attribute #54450
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
6915a93
Add NamedScope attribute
shaedrich 1b11b31
StyleCI
shaedrich df67443
Make Model::getAttributedNamedScope() protected
shaedrich 19590d2
wip
crynobone d6fc922
wip
crynobone 6d5aa00
wip
crynobone 3d3b2cd
wip
crynobone 9f6db62
wip
crynobone 90de5cf
fix(database): ✏ Fix typo
shaedrich 19f4804
refactor(database): :truck: Rename attribute class
shaedrich 799451a
refactor(database): :white_check_mark: Simplify test
shaedrich ded61f4
refactor(database): :recycle: Simplify named local scope attribute ch…
shaedrich ab19b5e
fix(database): :bug: Make attributed named scope statically callable
shaedrich 83a21e4
style(database): :rotating_light: StyleCI
shaedrich 50dbb5a
style(database): :rotating_light: StyleCI
shaedrich eb4fc57
formatting
taylorotwell 2c44cd5
add files
taylorotwell 1cf779d
fix tests
taylorotwell File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
<?php | ||
|
||
namespace Illuminate\Database\Eloquent\Attributes; | ||
|
||
use Attribute; | ||
|
||
#[Attribute(Attribute::TARGET_METHOD)] | ||
class Scope | ||
{ | ||
/** | ||
* Create a new attribute instance. | ||
* | ||
* @param array|string $classes | ||
* @return void | ||
*/ | ||
public function __construct() | ||
{ | ||
} | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
36 changes: 36 additions & 0 deletions
36
tests/Integration/Database/EloquentNamedScopeAttibuteTest.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
<?php | ||
|
||
namespace Illuminate\Tests\Integration\Database; | ||
|
||
use Orchestra\Testbench\Attributes\WithMigration; | ||
use Orchestra\Testbench\TestCase; | ||
|
||
#[WithMigration] | ||
class EloquentNamedScopeAttibuteTest extends TestCase | ||
{ | ||
protected $query = 'select * from "named_scope_users" where "email_verified_at" is not null'; | ||
|
||
protected function setUp(): void | ||
{ | ||
parent::setUp(); | ||
|
||
$this->markTestSkippedUnless( | ||
$this->usesSqliteInMemoryDatabaseConnection(), | ||
'Requires in-memory database connection', | ||
); | ||
} | ||
|
||
public function test_it_can_query_named_scoped_from_the_query_builder() | ||
{ | ||
$query = Fixtures\NamedScopeUser::query()->verified(true); | ||
|
||
$this->assertSame($this->query, $query->toRawSql()); | ||
} | ||
|
||
public function test_it_can_query_named_scoped_from_static_query() | ||
{ | ||
$query = Fixtures\NamedScopeUser::verified(true); | ||
|
||
$this->assertSame($this->query, $query->toRawSql()); | ||
} | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
<?php | ||
|
||
namespace Illuminate\Tests\Integration\Database\Fixtures; | ||
|
||
use Illuminate\Database\Eloquent\Attributes\Scope as NamedScope; | ||
use Illuminate\Database\Eloquent\Builder; | ||
|
||
class NamedScopeUser extends User | ||
{ | ||
/** {@inheritdoc} */ | ||
#[\Override] | ||
protected function casts(): array | ||
{ | ||
return [ | ||
'email_verified_at' => 'datetime', | ||
'password' => 'hashed', | ||
]; | ||
} | ||
|
||
#[NamedScope] | ||
protected function verified(Builder $builder, bool $email = true) | ||
{ | ||
return $builder->when( | ||
$email === true, | ||
fn ($query) => $query->whereNotNull('email_verified_at'), | ||
fn ($query) => $query->whereNull('email_verified_at'), | ||
); | ||
} | ||
|
||
public function scopeVerifiedUser(Builder $builder, bool $email = true) | ||
{ | ||
return $builder->when( | ||
$email === true, | ||
fn ($query) => $query->whereNotNull('email_verified_at'), | ||
fn ($query) => $query->whereNull('email_verified_at'), | ||
); | ||
} | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.