Added fallbacks to template loading

Author: srtab

CHANGELOG.md

@@ -7,10 +7,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ## [1.1.0] - XXXX-XX-XX
 ### Added
  - Renderers to facilitate integrations of template-engines:
-    - Added integration to `twig/twig` through `TwigRenderer` class renderer (defined as default);
+    - Added `Renderer` interface;
+    - Added `TwigRenderer` that integrates `twig/twig`;
+    - Added fallback template loading support.
  - Template packs to facilitate customization and extensibility of templates:
-    - Added template pack `default` and `bootstrap4`.
- - Support to configure default renderer and default template pack through `Config` singleton class;
+    - Added template pack `default` and defined as fallback;
+    - Added template pack `bootstrap4` that integrates custom elements of Bootstrap v4.0.0-beta.2.
+ - Added extra arg `label` on method `getContext` of `Widget` class;
+ - Support to configure renderer and template pack through `Config` singleton class;
 
 ### Changed
  - Class name `PHPFormConfig` to `Config` and moved to `src/` directory;

src/Config.php

@@ -6,73 +6,70 @@
 class Config extends Singleton
 {
     /**
-     * Template packs available
+     * @var string Directory with templates
      */
-    const TEMPLATE_PACKS = array("default", "bootstrap4");
+    protected $templates_dir = __DIR__ . '/templates/';
 
     /**
-     * Directory with templates
-     * @var string
+     * @var string Default fallback template pack
      */
-    protected $templates_dir = __DIR__ . '/templates/';
+    protected $fallback_template_pack = "default";
 
     /**
-     * Template pack defined
-     * @var string
+     * @var string Default template pack defined. If null, fallback is used.
      */
-    protected $template_pack = "default";
+    protected $template_pack = null;
 
     /**
-     * Renderer class used to render html content
-     * @var string
+     * @var string Renderer class used to render html content
      */
     protected $renderer_class = TwigRenderer::class;
 
     /**
-     * Renderer instance based on $renderer_class.
-     * @var PHPForm\Renderers\Renderer
+     * @var PHPForm\Renderers\Renderer Renderer instance based on $renderer_class.
      */
     private $renderer;
 
     /**
      * Templates path accordingly with defined template pack.
+     *
      * @return string
      */
-    private function getTemplatesPath()
+    private function buildPath($template_pack)
     {
-        $path = $this->templates_dir . $this->template_pack . "/";
+        $path = $this->templates_dir . $template_pack . "/";
 
         if (!file_exists($path)) {
-            trigger_error("Template dir '$path' don't exists.", E_USER_ERROR);
+            trigger_error("Template pack dir '$path' don't exists.", E_USER_ERROR);
         }
 
         return $path;
     }
 
     /**
      * Return renderer class instantiated
+     *
      * @return PHPForm\Renderers\Renderer
      */
     public function getRenderer()
     {
         if (is_null($this->renderer)) {
-            $this->renderer = new $this->renderer_class($this->getTemplatesPath());
+            $fallback_pack_dir = $this->buildPath($this->fallback_template_pack);
+            $pack_dir = !is_null($this->template_pack) ? $this->buildPath($this->template_pack) : null;
+
+            $this->renderer = new $this->renderer_class($fallback_pack_dir, $pack_dir);
         }
 
         return $this->renderer;
     }
 
     /**
      * Define template pack
+     *
      * @param string
      */
     public function setTemplatePack($template_pack)
     {
-        if (!in_array($template_pack, self::TEMPLATE_PACKS)) {
-            $packs = implode(", ", self::TEMPLATE_PACKS);
-            trigger_error("Template pack '$template_pack' not valid. Available packs are: $packs", E_USER_ERROR);
-        }
-
         $this->template_pack = $template_pack;
     }
 }

src/Fields/BoundField.php

@@ -77,7 +77,7 @@ protected function asWidget($widget = null, array $attrs = array())
 
         $attrs = $this->buildWidgetAttrs($attrs);
 
-        return $widget->render($this->html_name, $this->getValue(), $attrs);
+        return $widget->render($this->html_name, $this->getValue(), $this->label, $attrs);
     }
 
     public function labelTag($contents = null, array $attrs = array())

src/Renderers/Renderer.php

@@ -4,8 +4,9 @@
 */
 namespace PHPForm\Renderers;
 
-abstract class Renderer
+interface Renderer
 {
-    abstract public function getTemplate($template_name);
-    abstract public function render($template_name, $context);
+    public function __construct(string $fallback_templates_dir, string $templates_dir);
+    public function getTemplate(string $template_name);
+    public function render(string $template_name, array $context);
 }

src/Renderers/TwigRenderer.php

@@ -6,24 +6,31 @@
 
 use Twig_Loader_Filesystem;
 use Twig_Environment;
+use Twig_Loader_Chain;
 
-class TwigRenderer extends Renderer
+class TwigRenderer implements Renderer
 {
-    private $loader;
     private $twig;
 
-    public function __construct($templates_dir)
+    public function __construct(string $fallback_templates_dir, string $templates_dir = null)
     {
-        $this->loader = new Twig_Loader_Filesystem($templates_dir);
-        $this->twig = new Twig_Environment($this->loader);
+        $loaders = new Twig_Loader_Chain();
+
+        if (!is_null($templates_dir)) {
+            $loaders->addLoader(new Twig_Loader_Filesystem($templates_dir));
+        }
+
+        $loaders->addLoader(new Twig_Loader_Filesystem($fallback_templates_dir));
+
+        $this->twig = new Twig_Environment($loaders);
     }
 
-    public function getTemplate($template_name)
+    public function getTemplate(string $template_name)
     {
         return $this->twig->load($template_name);
     }
 
-    public function render($template_name, $context)
+    public function render(string $template_name, array $context)
     {
         $template = $this->getTemplate($template_name);
         return $template->render($context);

src/Widgets/CheckboxInput.php

@@ -9,14 +9,14 @@ class CheckboxInput extends Input
     const TEMPLATE = 'checkbox.html';
     const INPUT_TYPE = 'checkbox';
 
-    public function getContext(string $name, $value, array $attrs = null)
+    public function getContext(string $name, $value, string $label = null, array $attrs = null)
     {
         if ($value) {
             $attrs = is_null($attrs) ? array() : $attrs;
             $attrs["checked"] = "checked";
         }
 
-        return parent::getContext($name, $value, $attrs);
+        return parent::getContext($name, $value, $label, $attrs);
     }
 
     public function valueFromData($data, $files, string $name)

src/Widgets/ChoiceWidget.php

@@ -73,9 +73,9 @@ protected function buildName(string $name)
      *
      * @return array
      */
-    protected function getContext(string $name, $value, array $attrs = null)
+    protected function getContext(string $name, $value, string $label = null, array $attrs = null)
     {
-        $context = parent::getContext($name, $value, $attrs);
+        $context = parent::getContext($name, $value, $label, $attrs);
 
         $context["name"] = $this->buildName($name);
         $context["options"] = $this->getOptions($name, $value, $attrs);

src/Widgets/Input.php

@@ -18,9 +18,9 @@ abstract class Input extends Widget
      *
      * @return array
      */
-    public function getContext(string $name, $value, array $attrs = null)
+    public function getContext(string $name, $value, string $label = null, array $attrs = null)
     {
-        $context = parent::getContext($name, $value, $attrs);
+        $context = parent::getContext($name, $value, $label, $attrs);
 
         $context["type"] = static::INPUT_TYPE;
 

src/Widgets/Select.php

@@ -13,9 +13,9 @@ class Select extends ChoiceWidget
 
     protected $option_inherits_attrs = false;
 
-    public function getContext(string $name, $value, array $attrs = null)
+    public function getContext(string $name, $value, string $label = null, array $attrs = null)
     {
-        $context = parent::getContext($name, $value, $attrs);
+        $context = parent::getContext($name, $value, $label, $attrs);
 
         if ($this->allow_multiple_selected) {
             $context["attrs"]["multiple"] = "multiple";

src/Widgets/Widget.php

@@ -35,11 +35,11 @@ public function __construct(array $attrs = null)
      *
      * @return string
      */
-    public function render(string $name, $value, array $attrs = null)
+    public function render(string $name, $value, string $label = null, array $attrs = null)
     {
         $renderer = Config::getInstance()->getRenderer();
 
-        $context = $this->getContext($name, $value, $attrs);
+        $context = $this->getContext($name, $value, $label, $attrs);
 
         return $renderer->render(static::TEMPLATE, $context);
     }
@@ -53,7 +53,7 @@ public function render(string $name, $value, array $attrs = null)
      *
      * @return array
      */
-    protected function getContext(string $name, $value, array $attrs = null)
+    protected function getContext(string $name, $value, string $label = null, array $attrs = null)
     {
         $value = $this->formatValue($value);
         $attrs = $this->buildAttrs($attrs);
@@ -63,9 +63,11 @@ protected function getContext(string $name, $value, array $attrs = null)
         }
 
         return array(
+            "for" => $this->buildAutoId($name),
             "name" => $name,
             "attrs" => $attrs,
             "value" => $value,
+            "label" => $label,
         );
     }