Fixes yiisoft#16657: Ensure widgets after run event result contains t…

…he result of the rendered widget

framework/CHANGELOG.md

@@ -4,6 +4,7 @@ Yii Framework 2 Change Log
 2.0.16 under development
 ------------------------
 
+- Bug #16657: Ensure widgets after run event result contains the result of the rendered widget (AdeAttwood)
 - Enh #16151: Change of scope for method `getTableNameAndAlias()` (s1lver)
 - Bug #14230: Fixed `itemsOptions` ignored in `checkBoxList` (s1lver)
 - Bug #14368: Added `role` attribute for active radio list (s1lver)

framework/grid/GridView.php

@@ -298,7 +298,7 @@ public function run()
         $id = $this->options['id'];
         $options = Json::htmlEncode(array_merge($this->getClientOptions(), ['filterOnFocusOut' => $this->filterOnFocusOut]));
         $view->registerJs("jQuery('#$id').yiiGridView($options);");
-        parent::run();
+        return parent::run();
     }
 
     /**
@@ -359,7 +359,7 @@ public function renderItems()
 
         $tableFooter = false;
         $tableFooterAfterBody = false;
-        
+
         if ($this->showFooter) {
             if ($this->placeFooterAfterBody) {
                 $tableFooterAfterBody = $this->renderTableFooter();

framework/widgets/BaseListView.php

@@ -142,7 +142,7 @@ public function run()
 
         $options = $this->options;
         $tag = ArrayHelper::remove($options, 'tag', 'div');
-        echo Html::tag($tag, $content, $options);
+        return Html::tag($tag, $content, $options);
     }
 
     /**

framework/widgets/Block.php

@@ -64,7 +64,7 @@ public function run()
     {
         $block = ob_get_clean();
         if ($this->renderInPlace) {
-            echo $block;
+            return $block;
         }
         $this->view->blocks[$this->getId()] = $block;
     }

framework/widgets/Breadcrumbs.php

@@ -147,7 +147,7 @@ public function run()
             }
             $links[] = $this->renderItem($link, isset($link['url']) ? $this->itemTemplate : $this->activeItemTemplate);
         }
-        echo Html::tag($this->tag, implode('', $links), $this->options);
+        return Html::tag($this->tag, implode('', $links), $this->options);
     }
 
     /**

framework/widgets/ContentDecorator.php

@@ -76,6 +76,6 @@ public function run()
         $params = $this->params;
         $params['content'] = ob_get_clean();
         // render under the existing context
-        echo $this->view->renderFile($this->viewFile, $params);
+        return $this->view->renderFile($this->viewFile, $params);
     }
 }

framework/widgets/DetailView.php

@@ -161,7 +161,7 @@ public function run()
 
         $options = $this->options;
         $tag = ArrayHelper::remove($options, 'tag', 'table');
-        echo Html::tag($tag, implode("\n", $rows), $options);
+        return Html::tag($tag, implode("\n", $rows), $options);
     }
 
     /**

framework/widgets/FragmentCache.php

@@ -101,7 +101,7 @@ public function init()
     public function run()
     {
         if (($content = $this->getCachedContent()) !== false) {
-            echo $content;
+            return $content;
         } elseif ($this->cache instanceof CacheInterface) {
             $this->getView()->popDynamicContent();
 
@@ -114,7 +114,7 @@ public function run()
             }
             $data = [$content, $this->getDynamicPlaceholders()];
             $this->cache->set($this->calculateKey(), $data, $this->duration, $this->dependency);
-            echo $this->updateDynamicContent($content, $this->getDynamicPlaceholders());
+            return $this->updateDynamicContent($content, $this->getDynamicPlaceholders());
         }
     }
 

framework/widgets/LinkPager.php

@@ -155,7 +155,7 @@ public function run()
         if ($this->registerLinkTags) {
             $this->registerLinkTags();
         }
-        echo $this->renderPageButtons();
+        return $this->renderPageButtons();
     }
 
     /**

framework/widgets/LinkSorter.php

@@ -66,7 +66,7 @@ public function init()
      */
     public function run()
     {
-        echo $this->renderSortLinks();
+        return $this->renderSortLinks();
     }
 
     /**

framework/widgets/MaskedInput.php

@@ -124,7 +124,7 @@ public function init()
     public function run()
     {
         $this->registerClientScript();
-        echo $this->renderInputHtml($this->type);
+        return $this->renderInputHtml($this->type);
     }
 
     /**

framework/widgets/Menu.php

@@ -182,7 +182,7 @@ public function run()
             $options = $this->options;
             $tag = ArrayHelper::remove($options, 'tag', 'ul');
 
-            echo Html::tag($tag, $this->renderItems($items), $options);
+            return Html::tag($tag, $this->renderItems($items), $options);
         }
     }
 

framework/widgets/Pjax.php

@@ -127,12 +127,12 @@ public function init()
             $view->head();
             $view->beginBody();
             if ($view->title !== null) {
-                echo Html::tag('title', Html::encode($view->title));
+                return Html::tag('title', Html::encode($view->title));
             }
         } else {
             $options = $this->options;
             $tag = ArrayHelper::remove($options, 'tag', 'div');
-            echo Html::beginTag($tag, array_merge([
+            return Html::beginTag($tag, array_merge([
                 'data-pjax-container' => '',
                 'data-pjax-push-state' => $this->enablePushState,
                 'data-pjax-replace-state' => $this->enableReplaceState,
@@ -148,7 +148,7 @@ public function init()
     public function run()
     {
         if (!$this->requiresPjax()) {
-            echo Html::endTag(ArrayHelper::remove($this->options, 'tag', 'div'));
+            return Html::endTag(ArrayHelper::remove($this->options, 'tag', 'div'));
             $this->registerClientScript();
 
             return;

framework/widgets/Spaceless.php

@@ -61,10 +61,10 @@ public function init()
 
     /**
      * Marks the end of content to be cleaned from whitespace characters between HTML tags.
-     * Stops capturing an output and echoes cleaned result.
+     * Stops capturing an output and returns cleaned result.
      */
     public function run()
     {
-        echo trim(preg_replace('/>\s+</', '><', ob_get_clean()));
+        return trim(preg_replace('/>\s+</', '><', ob_get_clean()));
     }
 }

tests/framework/grid/RadiobuttonColumnTest.php

@@ -105,7 +105,7 @@ public function testMultipleInGrid()
             ],
         ]);
         ob_start();
-        $grid->run();
+        echo $grid->run();
         $actual = ob_get_clean();
         $this->assertEqualsWithoutLE(<<<'HTML'
 <div id="radio-gridview"><div class="summary">Showing <b>1-2</b> of <b>2</b> items.</div>

tests/framework/widgets/BlockTest.php

@@ -40,4 +40,24 @@ public function testShouldTriggerInitEvent()
 
         $this->assertTrue($initTriggered);
     }
+
+    public function testAfterRunResultNotEmpty()
+    {
+        $result = null;
+
+        ob_start();
+        Block::begin([
+            'renderInPlace' => true,
+            'on afterRun' => function($event) use (&$result) {
+                $result = $event->result;
+            },
+        ]);
+
+        echo 'The Block';
+
+        Block::end();
+        ob_end_clean();
+
+        $this->assertEquals('The Block', $result);
+    }
 }

tests/framework/widgets/BreadcrumbsTest.php

@@ -41,7 +41,7 @@ public function testHomeLinkNull()
             . '</ul>';
 
         ob_start();
-        $this->breadcrumbs->run();
+        echo $this->breadcrumbs->run();
         $actualHtml = ob_get_contents();
         ob_end_clean();
 
@@ -63,7 +63,7 @@ public function testHomeLinkFalse()
             . '</ul>';
 
         ob_start();
-        $this->breadcrumbs->run();
+        echo $this->breadcrumbs->run();
         $actualHtml = ob_get_contents();
         ob_end_clean();
 
@@ -82,7 +82,7 @@ public function testHomeLink()
             . '</ul>';
 
         ob_start();
-        $this->breadcrumbs->run();
+        echo $this->breadcrumbs->run();
         $actualHtml = ob_get_contents();
         ob_end_clean();
 
@@ -180,13 +180,29 @@ public function testTag()
             . "http://my.example.com/yii2/link/page\n";
 
         ob_start();
-        $this->breadcrumbs->run();
+        echo $this->breadcrumbs->run();
         $actualHtml = ob_get_contents();
         ob_end_clean();
 
         $this->assertEquals($expectedHtml, $actualHtml);
     }
 
+    public function testAfterRunResultNotEmpty()
+    {
+        $result = null;
+        Breadcrumbs::widget([
+            'links' => [
+                ['label' => 'Sample Post', 'url' => 'post/edit'],
+                'Edit',
+            ],
+            'on afterRun' => function ($event) use (&$result) {
+                $result = $event->result;
+            },
+        ]);
+
+        $this->assertNotNull($result);
+    }
+
     /**
      * Helper methods.
      * @param string $class

tests/framework/widgets/ContentDecoratorTest.php

@@ -41,4 +41,25 @@ public function testShouldTriggerInitEvent()
 
         $this->assertTrue($initTriggered);
     }
+
+    public function testAfterRunResultNotEmpty()
+    {
+        $result = null;
+
+        ob_start();
+        ContentDecorator::begin([
+            'viewFile' => '@yiiunit/data/views/layout.php',
+            'on afterRun' => function ($event) use (&$result) {
+                $result = $event->result;
+            },
+        ]);
+
+        echo 'The Content';
+
+        ContentDecorator::end();
+        ob_end_clean();
+
+        $this->assertContains('The Content', $result);
+        $this->assertContains('<title>Test</title>', $result);
+    }
 }

tests/framework/widgets/DetailViewTest.php

@@ -334,6 +334,25 @@ public function testShouldTriggerInitEvent()
 
         $this->assertTrue($initTriggered);
     }
+
+    public function testAfterRunResultNotEmpty()
+    {
+        $result = null;
+
+        $model = new ModelMock();
+        $model->id = 1;
+
+        ob_start();
+        DetailView::widget([
+            'model' => $model,
+            'on afterRun' => function ($event) use (&$result) {
+                $result = $event->result;
+            },
+        ]);
+        ob_end_clean();
+
+        $this->assertNotNull($result);
+    }
 }
 
 /**

tests/framework/widgets/LinkPagerTest.php

@@ -160,4 +160,20 @@ public function testShouldTriggerInitEvent()
 
         $this->assertTrue($initTriggered);
     }
+
+    public function testAfterRunResultNotEmpty()
+    {
+        $result = null;
+
+        ob_start();
+        LinkPager::widget([
+            'pagination' => $this->getPagination(1),
+            'on afterRun' => function ($event) use (&$result) {
+                $result = $event->result;
+            },
+        ]);
+        ob_end_clean();
+
+        $this->assertNotNull($result);
+    }
 }

tests/framework/widgets/LinkSorterTest.php

@@ -100,4 +100,32 @@ public function testShouldTriggerInitEvent()
 
         $this->assertTrue($initTriggered);
     }
+
+    public function testAfterRunResultNotEmpty()
+    {
+        $result = null;
+        $dataProvider = new ActiveDataProvider([
+            'query' => Order::find(),
+            'models' => [new Order()],
+            'totalCount' => 1,
+            'sort' => [
+                'attributes' => ['total'],
+                'route' => 'site/index',
+            ],
+        ]);
+
+        ob_start();
+        echo ListView::widget([
+            'dataProvider' => $dataProvider,
+            'layout' => '{sorter}',
+            'sorter' => [
+                'on afterRun' => function ($event) use (&$result) {
+                    $result = $event->result;
+                },
+            ]
+        ]);
+        ob_end_clean();
+
+        $this->assertNotNull($result);
+    }
 }