Merge branch 'master' into feat/docs

Author: srtab

CHANGELOG.md

@@ -4,8 +4,9 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## [1.1.0] - XXXX-XX-XX
+## [2.0.0] - 2017-12-11
 ### Added
+ - Documentation of package;
  - Renderers to facilitate integrations of template-engines:
     - Added `Renderer` interface;
     - Added `TwigRenderer` that integrates `twig/twig`;
@@ -15,12 +16,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
     - Added template pack `DefaultTemplatePack`. Defined as default template pack;
     - Added template pack `Bootstrap4TemplatePack` that integrates Bootstrap v4.0.0-beta.2.
  - `Config` singleton class allowing:
-    - Configure custom template packs class;
-    - Configure custom messages class;
-    - Configure custom renderers class.
- - Added extra arg `label` to method `getContext` of `Widget` class.
+    - Configure custom template packs;
+    - Configure custom messages;
+    - Configure custom renderers.
+ - Added extra arg `label` to method `getContext` of `Widget` class;
+ - `BoundWidget` class to represent the choices of a `ChoiceWidget` in `BoundField`, allowing individual render or data access to each option.
 
 ### Changed
+ - `BoundField` moved from `Fields` to new namespace `Bounds`;
  - `BoundField` attribute name `choices` changed to `options`;
  - `BoundField` attribute `options` now return an array instead of formated string;
  - `Widgets`, `labelTag` and `ErrorList` now render through default renderer instead of formatter `fleshgrinder/format`;

src/Fields/BoundField.php renamed to src/Bounds/BoundField.php

@@ -1,5 +1,5 @@
 <?php
-namespace PHPForm\Fields;
+namespace PHPForm\Bounds;
 
 use PHPForm\Config;
 
@@ -10,7 +10,7 @@ class BoundField
     private $form;
     private $field;
     private $name;
-    private $options_cache;
+    private $bound_widgets_cache;
 
     public $html_name;
     public $help_text;
@@ -55,18 +55,25 @@ public function __get($name)
         }
 
         if ($name == 'options') {
-            if (!isset($options_cache)) {
-                $options_cache = $this->getOptions();
+            if (!isset($bound_widgets_cache)) {
+                $bound_widgets_cache = $this->getSubWidgets();
             }
-            return $options_cache;
+            return $bound_widgets_cache;
         }
     }
 
-    private function getOptions(array $attrs = array())
+    private function getSubWidgets(array $attrs = array())
     {
+        $bounds = [];
+
         $attrs = $this->buildWidgetAttrs($attrs);
+        $options = $this->field->getWidget()->getOptions($this->html_name, $this->getValue(), $attrs);
+
+        foreach ($options as $option) {
+            $bounds[] = new BoundWidget($option);
+        }
 
-        return $this->field->getWidget()->getOptions($this->html_name, $this->getValue(), $attrs);
+        return $bounds;
     }
 
     protected function asWidget($widget = null, array $attrs = array())

src/Bounds/BoundWidget.php

@@ -0,0 +1,37 @@
+<?php
+namespace PHPForm\Bounds;
+
+use PHPForm\Config;
+
+class BoundWidget
+{
+    private $data;
+    private $template;
+
+    public $for;
+    public $type;
+    public $name;
+    public $value;
+    public $label;
+
+    public function __construct(array $data)
+    {
+        $this->for = $data["for"];
+        $this->type = $data["type"];
+        $this->name = $data["name"];
+        $this->value = $data["value"];
+        $this->label = $data["label"];
+        $this->template = $data["template"];
+
+        unset($data["template"]);
+
+        $this->data = $data;
+    }
+
+    public function __toString()
+    {
+        $renderer = Config::getInstance()->getRenderer();
+
+        return $renderer->render($this->template, $this->data);
+    }
+}

src/Config.php

@@ -39,17 +39,17 @@ class Config extends Singleton
      */
     public function setTemplatePack(string $template_pack)
     {
-        $this->template_packs = array_unshift($this->template_packs, $template_pack);
+        array_unshift($this->template_packs, $template_pack);
     }
 
     /**
-     * Set messages class.
+     * Redefine default messages.
      *
-     * @param string Class name of Renderer.
+     * @param array Messages array.
      */
-    public function setMessages(string $messages_class)
+    public function setMessages(array $messages)
     {
-        $this->messages_class = $messages_class;
+        $this->messages_class::setMessages($messages);
     }
 
     /**

src/Forms/Form.php

@@ -7,9 +7,9 @@
 use Iterator;
 use UnexpectedValueException;
 
+use PHPForm\Bounds\BoundField;
 use PHPForm\Errors\ErrorList;
 use PHPForm\Exceptions\ValidationError;
-use PHPForm\Fields\BoundField;
 
 abstract class Form implements ArrayAccess, Iterator, Countable
 {

src/Messages.php

@@ -8,22 +8,32 @@
 
 class Messages
 {
-    const REQUIRED = 'This field is required.';
-    const INVALID_CHOICE = 'Select a valid choice. "{choice}" is not one of the available choices.';
-    const INVALID_LIST = 'Enter a list of values.';
-    const INVALID_DATE = 'Enter a valid date.';
-    const INVALID_DATETIME = 'Enter a valid date/time.';
-    const INVALID_NUMBER = 'Enter a whole number.';
-    const INVALID_EMAIL = 'Enter a valid email address.';
-    const INVALID_URL = 'Enter a valid URL.';
-    const INVALID_FILE = 'Invalid file submitted.';
-    const EMPTY_FILE = 'The submitted file is empty.';
-    const INVALID_FILE_MAX_SIZE = 'Ensure the file has at most {limit} bytes (it has {value} bytes).';
-    const INVALID_FILE_TYPE = 'Ensure the file is one of "{valid_types}" types (it has {type}).';
-    const INVALID_MAX_LENGTH = 'Ensure this value has at most {limit} character (it has {value}).';
-    const INVALID_MAX_VALUE = 'Ensure this value is less than or equal to {limit}.';
-    const INVALID_MIN_LENGTH = 'Ensure this value has at least {limit} character (it has {value}).';
-    const INVALID_MIN_VALUE = 'Ensure this value is greater than or equal to {limit}.';
+    /**
+     * @var array Default messages
+     */
+    private static $messages = array(
+        "REQUIRED" => 'This field is required.',
+        "INVALID_CHOICE" => 'Select a valid choice. "{choice}" is not one of the available choices.',
+        "INVALID_LIST" => 'Enter a list of values.',
+        "INVALID_DATE" => 'Enter a valid date.',
+        "INVALID_DATETIME" => 'Enter a valid date/time.',
+        "INVALID_NUMBER" => 'Enter a whole number.',
+        "INVALID_EMAIL" => 'Enter a valid email address.',
+        "INVALID_URL" => 'Enter a valid URL.',
+        "INVALID_FILE" => 'Invalid file submitted.',
+        "EMPTY_FILE" => 'The submitted file is empty.',
+        "INVALID_FILE_MAX_SIZE" => 'Ensure the file has at most {limit} bytes (it has {value} bytes).',
+        "INVALID_FILE_TYPE" => 'Ensure the file is one of "{valid_types}" types (it has {type}).',
+        "INVALID_MAX_LENGTH" => 'Ensure this value has at most {limit} character (it has {value}).',
+        "INVALID_MAX_VALUE" => 'Ensure this value is less than or equal to {limit}.',
+        "INVALID_MIN_LENGTH" => 'Ensure this value has at least {limit} character (it has {value}).',
+        "INVALID_MIN_VALUE" => 'Ensure this value is greater than or equal to {limit}.'
+    );
+
+    public static function setMessages(array $messages)
+    {
+        self::$messages = array_merge(self::$messages, $messages);
+    }
 
     /**
      * Format message witg context.
@@ -35,7 +45,7 @@ class Messages
      */
     public static function format(string $id, array $context = null)
     {
-        $message = defined("static::$id") ? constant("static::$id") : $id;
+        $message = array_key_exists($id, self::$messages) ? self::$messages[$id] : $id;
 
         if (!is_null($context)) {
             $message = Formatter::format($message, $context);

src/Widgets/FileInput.php

@@ -32,10 +32,6 @@ public function formatValue($value)
      */
     public function valueFromData($data, $files, string $name)
     {
-        if (array_key_exists($name, $files)) {
-            return $files[$name];
-        }
-
-        return null;
+        return !is_null($files) && array_key_exists($name, $files) ? $files[$name] : null;
     }
 }

src/Widgets/Widget.php

@@ -94,7 +94,7 @@ protected function formatValue($value)
      */
     public function valueFromData($data, $files, string $name)
     {
-        return array_key_exists($name, $data) ? $data[$name] : null;
+        return !is_null($data) && array_key_exists($name, $data) ? $data[$name] : null;
     }
 
     /**

tests/unit/Fields/BoundFieldTest.php renamed to tests/unit/Bounds/BoundFieldTest.php

@@ -1,11 +1,12 @@
 <?php
-namespace PHPForm\Unit\Fields;
+namespace PHPForm\Unit\Bounds;
 
 use PHPUnit\Framework\TestCase;
 
+use PHPForm\Bounds\BoundField;
+use PHPForm\Bounds\BoundWidget;
 use PHPForm\Errors\ErrorList;
 use PHPForm\Exceptions\ValidationError;
-use PHPForm\Fields\BoundField;
 use PHPForm\Fields\CharField;
 use PHPForm\Fields\ChoiceField;
 use PHPForm\Widgets\RadioSelect;
@@ -214,16 +215,6 @@ public function testOptions()
         $field = new ChoiceField(["choices" => array("option1" => "Option1")]);
         $bound = new BoundField($this->simple_form, $field, "name");
 
-        $expected = array(array(
-            "for" => "id_name_1",
-            "type" => null,
-            "name" => "name",
-            "value" => "option1",
-            "label" => "Option1",
-            "attrs" => array(),
-            "template" => "select_option.html"
-        ));
-
-        $this->assertEquals($expected, $bound->options);
+        $this->assertInstanceOf(BoundWidget::class, $bound->options[0]);
     }
 }

tests/unit/Bounds/BoundWidgetTest.php

@@ -0,0 +1,44 @@
+<?php
+namespace PHPForm\Unit\Bounds;
+
+use PHPUnit\Framework\TestCase;
+
+use PHPForm\Bounds\BoundWidget;
+use PHPForm\Widgets\RadioSelect;
+
+class BoundWidgetTest extends TestCase
+{
+
+    protected function setUp()
+    {
+        $this->data = array(
+            "for" => "for",
+            "type" => "type",
+            "name" => "name",
+            "value" => "value",
+            "label" => "label",
+            "attrs" => array(),
+            "template" => RadioSelect::TEMPLATE_CHOICE,
+        );
+    }
+
+    public function testConstruct()
+    {
+        $bound = new BoundWidget($this->data);
+
+        $this->assertAttributeEquals("for", "for", $bound);
+        $this->assertAttributeEquals("type", "type", $bound);
+        $this->assertAttributeEquals("name", "name", $bound);
+        $this->assertAttributeEquals("value", "value", $bound);
+        $this->assertAttributeEquals("label", "label", $bound);
+        $this->assertAttributeEquals("radio_select_option.html", "template", $bound);
+    }
+
+    public function testToString()
+    {
+        $bound = new BoundWidget($this->data);
+
+        $expected = '<label for="for"><input name="name" type="type" value="value"/> label</label>';
+        $this->assertXmlStringEqualsXmlString((string) $bound, $expected);
+    }
+}