create View

src/View.php

@@ -0,0 +1,215 @@
+<?php
+
+namespace yii1tech\mailer;
+
+use CFileHelper;
+use Yii;
+
+/**
+ * View is a email template view renderer.
+ *
+ * @property string $viewPath the root directory of view files. Defaults to 'views/mail' under the application base path.
+ * @property \IViewRenderer|\CViewRenderer|array|string|null|false $viewRenderer view renderer or its array configuration.
+ *
+ * @author Paul Klimov <[email protected]>
+ * @since 1.0
+ */
+class View extends \CBaseController
+{
+    /**
+     * @var string|null the name of the layout to be applied to the views.
+     * Defaults to `null`, meaning no layout should be applied.
+     *
+     * > Tip: you may change this value within particular view template - its original value will be restored after rendering.
+     */
+    public $layout;
+
+    /**
+     * @var string the root directory of view files. Defaults to 'views/mail' under the application base path.
+     */
+    private $_viewPath;
+
+    /**
+     * @var \IViewRenderer|\CViewRenderer|array|string|null|false view renderer or its array configuration.
+     */
+    private $_viewRenderer;
+
+    /**
+     * @return string the root directory of view files. Defaults to 'views/mail' under the application base path.
+     */
+    public function getViewPath(): string
+    {
+        if ($this->_viewPath === null) {
+            $this->_viewPath = Yii::app()->getBasePath() . DIRECTORY_SEPARATOR . 'views' . DIRECTORY_SEPARATOR . 'mail';
+        }
+
+        return $this->_viewPath;
+    }
+
+    /**
+     * @param string $viewPath the root directory of view files.
+     * @return static self reference.
+     */
+    public function setViewPath(string $viewPath): self
+    {
+        $this->_viewPath = $viewPath;
+
+        return $this;
+    }
+
+    /**
+     * Returns the view renderer - a component whose wants to replace the default view rendering logic.
+     * By default the application 'viewRenderer' component will be used, if it has been set.
+     *
+     * @return \IViewRenderer|\CViewRenderer|null|false view renderer.
+     */
+    public function getViewRenderer()
+    {
+        if (!is_object($this->_viewRenderer)) {
+            if ($this->_viewRenderer === null) {
+                if (Yii::app()->hasComponent('viewRenderer')) {
+                    return Yii::app()->getComponent('viewRenderer');
+                }
+            } elseif (is_string($this->_viewRenderer) || is_array($this->_viewRenderer)) {
+                $renderer = Yii::createComponent($this->_viewRenderer);
+                if ($renderer instanceof \IApplicationComponent) {
+                    $renderer->init();
+                }
+
+                $this->_viewRenderer = $renderer;
+            }
+        }
+
+        return $this->_viewRenderer;
+    }
+
+    /**
+     * Sets the view renderer - a component whose wants to replace the default view rendering logic.
+     * Component can be provided as an object or its array configuration.
+     * If `null` is given - the application 'viewRenderer' component will be used, if it has been set.
+     * If `false` is given - no custom view renderer will be used.
+     *
+     * @see \IViewRenderer
+     *
+     * @param \IViewRenderer|\CViewRenderer|array|string|null|false $viewRenderer view renderer.
+     * @return static self reference.
+     */
+    public function setViewRenderer($viewRenderer): self
+    {
+        $this->_viewRenderer = $viewRenderer;
+
+        return $this;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getViewFile($viewName)
+    {
+        if (empty($viewName)) {
+            return false;
+        }
+
+        if (!empty($renderer = $this->getViewRenderer())) {
+            $extension = $renderer->fileExtension;
+        } else {
+            $extension = '.php';
+        }
+
+        if (strpos($viewName, '.')) {
+            $viewFile = Yii::getPathOfAlias($viewName);
+        } else {
+            $viewFile = $this->getViewPath() . DIRECTORY_SEPARATOR . $viewName;
+        }
+
+        $viewFile .= $extension;
+
+        if (!file_exists($viewFile)) {
+            return false;
+        }
+
+        return $viewFile;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function renderFile($viewFile, $data = null, $return = false)
+    {
+        if (!empty($renderer = $this->getViewRenderer())) {
+            if ($renderer->fileExtension === '.' . CFileHelper::getExtension($viewFile)) {
+                return $renderer->renderFile($this, $viewFile, $data, $return);
+            }
+        }
+
+        return $this->renderInternal($viewFile, $data, $return);
+    }
+
+    /**
+     * Renders a view with a layout.
+     *
+     * This method first calls {@see renderPartial()} to render the view (called content view).
+     * It then renders the layout view which may embed the content view at appropriate place.
+     * In the layout view, the content view rendering result can be accessed via variable `$content`.
+     *
+     * @param string $view name of the view to be rendered. See {@see getViewFile()} for details about how the view script is resolved.
+     * @param array|null $data data to be extracted into PHP variables and made available to the view script.
+     * @return string the rendering result.
+     */
+    public function render(string $view, ?array $data = null): string
+    {
+        $originalLayout = $this->layout;
+        $obInitialLevel = ob_get_level();
+
+        try {
+            $content = $this->renderPartial($view, $data, true);
+
+            if (!empty($this->layout)) {
+                $content = $this->renderPartial($this->layout, ['content' => $content], true);
+            }
+        } catch (\Throwable $e) {
+            while (ob_get_level() > $obInitialLevel) {
+                if (!@ob_end_clean()) {
+                    ob_clean();
+                }
+            }
+
+            $this->layout = $originalLayout;
+
+            throw $e;
+        }
+
+        $this->layout = $originalLayout;
+
+        return $content;
+    }
+
+    /**
+     * Renders a view.
+     *
+     * The named view refers to a PHP script (resolved via {@see getViewFile()})
+     * that is included by this method. If $data is an associative array,
+     * it will be extracted as PHP variables and made available to the script.
+     *
+     * This method differs from {@see render()} in that it does not apply a layout to the rendered result.
+     *
+     * @param string $view name of the view to be rendered. See {@see getViewFile()} for details about how the view script is resolved.
+     * @param array|null $data data to be extracted into PHP variables and made available to the view script.
+     * @param bool $return whether the rendering result should be returned instead of being sent to output.
+     * @return string|null the rendering result. `Null` if the rendering result is not required.
+     * @throws \CException
+     */
+    public function renderPartial(string $view, ?array $data = null, bool $return = false)
+    {
+        $viewFile = $this->getViewFile($view);
+
+        if ($viewFile === false) {
+            throw new \InvalidArgumentException(Yii::t('yii', '{controller} cannot find the requested view "{view}".', [
+                '{controller}' => get_class($this),
+                '{view}' => $view,
+            ]));
+        }
+
+        return $this->renderFile($viewFile, $data, $return);
+    }
+}

tests/ViewTest.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace yii1tech\mailer\test;
+
+use yii1tech\mailer\View;
+
+class ViewTest extends TestCase
+{
+    public function testGetViewFile(): void
+    {
+        $view = new View();
+
+        $filename = $view->getViewFile('plain');
+        $this->assertSame(__DIR__ . '/views/mail/plain.php', $filename);
+
+        $filename = $view->getViewFile('application.bootstrap');
+        $this->assertSame(__DIR__ . '/bootstrap.php', $filename);
+    }
+
+    public function testRenderWithoutLayout(): void
+    {
+        $view = new View();
+        $view->layout = null;
+
+        $content = $view->render('plain', [
+            'name' => 'John Doe',
+        ]);
+
+        $this->assertStringContainsString('Name = John Doe', $content);
+    }
+
+    public function testRenderWithLayout(): void
+    {
+        $view = new View();
+        $view->layout = 'layout';
+
+        $content = $view->render('plain', [
+            'name' => 'John Doe',
+        ]);
+
+        $this->assertStringContainsString('Name = John Doe', $content);
+        $this->assertStringContainsString('<!--Header-->', $content);
+        $this->assertStringContainsString('<!--Footer-->', $content);
+    }
+
+    public function testSetupViewRenderer(): void
+    {
+        $view = new View();
+        $view->setViewRenderer([
+            'class' => \CPradoViewRenderer::class,
+        ]);
+
+        $viewRenderer = $view->getViewRenderer();
+
+        $this->assertTrue($viewRenderer instanceof \CPradoViewRenderer);
+    }
+}

tests/views/mail/layout.php

@@ -0,0 +1,3 @@
+<!--Header-->
+<?php echo $content; ?>
+<!--Footer-->

tests/views/mail/plain.php

@@ -0,0 +1,2 @@
+Test plain mail template
+Name = <?php echo $name; ?>