Skip to content

Clarify CastsAttributes::set() phpdoc to accept TGet; recommend symmetric casts #10

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Clarify CastsAttributes::set() phpdoc to accept TGet; recommend symmetric casts #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions Database/Eloquent/CastsAttributes.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@
use Illuminate\Database\Eloquent\Model;

/**
* Recommendation:
* Prefer symmetric casts (TGet == TSet) so "$a = $a = $b"
* remain safe and unsurprising.
*
* @template TGet
* @template TSet
*/
Expand All @@ -24,10 +28,12 @@ public function get(Model $model, string $key, mixed $value, array $attributes);
/**
* Transform the attribute to its underlying model values.
*
* @param \Illuminate\Database\Eloquent\Model $model
* @param string $key
* @param TSet|null $value
* @param array<string, mixed> $attributes
* Important:
* Implementations must tolerate receiving the runtime cast value (TGet) here.
* As with object caching, `set()` may receive the value returned by `get()` (TGet).
* Implementations should therefore accept both TGet and TSet.
*
* @param TGet|TSet|null $value
* @return mixed
*/
public function set(Model $model, string $key, mixed $value, array $attributes);
Expand Down
Loading