Skip to content
Open
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
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,35 @@ Route::resource('users', UserController::class)
]);
```

You can define breadcrumbs for nested resources. Parent resources will be passed
to callables, otherwise is the same simple resource controllers.


```php
Route::resource('users.files', FilesController::class)
->breadcrumbs(function(ResourceBreadcrumbs $breadcrumbs) {
$breadcrumbs
->index('Files')
->create('New File')
->show(fn(User $user, File $file) => $file->name)
->edit('Edit');
});
```

In addition you can set parent a parent resource route as parent route. Parent
resource parameters are included in the route generation params.

```php
Route::resource('users.files', FilesController::class)
->breadcrumbs(function(ResourceBreadcrumbs $breadcrumbs) {
$breadcrumbs
->index('Files', 'users.show')
->create('New File')
->show(fn(User $user, File $file) => $file->name)
->edit('Edit');
});
```

#### Vendor Routes

Sometimes you want to register breadcrumbs for routes that are defined in 3rd-party packages.
Expand Down
16 changes: 10 additions & 6 deletions src/Routing/ResourceBreadcrumbs.php
Original file line number Diff line number Diff line change
Expand Up @@ -109,11 +109,15 @@ protected function getRouteNameForAction(string $action): string
protected function getParameterNamesForAction(string $action): array
{
$parameters = $this->getRouteGroupParameters();

if (in_array($action, ['show', 'edit'])) {
$parameters[] = $this->getResourceWildcard();
$nameParts = explode('.', $this->name);
$lastPart = end($nameParts);

foreach ($nameParts as $part) {
if ($lastPart !== $part || in_array($action, ['show', 'edit'])) {
$parameters[] = $this->getResourceWildcard($part);
}
}

return $parameters;
}

Expand All @@ -127,13 +131,13 @@ protected function getRouteGroupParameters(): array
return $matches[1] ?? [];
}

protected function getResourceWildcard(): string
protected function getResourceWildcard(string $value): string
{
return str_replace('-', '_', $this->getRawResourceWildcard());
}

/** @see \Illuminate\Routing\ResourceRegistrar::getResourceWildcard() */
protected function getRawResourceWildcard(): string
protected function getRawResourceWildcard(string $value): string
{
$value = $this->name;

Expand Down
92 changes: 90 additions & 2 deletions tests/ResourceRoutesTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

use Closure;
use Glhd\Gretel\Routing\ResourceBreadcrumbs;
use Glhd\Gretel\Tests\Models\Note;
use Glhd\Gretel\Tests\Models\User;
use Illuminate\Routing\Middleware\SubstituteBindings;
use Illuminate\Routing\PendingResourceRegistration;
Expand All @@ -14,7 +15,7 @@ class ResourceRoutesTest extends TestCase
use TestsCachedBreadcrumbs;

protected User $user;

protected Note $note;
protected function setUp(): void
{
parent::setUp();
Expand Down Expand Up @@ -373,7 +374,71 @@ public function test_grouped_resource_routes(bool $cache): void
['Create', '/movies/1/actors/create'],
);
}


/** @dataProvider cachingProvider */
public function test_nested_resource_routes(bool $cache): void
{
Route::middleware(SubstituteBindings::class)->group(function() {
Route::get('/', fn() => 'Home')->name('home')->breadcrumb('Home');

Route::resource('users', ResourceRoutesTestController::class)
->breadcrumbs(fn(ResourceBreadcrumbs $breadcrumbs) => $breadcrumbs
->index('Users', 'home')
->create('New User')
->show(fn(User $user) => $user->name)
->edit('Edit'));

Route::resource('users.notes', NestedResourceRoutesTestController::class)
->breadcrumbs(fn(ResourceBreadcrumbs $breadcrumbs) => $breadcrumbs
->index('Notes', 'users.show')
->create('Create')
->edit('Edit')
->show(fn(User $user, Note $note) => "{$user->name} : {$note->note}"));
});

$this->setUpCache($cache);

$this->note = Note::factory()->create([
'user_id' => $this->user->id
]);

$this->get(route('users.notes.index', $this->user));
$this->assertActiveBreadcrumbs(
['Home', '/'],
['Users', '/users'],
[$this->user->name, '/users/1'],
['Notes', '/users/1/notes'],
);

$this->get(route('users.notes.create', $this->user));
$this->assertActiveBreadcrumbs(
['Home', '/'],
['Users', '/users'],
[$this->user->name, '/users/1'],
['Notes', '/users/1/notes'],
['Create', '/users/1/notes/create'],
);

$this->get(route('users.notes.show', [$this->user, $this->note]));
$this->assertActiveBreadcrumbs(
['Home', '/'],
['Users', '/users'],
[$this->user->name, '/users/1'],
['Notes', '/users/1/notes'],
["{$this->user->name} : {$this->note->note}", '/users/1/notes/1'],
);

$this->get(route('users.notes.edit', [$this->user, $this->note]));
$this->assertActiveBreadcrumbs(
['Home', '/'],
['Users', '/users'],
[$this->user->name, '/users/1'],
['Notes', '/users/1/notes'],
["{$this->user->name} : {$this->note->note}", '/users/1/notes/1'],
['Edit', '/users/1/notes/1/edit'],
);
}

protected function registerResourceRoute(bool $cache, Closure $setup): self
{
Route::middleware(SubstituteBindings::class)
Expand Down Expand Up @@ -433,3 +498,26 @@ public function edit(User $jazzy_dancer)
return $jazzy_dancer->name;
}
}

class NestedResourceRoutesTestController
{
public function index(User $user)
{
return 'User Notes';
}

public function create(User $user)
{
return 'Create';
}

public function show(User $user, Note $note)
{
return $note->note;
}

public function edit(User $user, Note $note)
{
return $note->note;
}
}