Merge remote-tracking branch 'origin/main'

Author: aguingand

docs/guide/link-to.md

@@ -130,6 +130,12 @@ To manually build the querystring (which you should avoid).
 
 To generate a list > show > form breadcrumb, instead of (by default) just a list > form.
 
+### `withListEntityKey(string $entityClassOrKey)`
+
+`LinkToShow` and `LinkToForm` only
+
+Allows specifying the entity key of the list, very useful in multi-entities lists (see the [Entity map feature](building-entity-list.md#entity-map)).
+
 ### `withBreadcrumb(Closure $closure)`
 
 `LinkToForm` and `LinkToShowPage` only

src/Utils/Links/LinkToForm.php

@@ -23,7 +23,7 @@ protected function generateUrl(): string
             return route('code16.sharp.form.edit', [
                 'parentUri' => sprintf(
                     's-list/%s%s',
-                    $this->entityKey,
+                    $this->listEntityKey ?: $this->entityKey,
                     $this->throughShowPage ? '/'.parent::generateUri() : ''
                 ),
                 'entityKey' => $this->entityKey,
@@ -32,7 +32,7 @@ protected function generateUrl(): string
         }
 
         return route('code16.sharp.form.create', [
-            'parentUri' => sprintf('s-list/%s', $this->entityKey),
+            'parentUri' => sprintf('s-list/%s', $this->listEntityKey ?: $this->entityKey),
             'entityKey' => $this->entityKey,
         ]);
     }

src/Utils/Links/LinkToShowPage.php

@@ -3,11 +3,13 @@
 namespace Code16\Sharp\Utils\Links;
 
 use Closure;
+use Code16\Sharp\Utils\Entities\SharpEntityManager;
 
 class LinkToShowPage extends SharpLinkTo
 {
     protected string $instanceId;
     protected BreadcrumbBuilder $breadcrumbBuilder;
+    protected ?string $listEntityKey = null;
 
     public static function make(string $entityClassOrKey, string $instanceId): self
     {
@@ -28,6 +30,13 @@ public function withBreadcrumb(Closure $closure): self
         return $this;
     }
 
+    public function withListEntityKey(string $entityClassOrKey): self
+    {
+        $this->listEntityKey = app(SharpEntityManager::class)->entityKeyFor($entityClassOrKey);
+
+        return $this;
+    }
+
     public function renderAsUrl(): string
     {
         if (isset($this->breadcrumbBuilder)) {
@@ -47,7 +56,7 @@ public function renderAsUrl(): string
     protected function generateUrl(): string
     {
         return route('code16.sharp.show.show', [
-            'parentUri' => sprintf('s-list/%s', $this->entityKey),
+            'parentUri' => sprintf('s-list/%s', $this->listEntityKey ?: $this->entityKey),
             'entityKey' => $this->entityKey,
             'instanceId' => $this->instanceId,
         ]);

tests/Unit/Utils/SharpLinkToTest.php

@@ -4,6 +4,7 @@
 use Code16\Sharp\Exceptions\SharpInvalidBreadcrumbItemException;
 use Code16\Sharp\Filters\SelectFilter;
 use Code16\Sharp\Tests\Fixtures\Entities\PersonEntity;
+use Code16\Sharp\Tests\Fixtures\Entities\PersonPhysicistEntity;
 use Code16\Sharp\Utils\Links\BreadcrumbBuilder;
 use Code16\Sharp\Utils\Links\LinkToDashboard;
 use Code16\Sharp\Utils\Links\LinkToEntityList;
@@ -28,6 +29,15 @@
     );
 });
 
+it('allows to generate a link to a form with another key for the list', function () {
+    $this->assertEquals(
+        '<a href="http://localhost/sharp/s-list/my-list-entity/s-form/my-entity/23" title="">test</a>',
+        LinkToForm::make('my-entity', 23)
+            ->withListEntityKey('my-list-entity')
+            ->renderAsText('test'),
+    );
+});
+
 it('allows to generate a link to a form through a show page', function () {
     $this->assertEquals(
         '<a href="http://localhost/sharp/s-list/my-entity/s-show/my-entity/23/s-form/my-entity/23" title="">test</a>',
@@ -37,6 +47,16 @@
     );
 });
 
+it('allows to generate a link to a form through a show page with another key for the list', function () {
+    $this->assertEquals(
+        '<a href="http://localhost/sharp/s-list/my-list-entity/s-show/my-entity/23/s-form/my-entity/23" title="">test</a>',
+        LinkToForm::make('my-entity', 23)
+            ->withListEntityKey('my-list-entity')
+            ->throughShowPage()
+            ->renderAsText('test'),
+    );
+});
+
 it('allows to generate a link to a show page', function () {
     $this->assertEquals(
         '<a href="http://localhost/sharp/s-list/my-entity/s-show/my-entity/23" title="">test</a>',
@@ -45,6 +65,15 @@
     );
 });
 
+it('allows to generate a link to a show page with another key for the list', function () {
+    $this->assertEquals(
+        '<a href="http://localhost/sharp/s-list/my-list-entity/s-show/my-entity/23" title="">test</a>',
+        LinkToShowPage::make('my-entity', 23)
+            ->withListEntityKey('my-list-entity')
+            ->renderAsText('test'),
+    );
+});
+
 it('allows to generate a link to a single show page', function () {
     $this->assertEquals(
         '<a href="http://localhost/sharp/s-show/my-entity" title="">test</a>',
@@ -71,6 +100,19 @@
     );
 });
 
+it('allows to generate a link to a show page with another key for the list passing SharpEntity classes', function () {
+    app(SharpConfigBuilder::class)
+        ->declareEntity(PersonEntity::class)
+        ->declareEntity(PersonPhysicistEntity::class);
+
+    $this->assertEquals(
+        '<a href="http://localhost/sharp/s-list/person/s-show/person-physicist/23" title="">test</a>',
+        LinkToShowPage::make(PersonPhysicistEntity::class, 23)
+            ->withListEntityKey(PersonEntity::class)
+            ->renderAsText('test'),
+    );
+});
+
 it('allows to generate an url to a show page with a specific breadcrumb', function () {
     $this->assertEquals(
         'http://localhost/sharp/s-list/base-entity/s-show/base-entity/3/s-show/my-entity/4',