v 1.0.5: feature - empty template file calls errorDispatcher

private-classes/Template/FileModelTemplateResolver.php

@@ -7,6 +7,7 @@
 use Prosopo\Views\Interfaces\Model\ModelNameResolverInterface;
 use Prosopo\Views\Interfaces\Model\ModelNamespaceResolverInterface;
 use Prosopo\Views\Interfaces\Model\TemplateModelInterface;
+use Prosopo\Views\Interfaces\Template\FileTemplateContentProviderInterface;
 use Prosopo\Views\Interfaces\Template\ModelTemplateResolverInterface;
 
 /**
@@ -19,6 +20,7 @@ final class FileModelTemplateResolver implements ModelTemplateResolverInterface
     private string $namespace;
     private string $extension;
     private bool $isFileBasedTemplate;
+    private FileTemplateContentProviderInterface $fileTemplateContentProvider;
     private ModelNameResolverInterface $modelNameProvider;
     private ModelNamespaceResolverInterface $modelNamespaceProvider;
 
@@ -27,12 +29,15 @@ public function __construct(
         string $templatesRootPath,
         string $extension,
         bool $isFileBasedTemplate,
+        FileTemplateContentProviderInterface $fileTemplateContentProvider,
         ModelNamespaceResolverInterface $modelNamespaceProvider,
         ModelNameResolverInterface $modelNameProvider
     ) {
         $this->templatesRootPath = $templatesRootPath;
         $this->namespace = $namespace;
         $this->extension = $extension;
+
+        $this->fileTemplateContentProvider = $fileTemplateContentProvider;
         $this->isFileBasedTemplate = $isFileBasedTemplate;
         $this->modelNameProvider = $modelNameProvider;
         $this->modelNamespaceProvider = $modelNamespaceProvider;
@@ -49,22 +54,11 @@ public function resolveModelTemplate(TemplateModelInterface $model): string
 
         $relativeTemplatePath = $this->getRelativeTemplatePath($relativeModelNamespace, $modelName);
 
-
         $absoluteTemplatePath = $this->getAbsoluteTemplatePath($relativeTemplatePath);
 
-        return  $this->isFileBasedTemplate ?
+        return $this->isFileBasedTemplate ?
             $absoluteTemplatePath :
-            $this->getFileContent($absoluteTemplatePath);
-    }
-
-    protected function getFileContent(string $file): string
-    {
-        if (! file_exists($file)) {
-            return '';
-        }
-
-        // @phpcs:ignore
-        return (string)file_get_contents($file);
+            $this->fileTemplateContentProvider->getFileTemplateContent($absoluteTemplatePath);
     }
 
     protected function getAbsoluteTemplatePath(string $relativeTemplatePath): string

private-classes/Template/FileTemplateContentProvider.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Prosopo\Views\PrivateClasses\Template;
+
+use Prosopo\Views\Interfaces\EventDispatcherInterface;
+use Prosopo\Views\Interfaces\Template\FileTemplateContentProviderInterface;
+
+/**
+ * This class is marked as a final and placed under the 'Private' namespace to prevent anyone from using it directly.
+ * We reserve the right to change its name and implementation.
+ */
+final class FileTemplateContentProvider implements FileTemplateContentProviderInterface
+{
+    private string $errorEventName;
+    private EventDispatcherInterface $eventDispatcher;
+
+    public function __construct(
+        string $errorEventName,
+        EventDispatcherInterface $eventDispatcher
+    ) {
+        $this->errorEventName = $errorEventName;
+        $this->eventDispatcher = $eventDispatcher;
+    }
+
+    public function getFileTemplateContent(string $file): string
+    {
+        if (file_exists($file)) {
+            // @phpcs:ignore
+            return (string)file_get_contents($file);
+        }
+
+        $this->eventDispatcher->dispatchEvent($this->errorEventName, [
+            'error' => 'Template file does not exist',
+            'file' => $file,
+        ]);
+
+        return '';
+    }
+}

private-classes/Template/TemplateRendererWithFileTemplate.php

@@ -4,6 +4,7 @@
 
 namespace Prosopo\Views\PrivateClasses\Template;
 
+use Prosopo\Views\Interfaces\Template\FileTemplateContentProviderInterface;
 use Prosopo\Views\Interfaces\Template\TemplateRendererInterface;
 
 /**
@@ -12,26 +13,21 @@
  */
 final class TemplateRendererWithFileTemplate implements TemplateRendererInterface
 {
+    private FileTemplateContentProviderInterface $fileTemplateContentProvider;
     private TemplateRendererInterface $templateRenderer;
 
-    public function __construct(TemplateRendererInterface $templateRenderer)
-    {
+    public function __construct(
+        FileTemplateContentProviderInterface $fileTemplateContentProvider,
+        TemplateRendererInterface $templateRenderer
+    ) {
+        $this->fileTemplateContentProvider = $fileTemplateContentProvider;
         $this->templateRenderer = $templateRenderer;
     }
 
     public function renderTemplate(string $template, array $variables = []): string
     {
-        $template = $this->getFileContent($template);
+        $template = $this->fileTemplateContentProvider->getFileTemplateContent($template);
 
         return $this->templateRenderer->renderTemplate($template, $variables);
     }
-
-    protected function getFileContent(string $file): string
-    {
-        if (! file_exists($file)) {
-            return '';
-        }
-
-        return (string) file_get_contents($file);
-    }
 }

private-classes/View/ViewNamespace.php

@@ -22,6 +22,7 @@
     ModelRendererWithEventDetails};
 use Prosopo\Views\PrivateClasses\EventDispatcher;
 use Prosopo\Views\PrivateClasses\Template\FileModelTemplateResolver;
+use Prosopo\Views\PrivateClasses\Template\FileTemplateContentProvider;
 use Prosopo\Views\PrivateClasses\Template\TemplateRendererWithModelsRender;
 use Prosopo\Views\View\ViewNamespaceConfig;
 use Prosopo\Views\View\ViewNamespaceModules;
@@ -81,13 +82,19 @@ public function __construct(
             new ModelNameResolver(new ObjectClassReader()) :
             $modelNameProvider;
 
+        $fileTemplateContentProvider = new FileTemplateContentProvider(
+            $templateErrorEventName,
+            $eventDispatcher,
+        );
+
         $modelTemplateResolver = $modules->getModelTemplateResolver();
         $modelTemplateResolver = null === $modelTemplateResolver ?
             new FileModelTemplateResolver(
                 $namespace,
                 $config->getTemplatesRootPath(),
                 $config->getTemplateFileExtension(),
                 $config->fileBasedTemplates(),
+                $fileTemplateContentProvider,
                 $modelNamespaceProvider,
                 $modelNameProvider
             ) :

src/Interfaces/Template/FileTemplateContentProviderInterface.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Prosopo\Views\Interfaces\Template;
+
+interface FileTemplateContentProviderInterface
+{
+    public function getFileTemplateContent(string $file): string;
+}

src/View/ViewTemplateRenderer.php

@@ -11,6 +11,7 @@
 use Prosopo\Views\PrivateClasses\CodeRunner\CodeRunnerWithTemplateCompilation;
 use Prosopo\Views\PrivateClasses\CodeRunner\PhpCodeRunner;
 use Prosopo\Views\PrivateClasses\EventDispatcher;
+use Prosopo\Views\PrivateClasses\Template\FileTemplateContentProvider;
 use Prosopo\Views\PrivateClasses\Template\TemplateRenderer;
 use Prosopo\Views\PrivateClasses\Template\TemplateRendererWithCustomEscape;
 use Prosopo\Views\PrivateClasses\Template\TemplateRendererWithEventDetails;
@@ -66,7 +67,12 @@ public function __construct(?ViewTemplateRendererConfig $config = null)
             $templateRenderer;
 
         if ($config->fileBasedTemplates()) {
-            $templateRenderer = new TemplateRendererWithFileTemplate($templateRenderer);
+            $fileTemplateContentProvider = new FileTemplateContentProvider(
+                $errorEventName,
+                $eventDispatcher,
+            );
+
+            $templateRenderer = new TemplateRendererWithFileTemplate($fileTemplateContentProvider, $templateRenderer);
         }
 
         $templateRenderer = new TemplateRendererWithCustomEscape(