Improvements and bug fixes

Author: Sandro Rodrigues

src/Fields/BoundField.php

@@ -7,7 +7,8 @@
 
 class BoundField
 {
-    const LABEL_TEMPLATE = '<label for="{for}" [{attrs}?]>{contents}</label>';
+    const LABEL_TEMPLATE = '<label for="{for}"[ {attrs}?]>{contents}[ {required}?]</label>';
+    const LABEL_REQUIRED = '<span class="required">*</span>';
 
     private $form;
     private $field;
@@ -39,14 +40,26 @@ public function __get($name)
             return $this->form->getFieldErrors($this->name);
         }
 
+        if ($name == 'has_errors') {
+            return $this->form->hasErrors($this->name);
+        }
+
+        if ($name == 'label_tag') {
+            return $this->labelTag();
+        }
+
+        if ($name == 'is_required') {
+            return $this->field->isRequired();
+        }
+
         return parent::__get($name);
     }
 
     protected function asWidget($widget = null, array $attrs = null)
     {
         $widget = is_null($widget) ? $this->field->getWidget() : $widget;
 
-        $value = null;
+        $value = $this->form->getInitialForField($this->field, $this->name);
 
         if ($this->form->isBound()) {
             $value = $widget->valueFromData($this->form->data, $this->form->files, $this->html_name);
@@ -68,7 +81,8 @@ public function labelTag($contents = null, array $attrs = null)
         return Formatter::format(self::LABEL_TEMPLATE, array(
             "for" => $widget->buildAutoId($this->html_name),
             "attrs" => $attrs,
-            "contents" => $contents
+            "contents" => $contents,
+            "required" => $this->field->isRequired() ? $this::LABEL_REQUIRED : null
         ));
     }
 }

src/Fields/Field.php

@@ -31,6 +31,12 @@ abstract class Field
     */
     protected $required = false;
 
+    /**
+     * Initial value if no data bounded.
+     * @var mixed
+     */
+    protected $initial = null;
+
     /**
     * @var array Array of user validators.
     */
@@ -57,7 +63,14 @@ abstract class Field
     */
     public function __construct(array $args = array())
     {
-        $this->computeArgs($args);
+        $this->widget = array_key_exists('widget', $args) ? $args['widget'] : $this->widget;
+        $this->label = array_key_exists('label', $args) ? $args['label'] : $this->label;
+        $this->help_text = array_key_exists('help_text', $args) ? $args['help_text'] : $this->help_text;
+        $this->required = array_key_exists('required', $args) ? $args['required'] : $this->required;
+        $this->initial = array_key_exists('initial', $args) ? $args['initial'] : $this->initial;
+        $this->validators = array_key_exists('validators', $args) ? $args['validators'] : $this->validators;
+        $this->error_messages = array_key_exists('error_messages', $args) ?
+            $args['error_messages'] : $this->error_messages;
 
         if (!is_null($this->widget)) {
             $this->widget = new $this->widget;
@@ -78,6 +91,26 @@ public function getWidget()
         return $this->widget;
     }
 
+    /**
+    * Return defined initial value.
+    *
+    * @return mixed
+    */
+    public function getInitial()
+    {
+        return $this->initial;
+    }
+
+    /**
+    * Return defined if this field is required or not.
+    *
+    * @return bool
+    */
+    public function isRequired()
+    {
+        return $this->required;
+    }
+
     /**
     * Return defined label or construct one based on the field name.
     *
@@ -210,25 +243,4 @@ private function getErrorMessages($class = null)
 
         return $error_messages;
     }
-
-    /**
-    * Init object arguments, but only valid class arguments, otherwise throw an exception.
-    *
-    * @param array $args    Arguments to be setted.
-    * @param array $exclude Fields to be excluded when trying to set value.
-    *
-    * @throws InvalidArgumentException
-    */
-    private function computeArgs(array $args = array(), array $exclude = array())
-    {
-        foreach ($args as $name => $value) {
-            if (property_exists(get_class($this), $name)) {
-                if (!in_array($name, $exclude)) {
-                    $this->$name = $value;
-                }
-            } else {
-                throw new InvalidArgumentException("Unexpected argument: '$name'");
-            }
-        }
-    }
 }

src/Forms/Form.php

@@ -2,8 +2,10 @@
 namespace PHPForm\Forms;
 
 use ArrayAccess;
-use Iterator;
 use Countable;
+use InvalidArgumentException;
+use Iterator;
+use UnexpectedValueException;
 
 use Fleshgrinder\Core\Formatter;
 
@@ -17,40 +19,78 @@ abstract class Form implements ArrayAccess, Iterator, Countable
     const PREFIX_TEMPLATE = '{prefix}-{field_name}';
     const NON_FIELD_ERRORS = '__all__';
 
+    /**
+     * List of form errors.
+     * @var array
+     */
     private $form_errors = null;
+
+    /**
+     * Array of bounded field to cache propose.
+     * @var array
+     */
+    private $bound_fields_cache = array();
+
+    /**
+     * Indicates if there's data bounded to form.
+     * @var boolean
+     */
     private $is_bound = false;
+
+    /**
+     * Prefix to be used in form names.
+     * @var string
+     */
+    protected $prefix = null;
+
+    /**
+     * Fields declared to this form.
+     * @var array
+     */
     protected $fields = array();
+
+    /**
+     * Cleaned values after validation.
+     * @var array
+     */
     protected $cleaned_data = array();
 
-    public function __construct(array $data = null, array $files = null, string $prefix = null)
+    /**
+     * Constructor method
+     * @param array $args Arguments
+     */
+    public function __construct(array $args = array())
     {
-        $this->is_bound = !is_null($data) or !is_null($files);
-        $this->data = $data;
-        $this->files = $files;
-        $this->prefix = $prefix;
+        $this->data = array_key_exists('data', $args) ? $args['data'] : null;
+        $this->files = array_key_exists('files', $args) ? $args['files'] : null;
+        $this->prefix = array_key_exists('prefix', $args) ? $args['prefix'] : $this->prefix;
+        $this->initial = array_key_exists('initial', $args) ? $args['initial'] : array();
+
+        $this->is_bound = !is_null($this->data) or !is_null($this->files);
         $this->fields = $this::setFields();
     }
 
     /**
      * Method to be redefined with form fields
-     *
      * @return array Desired fields for this form.
      */
     protected static function setFields()
     {
         return array();
     }
 
+    /**
+     * Return if form is bounded or not.
+     * @return boolean
+     */
     public function isBound()
     {
         return $this->is_bound;
     }
 
     /**
      * Special method to make errors accessible as a attribute.
-     *
-     * @param  string Attribute name.
-     *
+     * @param  string $name Attribute name.
      * @return mixed
      */
     public function __get(string $name)
@@ -68,9 +108,7 @@ public function __get(string $name)
 
     /**
      * Add a prefix to a name.
-     *
-     * @param  string Field name.
-     *
+     * @param  string $field_name Field name.
      * @return string
      */
     public function addPrefix(string $field_name)
@@ -86,8 +124,9 @@ public function addPrefix(string $field_name)
     }
 
     /**
-     * @param mixed
-     * @param string
+     * Add error to specific $field_name, if null, define to NON_FIELD_ERRORS.
+     * @param mixed  $error
+     * @param string $field_name
      */
     protected function addError($error, string $field_name = null)
     {
@@ -157,7 +196,6 @@ private function cleanForm()
 
     /**
      * Redefine if need to validate crossfields.
-     *
      * @return array Cleaned data
      */
     protected function clean()
@@ -166,12 +204,42 @@ protected function clean()
     }
 
     /**
-     * @param  string Field name
+     * Return cleaned data values.
+     * @return array Cleaned data
+     */
+    public function getCleanedData()
+    {
+        return $this->cleaned_data;
+    }
+
+    /**
+     * Return cleaned field value.
+     * @param  string $field_name Name of field.
+     * @return string             Cleaned field value.
+     */
+    public function getCleanedField(string $field_name)
+    {
+        return isset($this->cleaned_data[$field_name]) ? $this->cleaned_data[$field_name] : null;
+    }
+
+    /**
+     * Check if field has error on it.
+     * @param  string   $field_name Name of field to check
+     * @return boolean
+     */
+    public function hasError($field_name)
+    {
+        return array_key_exists($field_name, $this->errors);
+    }
+
+    /**
+     * Return all errors associated to $field_name.
+     * @param  string    $field_name Field name
      * @return ErrorList
      */
     public function getFieldErrors(string $field_name)
     {
-        if (!array_key_exists($field_name, $this->errors)) {
+        if (!$this->hasError($field_name)) {
             return new ErrorList();
         }
 
@@ -180,12 +248,11 @@ public function getFieldErrors(string $field_name)
 
     /**
      * Return errors not associated with any field.
-     *
      * @return ErrorList
      */
     public function getNonFieldErrors()
     {
-        if (!array_key_exists($this::NON_FIELD_ERRORS, $this->errors)) {
+        if (!$this->hasError($this::NON_FIELD_ERRORS)) {
             return new ErrorList();
         }
 
@@ -194,14 +261,22 @@ public function getNonFieldErrors()
 
     /**
      * Check if form is valid.
-     *
      * @return bool
      */
     public function isValid()
     {
         return $this->is_bound and !count($this->errors);
     }
 
+    /**
+     * Check if form is valid.
+     * @return bool
+     */
+    public function getInitialForField($field, $field_name)
+    {
+        return isset($this->initial[$field_name]) ? $this->initial[$field_name] : $field->getInitial();
+    }
+
     /**
      * Implementation of ArrayAccess interface to provide accessing objects as arrays.
      */
@@ -224,10 +299,25 @@ public function offsetUnset($offset)
         unset($this->fields[$offset]);
     }
 
+    /**
+     * @throws UnexpectedValueException
+     * @return BoundField
+     */
     public function offsetGet($offset)
     {
         $field = isset($this->fields[$offset]) ? $this->fields[$offset] : null;
-        return new BoundField($this, $field, $offset);
+
+        if (is_null($field)) {
+            $choices = implode(", ", array_keys($this->fields));
+            $class_name = get_called_class();
+            throw new UnexpectedValueException("Field '$offset' not found in $class_name. Choices are: $choices", 1);
+        }
+
+        if (!isset($this->bound_fields_cache[$offset])) {
+            $this->bound_fields_cache[$offset] = new BoundField($this, $field, $offset);
+        }
+
+        return $this->bound_fields_cache[$offset];
     }
 
     /**

src/Validators/URLValidator.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Validator to check if $value is an valid email
+ * Validator to check if $value is an valid url
  */
 namespace PHPForm\Validators;