Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
19 changes: 19 additions & 0 deletions src/Illuminate/Database/Eloquent/Attributes/RoutedBy.php
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_CLASS)]
class RoutedBy
{
/**
* Create a new attribute instance.
*
* @param string $key
* @return void
*/
public function __construct(public string $key)
{
}
}
22 changes: 21 additions & 1 deletion src/Illuminate/Database/Eloquent/Model.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
use Illuminate\Contracts\Support\CanBeEscapedWhenCastToString;
use Illuminate\Contracts\Support\Jsonable;
use Illuminate\Database\ConnectionResolverInterface as Resolver;
use Illuminate\Database\Eloquent\Attributes\RoutedBy;
use Illuminate\Database\Eloquent\Collection as EloquentCollection;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
use Illuminate\Database\Eloquent\Relations\Concerns\AsPivot;
Expand All @@ -24,6 +25,7 @@
use JsonException;
use JsonSerializable;
use LogicException;
use ReflectionClass;
use Stringable;

abstract class Model implements Arrayable, ArrayAccess, CanBeEscapedWhenCastToString, HasBroadcastChannel, Jsonable, JsonSerializable, QueueableEntity, Stringable, UrlRoutable
Expand Down Expand Up @@ -2065,7 +2067,25 @@ public function getRouteKey()
*/
public function getRouteKeyName()
{
return $this->getKeyName();
return $this->resolveRouteKeyNameFromAttribute() ?? $this->getKeyName();
}

/**
* Resolve the route key name from the RoutedBy attribute.
*
* @return string|void
*/
protected function resolveRouteKeyNameFromAttribute()
{
$reflectionClass = new ReflectionClass(static::class);

$attributes = $reflectionClass->getAttributes(RoutedBy::class);

if (! isset($attributes[0]) || ! isset($attributes[0]->getArguments()[0])) {
return;
}

return $attributes[0]->getArguments()[0];
}

/**
Expand Down
12 changes: 12 additions & 0 deletions tests/Database/DatabaseEloquentModelTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
use Illuminate\Database\ConnectionResolverInterface as Resolver;
use Illuminate\Database\Eloquent\Attributes\CollectedBy;
use Illuminate\Database\Eloquent\Attributes\ObservedBy;
use Illuminate\Database\Eloquent\Attributes\RoutedBy;
use Illuminate\Database\Eloquent\Attributes\UseFactory;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Casts\ArrayObject;
Expand Down Expand Up @@ -1944,6 +1945,12 @@ public function testRouteNameIsPrimaryKeyName()
$this->assertSame('id', $model->getRouteKeyName());
}

public function testRouteNameCanBeSetWithRoutedByAttribute()
{
$model = new EloquentModelWithRoutedByAttribute;
$this->assertSame('slug', $model->getRouteKeyName());
}

public function testCloneModelMakesAFreshCopyOfTheModel()
{
$class = new EloquentModelStub;
Expand Down Expand Up @@ -4019,3 +4026,8 @@ class EloquentModelWithUseFactoryAttribute extends Model
{
use HasFactory;
}

#[RoutedBy('slug')]
class EloquentModelWithRoutedByAttribute extends Model
{
}