Merge pull request #7392 from sammyskills/fix-view-cells

fix: view cell cannot locate the auto-generated view file

Author: kenjis

system/Commands/Generators/CellGenerator.php

@@ -88,11 +88,8 @@ public function run(array $params)
         // Form the view name
         $segments = explode('\\', $this->qualifyClassName());
 
-        $view = array_pop($segments);
-        $view = str_replace('Cell', '', decamelize($view));
-        if (strpos($view, '_cell') === false) {
-            $view .= '_cell';
-        }
+        $view       = array_pop($segments);
+        $view       = decamelize($view);
         $segments[] = $view;
         $view       = implode('\\', $segments);
 

system/View/Cells/Cell.php

@@ -73,8 +73,13 @@ final protected function view(?string $view, array $data = []): string
 
         // If no view is specified, we'll try to guess it based on the class name.
         if (empty($view)) {
-            $view = decamelize((new ReflectionClass($this))->getShortName());
-            $view = str_replace('_cell', '', $view);
+            // According to the docs, the name of the view file should be the
+            // snake_cased version of the cell's class name, but for backward
+            // compatibility, the name also accepts '_cell' being omitted.
+            $ref      = new ReflectionClass($this);
+            $view     = decamelize($ref->getShortName());
+            $viewPath = dirname($ref->getFileName()) . DIRECTORY_SEPARATOR . $view . '.php';
+            $view     = is_file($viewPath) ? $viewPath : str_replace('_cell', '', $view);
         }
 
         // Locate our view, preferring the directory of the class.

tests/_support/View/Cells/AwesomeCell.php

@@ -0,0 +1,19 @@
+<?php
+
+/**
+ * This file is part of CodeIgniter 4 framework.
+ *
+ * (c) CodeIgniter Foundation <[email protected]>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace Tests\Support\View\Cells;
+
+use CodeIgniter\View\Cells\Cell;
+
+class AwesomeCell extends Cell
+{
+    public string $message = 'Found!';
+}

tests/_support/View/Cells/awesome_cell.php

@@ -0,0 +1 @@
+<div><?= $message ?></div>

tests/system/Commands/CellGeneratorTest.php

@@ -73,7 +73,7 @@ public function testGenerateCellSimpleName()
         $this->assertStringContainsString('class Another extends Cell', $contents);
 
         // Check the view was generated
-        $file = APPPATH . 'Cells/another_cell.php';
+        $file = APPPATH . 'Cells/another.php';
         $this->assertStringContainsString('File created: ', $this->getStreamFilterBuffer());
         $this->assertFileExists($file);
     }

tests/system/View/ControlledCellTest.php

@@ -14,6 +14,7 @@
 use CodeIgniter\Test\CIUnitTestCase;
 use CodeIgniter\View\Exceptions\ViewException;
 use Tests\Support\View\Cells\AdditionCell;
+use Tests\Support\View\Cells\AwesomeCell;
 use Tests\Support\View\Cells\ColorsCell;
 use Tests\Support\View\Cells\GreetingCell;
 use Tests\Support\View\Cells\ListerCell;
@@ -36,6 +37,13 @@ public function testCellRendersDefaultValues()
         $this->assertStringContainsString('Hello World', $result);
     }
 
+    public function testCellRendersViewWithActualClassName()
+    {
+        $result = view_cell(AwesomeCell::class);
+
+        $this->assertStringContainsString('Found!', $result);
+    }
+
     public function testCellWithNamedView()
     {
         $result = view_cell(SimpleNotice::class);