Bug #18469: fix Link::serialize method

framework/CHANGELOG.md

@@ -4,6 +4,7 @@ Yii Framework 2 Change Log
 2.0.50 under development
 ------------------------
 
+- Bug #18469: Fixed `Link::serialize(array $links)` method in `yii\web\Link` (ggh2e3)
 - Bug #13920: Fixed erroneous validation for specific cases (tim-fischer-maschinensucher)
 - Bug #19927: Fixed `console\controllers\MessageController` when saving translations to database: fixed FK error when adding new string and language at the same time, checking/regenerating all missing messages and dropping messages for unused languages (atrandafir)
 - Bug #20002: Fixed superfluous query on HEAD request in serializer (xicond)

framework/web/Link.php

@@ -66,7 +66,11 @@ public static function serialize(array $links)
                     $link[$i] = $l instanceof self ? array_filter((array) $l) : ['href' => $l];
                 }
                 $links[$rel] = $link;
-            } elseif (!$link instanceof self) {
+            }
+            if ($link instanceof self) {
+                $l = array_filter((array)$link);
+                $links[$rel] = $l;
+            } else {
                 $links[$rel] = ['href' => $link];
             }
         }

tests/framework/web/LinkTest.php

@@ -0,0 +1,105 @@
+<?php
+/**
+ * @link https://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
+ * @license https://www.yiiframework.com/license/
+ */
+
+namespace yiiunit\framework\web;
+
+use yii\base\BaseObject;
+use yii\web\Link;
+use yiiunit\TestCase;
+
+/**
+ * @group web
+ */
+class LinkTest extends TestCase
+{
+    public function testSerializeSimpleArraySuccessfully()
+    {
+        $this->assertEquals([
+            'link' => [
+                'href' => 'http://example.com/users/4'
+            ],
+            'title' => [
+                'href' => 'My user',
+            ]
+        ], Link::serialize([
+            'link' => 'http://example.com/users/4',
+            'title' => 'My user',
+        ]));
+    }
+
+    public function testSerializeArrayWithLinkSuccessfully()
+    {
+        $link = new UserLink([
+            'link' => 'http://example.com/users/4',
+            'title' => 'User 4',
+        ]);
+
+        $this->assertEquals([
+            'link serialized' => [
+                'title' => 'User 4',
+                'link' => 'http://example.com/users/4'
+            ],
+            'title' => ['href' => 'My user'],
+        ], Link::serialize([
+            'link serialized' => $link,
+            'title' => 'My user',
+        ]));
+    }
+
+    public function testSerializeNestedArrayWithLinkSuccessfully()
+    {
+        $link = new UserLink([
+            'link' => 'http://example.com/users/4',
+            'title' => 'User 4',
+        ]);
+
+        $this->assertEquals([
+            'link serialized' => [
+                'href' => [
+                    'manager' => [
+                        'title' => 'User 4',
+                        'link' => 'http://example.com/users/4'
+                    ]]
+            ],
+            'title' => ['href' => 'My user'],
+        ],
+            Link::serialize([
+                'link serialized' => [
+                    'manager' => $link
+                ],
+                'title' => 'My user',
+            ]));
+    }
+
+    public function testSerializeArrayWithNotaLinkClassesSuccessfully()
+    {
+        $notALink = new NotALink([
+            'fakeName' => 'John',
+        ]);
+
+        $this->assertEquals([
+            'this is not a link' => ['href' => $notALink],
+        ], Link::serialize([
+            'this is not a link' => $notALink,
+        ]));
+    }
+}
+
+class UserLink extends Link
+{
+    /** @var string */
+    public $link;
+
+    /** @var string */
+    public $title;
+}
+
+class NotALink extends BaseObject
+{
+    /** @var string */
+    public $fakeName;
+}