Merge pull request #4 from dipcode-software/feat/messages

Moved messages.php to class based and made if configurable on Config

Author: srtab

CHANGELOG.md

@@ -15,20 +15,22 @@ 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 renderers;
-    - Configure custom template packs.
+    - Configure custom template packs;
+    - Configure custom messages;
+    - Configure custom renderers.
  - Added extra arg `label` to method `getContext` of `Widget` class.
 
 ### Changed
  - `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`;
  - `CheckboxSelectMultiple` and `RadioSelect` widget wrapped in an unordered list tag instead of previous `div`;
- - Method name `getSubWidgets` to `getOptions` in `Widgets` class and now returns an array instead of formated string.
+ - Method name `getSubWidgets` to `getOptions` in `Widgets` class and now returns an array instead of formated string;
+ - `messages.php` to class based definition.
 
 ### Removed:
  - `PHPFormConfig` class. Use new `Config` class instead to configure `PHPForm`;
- - `\Utils\Attributes` class. All static methods, except `flatattr` which is no longer used, where migrated to `helpers.php`;
+ - `Attribute` class. All static methods, except `flatattr` which is no longer used, where migrated to `helpers.php`;
  - Method `asUL` from `ErrorList` class.
 
 ## [1.0.1] - 2017-12-07

composer.json

@@ -25,8 +25,7 @@
   },
   "autoload": {
     "files": [
-      "src/helpers.php",
-      "config.php"
+      "src/helpers.php"
     ],
     "psr-4": {
       "PHPForm\\" : "src/"

config.php

@@ -3,6 +3,7 @@
 
 use PHPForm\Renderers\TwigRenderer;
 use PHPForm\TemplatePacks\DefaultTemplatePack;
+use PHPForm\Messages;
 
 class Config extends Singleton
 {
@@ -14,6 +15,11 @@ class Config extends Singleton
         DefaultTemplatePack::class,
     );
 
+    /**
+     * @var string Renderer class used to render html content.
+     */
+    protected $messages_class = Messages::class;
+
     /**
      * @var string Renderer class used to render html content.
      */
@@ -25,17 +31,33 @@ class Config extends Singleton
     private $renderer;
 
     /**
-     * Return renderer class instantiated
+     * Set template pack on top level.
      *
-     * @return PHPForm\Renderers\Renderer
+     * @param string Class name of TemplatePack.
      */
-    public function getRenderer()
+    public function setTemplatePack(string $template_pack)
     {
-        if (is_null($this->renderer)) {
-            $this->renderer = new $this->renderer_class($this->getTemplatesDirs());
-        }
+        $this->template_packs = array_unshift($this->template_packs, $template_pack);
+    }
 
-        return $this->renderer;
+    /**
+     * Set messages class.
+     *
+     * @param string Class name of Renderer.
+     */
+    public function setMessages(string $messages_class)
+    {
+        $this->messages_class = $messages_class;
+    }
+
+    /**
+     * Get messages class.
+     *
+     * @param Messages Messages class.
+     */
+    public function getMessages()
+    {
+        return $this->messages_class;
     }
 
     /**
@@ -49,13 +71,17 @@ public function setRenderer(string $renderer_class)
     }
 
     /**
-     * Set template pack on top level.
+     * Return renderer class instantiated
      *
-     * @param string Class name of TemplatePack.
+     * @return PHPForm\Renderers\Renderer
      */
-    public function setTemplatePack(string $template_pack)
+    public function getRenderer()
     {
-        $this->template_packs = array_unshift($this->template_packs, $template_pack);
+        if (is_null($this->renderer)) {
+            $this->renderer = new $this->renderer_class($this->getTemplatesDirs());
+        }
+
+        return $this->renderer;
     }
 
     /**

src/Config.php

@@ -4,10 +4,7 @@
  */
 namespace PHPForm\Fields;
 
-use Fleshgrinder\Core\Formatter;
-
 use PHPForm\Exceptions\ValidationError;
-use PHPForm\PHPFormConfig;
 use PHPForm\Widgets\Select;
 
 class ChoiceField extends Field
@@ -45,14 +42,12 @@ public function validate($value)
         parent::validate($value);
 
         if (!$this->validValue($value)) {
-            $error_message = PHPFormConfig::getIMessage("INVALID_CHOICE");
-
             if (is_array($value)) {
                 $value_diff = array_diff($value, array_keys($this->choices));
                 $value = implode(', ', $value_diff);
             }
 
-            $message = Formatter::format($error_message, array(
+            $message = msg("INVALID_CHOICE", array(
                 'choice' => $value,
             ));
 

src/Fields/ChoiceField.php

@@ -4,7 +4,6 @@
  */
 namespace PHPForm\Fields;
 
-use PHPForm\PHPFormConfig;
 use PHPForm\Widgets\DateInput;
 
 class DateField extends TemporalField
@@ -17,6 +16,6 @@ public function __construct(array $args = array())
     {
         parent::__construct($args);
 
-        $this->error_messages['invalid'] = PHPFormConfig::getIMessage("INVALID_DATE");
+        $this->error_messages['invalid'] = msg("INVALID_DATE");
     }
 }

src/Fields/DateField.php

@@ -4,7 +4,6 @@
  */
 namespace PHPForm\Fields;
 
-use PHPForm\PHPFormConfig;
 use PHPForm\Widgets\DateTimeInput;
 
 class DateTimeField extends TemporalField
@@ -17,6 +16,6 @@ public function __construct(array $args = array())
     {
         parent::__construct($args);
 
-        $this->error_messages['invalid'] = PHPFormConfig::getIMessage("INVALID_DATETIME");
+        $this->error_messages['invalid'] = msg("INVALID_DATETIME");
     }
 }

src/Fields/DateTimeField.php

@@ -7,7 +7,6 @@
 use InvalidArgumentException;
 
 use PHPForm\Exceptions\ValidationError;
-use PHPForm\PHPFormConfig;
 
 abstract class Field
 {
@@ -83,7 +82,7 @@ public function __construct(array $args = array())
             $args['error_messages'] : $this->error_messages;
 
         $default_error_messages = array(
-            'required' => PHPFormConfig::getIMessage("REQUIRED"),
+            'required' => msg("REQUIRED"),
         );
 
         $this->error_messages = array_merge($default_error_messages, $this->error_messages);

src/Fields/Field.php

@@ -4,10 +4,7 @@
  */
 namespace PHPForm\Fields;
 
-use Fleshgrinder\Core\Formatter;
-
 use PHPForm\Exceptions\ValidationError;
-use PHPForm\PHPFormConfig;
 use PHPForm\Validators\FileTypeValidator;
 use PHPForm\Widgets\FileInput;
 
@@ -39,14 +36,11 @@ public function validate($value)
         }
 
         if (0 == $value->size) {
-            $errormsg = PHPFormConfig::getIMessage("EMPTY_FILE");
-            throw new ValidationError($errormsg, 'empty_file');
+            throw new ValidationError(msg("EMPTY_FILE"), 'empty_file');
         }
 
         if (!is_null($this->max_size) && $value->size >= $this->max_size) {
-            $errormsg = PHPFormConfig::getIMessage("INVALID_FILE_MAX_SIZE");
-
-            $message = Formatter::format($errormsg, array(
+            $message = msg("INVALID_FILE_MAX_SIZE", array(
                 "limit" => $this->max_size,
                 "value" => $value->size
             ));
@@ -58,7 +52,7 @@ public function validate($value)
     public function toNative($value)
     {
         if (!is_array($value)) {
-            throw new ValidationError(PHPFormConfig::getIMessage("INVALID_FILE"), 'invalid');
+            throw new ValidationError(msg("INVALID_FILE"), 'invalid');
         }
 
         return (object) $value;

src/Fields/FileField.php

@@ -5,7 +5,6 @@
 namespace PHPForm\Fields;
 
 use PHPForm\Exceptions\ValidationError;
-use PHPForm\PHPFormConfig;
 use PHPForm\Validators\MinValueValidator;
 use PHPForm\Validators\MaxValueValidator;
 use PHPForm\Widgets\NumberInput;
@@ -36,8 +35,7 @@ public function toNative($value)
         if (is_numeric($value)) {
             return intval($value);
         } else {
-            $error_messages = PHPFormConfig::getIMessage("INVALID_NUMBER");
-            throw new ValidationError($error_messages, 'invalid');
+            throw new ValidationError(msg("INVALID_NUMBER"), 'invalid');
         }
     }