formers / former

src/Former/Form/Elements.php

Indentation +102 added lines, -102 removed lines

@@ -12,106 +12,106 @@
  */
 class Elements
 {
-	/**
-	 * The Container
-	 *
-	 * @var Container
-	 */
-	protected $app;
-
-	/**
-	 * The Session instance
-	 *
-	 * @var Session
-	 */
-	protected $session;
-
-	/**
-	 * Build a new Element
-	 *
-	 * @param Container $app
-	 */
-	public function __construct(Container $app, $session)
-	{
-		$this->app     = $app;
-		$this->session = $session;
-	}
-
-	/**
-	 * Generate a hidden field containing the current CSRF token.
-	 *
-	 * @return string
-	 */
-	public function token()
-	{
-		$csrf = method_exists($this->session, 'getToken') ? $this->session->getToken() : $this->session->token();
-
-		return (string) $this->app['former']->hidden('_token', $csrf);
-	}
-
-	/**
-	 * Creates a label tag
-	 *
-	 * @param  string $label      The label content
-	 * @param  string $for        The field the label's for
-	 * @param  array  $attributes The label's attributes
-	 *
-	 * @return Element             A <label> tag
-	 */
-	public function label($label, $for = null, $attributes = array())
-	{
-		if (!$label instanceof Htmlable) {
-			$oldLabel = (string) $label;
-			$label    = Helpers::translate($oldLabel);
-
-			// If there was no change to the label,
-			// then a Laravel translation did not occur
-			if (lcfirst($label) == $oldLabel) {
-				$label = str_replace('_', ' ', $label);
-			}
-		} else {
-			$label = (string) $label->toHtml();
-		}
-
-		$attributes['for']             = $for;
-		$this->app['former']->labels[] = $for;
-
-		return Element::create('label', $label, $attributes);
-	}
-
-	/**
-	 * Creates a form legend
-	 *
-	 * @param  string $legend     The text
-	 * @param  array  $attributes Its attributes
-	 *
-	 * @return Element             A <legend> tag
-	 */
-	public function legend($legend, $attributes = array())
-	{
-		$legend = Helpers::translate($legend);
-
-		return Element::create('legend', $legend, $attributes);
-	}
-
-	/**
-	 * Close a field group
-	 *
-	 * @return string
-	 */
-	public function closeGroup()
-	{
-		$closing = '';
-		if (Group::$opened && isset(Group::$openGroup)) {
-			$closing = Group::$openGroup->close();
-		}
-
-		// Close custom group
-		Group::$opened = false;
-
-		// Reset custom group reference
-		Group::$openGroup = null;
-
-		return $closing;
-	}
+    /**
+     * The Container
+     *
+     * @var Container
+     */
+    protected $app;
+
+    /**
+     * The Session instance
+     *
+     * @var Session
+     */
+    protected $session;
+
+    /**
+     * Build a new Element
+     *
+     * @param Container $app
+     */
+    public function __construct(Container $app, $session)
+    {
+        $this->app     = $app;
+        $this->session = $session;
+    }
+
+    /**
+     * Generate a hidden field containing the current CSRF token.
+     *
+     * @return string
+     */
+    public function token()
+    {
+        $csrf = method_exists($this->session, 'getToken') ? $this->session->getToken() : $this->session->token();
+
+        return (string) $this->app['former']->hidden('_token', $csrf);
+    }
+
+    /**
+     * Creates a label tag
+     *
+     * @param  string $label      The label content
+     * @param  string $for        The field the label's for
+     * @param  array  $attributes The label's attributes
+     *
+     * @return Element             A <label> tag
+     */
+    public function label($label, $for = null, $attributes = array())
+    {
+        if (!$label instanceof Htmlable) {
+            $oldLabel = (string) $label;
+            $label    = Helpers::translate($oldLabel);
+
+            // If there was no change to the label,
+            // then a Laravel translation did not occur
+            if (lcfirst($label) == $oldLabel) {
+                $label = str_replace('_', ' ', $label);
+            }
+        } else {
+            $label = (string) $label->toHtml();
+        }
+
+        $attributes['for']             = $for;
+        $this->app['former']->labels[] = $for;
+
+        return Element::create('label', $label, $attributes);
+    }
+
+    /**
+     * Creates a form legend
+     *
+     * @param  string $legend     The text
+     * @param  array  $attributes Its attributes
+     *
+     * @return Element             A <legend> tag
+     */
+    public function legend($legend, $attributes = array())
+    {
+        $legend = Helpers::translate($legend);
+
+        return Element::create('legend', $legend, $attributes);
+    }
+
+    /**
+     * Close a field group
+     *
+     * @return string
+     */
+    public function closeGroup()
+    {
+        $closing = '';
+        if (Group::$opened && isset(Group::$openGroup)) {
+            $closing = Group::$openGroup->close();
+        }
+
+        // Close custom group
+        Group::$opened = false;
+
+        // Reset custom group reference
+        Group::$openGroup = null;
+
+        return $closing;
+    }
 }

src/Former/Traits/Field.php

Indentation +406 added lines, -406 removed lines

@@ -16,264 +16,264 @@ 
  */
 abstract class Field extends FormerObject implements FieldInterface
 {
-	/**
-	 * The IoC Container
-	 *
-	 * @var Container
-	 */
-	protected $app;
-
-	/**
-	 * The Form instance
-	 *
-	 * @var Former\Form
-	 */
-	protected $form;
-
-	/**
-	 * A label for the field (if not using Bootstrap)
-	 *
-	 * @var string
-	 */
-	protected $label;
-
-	/**
-	 * The field's group
-	 *
-	 * @var Group
-	 */
-	protected $group;
-
-	/**
-	 * The field's default element
-	 *
-	 * @var string
-	 */
-	protected $element = 'input';
-
-	/**
-	 * Whether the Field is self-closing or not
-	 *
-	 * @var boolean
-	 */
-	protected $isSelfClosing = true;
-
-	/**
-	 * The field's bind destination
-	 *
-	 * @var string
-	 */
-	protected $bind;
-
-	/**
-	 * Get the current framework instance
-	 *
-	 * @return Framework
-	 */
-	protected function currentFramework()
-	{
-		if ($this->app->bound('former.form.framework')) {
-			return $this->app['former.form.framework'];
-		}
-
-		return $this->app['former.framework'];
-	}
-
-	////////////////////////////////////////////////////////////////////
-	///////////////////////////// INTERFACE ////////////////////////////
-	////////////////////////////////////////////////////////////////////
-
-	/**
-	 * Set up a Field instance
-	 *
-	 * @param string $type A field type
-	 */
-	public function __construct(Container $app, $type, $name, $label, $value, $attributes)
-	{
-		// Set base parameters
-		$this->app   = $app;
-		$this->type  = $type;
-		$this->value = $value;
-		$this->setAttributes($attributes);
-		$this->form = $this->app->bound('former.form') ? $this->app['former.form'] : null;
-
-		// Compute and translate label
-		$this->automaticLabels($name, $label);
-
-		// Repopulate field
-		if ($type != 'password' && $name !== '_token') {
-			$this->value = $this->repopulate();
-		}
-
-		// Apply Live validation rules
-		if ($this->app['former']->getOption('live_validation')) {
-			$rules = new LiveValidation($this);
-			$rules->apply($this->getRules());
-		}
-
-		// Bind the Group class
-		$groupClass = $this->isCheckable() ? 'CheckableGroup' : 'Group';
-		$groupClass = Former::FORMSPACE.$groupClass;
-
-		$this->group = new $groupClass($this->app, $this->label);
-	}
-
-	/**
-	 * Redirect calls to the group if necessary
-	 *
-	 * @param string $method
-	 */
-	public function __call($method, $parameters)
-	{
-		// Translate attributes
-		$translatable = $this->app['former']->getOption('translatable', array());
-		if (in_array($method, $translatable) and isset($parameters[0])) {
-			$parameters[0] = Helpers::translate($parameters[0]);
-		}
-
-		// Redirect calls to the Control Group
-		if (method_exists($this->group, $method) or Str::startsWith($method, 'onGroup')) {
-			$method = str_replace('onGroup', '', $method);
-			$method = lcfirst($method);
-
-			call_user_func_array(array($this->group, $method), $parameters);
-
-			return $this;
-		}
-
-		return parent::__call($method, $parameters);
-	}
-
-	/**
-	 * Prints out the field, wrapped in its group
-	 *
-	 * @return string
-	 */
-	public function wrapAndRender()
-	{
-		// Dry syntax (hidden fields, plain fields)
-		if ($this->isUnwrappable()) {
-			$html = $this->render();
-			// Control group syntax
-		} elseif (Form::hasInstanceOpened()) {
-			$html = $this->group->wrapField($this);
-			// Classic syntax
-		} else {
-			$html = $this->currentFramework()->createLabelOf($this);
-			$html .= $this->render();
-		}
-
-		return $html;
-	}
-
-	/**
-	 * Prints out the field
-	 *
-	 * @return string
-	 */
-	public function __toString()
-	{
-		return $this->wrapAndRender();
-	}
-
-	////////////////////////////////////////////////////////////////////
-	////////////////////////// PUBLIC INTERFACE ////////////////////////
-	////////////////////////////////////////////////////////////////////
-
-	/**
-	 * Whether the current field is required or not
-	 *
-	 * @return boolean
-	 */
-	public function isRequired()
-	{
-		return isset($this->attributes['required']);
-	}
-
-	/**
-	 * Set required live validation attribute
-	 *
-	 * @param boolean $isRequired
-	 * @return $this
-	 */
-	public function required($isRequired=true)
-	{
-		if ($isRequired) {
-			$this->attributes['required'] = true;
-		} else {
-			unset($this->attributes['required']);
-		}
-
-		return $this;
-	}
-
-	/**
-	 * Check if a field is unwrappable (no label)
-	 *
-	 * @return boolean
-	 */
-	public function isUnwrappable()
-	{
-		return
-			($this->form and $this->currentFramework()->is('Nude')) or
-			($this->form and $this->isOfType('inline')) or
-			$this->isButton() or
-			$this->isOfType('hidden') or
-			\Former\Form\Group::$opened or
-			$this->group and $this->group->isRaw();
-	}
-
-	/**
-	 * Check if field is a checkbox or a radio
-	 *
-	 * @return boolean
-	 */
-	public function isCheckable()
-	{
-		return $this->isOfType('checkbox', 'checkboxes', 'radio', 'radios');
-	}
-
-	/**
-	 * Check if the field is a button
-	 *
-	 * @return boolean
-	 */
-	public function isButton()
-	{
-		return false;
-	}
-
-	/**
-	 * Get the rules applied to the current field
-	 *
-	 * @return array An array of rules
-	 */
-	public function getRules()
-	{
-		return $this->app['former']->getRules($this->name);
-	}
-
-	////////////////////////////////////////////////////////////////////
-	//////////////////////// SETTERS AND GETTERS ///////////////////////
-	////////////////////////////////////////////////////////////////////
-
-	/**
-	 * Apply a Live Validation rule by chaining
-	 *
-	 * @param string $rule The rule
-	 */
-	public function rule($rule)
-	{
-		$parameters = func_get_args();
-		array_shift($parameters);
-
-		$live = new LiveValidation($this);
-		$live->apply(array(
-			$rule => $parameters,
-		));
-
-		return $this;
-	}
+    /**
+     * The IoC Container
+     *
+     * @var Container
+     */
+    protected $app;
+
+    /**
+     * The Form instance
+     *
+     * @var Former\Form
+     */
+    protected $form;
+
+    /**
+     * A label for the field (if not using Bootstrap)
+     *
+     * @var string
+     */
+    protected $label;
+
+    /**
+     * The field's group
+     *
+     * @var Group
+     */
+    protected $group;
+
+    /**
+     * The field's default element
+     *
+     * @var string
+     */
+    protected $element = 'input';
+
+    /**
+     * Whether the Field is self-closing or not
+     *
+     * @var boolean
+     */
+    protected $isSelfClosing = true;
+
+    /**
+     * The field's bind destination
+     *
+     * @var string
+     */
+    protected $bind;
+
+    /**
+     * Get the current framework instance
+     *
+     * @return Framework
+     */
+    protected function currentFramework()
+    {
+        if ($this->app->bound('former.form.framework')) {
+            return $this->app['former.form.framework'];
+        }
+
+        return $this->app['former.framework'];
+    }
+
+    ////////////////////////////////////////////////////////////////////
+    ///////////////////////////// INTERFACE ////////////////////////////
+    ////////////////////////////////////////////////////////////////////
+
+    /**
+     * Set up a Field instance
+     *
+     * @param string $type A field type
+     */
+    public function __construct(Container $app, $type, $name, $label, $value, $attributes)
+    {
+        // Set base parameters
+        $this->app   = $app;
+        $this->type  = $type;
+        $this->value = $value;
+        $this->setAttributes($attributes);
+        $this->form = $this->app->bound('former.form') ? $this->app['former.form'] : null;
+
+        // Compute and translate label
+        $this->automaticLabels($name, $label);
+
+        // Repopulate field
+        if ($type != 'password' && $name !== '_token') {
+            $this->value = $this->repopulate();
+        }
+
+        // Apply Live validation rules
+        if ($this->app['former']->getOption('live_validation')) {
+            $rules = new LiveValidation($this);
+            $rules->apply($this->getRules());
+        }
+
+        // Bind the Group class
+        $groupClass = $this->isCheckable() ? 'CheckableGroup' : 'Group';
+        $groupClass = Former::FORMSPACE.$groupClass;
+
+        $this->group = new $groupClass($this->app, $this->label);
+    }
+
+    /**
+     * Redirect calls to the group if necessary
+     *
+     * @param string $method
+     */
+    public function __call($method, $parameters)
+    {
+        // Translate attributes
+        $translatable = $this->app['former']->getOption('translatable', array());
+        if (in_array($method, $translatable) and isset($parameters[0])) {
+            $parameters[0] = Helpers::translate($parameters[0]);
+        }
+
+        // Redirect calls to the Control Group
+        if (method_exists($this->group, $method) or Str::startsWith($method, 'onGroup')) {
+            $method = str_replace('onGroup', '', $method);
+            $method = lcfirst($method);
+
+            call_user_func_array(array($this->group, $method), $parameters);
+
+            return $this;
+        }
+
+        return parent::__call($method, $parameters);
+    }
+
+    /**
+     * Prints out the field, wrapped in its group
+     *
+     * @return string
+     */
+    public function wrapAndRender()
+    {
+        // Dry syntax (hidden fields, plain fields)
+        if ($this->isUnwrappable()) {
+            $html = $this->render();
+            // Control group syntax
+        } elseif (Form::hasInstanceOpened()) {
+            $html = $this->group->wrapField($this);
+            // Classic syntax
+        } else {
+            $html = $this->currentFramework()->createLabelOf($this);
+            $html .= $this->render();
+        }
+
+        return $html;
+    }
+
+    /**
+     * Prints out the field
+     *
+     * @return string
+     */
+    public function __toString()
+    {
+        return $this->wrapAndRender();
+    }
+
+    ////////////////////////////////////////////////////////////////////
+    ////////////////////////// PUBLIC INTERFACE ////////////////////////
+    ////////////////////////////////////////////////////////////////////
+
+    /**
+     * Whether the current field is required or not
+     *
+     * @return boolean
+     */
+    public function isRequired()
+    {
+        return isset($this->attributes['required']);
+    }
+
+    /**
+     * Set required live validation attribute
+     *
+     * @param boolean $isRequired
+     * @return $this
+     */
+    public function required($isRequired=true)
+    {
+        if ($isRequired) {
+            $this->attributes['required'] = true;
+        } else {
+            unset($this->attributes['required']);
+        }
+
+        return $this;
+    }
+
+    /**
+     * Check if a field is unwrappable (no label)
+     *
+     * @return boolean
+     */
+    public function isUnwrappable()
+    {
+        return
+            ($this->form and $this->currentFramework()->is('Nude')) or
+            ($this->form and $this->isOfType('inline')) or
+            $this->isButton() or
+            $this->isOfType('hidden') or
+            \Former\Form\Group::$opened or
+            $this->group and $this->group->isRaw();
+    }
+
+    /**
+     * Check if field is a checkbox or a radio
+     *
+     * @return boolean
+     */
+    public function isCheckable()
+    {
+        return $this->isOfType('checkbox', 'checkboxes', 'radio', 'radios');
+    }
+
+    /**
+     * Check if the field is a button
+     *
+     * @return boolean
+     */
+    public function isButton()
+    {
+        return false;
+    }
+
+    /**
+     * Get the rules applied to the current field
+     *
+     * @return array An array of rules
+     */
+    public function getRules()
+    {
+        return $this->app['former']->getRules($this->name);
+    }
+
+    ////////////////////////////////////////////////////////////////////
+    //////////////////////// SETTERS AND GETTERS ///////////////////////
+    ////////////////////////////////////////////////////////////////////
+
+    /**
+     * Apply a Live Validation rule by chaining
+     *
+     * @param string $rule The rule
+     */
+    public function rule($rule)
+    {
+        $parameters = func_get_args();
+        array_shift($parameters);
+
+        $live = new LiveValidation($this);
+        $live->apply(array(
+            $rule => $parameters,
+        ));
+
+        return $this;
+    }
 
     /**
      * Apply multiple rules passed as a string.
@@ -295,9 +295,9 @@ 
                 $rulename = substr($rule, 0, $colon) ;
 
                 /**
-                * Regular expressions may contain commas and should not be divided by str_getcsv.
-                * For regular expressions we are just using the complete expression as a parameter.
-                */
+                 * Regular expressions may contain commas and should not be divided by str_getcsv.
+                 * For regular expressions we are just using the complete expression as a parameter.
+                 */
                 if ($rulename !== 'regex') {
                     $parameters = str_getcsv(substr($rule, $colon + 1));
                 } else {
@@ -319,149 +319,149 @@ 
         return $this;
     }
 
-	/**
-	 * Adds a label to the group/field
-	 *
-	 * @param  string $text       A label
-	 * @param  array  $attributes The label's attributes
-	 *
-	 * @return Field              A field
-	 */
-	public function label($text, $attributes = array())
-	{
-		// Create the Label element
-		$for   = $this->id ?: $this->name;
-		$label = $this->app['former']->label($text, $for, $attributes);
-
-		// Set label
-		$this->label = $label;
-		if ($this->group) {
-			$this->group->setLabel($label);
-		}
-
-		return $this;
-	}
-
-	/**
-	 * Set the Field value no matter what
-	 *
-	 * @param string $value A new value
-	 */
-	public function forceValue($value)
-	{
-		$this->value = $value;
-
-		return $this;
-	}
-
-	/**
-	 * Classic setting of attribute, won't overwrite any populate() attempt
-	 *
-	 * @param  string $value A new value
-	 */
-	public function value($value)
-	{
-		// Check if we already have a value stored for this field or in POST data
-		$already = $this->repopulate();
-
-		if (!$already) {
-			$this->value = $value;
-		}
-
-		return $this;
-	}
-
-	/**
-	 * Change the field's name
-	 *
-	 * @param  string $name The new name
-	 */
-	public function name($name)
-	{
-		$this->name = $name;
-
-		// Also relink the label to the new name
-		$this->label($name);
-
-		return $this;
-	}
-
-	/**
-	 * Get the field's labels
-	 *
-	 * @return string
-	 */
-	public function getLabel()
-	{
-		return $this->label;
-	}
-
-	/**
-	 * Change the field's bind destination
-	 *
-	 * @param $destination
-	 */
-	public function bind($destination) {
-		$this->bind = $destination;
-		if ($this->type != 'password') {
-			$this->value = $this->repopulate();
-		}
-
-		return $this;
-	}
-
-	////////////////////////////////////////////////////////////////////
-	//////////////////////////////// HELPERS ///////////////////////////
-	////////////////////////////////////////////////////////////////////
-
-	/**
-	 * Use values stored in Former to populate the current field
-	 */
-	private function repopulate($fallback = null)
-	{
-		// Get values from POST, populated, and manually set value
-		$post      = $this->app['former']->getPost($this->name);
-		$populator = $this->form ? $this->form->getPopulator() : $this->app['former.populator'];
-		$populate  = $populator->get($this->bind ?: $this->name);
-
-		// Assign a priority to each
-		if (!is_null($post)) {
-			return $post;
-		}
-		if (!is_null($populate)) {
-			return $populate;
-		}
-
-		return $fallback ?: $this->value;
-	}
-
-	/**
-	 * Ponders a label and a field name, and tries to get the best out of it
-	 *
-	 * @param  string $label A label
-	 * @param  string $name  A field name
-	 *
-	 * @return false|null         A label and a field name
-	 */
-	private function automaticLabels($name, $label)
-	{
-		// Disabled automatic labels
-		if (!$this->app['former']->getOption('automatic_label')) {
-			$this->name = $name;
-			$this->label($label);
-
-			return false;
-		}
-
-		// Check for the two possibilities
-		if ($label and is_null($name)) {
-			$name = Str::slug($label);
-		} elseif (is_null($label) and $name) {
-			$label = preg_replace('/\[\]$/', '', $name);
-		}
-
-		// Save values
-		$this->name = $name;
-		$this->label($label);
-	}
+    /**
+     * Adds a label to the group/field
+     *
+     * @param  string $text       A label
+     * @param  array  $attributes The label's attributes
+     *
+     * @return Field              A field
+     */
+    public function label($text, $attributes = array())
+    {
+        // Create the Label element
+        $for   = $this->id ?: $this->name;
+        $label = $this->app['former']->label($text, $for, $attributes);
+
+        // Set label
+        $this->label = $label;
+        if ($this->group) {
+            $this->group->setLabel($label);
+        }
+
+        return $this;
+    }
+
+    /**
+     * Set the Field value no matter what
+     *
+     * @param string $value A new value
+     */
+    public function forceValue($value)
+    {
+        $this->value = $value;
+
+        return $this;
+    }
+
+    /**
+     * Classic setting of attribute, won't overwrite any populate() attempt
+     *
+     * @param  string $value A new value
+     */
+    public function value($value)
+    {
+        // Check if we already have a value stored for this field or in POST data
+        $already = $this->repopulate();
+
+        if (!$already) {
+            $this->value = $value;
+        }
+
+        return $this;
+    }
+
+    /**
+     * Change the field's name
+     *
+     * @param  string $name The new name
+     */
+    public function name($name)
+    {
+        $this->name = $name;
+
+        // Also relink the label to the new name
+        $this->label($name);
+
+        return $this;
+    }
+
+    /**
+     * Get the field's labels
+     *
+     * @return string
+     */
+    public function getLabel()
+    {
+        return $this->label;
+    }
+
+    /**
+     * Change the field's bind destination
+     *
+     * @param $destination
+     */
+    public function bind($destination) {
+        $this->bind = $destination;
+        if ($this->type != 'password') {
+            $this->value = $this->repopulate();
+        }
+
+        return $this;
+    }
+
+    ////////////////////////////////////////////////////////////////////
+    //////////////////////////////// HELPERS ///////////////////////////
+    ////////////////////////////////////////////////////////////////////
+
+    /**
+     * Use values stored in Former to populate the current field
+     */
+    private function repopulate($fallback = null)
+    {
+        // Get values from POST, populated, and manually set value
+        $post      = $this->app['former']->getPost($this->name);
+        $populator = $this->form ? $this->form->getPopulator() : $this->app['former.populator'];
+        $populate  = $populator->get($this->bind ?: $this->name);
+
+        // Assign a priority to each
+        if (!is_null($post)) {
+            return $post;
+        }
+        if (!is_null($populate)) {
+            return $populate;
+        }
+
+        return $fallback ?: $this->value;
+    }
+
+    /**
+     * Ponders a label and a field name, and tries to get the best out of it
+     *
+     * @param  string $label A label
+     * @param  string $name  A field name
+     *
+     * @return false|null         A label and a field name
+     */
+    private function automaticLabels($name, $label)
+    {
+        // Disabled automatic labels
+        if (!$this->app['former']->getOption('automatic_label')) {
+            $this->name = $name;
+            $this->label($label);
+
+            return false;
+        }
+
+        // Check for the two possibilities
+        if ($label and is_null($name)) {
+            $name = Str::slug($label);
+        } elseif (is_null($label) and $name) {
+            $label = preg_replace('/\[\]$/', '', $name);
+        }
+
+        // Save values
+        $this->name = $name;
+        $this->label($label);
+    }
 }

Spacing +2 added lines, -2 removed lines

@@ -196,7 +196,7 @@ 
 	 * @param boolean $isRequired
 	 * @return $this
 	 */
-	public function required($isRequired=true)
+	public function required($isRequired = true)
 	{
 		if ($isRequired) {
 			$this->attributes['required'] = true;
@@ -292,7 +292,7 @@ 
 
             // If we have a rule with a value
             if (($colon = strpos($rule, ':')) !== false) {
-                $rulename = substr($rule, 0, $colon) ;
+                $rulename = substr($rule, 0, $colon);
 
                 /**
                 * Regular expressions may contain commas and should not be divided by str_getcsv.

src/Former/Form/Fields/Choice.php

Doc Comments +4 added lines, -7 removed lines

@@ -188,6 +188,9 @@ 
 		return $element;
 	}
 
+	/**
+	 * @param string $choiceType
+	 */
 	public function getCheckables($choiceType)
 	{
 		if (!(is_array($this->value) || $this->value instanceof \ArrayAccess)) {
@@ -292,7 +295,7 @@ 
 	/**
 	 * Sets the element's type based on options
 	 *
-	 * @return this
+	 * @return Choice
 	 */
 	protected function setChoiceType()
 	{
@@ -309,7 +312,6 @@ 
 	/**
 	 * Select a value in the field's children
 	 *
-	 * @param mixed   $value
 	 *
 	 * @return bool
 	 */
@@ -333,10 +335,6 @@ 
 	/**
 	 * Set the choices
 	 *
-	 * @param  array   $_choices     The choices as an array
-	 * @param  mixed   $selected     Facultative selected entry
-	 * @param  boolean $valuesAsKeys Whether the array's values should be used as
-	 *                               the option's values instead of the array's keys
 	 */
 	public function addChoice($value, $key = null)
 	{
@@ -349,7 +347,6 @@ 
 	 * Set the choices
 	 *
 	 * @param  array   $_choices     The choices as an array
-	 * @param  mixed   $selected     Facultative selected entry
 	 * @param  boolean $valuesAsKeys Whether the array's values should be used as
 	 *                               the option's values instead of the array's keys
 	 */

Indentation +452 added lines, -452 removed lines

@@ -12,477 +12,477 @@
  */
 class Choice extends Field
 {
-	/**
-	 * Renders the checkables as inline
-	 *
-	 * @var boolean
-	 */
-	protected $inline = false;
-
-	/**
-	 * The choice's placeholder
-	 *
-	 * @var string
-	 */
-	private $placeholder = null;
-
-	/**
-	 * The choice's options
-	 *
-	 * @var array
-	 */
-	protected $options = [
+    /**
+     * Renders the checkables as inline
+     *
+     * @var boolean
+     */
+    protected $inline = false;
+
+    /**
+     * The choice's placeholder
+     *
+     * @var string
+     */
+    private $placeholder = null;
+
+    /**
+     * The choice's options
+     *
+     * @var array
+     */
+    protected $options = [
         'isMultiple' => false,
         'isExpanded' => false,
     ];
 
-	/**
-	 * The choice's choices
-	 *
-	 * @var array
-	 */
-	protected $choices = [];
-
-	/**
-	 * The choice's element
-	 *
-	 * @var string
-	 */
-	protected $element = 'choice';
-
-	/**
-	 * The choice's self-closing state
-	 *
-	 * @var boolean
-	 */
-	protected $isSelfClosing = false;
-
-	////////////////////////////////////////////////////////////////////
-	/////////////////////////// CORE METHODS ///////////////////////////
-	////////////////////////////////////////////////////////////////////
-
-	/**
-	 * Easier arguments order for selects
-	 *
-	 * @param Container $app        The Container instance
-	 * @param string    $type       select
-	 * @param string    $name       Field name
-	 * @param string    $label      Its label
-	 * @param array     $choices    The choice's choices
-	 * @param string    $selected   The selected choice(s)
-	 * @param array     $attributes Attributes
-	 */
-	public function __construct(Container $app, $type, $name, $label, $choices, $selected, $attributes)
-	{
-		if ($selected) {
-			$this->value = $selected;
-		}
-		if ($choices) {
-			$this->choices($choices);
-		}
+    /**
+     * The choice's choices
+     *
+     * @var array
+     */
+    protected $choices = [];
+
+    /**
+     * The choice's element
+     *
+     * @var string
+     */
+    protected $element = 'choice';
+
+    /**
+     * The choice's self-closing state
+     *
+     * @var boolean
+     */
+    protected $isSelfClosing = false;
+
+    ////////////////////////////////////////////////////////////////////
+    /////////////////////////// CORE METHODS ///////////////////////////
+    ////////////////////////////////////////////////////////////////////
+
+    /**
+     * Easier arguments order for selects
+     *
+     * @param Container $app        The Container instance
+     * @param string    $type       select
+     * @param string    $name       Field name
+     * @param string    $label      Its label
+     * @param array     $choices    The choice's choices
+     * @param string    $selected   The selected choice(s)
+     * @param array     $attributes Attributes
+     */
+    public function __construct(Container $app, $type, $name, $label, $choices, $selected, $attributes)
+    {
+        if ($selected) {
+            $this->value = $selected;
+        }
+        if ($choices) {
+            $this->choices($choices);
+        }
 		
-		parent::__construct($app, $type, $name, $label, $selected, $attributes);
+        parent::__construct($app, $type, $name, $label, $selected, $attributes);
 		
-		$this->setChoiceType();
-
-		// Nested models population
-		if (str_contains($this->name, '.') and is_array($this->value) and !empty($this->value) and is_string($this->value[key($this->value)])) {
-			$this->fromQuery($this->value);
-			$this->value = $selected ?: null;
-		}
-	}
-
-	/**
-	 * Renders the choice
-	 *
-	 * @return string A <select> tag
-	 */
-	public function render()
-	{
-		$choiceType = $this->getType();
-		$this->setFieldClasses();
-
-		if (!isset($this->attributes['id'])) {
-			$this->setAttribute('id', $this->name);
-		}
-
-		switch ($choiceType) {
-			case 'select':
-				$field = $this->getSelect();
-				break;
-			case 'checkbox':
-			case 'radio':
-				$field = $this->getCheckables($choiceType);
-				break;
-		}
-		$this->value = null;
-		$content = $field->render();
-		return $content;
-	}
-
-	public function getSelect()
-	{
-		$field = Element::create('select', null, $this->attributes);
-
-		$name = $this->name;
-		if ($this->options['isMultiple']) {
-			$field->multiple();
-			$name .= '[]';
-		}
+        $this->setChoiceType();
+
+        // Nested models population
+        if (str_contains($this->name, '.') and is_array($this->value) and !empty($this->value) and is_string($this->value[key($this->value)])) {
+            $this->fromQuery($this->value);
+            $this->value = $selected ?: null;
+        }
+    }
+
+    /**
+     * Renders the choice
+     *
+     * @return string A <select> tag
+     */
+    public function render()
+    {
+        $choiceType = $this->getType();
+        $this->setFieldClasses();
+
+        if (!isset($this->attributes['id'])) {
+            $this->setAttribute('id', $this->name);
+        }
+
+        switch ($choiceType) {
+            case 'select':
+                $field = $this->getSelect();
+                break;
+            case 'checkbox':
+            case 'radio':
+                $field = $this->getCheckables($choiceType);
+                break;
+        }
+        $this->value = null;
+        $content = $field->render();
+        return $content;
+    }
+
+    public function getSelect()
+    {
+        $field = Element::create('select', null, $this->attributes);
+
+        $name = $this->name;
+        if ($this->options['isMultiple']) {
+            $field->multiple();
+            $name .= '[]';
+        }
 		
-		$field->setAttribute('name', $name);
+        $field->setAttribute('name', $name);
 
-		$field->nest($this->getOptions());
+        $field->nest($this->getOptions());
 
-		return $field;
-	}
+        return $field;
+    }
 
-	public function getOptions()
-	{
-		$children = [];
+    public function getOptions()
+    {
+        $children = [];
 		
-		// Add placeholder text if any
-		if ($placeholder = $this->getPlaceholder()) {
-			$children[] = $placeholder;
-		}
-
-		foreach ($this->choices as $key => $value) {
-			if (is_array($value) and !isset($value['value'])) {
-				$children[] = $this->getOptGroup($key, $value);
-			} else {
-				$children[] = $this->getOption($key, $value);
-			}
-		}
-		return $children;
-	}
-
-	public function getOptGroup($label, $options)
-	{
-		$element = Element::create('optgroup')->label($label);
-		$children = [];
-		foreach ($options as $key => $value) {
-			$option = $this->getOption($key, $value);
-			$children[] = $option;
-		}
-		$element->nest($children);
-
-		return $element;
-	}
-
-	public function getOption($key, $value)
-	{
-		if (is_array($value) and isset($value['value'])) {
-			$attributes = $value;
-			$text = $key;
-			$key = null;
-		} else {
-			$attributes = array('value' => $key);
-			$text = $value;
-		}
-
-		$element = Element::create('option', $text, $attributes);
-		if ($this->hasValue($attributes['value'])) {
-			$element->selected('selected');
-		}
-
-		return $element;
-	}
-
-	public function getCheckables($choiceType)
-	{
-		if (!(is_array($this->value) || $this->value instanceof \ArrayAccess)) {
-			$this->value = explode(',', $this->value);
-		}
-
-		$disabled = isset($this->attributes['disabled']);
-		unset($this->attributes['disabled']);
-
-		$field = Element::create('div', null, $this->attributes);
-
-		$children = [];
-		foreach ($this->choices as $key => $value) {
-			$attributes = [];
-
-			if (is_array($value) and isset($value['value'])) {
-				$attributes = $value;
-				$label = $key;
-				$inputValue = $value['value'];
-			} else {
-				$attributes = [];
-				$label = $value;
-				$inputValue = $key;
-			}
-
-			if ($disabled) {
-				$attributes['disabled'] = true;
-			}
-
-			if(isset($attributes['name'])) {
-				$name = $attributes['name'];
-				unset($attributes['name']);
-			} else {
-				$name = $this->name;
-			}
-			if ($this->options['isMultiple']) {
-				$name .= '[]';
-			}
+        // Add placeholder text if any
+        if ($placeholder = $this->getPlaceholder()) {
+            $children[] = $placeholder;
+        }
+
+        foreach ($this->choices as $key => $value) {
+            if (is_array($value) and !isset($value['value'])) {
+                $children[] = $this->getOptGroup($key, $value);
+            } else {
+                $children[] = $this->getOption($key, $value);
+            }
+        }
+        return $children;
+    }
+
+    public function getOptGroup($label, $options)
+    {
+        $element = Element::create('optgroup')->label($label);
+        $children = [];
+        foreach ($options as $key => $value) {
+            $option = $this->getOption($key, $value);
+            $children[] = $option;
+        }
+        $element->nest($children);
+
+        return $element;
+    }
+
+    public function getOption($key, $value)
+    {
+        if (is_array($value) and isset($value['value'])) {
+            $attributes = $value;
+            $text = $key;
+            $key = null;
+        } else {
+            $attributes = array('value' => $key);
+            $text = $value;
+        }
+
+        $element = Element::create('option', $text, $attributes);
+        if ($this->hasValue($attributes['value'])) {
+            $element->selected('selected');
+        }
+
+        return $element;
+    }
+
+    public function getCheckables($choiceType)
+    {
+        if (!(is_array($this->value) || $this->value instanceof \ArrayAccess)) {
+            $this->value = explode(',', $this->value);
+        }
+
+        $disabled = isset($this->attributes['disabled']);
+        unset($this->attributes['disabled']);
+
+        $field = Element::create('div', null, $this->attributes);
+
+        $children = [];
+        foreach ($this->choices as $key => $value) {
+            $attributes = [];
+
+            if (is_array($value) and isset($value['value'])) {
+                $attributes = $value;
+                $label = $key;
+                $inputValue = $value['value'];
+            } else {
+                $attributes = [];
+                $label = $value;
+                $inputValue = $key;
+            }
+
+            if ($disabled) {
+                $attributes['disabled'] = true;
+            }
+
+            if(isset($attributes['name'])) {
+                $name = $attributes['name'];
+                unset($attributes['name']);
+            } else {
+                $name = $this->name;
+            }
+            if ($this->options['isMultiple']) {
+                $name .= '[]';
+            }
 		
-			if(!isset($attributes['id'])) {
-				$attributes['id'] = $this->id.'_'.count($children);
-			}
+            if(!isset($attributes['id'])) {
+                $attributes['id'] = $this->id.'_'.count($children);
+            }
 
-			// If inline items, add class
-			$isInline = $this->inline ? ' '.$this->app['former.framework']->getInlineLabelClass($this) : null;
+            // If inline items, add class
+            $isInline = $this->inline ? ' '.$this->app['former.framework']->getInlineLabelClass($this) : null;
 
-			// In Bootsrap 3, don't append the the checkable type (radio/checkbox) as a class if
-			// rendering inline.
-			$class = $this->app['former']->framework() == 'TwitterBootstrap3' ? trim($isInline) : $choiceType.$isInline;
+            // In Bootsrap 3, don't append the the checkable type (radio/checkbox) as a class if
+            // rendering inline.
+            $class = $this->app['former']->framework() == 'TwitterBootstrap3' ? trim($isInline) : $choiceType.$isInline;
 
-			$element = Input::create($choiceType, $name, $inputValue, $attributes);
+            $element = Input::create($choiceType, $name, $inputValue, $attributes);
 			
-			// $element->setAttribute('name', $name);
-
-			if ($this->hasValue($inputValue)) {
-				$element->checked('checked');
-			}
-			// $attributes['value'] = $key;
-			if (!$label) {
-				$element = (is_object($field)) ? $field->render() : $field;
-			} else {
-				$rendered = $element->render();
-				$labelElement = Element::create('label', $rendered.$label);
-				$element = $labelElement->for($attributes['id'])->class($class);
-			}
+            // $element->setAttribute('name', $name);
+
+            if ($this->hasValue($inputValue)) {
+                $element->checked('checked');
+            }
+            // $attributes['value'] = $key;
+            if (!$label) {
+                $element = (is_object($field)) ? $field->render() : $field;
+            } else {
+                $rendered = $element->render();
+                $labelElement = Element::create('label', $rendered.$label);
+                $element = $labelElement->for($attributes['id'])->class($class);
+            }
 			
-			// If BS3, if checkables are stacked, wrap them in a div with the checkable type
-			if (!$isInline && $this->app['former']->framework() == 'TwitterBootstrap3') {
-				$wrapper = Element::create('div', $element->render())->class($choiceType);
-				if ($disabled) {
-					$wrapper->addClass('disabled');
-				}
-				$element = $wrapper;
-			}
-
-			$children[] = $element;
-		}
-		$field->nest($children);
+            // If BS3, if checkables are stacked, wrap them in a div with the checkable type
+            if (!$isInline && $this->app['former']->framework() == 'TwitterBootstrap3') {
+                $wrapper = Element::create('div', $element->render())->class($choiceType);
+                if ($disabled) {
+                    $wrapper->addClass('disabled');
+                }
+                $element = $wrapper;
+            }
+
+            $children[] = $element;
+        }
+        $field->nest($children);
 		
-		return $field;
-	}
-
-	/**
-	 * Get the choice's placeholder
-	 *
-	 * @return Element
-	 */
-	protected function getPlaceholder()
-	{
-		if (!$this->placeholder) {
-			return false;
-		}
-
-		$attributes = array('value' => '', 'disabled' => 'disabled');
-		if (!(array)$this->value) {
-			$attributes['selected'] = 'selected';
-		}
-
-		return Element::create('option', $this->placeholder, $attributes);
-	}
-
-	/**
-	 * Sets the element's type based on options
-	 *
-	 * @return this
-	 */
-	protected function setChoiceType()
-	{
-		if ($this->options['isExpanded'] && !$this->options['isMultiple']) {
-			$this->setType('radio');
-		} elseif ($this->options['isExpanded'] && $this->options['isMultiple']) {
-			$this->setType('checkbox');
-		} else {
-			$this->setType('select');
-		}
-		return $this;
-	}
-
-	/**
-	 * Select a value in the field's children
-	 *
-	 * @param mixed   $value
-	 *
-	 * @return bool
-	 */
-	protected function hasValue($choiceValue)
-	{
-		foreach ((array)$this->value as $key => $value) {
-			if (is_object($value) && method_exists($value, 'getKey')) {
-				$value = $value->getKey();
-			}
-			if ($choiceValue === $value || is_numeric($value) && $choiceValue === (int)$value) {
-				return true;
-			}
-		}
-		return false;
-	}
-
-	////////////////////////////////////////////////////////////////////
-	////////////////////////// FIELD METHODS ///////////////////////////
-	////////////////////////////////////////////////////////////////////
-
-	/**
-	 * Set the choices
-	 *
-	 * @param  array   $_choices     The choices as an array
-	 * @param  mixed   $selected     Facultative selected entry
-	 * @param  boolean $valuesAsKeys Whether the array's values should be used as
-	 *                               the option's values instead of the array's keys
-	 */
-	public function addChoice($value, $key = null)
-	{
-		$this->choices[$key ?? $value] = $value;
-
-		return $this;
-	}
-
-	/**
-	 * Set the choices
-	 *
-	 * @param  array   $_choices     The choices as an array
-	 * @param  mixed   $selected     Facultative selected entry
-	 * @param  boolean $valuesAsKeys Whether the array's values should be used as
-	 *                               the option's values instead of the array's keys
-	 */
-	public function choices($_choices, $valuesAsKeys = false)
-	{
-		$choices = (array) $_choices;
-
-		// If valuesAsKeys is true, use the values as keys
-		if ($valuesAsKeys) {
-			foreach ($choices as $value) {
-				$this->addChoice($value, $value);
-			}
-		} else {
-			foreach ($choices as $key => $value) {
-				$this->addChoice($value, $key);
-			}
-		}
-
-		return $this;
-	}
-
-	/**
-	 * Creates a list of choices from a range
-	 *
-	 * @param  integer $from
-	 * @param  integer $to
-	 * @param  integer $step
-	 */
-	public function range($from, $to, $step = 1)
-	{
-		$range = range($from, $to, $step);
-		$this->choices($range, true);
-
-		return $this;
-	}
-
-	/**
-	 * Use the results from a Fluent/Eloquent query as choices
-	 *
-	 * @param  array           $results    An array of Eloquent models
-	 * @param  string|function $text       The value to use as text
-	 * @param  string|array    $attributes The data to use as attributes
-	 * @param  string	       $selected   The default selected item
-	 */
-	public function fromQuery($results, $text = null, $attributes = null, $selected = null)
-	{
-		$this->choices(Helpers::queryToArray($results, $text, $attributes))->value($selected);
-
-		return $this;
-	}
-
-	/**
-	 * Add a placeholder to the current select
-	 *
-	 * @param  string $placeholder The placeholder text
-	 */
-	public function placeholder($placeholder)
-	{
-		$this->placeholder = Helpers::translate($placeholder);
-
-		return $this;
-	}
+        return $field;
+    }
+
+    /**
+     * Get the choice's placeholder
+     *
+     * @return Element
+     */
+    protected function getPlaceholder()
+    {
+        if (!$this->placeholder) {
+            return false;
+        }
+
+        $attributes = array('value' => '', 'disabled' => 'disabled');
+        if (!(array)$this->value) {
+            $attributes['selected'] = 'selected';
+        }
+
+        return Element::create('option', $this->placeholder, $attributes);
+    }
+
+    /**
+     * Sets the element's type based on options
+     *
+     * @return this
+     */
+    protected function setChoiceType()
+    {
+        if ($this->options['isExpanded'] && !$this->options['isMultiple']) {
+            $this->setType('radio');
+        } elseif ($this->options['isExpanded'] && $this->options['isMultiple']) {
+            $this->setType('checkbox');
+        } else {
+            $this->setType('select');
+        }
+        return $this;
+    }
+
+    /**
+     * Select a value in the field's children
+     *
+     * @param mixed   $value
+     *
+     * @return bool
+     */
+    protected function hasValue($choiceValue)
+    {
+        foreach ((array)$this->value as $key => $value) {
+            if (is_object($value) && method_exists($value, 'getKey')) {
+                $value = $value->getKey();
+            }
+            if ($choiceValue === $value || is_numeric($value) && $choiceValue === (int)$value) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    ////////////////////////////////////////////////////////////////////
+    ////////////////////////// FIELD METHODS ///////////////////////////
+    ////////////////////////////////////////////////////////////////////
+
+    /**
+     * Set the choices
+     *
+     * @param  array   $_choices     The choices as an array
+     * @param  mixed   $selected     Facultative selected entry
+     * @param  boolean $valuesAsKeys Whether the array's values should be used as
+     *                               the option's values instead of the array's keys
+     */
+    public function addChoice($value, $key = null)
+    {
+        $this->choices[$key ?? $value] = $value;
+
+        return $this;
+    }
+
+    /**
+     * Set the choices
+     *
+     * @param  array   $_choices     The choices as an array
+     * @param  mixed   $selected     Facultative selected entry
+     * @param  boolean $valuesAsKeys Whether the array's values should be used as
+     *                               the option's values instead of the array's keys
+     */
+    public function choices($_choices, $valuesAsKeys = false)
+    {
+        $choices = (array) $_choices;
+
+        // If valuesAsKeys is true, use the values as keys
+        if ($valuesAsKeys) {
+            foreach ($choices as $value) {
+                $this->addChoice($value, $value);
+            }
+        } else {
+            foreach ($choices as $key => $value) {
+                $this->addChoice($value, $key);
+            }
+        }
+
+        return $this;
+    }
+
+    /**
+     * Creates a list of choices from a range
+     *
+     * @param  integer $from
+     * @param  integer $to
+     * @param  integer $step
+     */
+    public function range($from, $to, $step = 1)
+    {
+        $range = range($from, $to, $step);
+        $this->choices($range, true);
+
+        return $this;
+    }
+
+    /**
+     * Use the results from a Fluent/Eloquent query as choices
+     *
+     * @param  array           $results    An array of Eloquent models
+     * @param  string|function $text       The value to use as text
+     * @param  string|array    $attributes The data to use as attributes
+     * @param  string	       $selected   The default selected item
+     */
+    public function fromQuery($results, $text = null, $attributes = null, $selected = null)
+    {
+        $this->choices(Helpers::queryToArray($results, $text, $attributes))->value($selected);
+
+        return $this;
+    }
+
+    /**
+     * Add a placeholder to the current select
+     *
+     * @param  string $placeholder The placeholder text
+     */
+    public function placeholder($placeholder)
+    {
+        $this->placeholder = Helpers::translate($placeholder);
+
+        return $this;
+    }
 	
-	/**
-	 * Set isMultiple
-	 *
-	 * @param boolean $isMultiple
-	 * @return $this
-	 */
-	public function multiple($isMultiple = true)
-	{
-		$this->options['isMultiple'] = $isMultiple;
-		$this->setChoiceType();
-
-		return $this;
-	}
+    /**
+     * Set isMultiple
+     *
+     * @param boolean $isMultiple
+     * @return $this
+     */
+    public function multiple($isMultiple = true)
+    {
+        $this->options['isMultiple'] = $isMultiple;
+        $this->setChoiceType();
+
+        return $this;
+    }
 	
-	/**
-	 * Set isExpanded
-	 *
-	 * @param boolean $isExpanded
-	 * @return $this
-	 */
-	public function expanded($isExpanded = true)
-	{
-		$this->options['isExpanded'] = $isExpanded;
-		$this->setChoiceType();
-
-		return $this;
-	}
-
-	/**
-	 * Set the choices as inline (for expanded items)
-	 */
-	public function inline($isInline = true)
-	{
-		$this->inline = $isInline;
-
-		return $this;
-	}
-
-	/**
-	 * Set the choices as stacked (for expanded items)
-	 */
-	public function stacked($isStacked = true)
-	{
-		$this->inline = !$isStacked;
-
-		return $this;
-	}
-
-	/**
-	 * Check if field is a checkbox or a radio
-	 *
-	 * @return boolean
-	 */
-	public function isCheckable()
-	{
-		return $this->options['isExpanded'];
-	}
-
-	////////////////////////////////////////////////////////////////////
-	////////////////////////////// HELPERS /////////////////////////////
-	////////////////////////////////////////////////////////////////////
-
-	/**
-	 * Returns the current choices in memory for manipulations
-	 *
-	 * @return array The current choices array
-	 */
-	public function getChoices()
-	{
-		return $this->choices;
-	}
+    /**
+     * Set isExpanded
+     *
+     * @param boolean $isExpanded
+     * @return $this
+     */
+    public function expanded($isExpanded = true)
+    {
+        $this->options['isExpanded'] = $isExpanded;
+        $this->setChoiceType();
+
+        return $this;
+    }
+
+    /**
+     * Set the choices as inline (for expanded items)
+     */
+    public function inline($isInline = true)
+    {
+        $this->inline = $isInline;
+
+        return $this;
+    }
+
+    /**
+     * Set the choices as stacked (for expanded items)
+     */
+    public function stacked($isStacked = true)
+    {
+        $this->inline = !$isStacked;
+
+        return $this;
+    }
+
+    /**
+     * Check if field is a checkbox or a radio
+     *
+     * @return boolean
+     */
+    public function isCheckable()
+    {
+        return $this->options['isExpanded'];
+    }
+
+    ////////////////////////////////////////////////////////////////////
+    ////////////////////////////// HELPERS /////////////////////////////
+    ////////////////////////////////////////////////////////////////////
+
+    /**
+     * Returns the current choices in memory for manipulations
+     *
+     * @return array The current choices array
+     */
+    public function getChoices()
+    {
+        return $this->choices;
+    }
 	
 }

Spacing +5 added lines, -5 removed lines

@@ -217,7 +217,7 @@ 
 				$attributes['disabled'] = true;
 			}
 
-			if(isset($attributes['name'])) {
+			if (isset($attributes['name'])) {
 				$name = $attributes['name'];
 				unset($attributes['name']);
 			} else {
@@ -227,7 +227,7 @@ 
 				$name .= '[]';
 			}
 		
-			if(!isset($attributes['id'])) {
+			if (!isset($attributes['id'])) {
 				$attributes['id'] = $this->id.'_'.count($children);
 			}
 
@@ -282,7 +282,7 @@ 
 		}
 
 		$attributes = array('value' => '', 'disabled' => 'disabled');
-		if (!(array)$this->value) {
+		if (!(array) $this->value) {
 			$attributes['selected'] = 'selected';
 		}
 
@@ -315,11 +315,11 @@ 
 	 */
 	protected function hasValue($choiceValue)
 	{
-		foreach ((array)$this->value as $key => $value) {
+		foreach ((array) $this->value as $key => $value) {
 			if (is_object($value) && method_exists($value, 'getKey')) {
 				$value = $value->getKey();
 			}
-			if ($choiceValue === $value || is_numeric($value) && $choiceValue === (int)$value) {
+			if ($choiceValue === $value || is_numeric($value) && $choiceValue === (int) $value) {
 				return true;
 			}
 		}

src/Former/Traits/FormerObject.php

Doc Comments +1 added lines, -1 removed lines

@@ -181,7 +181,7 @@
 	/**
 	 * Set the modifiers from initial method call
 	 *
-	 * @return $this
+	 * @return string
 	 */
 	public function getModifiers()
 	{

Indentation +187 added lines, -187 removed lines

@@ -10,192 +10,192 @@
  */
 abstract class FormerObject extends Element
 {
-	/**
-	 * The field's name
-	 *
-	 * @var string
-	 */
-	protected $name;
-
-	/**
-	 * The field type
-	 *
-	 * @var string
-	 */
-	protected $type;
-
-	/**
-	 * A list of class properties to be added to attributes
-	 *
-	 * @var array
-	 */
-	protected $injectedProperties = array('name');
-
-	/**
-	 * The field's modifiers from method call
-	 *
-	 * @var string
-	 */
-	protected $modifiers;
-
-	////////////////////////////////////////////////////////////////////
-	/////////////////////////// ID AND LABELS //////////////////////////
-	////////////////////////////////////////////////////////////////////
-
-	/**
-	 * Create an unique ID and return it
-	 *
-	 * @return string
-	 */
-	public function getCreatedId()
-	{
-		$this->setId();
-
-		return $this->attributes['id'];
-	}
-
-	/**
-	 * Set the matching ID on a field if possible
-	 */
-	protected function setId()
-	{
-		if (!array_key_exists('id', $this->attributes) and
-			in_array($this->name, $this->app['former']->labels)
-		) {
-			// Set and save the field's ID
-			$id                         = $this->getUniqueId($this->name);
-			$this->attributes['id']     = $id;
-			$this->app['former']->ids[] = $id;
-		}
-	}
-
-	/**
-	 * Get an unique ID for a field from its name
-	 *
-	 * @param string $name
-	 *
-	 * @return string
-	 */
-	protected function getUniqueId($name)
-	{
-		$names = &$this->app['former']->names;
-
-		if (array_key_exists($name, $names)) {
-			$count = $names[$name] + 1;
-			$names[$name] = $count;
-			return $name . '-' . $count;
-		}
-
-		$names[$name] = 1;
-		return $name;
-	}
-
-	/**
-	 * Runs the frameworks getFieldClasses method on this
-	 *
-	 * @return $this
-	 */
-	protected function setFieldClasses()
-	{
-		$framework = isset($this->app['former.form.framework']) ? $this->app['former.form.framework'] : $this->app['former.framework'];
-		$framework->getFieldClasses($this, $this->modifiers);
-
-		return $this;
-	}
-
-	/**
-	 * Render the FormerObject and set its id
-	 *
-	 * @return string
-	 */
-	public function render()
-	{
-		// Set the proper ID according to the label
-		$this->setId();
-
-		if($this instanceof Field) {
-			$this->setFieldClasses();
-		}
-
-		// Encode HTML value
-		$isButton = ($this instanceof Field) ? $this->isButton() : false;
-		if (!$isButton and is_string($this->value)) {
-			$this->value = Helpers::encode($this->value);
-		}
-
-		return parent::render();
-	}
-
-	////////////////////////////////////////////////////////////////////
-	////////////////////////////// GETTERS /////////////////////////////
-	////////////////////////////////////////////////////////////////////
-
-	/**
-	 * Get the object's name
-	 *
-	 * @return string
-	 */
-	public function getName()
-	{
-		return $this->name;
-	}
-
-	////////////////////////////////////////////////////////////////////
-	//////////////////////////// OBJECT TYPE ///////////////////////////
-	////////////////////////////////////////////////////////////////////
-
-	/**
-	 * Get the object's type
-	 *
-	 * @return string
-	 */
-	public function getType()
-	{
-		return $this->type;
-	}
-
-	/**
-	 * Change a object's type
-	 *
-	 * @param string $type
-	 */
-	public function setType($type)
-	{
-		$this->type = $type;
-
-		return $this;
-	}
-
-	/**
-	 * Check if an object is of a certain type
-	 *
-	 * @return boolean
-	 */
-	public function isOfType()
-	{
-		$types = func_get_args();
-
-		return in_array($this->type, $types);
-	}
+    /**
+     * The field's name
+     *
+     * @var string
+     */
+    protected $name;
+
+    /**
+     * The field type
+     *
+     * @var string
+     */
+    protected $type;
+
+    /**
+     * A list of class properties to be added to attributes
+     *
+     * @var array
+     */
+    protected $injectedProperties = array('name');
+
+    /**
+     * The field's modifiers from method call
+     *
+     * @var string
+     */
+    protected $modifiers;
+
+    ////////////////////////////////////////////////////////////////////
+    /////////////////////////// ID AND LABELS //////////////////////////
+    ////////////////////////////////////////////////////////////////////
+
+    /**
+     * Create an unique ID and return it
+     *
+     * @return string
+     */
+    public function getCreatedId()
+    {
+        $this->setId();
+
+        return $this->attributes['id'];
+    }
+
+    /**
+     * Set the matching ID on a field if possible
+     */
+    protected function setId()
+    {
+        if (!array_key_exists('id', $this->attributes) and
+            in_array($this->name, $this->app['former']->labels)
+        ) {
+            // Set and save the field's ID
+            $id                         = $this->getUniqueId($this->name);
+            $this->attributes['id']     = $id;
+            $this->app['former']->ids[] = $id;
+        }
+    }
+
+    /**
+     * Get an unique ID for a field from its name
+     *
+     * @param string $name
+     *
+     * @return string
+     */
+    protected function getUniqueId($name)
+    {
+        $names = &$this->app['former']->names;
+
+        if (array_key_exists($name, $names)) {
+            $count = $names[$name] + 1;
+            $names[$name] = $count;
+            return $name . '-' . $count;
+        }
+
+        $names[$name] = 1;
+        return $name;
+    }
+
+    /**
+     * Runs the frameworks getFieldClasses method on this
+     *
+     * @return $this
+     */
+    protected function setFieldClasses()
+    {
+        $framework = isset($this->app['former.form.framework']) ? $this->app['former.form.framework'] : $this->app['former.framework'];
+        $framework->getFieldClasses($this, $this->modifiers);
+
+        return $this;
+    }
+
+    /**
+     * Render the FormerObject and set its id
+     *
+     * @return string
+     */
+    public function render()
+    {
+        // Set the proper ID according to the label
+        $this->setId();
+
+        if($this instanceof Field) {
+            $this->setFieldClasses();
+        }
+
+        // Encode HTML value
+        $isButton = ($this instanceof Field) ? $this->isButton() : false;
+        if (!$isButton and is_string($this->value)) {
+            $this->value = Helpers::encode($this->value);
+        }
+
+        return parent::render();
+    }
+
+    ////////////////////////////////////////////////////////////////////
+    ////////////////////////////// GETTERS /////////////////////////////
+    ////////////////////////////////////////////////////////////////////
+
+    /**
+     * Get the object's name
+     *
+     * @return string
+     */
+    public function getName()
+    {
+        return $this->name;
+    }
+
+    ////////////////////////////////////////////////////////////////////
+    //////////////////////////// OBJECT TYPE ///////////////////////////
+    ////////////////////////////////////////////////////////////////////
+
+    /**
+     * Get the object's type
+     *
+     * @return string
+     */
+    public function getType()
+    {
+        return $this->type;
+    }
+
+    /**
+     * Change a object's type
+     *
+     * @param string $type
+     */
+    public function setType($type)
+    {
+        $this->type = $type;
+
+        return $this;
+    }
+
+    /**
+     * Check if an object is of a certain type
+     *
+     * @return boolean
+     */
+    public function isOfType()
+    {
+        $types = func_get_args();
+
+        return in_array($this->type, $types);
+    }
 	
-	/**
-	 * Set the modifiers from initial method call
-	 *
-	 * @return $this
-	 */
-	public function getModifiers()
-	{
-		return $this->modifiers;
-	}
-
-	/**
-	 * Set the modifiers from initial method call
-	 *
-	 * @return $this
-	 */
-	public function setModifiers($modifiers)
-	{
-		$this->modifiers = $modifiers;
-		return $this;
-	}
+    /**
+     * Set the modifiers from initial method call
+     *
+     * @return $this
+     */
+    public function getModifiers()
+    {
+        return $this->modifiers;
+    }
+
+    /**
+     * Set the modifiers from initial method call
+     *
+     * @return $this
+     */
+    public function setModifiers($modifiers)
+    {
+        $this->modifiers = $modifiers;
+        return $this;
+    }
 }

Spacing +2 added lines, -2 removed lines

@@ -83,7 +83,7 @@ 
 		if (array_key_exists($name, $names)) {
 			$count = $names[$name] + 1;
 			$names[$name] = $count;
-			return $name . '-' . $count;
+			return $name.'-'.$count;
 		}
 
 		$names[$name] = 1;
@@ -113,7 +113,7 @@ 
 		// Set the proper ID according to the label
 		$this->setId();
 
-		if($this instanceof Field) {
+		if ($this instanceof Field) {
 			$this->setFieldClasses();
 		}
 

src/Former/Former.php

Indentation +477 added lines, -477 removed lines

@@ -13,483 +13,483 @@
  */
 class Former
 {
-	// Instances
-	////////////////////////////////////////////////////////////////////
-
-
-	/**
-	 * The current environment
-	 *
-	 * @var \Illuminate\Container\Container
-	 */
-	protected $app;
-
-	/**
-	 * The Method Dispatcher
-	 *
-	 * @var MethodDispatcher
-	 */
-	protected $dispatch;
-
-	// Informations
-	////////////////////////////////////////////////////////////////////
-
-	/**
-	 * The form's errors
-	 *
-	 * @var Message
-	 */
-	protected $errors;
-
-	/**
-	 * An array of rules to use
-	 *
-	 * @var array
-	 */
-	protected $rules = array();
-
-	/**
-	 * An array of field macros
-	 *
-	 * @var array
-	 */
-	protected $macros = array();
-
-	/**
-	 * The labels created so far
-	 *
-	 * @var array
-	 */
-	public $labels = array();
-
-	/**
-	 * The IDs created so far
-	 *
-	 * @var array
-	 */
-	public $ids = array();
-
-	/**
-	 * A lookup table where the key is the input name,
-	 * and the value is number of times seen. This is
-	 * used to calculate unique ids.
-	 *
-	 * @var array
-	 */
-	public $names = array();
-
-	// Namespaces
-	////////////////////////////////////////////////////////////////////
-
-	/**
-	 * The namespace of Form elements
-	 */
-	const FORMSPACE = 'Former\Form\\';
-
-	/**
-	 * The namespace of fields
-	 */
-	const FIELDSPACE = 'Former\Form\Fields\\';
-
-	/**
-	 * Build a new Former instance
-	 *
-	 * @param Container        $app
-	 * @param MethodDispatcher $dispatcher
-	 */
-	public function __construct(Container $app, MethodDispatcher $dispatcher)
-	{
-		$this->app      = $app;
-		$this->dispatch = $dispatcher;
-	}
-
-	////////////////////////////////////////////////////////////////////
-	//////////////////////////// INTERFACE /////////////////////////////
-	////////////////////////////////////////////////////////////////////
-
-	/**
-	 * Acts as a router that redirects methods to all of Former classes
-	 *
-	 * @param  string $method     The method called
-	 * @param  array  $parameters An array of parameters
-	 *
-	 * @return mixed
-	 */
-	public function __call($method, $parameters)
-	{
-		// Dispatch to Form\Elements
-		// Explicitly check false since closeGroup() may return an empty string
-		if (($element = $this->dispatch->toElements($method, $parameters)) !== false) {
-			return $element;
-		}
-
-		// Dispatch to Form\Form
-		if ($form = $this->dispatch->toForm($method, $parameters)) {
-			$this->app->instance('former.form', $form);
-
-			return $this->app['former.form'];
-		}
-
-		// Dispatch to Form\Group
-		if ($group = $this->dispatch->toGroup($method, $parameters)) {
-			return $group;
-		}
-
-		// Dispatch to Form\Actions
-		if ($actions = $this->dispatch->toActions($method, $parameters)) {
-			return $actions;
-		}
-
-		// Dispatch to macros
-		if ($macro = $this->dispatch->toMacros($method, $parameters)) {
-			return $macro;
-		}
-
-		// Checking for any supplementary classes
-		$modifiers = explode('_', $method);
-		$method  = array_pop($modifiers);
+    // Instances
+    ////////////////////////////////////////////////////////////////////
+
+
+    /**
+     * The current environment
+     *
+     * @var \Illuminate\Container\Container
+     */
+    protected $app;
+
+    /**
+     * The Method Dispatcher
+     *
+     * @var MethodDispatcher
+     */
+    protected $dispatch;
+
+    // Informations
+    ////////////////////////////////////////////////////////////////////
+
+    /**
+     * The form's errors
+     *
+     * @var Message
+     */
+    protected $errors;
+
+    /**
+     * An array of rules to use
+     *
+     * @var array
+     */
+    protected $rules = array();
+
+    /**
+     * An array of field macros
+     *
+     * @var array
+     */
+    protected $macros = array();
+
+    /**
+     * The labels created so far
+     *
+     * @var array
+     */
+    public $labels = array();
+
+    /**
+     * The IDs created so far
+     *
+     * @var array
+     */
+    public $ids = array();
+
+    /**
+     * A lookup table where the key is the input name,
+     * and the value is number of times seen. This is
+     * used to calculate unique ids.
+     *
+     * @var array
+     */
+    public $names = array();
+
+    // Namespaces
+    ////////////////////////////////////////////////////////////////////
+
+    /**
+     * The namespace of Form elements
+     */
+    const FORMSPACE = 'Former\Form\\';
+
+    /**
+     * The namespace of fields
+     */
+    const FIELDSPACE = 'Former\Form\Fields\\';
+
+    /**
+     * Build a new Former instance
+     *
+     * @param Container        $app
+     * @param MethodDispatcher $dispatcher
+     */
+    public function __construct(Container $app, MethodDispatcher $dispatcher)
+    {
+        $this->app      = $app;
+        $this->dispatch = $dispatcher;
+    }
+
+    ////////////////////////////////////////////////////////////////////
+    //////////////////////////// INTERFACE /////////////////////////////
+    ////////////////////////////////////////////////////////////////////
+
+    /**
+     * Acts as a router that redirects methods to all of Former classes
+     *
+     * @param  string $method     The method called
+     * @param  array  $parameters An array of parameters
+     *
+     * @return mixed
+     */
+    public function __call($method, $parameters)
+    {
+        // Dispatch to Form\Elements
+        // Explicitly check false since closeGroup() may return an empty string
+        if (($element = $this->dispatch->toElements($method, $parameters)) !== false) {
+            return $element;
+        }
+
+        // Dispatch to Form\Form
+        if ($form = $this->dispatch->toForm($method, $parameters)) {
+            $this->app->instance('former.form', $form);
+
+            return $this->app['former.form'];
+        }
+
+        // Dispatch to Form\Group
+        if ($group = $this->dispatch->toGroup($method, $parameters)) {
+            return $group;
+        }
+
+        // Dispatch to Form\Actions
+        if ($actions = $this->dispatch->toActions($method, $parameters)) {
+            return $actions;
+        }
+
+        // Dispatch to macros
+        if ($macro = $this->dispatch->toMacros($method, $parameters)) {
+            return $macro;
+        }
+
+        // Checking for any supplementary classes
+        $modifiers = explode('_', $method);
+        $method  = array_pop($modifiers);
 		
-		// Dispatch to the different Form\Fields
-		$field     = $this->dispatch->toFields($method, $parameters);
-		$field->setModifiers($modifiers);
-		$field->addClass('');
+        // Dispatch to the different Form\Fields
+        $field     = $this->dispatch->toFields($method, $parameters);
+        $field->setModifiers($modifiers);
+        $field->addClass('');
 		
-		// Else bind field
-		$this->app->instance('former.field', $field);
-
-		return $this->app['former.field'];
-	}
-
-	////////////////////////////////////////////////////////////////////
-	//////////////////////////////// MACROS ////////////////////////////
-	////////////////////////////////////////////////////////////////////
-
-	/**
-	 * Register a macro with Former
-	 *
-	 * @param  string   $name  The name of the macro
-	 * @param  Callable $macro The macro itself
-	 *
-	 * @return mixed
-	 */
-	public function macro($name, $macro)
-	{
-		$this->macros[$name] = $macro;
-	}
-
-	/**
-	 * Check if a macro exists
-	 *
-	 * @param  string $name
-	 *
-	 * @return boolean
-	 */
-	public function hasMacro($name)
-	{
-		return isset($this->macros[$name]);
-	}
-
-	/**
-	 * Get a registered macro
-	 *
-	 * @param  string $name
-	 *
-	 * @return Closure
-	 */
-	public function getMacro($name)
-	{
-		return $this->macros[$name];
-	}
-
-	////////////////////////////////////////////////////////////////////
-	///////////////////////////// POPULATOR ////////////////////////////
-	////////////////////////////////////////////////////////////////////
-
-	/**
-	 * Add values to populate the array
-	 *
-	 * @param mixed $values Can be an Eloquent object or an array
-	 */
-	public function populate($values)
-	{
-		$this->app['former.populator']->replace($values);
-	}
-
-	/**
-	 * Set the value of a particular field
-	 *
-	 * @param string $field The field's name
-	 * @param mixed  $value Its new value
-	 */
-	public function populateField($field, $value)
-	{
-		$this->app['former.populator']->put($field, $value);
-	}
-
-	/**
-	 * Get the value of a field
-	 *
-	 * @param string $field The field's name
-	 * @param null   $fallback
-	 *
-	 * @return mixed
-	 */
-	public function getValue($field, $fallback = null)
-	{
-		return $this->app['former.populator']->get($field, $fallback);
-	}
-
-	/**
-	 * Fetch a field value from both the new and old POST array
-	 *
-	 * @param  string $name     A field name
-	 * @param  string $fallback A fallback if nothing was found
-	 *
-	 * @return string           The results
-	 */
-	public function getPost($name, $fallback = null)
-	{
-		$name     = str_replace(array('[', ']'), array('.', ''), $name);
-		$name     = trim($name, '.');
-		$oldValue = $this->app['request']->old($name, $fallback);
-
-		return $this->app['request']->input($name, $oldValue, true);
-	}
-
-	////////////////////////////////////////////////////////////////////
-	////////////////////////////// TOOLKIT /////////////////////////////
-	////////////////////////////////////////////////////////////////////
-
-	/**
-	 * Set the errors to use for validations
-	 *
-	 * @param Message $validator The result from a validation
-	 *
-	 * @return  void
-	 */
-	public function withErrors($validator = null)
-	{
-		// Try to get the errors form the session
-		if ($this->app['session']->has('errors')) {
-			$this->errors = $this->app['session']->get('errors');
-		}
-
-		// If we're given a raw Validator, go fetch the errors in it
-		if ($validator instanceof Validator) {
-			$this->errors = $validator->getMessageBag();
-		} else {
-			if ($validator instanceof MessageBag) {
-				$this->errors = $validator;
-			}
-		}
-
-		return $this->errors;
-	}
-
-	/**
-	 * Add live validation rules
-	 *
-	 * @param  array *$rules An array of Laravel rules
-	 *
-	 * @return  void
-	 */
-	public function withRules()
-	{
-		$rules = call_user_func_array('array_merge', func_get_args());
-
-		// Parse the rules according to Laravel conventions
-		foreach ($rules as $name => $fieldRules) {
-			$expFieldRules = $fieldRules;
-			if (!is_array($expFieldRules)) {
-				$expFieldRules = explode('|', $expFieldRules);
-				$expFieldRules = array_map('trim', $expFieldRules);
-			}
-
-			foreach ($expFieldRules as $rule) {
-
-				$parameters = null;
-
-				if (($colon = strpos($rule, ':')) !== false) {
-					$rulename = substr($rule, 0, $colon);
-
-					/**
-					 * Regular expressions may contain commas and should not be divided by str_getcsv.
-					 * For regular expressions we are just using the complete expression as a parameter.
-					 */
-					if ($rulename !== 'regex') {
-						$parameters = str_getcsv(substr($rule, $colon + 1));
-					} else {
-						$parameters = [substr($rule, $colon + 1)];
-					}
-				}
-
-				// Exclude unsupported rules
-				$rule = is_numeric($colon) ? substr($rule, 0, $colon) : $rule;
-
-				// Store processed rule in Former's array
-				if (!isset($parameters)) {
-					$parameters = array();
-				}
-
-				$this->rules[$name][$rule] = $parameters;
-			}
-		}
-	}
-
-	/**
-	 * Switch the framework used by Former
-	 *
-	 * @param string $framework The name of the framework to use
-	 */
-	public function framework($framework = null)
-	{
-		if (!$framework) {
-			return $this->app['former.framework']->current();
-		}
-
-		$this->setOption('framework', $framework);
-
-		$framework = $this->getFrameworkInstance($framework);
-		$this->app->bind('former.framework', function ($app) use ($framework) {
-			return $framework;
-		});
-	}
-
-	/**
-	 * Get a new framework instance
-	 *
-	 * @param string $framework
-	 *
-	 * @throws Exceptions\InvalidFrameworkException
-	 * @return \Former\Interfaces\FrameworkInterface
-	 */
-	public function getFrameworkInstance($framework)
-	{
-		$formerClass = __NAMESPACE__.'\Framework\\'.$framework;
-
-		//get interfaces of the given framework
-		$interfaces = class_exists($framework) ? class_implements($framework) : array();
-
-		if(class_exists($formerClass)) {
-			$returnClass = $formerClass;
-		} elseif(class_exists($framework) && isset($interfaces['Former\Interfaces\FrameworkInterface'])) {
-			// We have some outside class, lets return it.
-			$returnClass = $framework;
-		} else {
-			throw (new InvalidFrameworkException())->setFramework($framework);
-		}
-
-		return new $returnClass($this->app);
-	}
-
-	/**
-	 * Get an option from the config
-	 *
-	 * @param string $option  The option
-	 * @param mixed  $default Optional fallback
-	 *
-	 * @return mixed
-	 */
-	public function getOption($option, $default = null)
-	{
-		return $this->app['config']->get('former.'.$option, $default);
-	}
-
-	/**
-	 * Set an option on the config
-	 *
-	 * @param string $option
-	 * @param string $value
-	 */
-	public function setOption($option, $value)
-	{
-		return $this->app['config']->set('former.'.$option, $value);
-	}
-
-	////////////////////////////////////////////////////////////////////
-	////////////////////////////// BUILDERS ////////////////////////////
-	////////////////////////////////////////////////////////////////////
-
-	/**
-	 * Closes a form
-	 *
-	 * @return string A form closing tag
-	 */
-	public function close()
-	{
-		if ($this->app->bound('former.form')) {
-			$closing = $this->app['former.form']->close();
-		}
-
-		// Destroy instances
-		$instances = array('former.form', 'former.form.framework');
-		foreach ($instances as $instance) {
-			$this->app[$instance] = null;
-			unset($this->app[$instance]);
-		}
-
-		// Reset populator
-		$this->app['former.populator']->reset();
-
-		// Reset all values
-		$this->errors = null;
-		$this->rules  = array();
-
-		return isset($closing) ? $closing : null;
-	}
-
-	////////////////////////////////////////////////////////////////////
-	////////////////////////////// HELPERS /////////////////////////////
-	////////////////////////////////////////////////////////////////////
-
-	/**
-	 * Get the errors for the current field
-	 *
-	 * @param  string $name A field name
-	 *
-	 * @return string       An error message
-	 */
-	public function getErrors($name = null)
-	{
-		// Get name and translate array notation
-		if (!$name and $this->app['former.field']) {
-			$name = $this->app['former.field']->getName();
-
-			// Always return empty string for anonymous fields (i.e. fields with no name/id)
-			if (!$name) {
-				return '';
-			}
-		}
-
-		if ($this->errors and $name) {
-			$name = str_replace(array('[', ']'), array('.', ''), $name);
-			$name = trim($name, '.');
-
-			return $this->errors->first($name);
-		}
-
-		return $this->errors;
-	}
-
-	/**
-	 * Get a rule from the Rules array
-	 *
-	 * @param  string $name The field to fetch
-	 *
-	 * @return array        An array of rules
-	 */
-	public function getRules($name)
-	{
-		// Check the rules for the name as given
-		$ruleset = array_get($this->rules, $name);
-
-		// If no rules found, convert to dot notation and try again
-		if (is_null($ruleset)) {
-			$name = str_replace(array('[', ']'), array('.', ''), $name);
-			$name = trim($name, '.');
-			$ruleset = array_get($this->rules, $name);
-		}
-
-		return $ruleset;
-	}
+        // Else bind field
+        $this->app->instance('former.field', $field);
+
+        return $this->app['former.field'];
+    }
+
+    ////////////////////////////////////////////////////////////////////
+    //////////////////////////////// MACROS ////////////////////////////
+    ////////////////////////////////////////////////////////////////////
+
+    /**
+     * Register a macro with Former
+     *
+     * @param  string   $name  The name of the macro
+     * @param  Callable $macro The macro itself
+     *
+     * @return mixed
+     */
+    public function macro($name, $macro)
+    {
+        $this->macros[$name] = $macro;
+    }
+
+    /**
+     * Check if a macro exists
+     *
+     * @param  string $name
+     *
+     * @return boolean
+     */
+    public function hasMacro($name)
+    {
+        return isset($this->macros[$name]);
+    }
+
+    /**
+     * Get a registered macro
+     *
+     * @param  string $name
+     *
+     * @return Closure
+     */
+    public function getMacro($name)
+    {
+        return $this->macros[$name];
+    }
+
+    ////////////////////////////////////////////////////////////////////
+    ///////////////////////////// POPULATOR ////////////////////////////
+    ////////////////////////////////////////////////////////////////////
+
+    /**
+     * Add values to populate the array
+     *
+     * @param mixed $values Can be an Eloquent object or an array
+     */
+    public function populate($values)
+    {
+        $this->app['former.populator']->replace($values);
+    }
+
+    /**
+     * Set the value of a particular field
+     *
+     * @param string $field The field's name
+     * @param mixed  $value Its new value
+     */
+    public function populateField($field, $value)
+    {
+        $this->app['former.populator']->put($field, $value);
+    }
+
+    /**
+     * Get the value of a field
+     *
+     * @param string $field The field's name
+     * @param null   $fallback
+     *
+     * @return mixed
+     */
+    public function getValue($field, $fallback = null)
+    {
+        return $this->app['former.populator']->get($field, $fallback);
+    }
+
+    /**
+     * Fetch a field value from both the new and old POST array
+     *
+     * @param  string $name     A field name
+     * @param  string $fallback A fallback if nothing was found
+     *
+     * @return string           The results
+     */
+    public function getPost($name, $fallback = null)
+    {
+        $name     = str_replace(array('[', ']'), array('.', ''), $name);
+        $name     = trim($name, '.');
+        $oldValue = $this->app['request']->old($name, $fallback);
+
+        return $this->app['request']->input($name, $oldValue, true);
+    }
+
+    ////////////////////////////////////////////////////////////////////
+    ////////////////////////////// TOOLKIT /////////////////////////////
+    ////////////////////////////////////////////////////////////////////
+
+    /**
+     * Set the errors to use for validations
+     *
+     * @param Message $validator The result from a validation
+     *
+     * @return  void
+     */
+    public function withErrors($validator = null)
+    {
+        // Try to get the errors form the session
+        if ($this->app['session']->has('errors')) {
+            $this->errors = $this->app['session']->get('errors');
+        }
+
+        // If we're given a raw Validator, go fetch the errors in it
+        if ($validator instanceof Validator) {
+            $this->errors = $validator->getMessageBag();
+        } else {
+            if ($validator instanceof MessageBag) {
+                $this->errors = $validator;
+            }
+        }
+
+        return $this->errors;
+    }
+
+    /**
+     * Add live validation rules
+     *
+     * @param  array *$rules An array of Laravel rules
+     *
+     * @return  void
+     */
+    public function withRules()
+    {
+        $rules = call_user_func_array('array_merge', func_get_args());
+
+        // Parse the rules according to Laravel conventions
+        foreach ($rules as $name => $fieldRules) {
+            $expFieldRules = $fieldRules;
+            if (!is_array($expFieldRules)) {
+                $expFieldRules = explode('|', $expFieldRules);
+                $expFieldRules = array_map('trim', $expFieldRules);
+            }
+
+            foreach ($expFieldRules as $rule) {
+
+                $parameters = null;
+
+                if (($colon = strpos($rule, ':')) !== false) {
+                    $rulename = substr($rule, 0, $colon);
+
+                    /**
+                     * Regular expressions may contain commas and should not be divided by str_getcsv.
+                     * For regular expressions we are just using the complete expression as a parameter.
+                     */
+                    if ($rulename !== 'regex') {
+                        $parameters = str_getcsv(substr($rule, $colon + 1));
+                    } else {
+                        $parameters = [substr($rule, $colon + 1)];
+                    }
+                }
+
+                // Exclude unsupported rules
+                $rule = is_numeric($colon) ? substr($rule, 0, $colon) : $rule;
+
+                // Store processed rule in Former's array
+                if (!isset($parameters)) {
+                    $parameters = array();
+                }
+
+                $this->rules[$name][$rule] = $parameters;
+            }
+        }
+    }
+
+    /**
+     * Switch the framework used by Former
+     *
+     * @param string $framework The name of the framework to use
+     */
+    public function framework($framework = null)
+    {
+        if (!$framework) {
+            return $this->app['former.framework']->current();
+        }
+
+        $this->setOption('framework', $framework);
+
+        $framework = $this->getFrameworkInstance($framework);
+        $this->app->bind('former.framework', function ($app) use ($framework) {
+            return $framework;
+        });
+    }
+
+    /**
+     * Get a new framework instance
+     *
+     * @param string $framework
+     *
+     * @throws Exceptions\InvalidFrameworkException
+     * @return \Former\Interfaces\FrameworkInterface
+     */
+    public function getFrameworkInstance($framework)
+    {
+        $formerClass = __NAMESPACE__.'\Framework\\'.$framework;
+
+        //get interfaces of the given framework
+        $interfaces = class_exists($framework) ? class_implements($framework) : array();
+
+        if(class_exists($formerClass)) {
+            $returnClass = $formerClass;
+        } elseif(class_exists($framework) && isset($interfaces['Former\Interfaces\FrameworkInterface'])) {
+            // We have some outside class, lets return it.
+            $returnClass = $framework;
+        } else {
+            throw (new InvalidFrameworkException())->setFramework($framework);
+        }
+
+        return new $returnClass($this->app);
+    }
+
+    /**
+     * Get an option from the config
+     *
+     * @param string $option  The option
+     * @param mixed  $default Optional fallback
+     *
+     * @return mixed
+     */
+    public function getOption($option, $default = null)
+    {
+        return $this->app['config']->get('former.'.$option, $default);
+    }
+
+    /**
+     * Set an option on the config
+     *
+     * @param string $option
+     * @param string $value
+     */
+    public function setOption($option, $value)
+    {
+        return $this->app['config']->set('former.'.$option, $value);
+    }
+
+    ////////////////////////////////////////////////////////////////////
+    ////////////////////////////// BUILDERS ////////////////////////////
+    ////////////////////////////////////////////////////////////////////
+
+    /**
+     * Closes a form
+     *
+     * @return string A form closing tag
+     */
+    public function close()
+    {
+        if ($this->app->bound('former.form')) {
+            $closing = $this->app['former.form']->close();
+        }
+
+        // Destroy instances
+        $instances = array('former.form', 'former.form.framework');
+        foreach ($instances as $instance) {
+            $this->app[$instance] = null;
+            unset($this->app[$instance]);
+        }
+
+        // Reset populator
+        $this->app['former.populator']->reset();
+
+        // Reset all values
+        $this->errors = null;
+        $this->rules  = array();
+
+        return isset($closing) ? $closing : null;
+    }
+
+    ////////////////////////////////////////////////////////////////////
+    ////////////////////////////// HELPERS /////////////////////////////
+    ////////////////////////////////////////////////////////////////////
+
+    /**
+     * Get the errors for the current field
+     *
+     * @param  string $name A field name
+     *
+     * @return string       An error message
+     */
+    public function getErrors($name = null)
+    {
+        // Get name and translate array notation
+        if (!$name and $this->app['former.field']) {
+            $name = $this->app['former.field']->getName();
+
+            // Always return empty string for anonymous fields (i.e. fields with no name/id)
+            if (!$name) {
+                return '';
+            }
+        }
+
+        if ($this->errors and $name) {
+            $name = str_replace(array('[', ']'), array('.', ''), $name);
+            $name = trim($name, '.');
+
+            return $this->errors->first($name);
+        }
+
+        return $this->errors;
+    }
+
+    /**
+     * Get a rule from the Rules array
+     *
+     * @param  string $name The field to fetch
+     *
+     * @return array        An array of rules
+     */
+    public function getRules($name)
+    {
+        // Check the rules for the name as given
+        $ruleset = array_get($this->rules, $name);
+
+        // If no rules found, convert to dot notation and try again
+        if (is_null($ruleset)) {
+            $name = str_replace(array('[', ']'), array('.', ''), $name);
+            $name = trim($name, '.');
+            $ruleset = array_get($this->rules, $name);
+        }
+
+        return $ruleset;
+    }
 }

Spacing +5 added lines, -5 removed lines

@@ -147,10 +147,10 @@ 
 
 		// Checking for any supplementary classes
 		$modifiers = explode('_', $method);
-		$method  = array_pop($modifiers);
+		$method = array_pop($modifiers);
 		
 		// Dispatch to the different Form\Fields
-		$field     = $this->dispatch->toFields($method, $parameters);
+		$field = $this->dispatch->toFields($method, $parameters);
 		$field->setModifiers($modifiers);
 		$field->addClass('');
 		
@@ -350,7 +350,7 @@ 
 		$this->setOption('framework', $framework);
 
 		$framework = $this->getFrameworkInstance($framework);
-		$this->app->bind('former.framework', function ($app) use ($framework) {
+		$this->app->bind('former.framework', function($app) use ($framework) {
 			return $framework;
 		});
 	}
@@ -370,9 +370,9 @@ 
 		//get interfaces of the given framework
 		$interfaces = class_exists($framework) ? class_implements($framework) : array();
 
-		if(class_exists($formerClass)) {
+		if (class_exists($formerClass)) {
 			$returnClass = $formerClass;
-		} elseif(class_exists($framework) && isset($interfaces['Former\Interfaces\FrameworkInterface'])) {
+		} elseif (class_exists($framework) && isset($interfaces['Former\Interfaces\FrameworkInterface'])) {
 			// We have some outside class, lets return it.
 			$returnClass = $framework;
 		} else {

src/Former/Framework/TwitterBootstrap4.php

Spacing +1 added lines, -1 removed lines

@@ -139,7 +139,7 @@
 		$classes = array_intersect($classes, $this->fields);
 
 		// Prepend field type
-		$classes = array_map(function ($class) {
+		$classes = array_map(function($class) {
 			return Str::startsWith($class, 'col') ? $class : 'input-'.$class;
 		}, $classes);
 

Doc Comments +1 added lines, -1 removed lines

@@ -345,7 +345,7 @@
 	 * @param string $text
 	 * @param array  $attributes
 	 *
-	 * @return string
+	 * @return Element
 	 */
 	public function createValidationError($text, $attributes = array())
 	{

Indentation +455 added lines, -455 removed lines

@@ -13,459 +13,459 @@
  */
 class TwitterBootstrap4 extends Framework implements FrameworkInterface
 {
-	/**
-	 * Form types that trigger special styling for this Framework
-	 *
-	 * @var array
-	 */
-	protected $availableTypes = array('horizontal', 'vertical', 'inline');
-
-	/**
-	 * The button types available
-	 *
-	 * @var array
-	 */
-	private $buttons = array(
-		'lg',
-		'sm',
-		'xs',
-		'block',
-		'link',
-		'primary',
-		'secondary',
-		'warning',
-		'danger',
-		'success',
-		'info',
-		'light',
-		'dark',
-	);
-
-	/**
-	 * The field sizes available
-	 *
-	 * @var array
-	 */
-	private $fields = array(
-		'lg',
-		'sm',
-		// 'col-xs-1', 'col-xs-2', 'col-xs-3', 'col-xs-4', 'col-xs-5', 'col-xs-6',
-		// 'col-xs-7', 'col-xs-8', 'col-xs-9', 'col-xs-10', 'col-xs-11', 'col-xs-12',
-		// 'col-sm-1', 'col-sm-2', 'col-sm-3', 'col-sm-4', 'col-sm-5', 'col-sm-6',
-		// 'col-sm-7', 'col-sm-8', 'col-sm-9', 'col-sm-10', 'col-sm-11', 'col-sm-12',
-		// 'col-md-1', 'col-md-2', 'col-md-3', 'col-md-4', 'col-md-5', 'col-md-6',
-		// 'col-md-7', 'col-md-8', 'col-md-9', 'col-md-10', 'col-md-11', 'col-md-12',
-		// 'col-lg-1', 'col-lg-2', 'col-lg-3', 'col-lg-4', 'col-lg-5', 'col-lg-6',
-		// 'col-lg-7', 'col-lg-8', 'col-lg-9', 'col-lg-10', 'col-lg-11', 'col-lg-12',
-	);
-
-	/**
-	 * The field states available
-	 *
-	 * @var array
-	 */
-	protected $states = array(
-		'is-invalid',
-	);
-
-	/**
-	 * The default HTML tag used for icons
-	 *
-	 * @var string
-	 */
-	protected $iconTag = 'i';
-
-	/**
-	 * The default set for icon fonts
-	 * By default Bootstrap 4 offers no fonts, but we'll add Font Awesome
-	 *
-	 * @var string
-	 */
-	protected $iconSet = 'fa';
-
-	/**
-	 * The default prefix icon names
-	 * Using Font Awesome 5, this can be 'fa' or 'fas' for solid, 'far' for regular
-	 *
-	 * @var string
-	 */
-	protected $iconPrefix = 'fa';
-
-	/**
-	 * Create a new TwitterBootstrap instance
-	 *
-	 * @param \Illuminate\Container\Container $app
-	 */
-	public function __construct(Container $app)
-	{
-		$this->app = $app;
-		$this->setFrameworkDefaults();
-	}
-
-	////////////////////////////////////////////////////////////////////
-	/////////////////////////// FILTER ARRAYS //////////////////////////
-	////////////////////////////////////////////////////////////////////
-
-	/**
-	 * Filter buttons classes
-	 *
-	 * @param  array $classes An array of classes
-	 *
-	 * @return string[] A filtered array
-	 */
-	public function filterButtonClasses($classes)
-	{
-		// Filter classes
-		// $classes = array_intersect($classes, $this->buttons);
-
-		// Prepend button type
-		$classes   = $this->prependWith($classes, 'btn-');
-		$classes[] = 'btn';
-
-		return $classes;
-	}
-
-	/**
-	 * Filter field classes
-	 *
-	 * @param  array $classes An array of classes
-	 *
-	 * @return array A filtered array
-	 */
-	public function filterFieldClasses($classes)
-	{
-		// Filter classes
-		$classes = array_intersect($classes, $this->fields);
-
-		// Prepend field type
-		$classes = array_map(function ($class) {
-			return Str::startsWith($class, 'col') ? $class : 'input-'.$class;
-		}, $classes);
-
-		return $classes;
-	}
-
-	////////////////////////////////////////////////////////////////////
-	///////////////////// EXPOSE FRAMEWORK SPECIFICS ///////////////////
-	////////////////////////////////////////////////////////////////////
-
-	/**
-	 * Framework error state
-	 *
-	 * @return string
-	 */
-	public function errorState()
-	{
-		return 'is-invalid';
-	}
-
-	/**
-	 * Returns corresponding inline class of a field
-	 *
-	 * @param Field $field
-	 *
-	 * @return string
-	 */
-	public function getInlineLabelClass($field)
-	{
-		$inlineClass = parent::getInlineLabelClass($field);
-		if ($field->isOfType('checkbox', 'checkboxes', 'radio', 'radios')) {
-			$inlineClass = 'form-check-label';
-		}
-
-		return $inlineClass;
-	}
-
-	/**
-	 * Set the fields width from a label width
-	 *
-	 * @param array $labelWidths
-	 */
-	protected function setFieldWidths($labelWidths)
-	{
-		$labelWidthClass = $fieldWidthClass = $fieldOffsetClass = '';
-
-		$viewports = $this->getFrameworkOption('viewports');
-		foreach ($labelWidths as $viewport => $columns) {
-			if ($viewport) {
-				$labelWidthClass .= " col-$viewports[$viewport]-$columns";
-				$fieldWidthClass .= " col-$viewports[$viewport]-".(12 - $columns);
-				$fieldOffsetClass .= " col-$viewports[$viewport]-offset-$columns";
-			}
-		}
-
-		$this->labelWidth  = ltrim($labelWidthClass);
-		$this->fieldWidth  = ltrim($fieldWidthClass);
-		$this->fieldOffset = ltrim($fieldOffsetClass);
-	}
-
-	////////////////////////////////////////////////////////////////////
-	///////////////////////////// ADD CLASSES //////////////////////////
-	////////////////////////////////////////////////////////////////////
-
-	/**
-	 * Add classes to a field
-	 *
-	 * @param Field $field
-	 * @param array $classes The possible classes to add
-	 *
-	 * @return Field
-	 */
-	public function getFieldClasses(Field $field, $classes)
-	{
-		// Add inline class for checkables
-		if ($field->isCheckable()) {
-			$classes[] = 'form-check';
-
-			if (in_array('inline', $classes)) {
-				$field->inline();
-			}
-		}
-
-		// Filter classes according to field type
-		if ($field->isButton()) {
-			$classes = $this->filterButtonClasses($classes);
-		} else {
-			$classes = $this->filterFieldClasses($classes);
-		}
-
-		// Add form-control class for text-type, textarea and select fields
-		// As text-type is open-ended we instead exclude those that shouldn't receive the class
-		if (!$field->isCheckable() and !$field->isButton() and !in_array($field->getType(), array(
-					'file',
-					'plaintext',
-				)) and !in_array('form-control', $classes)
-		) {
-			$classes[] = 'form-control';
-		}
-
-		if ($this->app['former']->getErrors($field->getName())) {
-			$classes[] = $this->errorState();
-		}
-
-		return $this->addClassesToField($field, $classes);
-	}
-
-	/**
-	 * Add group classes
-	 *
-	 * @return string A list of group classes
-	 */
-	public function getGroupClasses()
-	{
-		if ($this->app['former.form']->isOfType('horizontal')) {
-			return 'form-group row';
-		} else {
-			return 'form-group';
-		}
-	}
-
-	/**
-	 * Add label classes
-	 *
-	 * @return string[] An array of attributes with the label class
-	 */
-	public function getLabelClasses()
-	{
-		if ($this->app['former.form']->isOfType('horizontal')) {
-			return array('control-label', $this->labelWidth);
-		} elseif ($this->app['former.form']->isOfType('inline')) {
-			return array('sr-only');
-		} else {
-			return array('control-label');
-		}
-	}
-
-	/**
-	 * Add uneditable field classes
-	 *
-	 * @return string An array of attributes with the uneditable class
-	 */
-	public function getUneditableClasses()
-	{
-		return '';
-	}
-
-	/**
-	 * Add plain text field classes
-	 *
-	 * @return string An array of attributes with the plain text class
-	 */
-	public function getPlainTextClasses()
-	{
-		return 'form-control-static';
-	}
-
-	/**
-	 * Add form class
-	 *
-	 * @param  string $type The type of form to add
-	 *
-	 * @return string|null
-	 */
-	public function getFormClasses($type)
-	{
-		return $type ? 'form-'.$type : null;
-	}
-
-	/**
-	 * Add actions block class
-	 *
-	 * @return string|null
-	 */
-	public function getActionClasses()
-	{
-		if ($this->app['former.form']->isOfType('horizontal') || $this->app['former.form']->isOfType('inline')) {
-			return 'form-group row';
-		}
-
-		return null;
-	}
-
-	////////////////////////////////////////////////////////////////////
-	//////////////////////////// RENDER BLOCKS /////////////////////////
-	////////////////////////////////////////////////////////////////////
-
-	/**
-	 * Render an help text
-	 *
-	 * @param string $text
-	 * @param array  $attributes
-	 *
-	 * @return Element
-	 */
-	public function createHelp($text, $attributes = array())
-	{
-		return Element::create('small', $text, $attributes)->addClass('text-muted');
-	}
-
-	/**
-	 * Render an validation error text
-	 *
-	 * @param string $text
-	 * @param array  $attributes
-	 *
-	 * @return string
-	 */
-	public function createValidationError($text, $attributes = array())
-	{
-		return Element::create('div', $text, $attributes)->addClass('invalid-feedback');
-	}
-
-	/**
-	 * Render an help text
-	 *
-	 * @param string $text
-	 * @param array  $attributes
-	 *
-	 * @return Element
-	 */
-	public function createBlockHelp($text, $attributes = array())
-	{
-		return Element::create('small', $text, $attributes)->addClass('form-text text-muted');
-	}
-
-	/**
-	 * Render a disabled field
-	 *
-	 * @param Field $field
-	 *
-	 * @return Element
-	 */
-	public function createDisabledField(Field $field)
-	{
-		return Element::create('span', $field->getValue(), $field->getAttributes());
-	}
-
-	/**
-	 * Render a plain text field
-	 *
-	 * @param Field $field
-	 *
-	 * @return Element
-	 */
-	public function createPlainTextField(Field $field)
-	{
-		$label = $field->getLabel();
-		if ($label) {
-			$label->for('');
-		}
-
-		return Element::create('div', $field->getValue(), $field->getAttributes());
-	}
-
-	////////////////////////////////////////////////////////////////////
-	//////////////////////////// WRAP BLOCKS ///////////////////////////
-	////////////////////////////////////////////////////////////////////
-
-	/**
-	 * Wrap an item to be prepended or appended to the current field
-	 *
-	 * @return Element A wrapped item
-	 */
-	public function placeAround($item)
-	{
-		// Render object
-		if (is_object($item) and method_exists($item, '__toString')) {
-			$item = $item->__toString();
-		}
-
-		// Get class to use
-		$class = (strpos($item, '<button') !== false) ? 'btn' : 'addon';
-
-		return Element::create('span', $item)->addClass('input-group-'.$class);
-	}
-
-	/**
-	 * Wrap a field with prepended and appended items
-	 *
-	 * @param  Field $field
-	 * @param  array $prepend
-	 * @param  array $append
-	 *
-	 * @return string A field concatented with prepended and/or appended items
-	 */
-	public function prependAppend($field, $prepend, $append)
-	{
-		$return = '<div class="input-group">';
-		$return .= join(null, $prepend);
-		$return .= $field->render();
-		$return .= join(null, $append);
-		$return .= '</div>';
-
-		return $return;
-	}
-
-	/**
-	 * Wrap a field with potential additional tags
-	 *
-	 * @param  Field $field
-	 *
-	 * @return Element A wrapped field
-	 */
-	public function wrapField($field)
-	{
-		if ($this->app['former.form']->isOfType('horizontal')) {
-			return Element::create('div', $field)->addClass($this->fieldWidth);
-		}
-
-		return $field;
-	}
-
-	/**
-	 * Wrap actions block with potential additional tags
-	 *
-	 * @param  Actions $actions
-	 *
-	 * @return string A wrapped actions block
-	 */
-	public function wrapActions($actions)
-	{
-		// For horizontal forms, we wrap the actions in a div
-		if ($this->app['former.form']->isOfType('horizontal')) {
-			return Element::create('div', $actions)->addClass(array($this->fieldOffset, $this->fieldWidth));
-		}
-
-		return $actions;
-	}
+    /**
+     * Form types that trigger special styling for this Framework
+     *
+     * @var array
+     */
+    protected $availableTypes = array('horizontal', 'vertical', 'inline');
+
+    /**
+     * The button types available
+     *
+     * @var array
+     */
+    private $buttons = array(
+        'lg',
+        'sm',
+        'xs',
+        'block',
+        'link',
+        'primary',
+        'secondary',
+        'warning',
+        'danger',
+        'success',
+        'info',
+        'light',
+        'dark',
+    );
+
+    /**
+     * The field sizes available
+     *
+     * @var array
+     */
+    private $fields = array(
+        'lg',
+        'sm',
+        // 'col-xs-1', 'col-xs-2', 'col-xs-3', 'col-xs-4', 'col-xs-5', 'col-xs-6',
+        // 'col-xs-7', 'col-xs-8', 'col-xs-9', 'col-xs-10', 'col-xs-11', 'col-xs-12',
+        // 'col-sm-1', 'col-sm-2', 'col-sm-3', 'col-sm-4', 'col-sm-5', 'col-sm-6',
+        // 'col-sm-7', 'col-sm-8', 'col-sm-9', 'col-sm-10', 'col-sm-11', 'col-sm-12',
+        // 'col-md-1', 'col-md-2', 'col-md-3', 'col-md-4', 'col-md-5', 'col-md-6',
+        // 'col-md-7', 'col-md-8', 'col-md-9', 'col-md-10', 'col-md-11', 'col-md-12',
+        // 'col-lg-1', 'col-lg-2', 'col-lg-3', 'col-lg-4', 'col-lg-5', 'col-lg-6',
+        // 'col-lg-7', 'col-lg-8', 'col-lg-9', 'col-lg-10', 'col-lg-11', 'col-lg-12',
+    );
+
+    /**
+     * The field states available
+     *
+     * @var array
+     */
+    protected $states = array(
+        'is-invalid',
+    );
+
+    /**
+     * The default HTML tag used for icons
+     *
+     * @var string
+     */
+    protected $iconTag = 'i';
+
+    /**
+     * The default set for icon fonts
+     * By default Bootstrap 4 offers no fonts, but we'll add Font Awesome
+     *
+     * @var string
+     */
+    protected $iconSet = 'fa';
+
+    /**
+     * The default prefix icon names
+     * Using Font Awesome 5, this can be 'fa' or 'fas' for solid, 'far' for regular
+     *
+     * @var string
+     */
+    protected $iconPrefix = 'fa';
+
+    /**
+     * Create a new TwitterBootstrap instance
+     *
+     * @param \Illuminate\Container\Container $app
+     */
+    public function __construct(Container $app)
+    {
+        $this->app = $app;
+        $this->setFrameworkDefaults();
+    }
+
+    ////////////////////////////////////////////////////////////////////
+    /////////////////////////// FILTER ARRAYS //////////////////////////
+    ////////////////////////////////////////////////////////////////////
+
+    /**
+     * Filter buttons classes
+     *
+     * @param  array $classes An array of classes
+     *
+     * @return string[] A filtered array
+     */
+    public function filterButtonClasses($classes)
+    {
+        // Filter classes
+        // $classes = array_intersect($classes, $this->buttons);
+
+        // Prepend button type
+        $classes   = $this->prependWith($classes, 'btn-');
+        $classes[] = 'btn';
+
+        return $classes;
+    }
+
+    /**
+     * Filter field classes
+     *
+     * @param  array $classes An array of classes
+     *
+     * @return array A filtered array
+     */
+    public function filterFieldClasses($classes)
+    {
+        // Filter classes
+        $classes = array_intersect($classes, $this->fields);
+
+        // Prepend field type
+        $classes = array_map(function ($class) {
+            return Str::startsWith($class, 'col') ? $class : 'input-'.$class;
+        }, $classes);
+
+        return $classes;
+    }
+
+    ////////////////////////////////////////////////////////////////////
+    ///////////////////// EXPOSE FRAMEWORK SPECIFICS ///////////////////
+    ////////////////////////////////////////////////////////////////////
+
+    /**
+     * Framework error state
+     *
+     * @return string
+     */
+    public function errorState()
+    {
+        return 'is-invalid';
+    }
+
+    /**
+     * Returns corresponding inline class of a field
+     *
+     * @param Field $field
+     *
+     * @return string
+     */
+    public function getInlineLabelClass($field)
+    {
+        $inlineClass = parent::getInlineLabelClass($field);
+        if ($field->isOfType('checkbox', 'checkboxes', 'radio', 'radios')) {
+            $inlineClass = 'form-check-label';
+        }
+
+        return $inlineClass;
+    }
+
+    /**
+     * Set the fields width from a label width
+     *
+     * @param array $labelWidths
+     */
+    protected function setFieldWidths($labelWidths)
+    {
+        $labelWidthClass = $fieldWidthClass = $fieldOffsetClass = '';
+
+        $viewports = $this->getFrameworkOption('viewports');
+        foreach ($labelWidths as $viewport => $columns) {
+            if ($viewport) {
+                $labelWidthClass .= " col-$viewports[$viewport]-$columns";
+                $fieldWidthClass .= " col-$viewports[$viewport]-".(12 - $columns);
+                $fieldOffsetClass .= " col-$viewports[$viewport]-offset-$columns";
+            }
+        }
+
+        $this->labelWidth  = ltrim($labelWidthClass);
+        $this->fieldWidth  = ltrim($fieldWidthClass);
+        $this->fieldOffset = ltrim($fieldOffsetClass);
+    }
+
+    ////////////////////////////////////////////////////////////////////
+    ///////////////////////////// ADD CLASSES //////////////////////////
+    ////////////////////////////////////////////////////////////////////
+
+    /**
+     * Add classes to a field
+     *
+     * @param Field $field
+     * @param array $classes The possible classes to add
+     *
+     * @return Field
+     */
+    public function getFieldClasses(Field $field, $classes)
+    {
+        // Add inline class for checkables
+        if ($field->isCheckable()) {
+            $classes[] = 'form-check';
+
+            if (in_array('inline', $classes)) {
+                $field->inline();
+            }
+        }
+
+        // Filter classes according to field type
+        if ($field->isButton()) {
+            $classes = $this->filterButtonClasses($classes);
+        } else {
+            $classes = $this->filterFieldClasses($classes);
+        }
+
+        // Add form-control class for text-type, textarea and select fields
+        // As text-type is open-ended we instead exclude those that shouldn't receive the class
+        if (!$field->isCheckable() and !$field->isButton() and !in_array($field->getType(), array(
+                    'file',
+                    'plaintext',
+                )) and !in_array('form-control', $classes)
+        ) {
+            $classes[] = 'form-control';
+        }
+
+        if ($this->app['former']->getErrors($field->getName())) {
+            $classes[] = $this->errorState();
+        }
+
+        return $this->addClassesToField($field, $classes);
+    }
+
+    /**
+     * Add group classes
+     *
+     * @return string A list of group classes
+     */
+    public function getGroupClasses()
+    {
+        if ($this->app['former.form']->isOfType('horizontal')) {
+            return 'form-group row';
+        } else {
+            return 'form-group';
+        }
+    }
+
+    /**
+     * Add label classes
+     *
+     * @return string[] An array of attributes with the label class
+     */
+    public function getLabelClasses()
+    {
+        if ($this->app['former.form']->isOfType('horizontal')) {
+            return array('control-label', $this->labelWidth);
+        } elseif ($this->app['former.form']->isOfType('inline')) {
+            return array('sr-only');
+        } else {
+            return array('control-label');
+        }
+    }
+
+    /**
+     * Add uneditable field classes
+     *
+     * @return string An array of attributes with the uneditable class
+     */
+    public function getUneditableClasses()
+    {
+        return '';
+    }
+
+    /**
+     * Add plain text field classes
+     *
+     * @return string An array of attributes with the plain text class
+     */
+    public function getPlainTextClasses()
+    {
+        return 'form-control-static';
+    }
+
+    /**
+     * Add form class
+     *
+     * @param  string $type The type of form to add
+     *
+     * @return string|null
+     */
+    public function getFormClasses($type)
+    {
+        return $type ? 'form-'.$type : null;
+    }
+
+    /**
+     * Add actions block class
+     *
+     * @return string|null
+     */
+    public function getActionClasses()
+    {
+        if ($this->app['former.form']->isOfType('horizontal') || $this->app['former.form']->isOfType('inline')) {
+            return 'form-group row';
+        }
+
+        return null;
+    }
+
+    ////////////////////////////////////////////////////////////////////
+    //////////////////////////// RENDER BLOCKS /////////////////////////
+    ////////////////////////////////////////////////////////////////////
+
+    /**
+     * Render an help text
+     *
+     * @param string $text
+     * @param array  $attributes
+     *
+     * @return Element
+     */
+    public function createHelp($text, $attributes = array())
+    {
+        return Element::create('small', $text, $attributes)->addClass('text-muted');
+    }
+
+    /**
+     * Render an validation error text
+     *
+     * @param string $text
+     * @param array  $attributes
+     *
+     * @return string
+     */
+    public function createValidationError($text, $attributes = array())
+    {
+        return Element::create('div', $text, $attributes)->addClass('invalid-feedback');
+    }
+
+    /**
+     * Render an help text
+     *
+     * @param string $text
+     * @param array  $attributes
+     *
+     * @return Element
+     */
+    public function createBlockHelp($text, $attributes = array())
+    {
+        return Element::create('small', $text, $attributes)->addClass('form-text text-muted');
+    }
+
+    /**
+     * Render a disabled field
+     *
+     * @param Field $field
+     *
+     * @return Element
+     */
+    public function createDisabledField(Field $field)
+    {
+        return Element::create('span', $field->getValue(), $field->getAttributes());
+    }
+
+    /**
+     * Render a plain text field
+     *
+     * @param Field $field
+     *
+     * @return Element
+     */
+    public function createPlainTextField(Field $field)
+    {
+        $label = $field->getLabel();
+        if ($label) {
+            $label->for('');
+        }
+
+        return Element::create('div', $field->getValue(), $field->getAttributes());
+    }
+
+    ////////////////////////////////////////////////////////////////////
+    //////////////////////////// WRAP BLOCKS ///////////////////////////
+    ////////////////////////////////////////////////////////////////////
+
+    /**
+     * Wrap an item to be prepended or appended to the current field
+     *
+     * @return Element A wrapped item
+     */
+    public function placeAround($item)
+    {
+        // Render object
+        if (is_object($item) and method_exists($item, '__toString')) {
+            $item = $item->__toString();
+        }
+
+        // Get class to use
+        $class = (strpos($item, '<button') !== false) ? 'btn' : 'addon';
+
+        return Element::create('span', $item)->addClass('input-group-'.$class);
+    }
+
+    /**
+     * Wrap a field with prepended and appended items
+     *
+     * @param  Field $field
+     * @param  array $prepend
+     * @param  array $append
+     *
+     * @return string A field concatented with prepended and/or appended items
+     */
+    public function prependAppend($field, $prepend, $append)
+    {
+        $return = '<div class="input-group">';
+        $return .= join(null, $prepend);
+        $return .= $field->render();
+        $return .= join(null, $append);
+        $return .= '</div>';
+
+        return $return;
+    }
+
+    /**
+     * Wrap a field with potential additional tags
+     *
+     * @param  Field $field
+     *
+     * @return Element A wrapped field
+     */
+    public function wrapField($field)
+    {
+        if ($this->app['former.form']->isOfType('horizontal')) {
+            return Element::create('div', $field)->addClass($this->fieldWidth);
+        }
+
+        return $field;
+    }
+
+    /**
+     * Wrap actions block with potential additional tags
+     *
+     * @param  Actions $actions
+     *
+     * @return string A wrapped actions block
+     */
+    public function wrapActions($actions)
+    {
+        // For horizontal forms, we wrap the actions in a div
+        if ($this->app['former.form']->isOfType('horizontal')) {
+            return Element::create('div', $actions)->addClass(array($this->fieldOffset, $this->fieldWidth));
+        }
+
+        return $actions;
+    }
 }

src/Former/Traits/Checkable.php

Spacing +3 added lines, -3 removed lines

@@ -350,7 +350,7 @@ 
 
 		// In Bootsrap 3 or 4, don't append the the checkable type (radio/checkbox) as a class if
 		// rendering inline.
-		$class =  ($this->app['former']->framework() == 'TwitterBootstrap3' ||
+		$class = ($this->app['former']->framework() == 'TwitterBootstrap3' ||
 			$this->app['former']->framework() == 'TwitterBootstrap4') ? trim($isInline) : $this->checkable.$isInline;
 
 		// Merge custom attributes with global attributes
@@ -381,7 +381,7 @@ 
 			$element = (is_object($field)) ? $field->render() : $field;
 		} elseif ($this->app['former']->framework() == 'TwitterBootstrap4') {
 			// Revised for Bootstrap 4, move the 'input' outside of the 'label'
-			$element = $field . Element::create('label', $label)->for($attributes['id'])->class($class)->render();
+			$element = $field.Element::create('label', $label)->for($attributes['id'])->class($class)->render();
 
 			$wrapper_class = $this->inline ? 'form-check form-check-inline' : 'form-check';
 			
@@ -421,7 +421,7 @@ 
 		$this->app['former']->labels[] = $name;
 
 		// Count number of fields with the same ID
-		$where  = array_filter($this->app['former']->labels, function ($label) use ($name) {
+		$where  = array_filter($this->app['former']->labels, function($label) use ($name) {
 			return $label == $name;
 		});
 		$unique = sizeof($where);

Indentation +555 added lines, -555 removed lines

@@ -12,560 +12,560 @@
  */
 abstract class Checkable extends Field
 {
-	/**
-	 * Renders the checkables as inline
-	 *
-	 * @var boolean
-	 */
-	protected $inline = false;
-
-	/**
-	 * Add a text to a single element
-	 *
-	 * @var string
-	 */
-	protected $text = null;
-
-	/**
-	 * Renders the checkables as grouped
-	 *
-	 * @var boolean
-	 */
-	protected $grouped = false;
-
-	/**
-	 * The checkable items currently stored
-	 *
-	 * @var array
-	 */
-	protected $items = array();
-
-	/**
-	 * The type of checkable item
-	 *
-	 * @var string
-	 */
-	protected $checkable = null;
-
-	/**
-	 * An array of checked items
-	 *
-	 * @var array
-	 */
-	protected $checked = array();
-
-	/**
-	 * The checkable currently being focused on
-	 *
-	 * @var integer
-	 */
-	protected $focus = null;
-
-	/**
-	 * Whether this particular checkable is to be pushed
-	 *
-	 * @var boolean
-	 */
-	protected $isPushed = null;
-
-	////////////////////////////////////////////////////////////////////
-	//////////////////////////// CORE METHODS //////////////////////////
-	////////////////////////////////////////////////////////////////////
-
-	/**
-	 * Build a new checkable
-	 *
-	 * @param Container $app
-	 * @param string    $type
-	 * @param array     $name
-	 * @param           $label
-	 * @param           $value
-	 * @param           $attributes
-	 */
-	public function __construct(Container $app, $type, $name, $label, $value, $attributes)
-	{
-		// Unify auto and chained methods of grouping checkboxes
-		if (ends_with($name, '[]')) {
-			$name = substr($name, 0, -2);
-			$this->grouped();
-		}
-		parent::__construct($app, $type, $name, $label, $value, $attributes);
-
-		if (is_array($this->value)) {
-			$this->items($this->value);
-		}
-	}
-
-	/**
-	 * Apply methods to focused checkable
-	 *
-	 * @param string $method
-	 * @param array  $parameters
-	 *
-	 * @return $this
-	 */
-	public function __call($method, $parameters)
-	{
-		$focused = $this->setOnFocused('attributes.'.$method, array_get($parameters, 0));
-		if ($focused) {
-			return $this;
-		}
-
-		return parent::__call($method, $parameters);
-	}
-
-	/**
-	 * Prints out the currently stored checkables
-	 */
-	public function render()
-	{
-		$html = null;
-
-		$this->setFieldClasses();
-
-		// Multiple items
-		if ($this->items) {
-			unset($this->app['former']->labels[array_search($this->name, $this->app['former']->labels)]);
-			foreach ($this->items as $key => $item) {
-				$value = $this->isCheckbox() && !$this->isGrouped() ? 1 : $key;
-				$html .= $this->createCheckable($item, $value);
-			}
-
-			return $html;
-		}
-
-		// Single item
-		return $this->createCheckable(array(
-			'name'  => $this->name,
-			'label' => $this->text,
-			'value' => $this->value,
-			'attributes' => $this->attributes,
-		));
-	}
-
-	////////////////////////////////////////////////////////////////////
-	////////////////////////// FIELD METHODS ///////////////////////////
-	////////////////////////////////////////////////////////////////////
-
-	/**
-	 * Focus on a particular checkable
-	 *
-	 * @param integer $on The checkable to focus on
-	 *
-	 * @return $this
-	 */
-	public function on($on)
-	{
-		if (!isset($this->items[$on])) {
-			return $this;
-		} else {
-			$this->focus = $on;
-		}
-
-		return $this;
-	}
-
-	/**
-	 * Set the checkables as inline
-	 */
-	public function inline($isInline = true)
-	{
-		$this->inline = $isInline;
-
-		return $this;
-	}
-
-	/**
-	 * Set the checkables as stacked
-	 */
-	public function stacked($isStacked = true)
-	{
-		$this->inline = !$isStacked;
-
-		return $this;
-	}
-
-	/**
-	 * Set the checkables as grouped
-	 */
-	public function grouped($isGrouped = true)
-	{
-		$this->grouped = $isGrouped;
-
-		return $this;
-	}
-
-	/**
-	 * Add text to a single checkable
-	 *
-	 * @param  string $text The checkable label
-	 *
-	 * @return $this
-	 */
-	public function text($text)
-	{
-		// Translate and format
-		$text = Helpers::translate($text);
-
-		// Apply on focused if any
-		$focused = $this->setOnFocused('label', $text);
-		if ($focused) {
-			return $this;
-		}
-
-		$this->text = $text;
-
-		return $this;
-	}
-
-	/**
-	 * Push this particular checkbox
-	 *
-	 * @param boolean $pushed
-	 *
-	 * @return $this
-	 */
-	public function push($pushed = true)
-	{
-		$this->isPushed = $pushed;
-
-		return $this;
-	}
-
-	/**
-	 * Check a specific item
-	 *
-	 * @param bool|string $checked The checkable to check, or an array of checked items
-	 *
-	 * @return $this
-	 */
-	public function check($checked = true)
-	{
-		// If we're setting all the checked items at once
-		if (is_array($checked)) {
-			$this->checked = $checked;
-			// Checking an item in particular
-		} elseif (is_string($checked) or is_int($checked)) {
-			$this->checked[$checked] = true;
-			// Only setting a single item
-		} else {
-			$this->checked[$this->name] = (bool) $checked;
-		}
-
-		return $this;
-	}
-
-	////////////////////////////////////////////////////////////////////
-	////////////////////////// INTERNAL METHODS ////////////////////////
-	////////////////////////////////////////////////////////////////////
-
-	/**
-	 * Creates a series of checkable items
-	 *
-	 * @param array $_items Items to create
-	 */
-	protected function items($_items)
-	{
-		// If passing an array
-		if (sizeof($_items) == 1 and
-			isset($_items[0]) and
-			is_array($_items[0])
-		) {
-			$_items = $_items[0];
-		}
-
-		// Fetch models if that's what we were passed
-		if (isset($_items[0]) and is_object($_items[0])) {
-			$_items = Helpers::queryToArray($_items);
-			$_items = array_flip($_items);
-		}
-
-		// Iterate through items, assign a name and a label to each
-		$count = 0;
-		foreach ($_items as $label => $name) {
-
-			// Define a fallback name in case none is found
-			$fallback = $this->isCheckbox()
-				? $this->name.'_'.$count
-				: $this->name;
-
-			// Grouped fields
-			if ($this->isGrouped()) {
-				$attributes['id'] = str_replace('[]', null, $fallback);
-				$fallback         = str_replace('[]', null, $this->name).'[]';
-			}
-
-			// If we haven't any name defined for the checkable, try to compute some
-			if (!is_string($label) and !is_array($name)) {
-				$label = $name;
-				$name  = $fallback;
-			}
-
-			// If we gave custom information on the item, add them
-			if (is_array($name)) {
-				$attributes = $name;
-				$name       = array_get($attributes, 'name', $fallback);
-				unset($attributes['name']);
-			}
-
-			// Store all informations we have in an array
-			$item = array(
-				'name'  => $name,
-				'label' => Helpers::translate($label),
-				'count' => $count,
-			);
-			if (isset($attributes)) {
-				$item['attributes'] = $attributes;
-			}
-
-			$this->items[] = $item;
-			$count++;
-		}
-	}
-
-	/**
-	 * Renders a checkable
-	 *
-	 * @param string|array $item          A checkable item
-	 * @param integer      $fallbackValue A fallback value if none is set
-	 *
-	 * @return string
-	 */
-	protected function createCheckable($item, $fallbackValue = 1)
-	{
-		// Extract informations
-		extract($item);
-
-		// Set default values
-		if (!isset($attributes)) {
-			$attributes = array();
-		}
-		if (isset($attributes['value'])) {
-			$value = $attributes['value'];
-		}
-		if (!isset($value) or $value === $this->app['former']->getOption('unchecked_value')) {
-			$value = $fallbackValue;
-		}
-
-		// If inline items, add class
-		$isInline = $this->inline ? ' '.$this->app['former.framework']->getInlineLabelClass($this) : null;
-
-		// In Bootsrap 3 or 4, don't append the the checkable type (radio/checkbox) as a class if
-		// rendering inline.
-		$class =  ($this->app['former']->framework() == 'TwitterBootstrap3' ||
-			$this->app['former']->framework() == 'TwitterBootstrap4') ? trim($isInline) : $this->checkable.$isInline;
-
-		// Merge custom attributes with global attributes
-		$attributes = array_merge($this->attributes, $attributes);
-		if (!isset($attributes['id'])) {
-			$attributes['id'] = $name.$this->unique($name);
-		}
-
-		// Create field
-		$field = Input::create($this->checkable, $name, Helpers::encode($value), $attributes);
-		if ($this->isChecked($item, $value)) {
-			$field->checked('checked');
-		}
-
-		// Add hidden checkbox if requested
-		if ($this->isOfType('checkbox', 'checkboxes')) {
-			if ($this->isPushed or ($this->app['former']->getOption('push_checkboxes') and $this->isPushed !== false)) {
-				$field = $this->app['former']->hidden($name)->forceValue($this->app['former']->getOption('unchecked_value')).$field->render();
-
-				// app['former.field'] was overwritten by Former::hidden() call in the line above, so here
-				// we reset it to $this to enable $this->app['former']->getErrors() to retrieve the correct object
-				$this->app->instance('former.field', $this);
-			}
-		}
-
-		// If no label to wrap, return plain checkable
-		if (!$label) {
-			$element = (is_object($field)) ? $field->render() : $field;
-		} elseif ($this->app['former']->framework() == 'TwitterBootstrap4') {
-			// Revised for Bootstrap 4, move the 'input' outside of the 'label'
-			$element = $field . Element::create('label', $label)->for($attributes['id'])->class($class)->render();
-
-			$wrapper_class = $this->inline ? 'form-check form-check-inline' : 'form-check';
+    /**
+     * Renders the checkables as inline
+     *
+     * @var boolean
+     */
+    protected $inline = false;
+
+    /**
+     * Add a text to a single element
+     *
+     * @var string
+     */
+    protected $text = null;
+
+    /**
+     * Renders the checkables as grouped
+     *
+     * @var boolean
+     */
+    protected $grouped = false;
+
+    /**
+     * The checkable items currently stored
+     *
+     * @var array
+     */
+    protected $items = array();
+
+    /**
+     * The type of checkable item
+     *
+     * @var string
+     */
+    protected $checkable = null;
+
+    /**
+     * An array of checked items
+     *
+     * @var array
+     */
+    protected $checked = array();
+
+    /**
+     * The checkable currently being focused on
+     *
+     * @var integer
+     */
+    protected $focus = null;
+
+    /**
+     * Whether this particular checkable is to be pushed
+     *
+     * @var boolean
+     */
+    protected $isPushed = null;
+
+    ////////////////////////////////////////////////////////////////////
+    //////////////////////////// CORE METHODS //////////////////////////
+    ////////////////////////////////////////////////////////////////////
+
+    /**
+     * Build a new checkable
+     *
+     * @param Container $app
+     * @param string    $type
+     * @param array     $name
+     * @param           $label
+     * @param           $value
+     * @param           $attributes
+     */
+    public function __construct(Container $app, $type, $name, $label, $value, $attributes)
+    {
+        // Unify auto and chained methods of grouping checkboxes
+        if (ends_with($name, '[]')) {
+            $name = substr($name, 0, -2);
+            $this->grouped();
+        }
+        parent::__construct($app, $type, $name, $label, $value, $attributes);
+
+        if (is_array($this->value)) {
+            $this->items($this->value);
+        }
+    }
+
+    /**
+     * Apply methods to focused checkable
+     *
+     * @param string $method
+     * @param array  $parameters
+     *
+     * @return $this
+     */
+    public function __call($method, $parameters)
+    {
+        $focused = $this->setOnFocused('attributes.'.$method, array_get($parameters, 0));
+        if ($focused) {
+            return $this;
+        }
+
+        return parent::__call($method, $parameters);
+    }
+
+    /**
+     * Prints out the currently stored checkables
+     */
+    public function render()
+    {
+        $html = null;
+
+        $this->setFieldClasses();
+
+        // Multiple items
+        if ($this->items) {
+            unset($this->app['former']->labels[array_search($this->name, $this->app['former']->labels)]);
+            foreach ($this->items as $key => $item) {
+                $value = $this->isCheckbox() && !$this->isGrouped() ? 1 : $key;
+                $html .= $this->createCheckable($item, $value);
+            }
+
+            return $html;
+        }
+
+        // Single item
+        return $this->createCheckable(array(
+            'name'  => $this->name,
+            'label' => $this->text,
+            'value' => $this->value,
+            'attributes' => $this->attributes,
+        ));
+    }
+
+    ////////////////////////////////////////////////////////////////////
+    ////////////////////////// FIELD METHODS ///////////////////////////
+    ////////////////////////////////////////////////////////////////////
+
+    /**
+     * Focus on a particular checkable
+     *
+     * @param integer $on The checkable to focus on
+     *
+     * @return $this
+     */
+    public function on($on)
+    {
+        if (!isset($this->items[$on])) {
+            return $this;
+        } else {
+            $this->focus = $on;
+        }
+
+        return $this;
+    }
+
+    /**
+     * Set the checkables as inline
+     */
+    public function inline($isInline = true)
+    {
+        $this->inline = $isInline;
+
+        return $this;
+    }
+
+    /**
+     * Set the checkables as stacked
+     */
+    public function stacked($isStacked = true)
+    {
+        $this->inline = !$isStacked;
+
+        return $this;
+    }
+
+    /**
+     * Set the checkables as grouped
+     */
+    public function grouped($isGrouped = true)
+    {
+        $this->grouped = $isGrouped;
+
+        return $this;
+    }
+
+    /**
+     * Add text to a single checkable
+     *
+     * @param  string $text The checkable label
+     *
+     * @return $this
+     */
+    public function text($text)
+    {
+        // Translate and format
+        $text = Helpers::translate($text);
+
+        // Apply on focused if any
+        $focused = $this->setOnFocused('label', $text);
+        if ($focused) {
+            return $this;
+        }
+
+        $this->text = $text;
+
+        return $this;
+    }
+
+    /**
+     * Push this particular checkbox
+     *
+     * @param boolean $pushed
+     *
+     * @return $this
+     */
+    public function push($pushed = true)
+    {
+        $this->isPushed = $pushed;
+
+        return $this;
+    }
+
+    /**
+     * Check a specific item
+     *
+     * @param bool|string $checked The checkable to check, or an array of checked items
+     *
+     * @return $this
+     */
+    public function check($checked = true)
+    {
+        // If we're setting all the checked items at once
+        if (is_array($checked)) {
+            $this->checked = $checked;
+            // Checking an item in particular
+        } elseif (is_string($checked) or is_int($checked)) {
+            $this->checked[$checked] = true;
+            // Only setting a single item
+        } else {
+            $this->checked[$this->name] = (bool) $checked;
+        }
+
+        return $this;
+    }
+
+    ////////////////////////////////////////////////////////////////////
+    ////////////////////////// INTERNAL METHODS ////////////////////////
+    ////////////////////////////////////////////////////////////////////
+
+    /**
+     * Creates a series of checkable items
+     *
+     * @param array $_items Items to create
+     */
+    protected function items($_items)
+    {
+        // If passing an array
+        if (sizeof($_items) == 1 and
+            isset($_items[0]) and
+            is_array($_items[0])
+        ) {
+            $_items = $_items[0];
+        }
+
+        // Fetch models if that's what we were passed
+        if (isset($_items[0]) and is_object($_items[0])) {
+            $_items = Helpers::queryToArray($_items);
+            $_items = array_flip($_items);
+        }
+
+        // Iterate through items, assign a name and a label to each
+        $count = 0;
+        foreach ($_items as $label => $name) {
+
+            // Define a fallback name in case none is found
+            $fallback = $this->isCheckbox()
+                ? $this->name.'_'.$count
+                : $this->name;
+
+            // Grouped fields
+            if ($this->isGrouped()) {
+                $attributes['id'] = str_replace('[]', null, $fallback);
+                $fallback         = str_replace('[]', null, $this->name).'[]';
+            }
+
+            // If we haven't any name defined for the checkable, try to compute some
+            if (!is_string($label) and !is_array($name)) {
+                $label = $name;
+                $name  = $fallback;
+            }
+
+            // If we gave custom information on the item, add them
+            if (is_array($name)) {
+                $attributes = $name;
+                $name       = array_get($attributes, 'name', $fallback);
+                unset($attributes['name']);
+            }
+
+            // Store all informations we have in an array
+            $item = array(
+                'name'  => $name,
+                'label' => Helpers::translate($label),
+                'count' => $count,
+            );
+            if (isset($attributes)) {
+                $item['attributes'] = $attributes;
+            }
+
+            $this->items[] = $item;
+            $count++;
+        }
+    }
+
+    /**
+     * Renders a checkable
+     *
+     * @param string|array $item          A checkable item
+     * @param integer      $fallbackValue A fallback value if none is set
+     *
+     * @return string
+     */
+    protected function createCheckable($item, $fallbackValue = 1)
+    {
+        // Extract informations
+        extract($item);
+
+        // Set default values
+        if (!isset($attributes)) {
+            $attributes = array();
+        }
+        if (isset($attributes['value'])) {
+            $value = $attributes['value'];
+        }
+        if (!isset($value) or $value === $this->app['former']->getOption('unchecked_value')) {
+            $value = $fallbackValue;
+        }
+
+        // If inline items, add class
+        $isInline = $this->inline ? ' '.$this->app['former.framework']->getInlineLabelClass($this) : null;
+
+        // In Bootsrap 3 or 4, don't append the the checkable type (radio/checkbox) as a class if
+        // rendering inline.
+        $class =  ($this->app['former']->framework() == 'TwitterBootstrap3' ||
+            $this->app['former']->framework() == 'TwitterBootstrap4') ? trim($isInline) : $this->checkable.$isInline;
+
+        // Merge custom attributes with global attributes
+        $attributes = array_merge($this->attributes, $attributes);
+        if (!isset($attributes['id'])) {
+            $attributes['id'] = $name.$this->unique($name);
+        }
+
+        // Create field
+        $field = Input::create($this->checkable, $name, Helpers::encode($value), $attributes);
+        if ($this->isChecked($item, $value)) {
+            $field->checked('checked');
+        }
+
+        // Add hidden checkbox if requested
+        if ($this->isOfType('checkbox', 'checkboxes')) {
+            if ($this->isPushed or ($this->app['former']->getOption('push_checkboxes') and $this->isPushed !== false)) {
+                $field = $this->app['former']->hidden($name)->forceValue($this->app['former']->getOption('unchecked_value')).$field->render();
+
+                // app['former.field'] was overwritten by Former::hidden() call in the line above, so here
+                // we reset it to $this to enable $this->app['former']->getErrors() to retrieve the correct object
+                $this->app->instance('former.field', $this);
+            }
+        }
+
+        // If no label to wrap, return plain checkable
+        if (!$label) {
+            $element = (is_object($field)) ? $field->render() : $field;
+        } elseif ($this->app['former']->framework() == 'TwitterBootstrap4') {
+            // Revised for Bootstrap 4, move the 'input' outside of the 'label'
+            $element = $field . Element::create('label', $label)->for($attributes['id'])->class($class)->render();
+
+            $wrapper_class = $this->inline ? 'form-check form-check-inline' : 'form-check';
 			
-			$element = Element::create('div', $element)->class($wrapper_class)->render();
-
-		} else {
-			// Original way is to add the 'input' inside the 'label'
-			$element = Element::create('label', $field.$label)->for($attributes['id'])->class($class)->render();
-		}
-
-		// If BS3, if checkables are stacked, wrap them in a div with the checkable type
-		if (!$isInline && $this->app['former']->framework() == 'TwitterBootstrap3') {
-			$wrapper = Element::create('div', $element)->class($this->checkable);
-			if ($this->getAttribute('disabled')) {
-				$wrapper->addClass('disabled');
-			}
-			$element = $wrapper->render();
-		}
-
-		// Return the field
-		return $element;
-	}
-
-	////////////////////////////////////////////////////////////////////
-	///////////////////////////// HELPERS //////////////////////////////
-	////////////////////////////////////////////////////////////////////
-
-	/**
-	 * Generate an unique ID for a field
-	 *
-	 * @param string $name The field's name
-	 *
-	 * @return string A field number to use
-	 */
-	protected function unique($name)
-	{
-		$this->app['former']->labels[] = $name;
-
-		// Count number of fields with the same ID
-		$where  = array_filter($this->app['former']->labels, function ($label) use ($name) {
-			return $label == $name;
-		});
-		$unique = sizeof($where);
-
-		// In case the field doesn't need to be numbered
-		if ($unique < 2 or empty($this->items)) {
-			return false;
-		}
-
-		return $unique;
-	}
-
-	/**
-	 * Set something on the currently focused checkable
-	 *
-	 * @param string $attribute The key to set
-	 * @param string $value     Its value
-	 *
-	 * @return $this|bool
-	 */
-	protected function setOnFocused($attribute, $value)
-	{
-		if (is_null($this->focus)) {
-			return false;
-		}
-
-		$this->items[$this->focus] = array_set($this->items[$this->focus], $attribute, $value);
-
-		return $this;
-	}
-
-	/**
-	 * Check if a checkable is checked
-	 *
-	 * @return boolean Checked or not
-	 */
-	protected function isChecked($item = null, $value = null)
-	{
-		if (isset($item['name'])) {
-			$name = $item['name'];
-		}
-		if (empty($name)) {
-			$name = $this->name;
-		}
-
-		// If it's a checkbox, see if we marqued that one as checked in the array
-		// Or if it's a single radio, simply see if we called check
-		if ($this->isCheckbox() or
-			!$this->isCheckbox() and !$this->items
-		) {
-			$checked = array_get($this->checked, $name, false);
-
-			// If there are multiple, search for the value
-			// as the name are the same between radios
-		} else {
-			$checked = array_get($this->checked, $value, false);
-		}
-
-		// Check the values and POST array
-		if ($this->isGrouped()) {
-			// The group index. (e.g. 'bar' if the item name is foo[bar], or the item index for foo[])
-			$groupIndex = self::getGroupIndexFromItem($item);
-
-			// Search using the bare name, not the individual item name
-			$post   = $this->app['former']->getPost($this->name);
-			$static = $this->app['former']->getValue($this->bind ?: $this->name);
-
-			if (isset($post[$groupIndex])) {
-				$post = $post[$groupIndex];
-			}
-
-			/**
-			 * Support for Laravel Collection repopulating for grouped checkboxes. Note that the groupIndex must
-			 * match the value in order for the checkbox to be considered checked, e.g.:
-			 *
-			 *  array(
-			 *    'name' = 'roles[foo]',
-			 *    'value' => 'foo',
-			 *  )
-			 */
-			if ($static instanceof Collection) {
-				// If the repopulate value is a collection, search for an item matching the $groupIndex
-				foreach ($static as $staticItem) {
-					$staticItemValue = method_exists($staticItem, 'getKey') ? $staticItem->getKey() : $staticItem;
-					if ($staticItemValue == $groupIndex) {
-						$static = $staticItemValue;
-						break;
-					}
-				}
-			} else if (isset($static[$groupIndex])) {
-				$static = $static[$groupIndex];
-			}
-		} else {
-			$post   = $this->app['former']->getPost($name);
-			$static = $this->app['former']->getValue($this->bind ?: $name);
-		}
-
-		if (!is_null($post) and $post !== $this->app['former']->getOption('unchecked_value')) {
-			$isChecked = ($post == $value);
-		} elseif (!is_null($static)) {
-			$isChecked = ($static == $value);
-		} else {
-			$isChecked = $checked;
-		}
-
-		return $isChecked ? true : false;
-	}
-
-	/**
-	 * Check if the current element is a checkbox
-	 *
-	 * @return boolean Checkbox or radio
-	 */
-	protected function isCheckbox()
-	{
-		return $this->checkable == 'checkbox';
-	}
-
-	/**
-	 * Check if the checkables are grouped or not
-	 *
-	 * @return boolean
-	 */
-	protected function isGrouped()
-	{
-		return
-			$this->grouped == true or
-			strpos($this->name, '[]') !== false;
-	}
-
-	/**
-	 * @param array $item The item array, containing at least name and count keys.
-	 *
-	 * @return mixed The group index. (e.g. returns bar if the item name is foo[bar], or the item count for foo[])
-	 */
-	public static function getGroupIndexFromItem($item)
-	{
-		$groupIndex = preg_replace('/^.*?\[(.*)\]$/', '$1', $item['name']);
-		if (empty($groupIndex) or $groupIndex == $item['name']) {
-			return $item['count'];
-		}
-
-		return $groupIndex;
-	}
+            $element = Element::create('div', $element)->class($wrapper_class)->render();
+
+        } else {
+            // Original way is to add the 'input' inside the 'label'
+            $element = Element::create('label', $field.$label)->for($attributes['id'])->class($class)->render();
+        }
+
+        // If BS3, if checkables are stacked, wrap them in a div with the checkable type
+        if (!$isInline && $this->app['former']->framework() == 'TwitterBootstrap3') {
+            $wrapper = Element::create('div', $element)->class($this->checkable);
+            if ($this->getAttribute('disabled')) {
+                $wrapper->addClass('disabled');
+            }
+            $element = $wrapper->render();
+        }
+
+        // Return the field
+        return $element;
+    }
+
+    ////////////////////////////////////////////////////////////////////
+    ///////////////////////////// HELPERS //////////////////////////////
+    ////////////////////////////////////////////////////////////////////
+
+    /**
+     * Generate an unique ID for a field
+     *
+     * @param string $name The field's name
+     *
+     * @return string A field number to use
+     */
+    protected function unique($name)
+    {
+        $this->app['former']->labels[] = $name;
+
+        // Count number of fields with the same ID
+        $where  = array_filter($this->app['former']->labels, function ($label) use ($name) {
+            return $label == $name;
+        });
+        $unique = sizeof($where);
+
+        // In case the field doesn't need to be numbered
+        if ($unique < 2 or empty($this->items)) {
+            return false;
+        }
+
+        return $unique;
+    }
+
+    /**
+     * Set something on the currently focused checkable
+     *
+     * @param string $attribute The key to set
+     * @param string $value     Its value
+     *
+     * @return $this|bool
+     */
+    protected function setOnFocused($attribute, $value)
+    {
+        if (is_null($this->focus)) {
+            return false;
+        }
+
+        $this->items[$this->focus] = array_set($this->items[$this->focus], $attribute, $value);
+
+        return $this;
+    }
+
+    /**
+     * Check if a checkable is checked
+     *
+     * @return boolean Checked or not
+     */
+    protected function isChecked($item = null, $value = null)
+    {
+        if (isset($item['name'])) {
+            $name = $item['name'];
+        }
+        if (empty($name)) {
+            $name = $this->name;
+        }
+
+        // If it's a checkbox, see if we marqued that one as checked in the array
+        // Or if it's a single radio, simply see if we called check
+        if ($this->isCheckbox() or
+            !$this->isCheckbox() and !$this->items
+        ) {
+            $checked = array_get($this->checked, $name, false);
+
+            // If there are multiple, search for the value
+            // as the name are the same between radios
+        } else {
+            $checked = array_get($this->checked, $value, false);
+        }
+
+        // Check the values and POST array
+        if ($this->isGrouped()) {
+            // The group index. (e.g. 'bar' if the item name is foo[bar], or the item index for foo[])
+            $groupIndex = self::getGroupIndexFromItem($item);
+
+            // Search using the bare name, not the individual item name
+            $post   = $this->app['former']->getPost($this->name);
+            $static = $this->app['former']->getValue($this->bind ?: $this->name);
+
+            if (isset($post[$groupIndex])) {
+                $post = $post[$groupIndex];
+            }
+
+            /**
+             * Support for Laravel Collection repopulating for grouped checkboxes. Note that the groupIndex must
+             * match the value in order for the checkbox to be considered checked, e.g.:
+             *
+             *  array(
+             *    'name' = 'roles[foo]',
+             *    'value' => 'foo',
+             *  )
+             */
+            if ($static instanceof Collection) {
+                // If the repopulate value is a collection, search for an item matching the $groupIndex
+                foreach ($static as $staticItem) {
+                    $staticItemValue = method_exists($staticItem, 'getKey') ? $staticItem->getKey() : $staticItem;
+                    if ($staticItemValue == $groupIndex) {
+                        $static = $staticItemValue;
+                        break;
+                    }
+                }
+            } else if (isset($static[$groupIndex])) {
+                $static = $static[$groupIndex];
+            }
+        } else {
+            $post   = $this->app['former']->getPost($name);
+            $static = $this->app['former']->getValue($this->bind ?: $name);
+        }
+
+        if (!is_null($post) and $post !== $this->app['former']->getOption('unchecked_value')) {
+            $isChecked = ($post == $value);
+        } elseif (!is_null($static)) {
+            $isChecked = ($static == $value);
+        } else {
+            $isChecked = $checked;
+        }
+
+        return $isChecked ? true : false;
+    }
+
+    /**
+     * Check if the current element is a checkbox
+     *
+     * @return boolean Checkbox or radio
+     */
+    protected function isCheckbox()
+    {
+        return $this->checkable == 'checkbox';
+    }
+
+    /**
+     * Check if the checkables are grouped or not
+     *
+     * @return boolean
+     */
+    protected function isGrouped()
+    {
+        return
+            $this->grouped == true or
+            strpos($this->name, '[]') !== false;
+    }
+
+    /**
+     * @param array $item The item array, containing at least name and count keys.
+     *
+     * @return mixed The group index. (e.g. returns bar if the item name is foo[bar], or the item count for foo[])
+     */
+    public static function getGroupIndexFromItem($item)
+    {
+        $groupIndex = preg_replace('/^.*?\[(.*)\]$/', '$1', $item['name']);
+        if (empty($groupIndex) or $groupIndex == $item['name']) {
+            return $item['count'];
+        }
+
+        return $groupIndex;
+    }
 }

src/config/former.php

Indentation +202 added lines, -202 removed lines

@@ -1,207 +1,207 @@
 <?php return array(
 
-	// Markup
-	////////////////////////////////////////////////////////////////////
-
-	// Whether labels should be automatically computed from name
-	'automatic_label'         => true,
-
-	// The default form type
-	'default_form_type'       => 'horizontal',
-
-	// Validation
-	////////////////////////////////////////////////////////////////////
-
-	// Whether Former should fetch errors from Session
-	'fetch_errors'            => true,
-
-	// Whether Former should try to apply Validator rules as attributes
-	'live_validation'         => true,
-
-	// Whether Former should automatically fetch error messages and
-	// display them next to the matching fields
-	'error_messages'          => true,
-
-	// Checkables
-	////////////////////////////////////////////////////////////////////
-
-	// Whether checkboxes should always be present in the POST data,
-	// no matter if you checked them or not
-	'push_checkboxes'         => false,
-
-	// The value a checkbox will have in the POST array if unchecked
-	'unchecked_value'         => 0,
-
-	// Required fields
-	////////////////////////////////////////////////////////////////////
-
-	// The class to be added to required fields
-	'required_class'          => 'required',
-
-	// A facultative text to append to the labels of required fields
-	'required_text'           => '<sup>*</sup>',
-
-	// Translations
-	////////////////////////////////////////////////////////////////////
-
-	// Where Former should look for translations
-	'translate_from'          => 'validation.attributes',
-
-	// Whether text that comes out of the translated
-	// should be capitalized (ex: email => Email) automatically
-	'capitalize_translations' => true,
-
-	// An array of attributes to automatically translate
-	'translatable'            => array(
-		'help',
-		'inlineHelp',
-		'blockHelp',
-		'placeholder',
-		'data_placeholder',
-		'label',
-	),
-
-	// Framework
-	////////////////////////////////////////////////////////////////////
-
-	// The framework to be used by Former
-	'framework'               => 'TwitterBootstrap3',
-
-	'TwitterBootstrap4'       => array(
-
-		// Map Former-supported viewports to Bootstrap 4 equivalents
-		'viewports'   => array(
-			'large'  => 'lg',
-			'medium' => 'md',
-			'small'  => 'sm',
-			'mini'   => 'xs',
-		),
-		// Width of labels for horizontal forms expressed as viewport => grid columns
-		'labelWidths' => array(
-			'large' => 2,
-			'small' => 4,
-		),
-		// HTML markup and classes used by Bootstrap 5 for icons
-		'icon'        => array(
-			'tag'    => 'i',
-			'set'    => 'fa',
-			'prefix' => 'fa',
-		),
-
-	),
-
-	'TwitterBootstrap3'       => array(
-
-		// Map Former-supported viewports to Bootstrap 3 equivalents
-		'viewports'   => array(
-			'large'  => 'lg',
-			'medium' => 'md',
-			'small'  => 'sm',
-			'mini'   => 'xs',
-		),
-		// Width of labels for horizontal forms expressed as viewport => grid columns
-		'labelWidths' => array(
-			'large' => 2,
-			'small' => 4,
-		),
-		// HTML markup and classes used by Bootstrap 3 for icons
-		'icon'        => array(
-			'tag'    => 'span',
-			'set'    => 'glyphicon',
-			'prefix' => 'glyphicon',
-		),
-
-	),
-
-	'Nude'                    => array(  // No-framework markup
-		'icon' => array(
-			'tag'    => 'i',
-			'set'    => null,
-			'prefix' => 'icon',
-		),
-	),
-
-	'TwitterBootstrap'        => array( // Twitter Bootstrap version 2
-		'icon' => array(
-			'tag'    => 'i',
-			'set'    => null,
-			'prefix' => 'icon',
-		),
-	),
-
-	'ZurbFoundation5'         => array(
-		// Map Former-supported viewports to Foundation 5 equivalents
-		'viewports'           => array(
-			'large'  => 'large',
-			'medium' => null,
-			'small'  => 'small',
-			'mini'   => null,
-		),
-		// Width of labels for horizontal forms expressed as viewport => grid columns
-		'labelWidths'         => array(
-			'small' => 3,
-		),
-		// Classes to be applied to wrapped labels in horizontal forms
-		'wrappedLabelClasses' => array('right', 'inline'),
-		// HTML markup and classes used by Foundation 5 for icons
-		'icon'                => array(
-			'tag'    => 'i',
-			'set'    => null,
-			'prefix' => 'fi',
-		),
-		// CSS for inline validation errors
-		'error_classes'       => array('class' => 'error'),
-	),
-
-	'ZurbFoundation4'         => array(
-		// Foundation 4 also has an experimental "medium" breakpoint
-		// explained at http://foundation.zurb.com/docs/components/grid.html
-		'viewports'           => array(
-			'large'  => 'large',
-			'medium' => null,
-			'small'  => 'small',
-			'mini'   => null,
-		),
-		// Width of labels for horizontal forms expressed as viewport => grid columns
-		'labelWidths'         => array(
-			'small' => 3,
-		),
-		// Classes to be applied to wrapped labels in horizontal forms
-		'wrappedLabelClasses' => array('right', 'inline'),
-		// HTML markup and classes used by Foundation 4 for icons
-		'icon'                => array(
-			'tag'    => 'i',
-			'set'    => 'general',
-			'prefix' => 'foundicon',
-		),
-		// CSS for inline validation errors
-		'error_classes'       => array('class' => 'alert-box radius warning'),
-	),
-
-	'ZurbFoundation'          => array( // Foundation 3
-		'viewports'           => array(
-			'large'  => '',
-			'medium' => null,
-			'small'  => 'mobile-',
-			'mini'   => null,
-		),
-		// Width of labels for horizontal forms expressed as viewport => grid columns
-		'labelWidths'         => array(
-			'large' => 2,
-			'small' => 4,
-		),
-		// Classes to be applied to wrapped labels in horizontal forms
-		'wrappedLabelClasses' => array('right', 'inline'),
-		// HTML markup and classes used by Foundation 3 for icons
-		'icon'                => array(
-			'tag'    => 'i',
-			'set'    => null,
-			'prefix' => 'fi',
-		),
-		// CSS for inline validation errors
-		// should work for Zurb 2 and 3
-		'error_classes'       => array('class' => 'alert-box alert error'),
-	),
+    // Markup
+    ////////////////////////////////////////////////////////////////////
+
+    // Whether labels should be automatically computed from name
+    'automatic_label'         => true,
+
+    // The default form type
+    'default_form_type'       => 'horizontal',
+
+    // Validation
+    ////////////////////////////////////////////////////////////////////
+
+    // Whether Former should fetch errors from Session
+    'fetch_errors'            => true,
+
+    // Whether Former should try to apply Validator rules as attributes
+    'live_validation'         => true,
+
+    // Whether Former should automatically fetch error messages and
+    // display them next to the matching fields
+    'error_messages'          => true,
+
+    // Checkables
+    ////////////////////////////////////////////////////////////////////
+
+    // Whether checkboxes should always be present in the POST data,
+    // no matter if you checked them or not
+    'push_checkboxes'         => false,
+
+    // The value a checkbox will have in the POST array if unchecked
+    'unchecked_value'         => 0,
+
+    // Required fields
+    ////////////////////////////////////////////////////////////////////
+
+    // The class to be added to required fields
+    'required_class'          => 'required',
+
+    // A facultative text to append to the labels of required fields
+    'required_text'           => '<sup>*</sup>',
+
+    // Translations
+    ////////////////////////////////////////////////////////////////////
+
+    // Where Former should look for translations
+    'translate_from'          => 'validation.attributes',
+
+    // Whether text that comes out of the translated
+    // should be capitalized (ex: email => Email) automatically
+    'capitalize_translations' => true,
+
+    // An array of attributes to automatically translate
+    'translatable'            => array(
+        'help',
+        'inlineHelp',
+        'blockHelp',
+        'placeholder',
+        'data_placeholder',
+        'label',
+    ),
+
+    // Framework
+    ////////////////////////////////////////////////////////////////////
+
+    // The framework to be used by Former
+    'framework'               => 'TwitterBootstrap3',
+
+    'TwitterBootstrap4'       => array(
+
+        // Map Former-supported viewports to Bootstrap 4 equivalents
+        'viewports'   => array(
+            'large'  => 'lg',
+            'medium' => 'md',
+            'small'  => 'sm',
+            'mini'   => 'xs',
+        ),
+        // Width of labels for horizontal forms expressed as viewport => grid columns
+        'labelWidths' => array(
+            'large' => 2,
+            'small' => 4,
+        ),
+        // HTML markup and classes used by Bootstrap 5 for icons
+        'icon'        => array(
+            'tag'    => 'i',
+            'set'    => 'fa',
+            'prefix' => 'fa',
+        ),
+
+    ),
+
+    'TwitterBootstrap3'       => array(
+
+        // Map Former-supported viewports to Bootstrap 3 equivalents
+        'viewports'   => array(
+            'large'  => 'lg',
+            'medium' => 'md',
+            'small'  => 'sm',
+            'mini'   => 'xs',
+        ),
+        // Width of labels for horizontal forms expressed as viewport => grid columns
+        'labelWidths' => array(
+            'large' => 2,
+            'small' => 4,
+        ),
+        // HTML markup and classes used by Bootstrap 3 for icons
+        'icon'        => array(
+            'tag'    => 'span',
+            'set'    => 'glyphicon',
+            'prefix' => 'glyphicon',
+        ),
+
+    ),
+
+    'Nude'                    => array(  // No-framework markup
+        'icon' => array(
+            'tag'    => 'i',
+            'set'    => null,
+            'prefix' => 'icon',
+        ),
+    ),
+
+    'TwitterBootstrap'        => array( // Twitter Bootstrap version 2
+        'icon' => array(
+            'tag'    => 'i',
+            'set'    => null,
+            'prefix' => 'icon',
+        ),
+    ),
+
+    'ZurbFoundation5'         => array(
+        // Map Former-supported viewports to Foundation 5 equivalents
+        'viewports'           => array(
+            'large'  => 'large',
+            'medium' => null,
+            'small'  => 'small',
+            'mini'   => null,
+        ),
+        // Width of labels for horizontal forms expressed as viewport => grid columns
+        'labelWidths'         => array(
+            'small' => 3,
+        ),
+        // Classes to be applied to wrapped labels in horizontal forms
+        'wrappedLabelClasses' => array('right', 'inline'),
+        // HTML markup and classes used by Foundation 5 for icons
+        'icon'                => array(
+            'tag'    => 'i',
+            'set'    => null,
+            'prefix' => 'fi',
+        ),
+        // CSS for inline validation errors
+        'error_classes'       => array('class' => 'error'),
+    ),
+
+    'ZurbFoundation4'         => array(
+        // Foundation 4 also has an experimental "medium" breakpoint
+        // explained at http://foundation.zurb.com/docs/components/grid.html
+        'viewports'           => array(
+            'large'  => 'large',
+            'medium' => null,
+            'small'  => 'small',
+            'mini'   => null,
+        ),
+        // Width of labels for horizontal forms expressed as viewport => grid columns
+        'labelWidths'         => array(
+            'small' => 3,
+        ),
+        // Classes to be applied to wrapped labels in horizontal forms
+        'wrappedLabelClasses' => array('right', 'inline'),
+        // HTML markup and classes used by Foundation 4 for icons
+        'icon'                => array(
+            'tag'    => 'i',
+            'set'    => 'general',
+            'prefix' => 'foundicon',
+        ),
+        // CSS for inline validation errors
+        'error_classes'       => array('class' => 'alert-box radius warning'),
+    ),
+
+    'ZurbFoundation'          => array( // Foundation 3
+        'viewports'           => array(
+            'large'  => '',
+            'medium' => null,
+            'small'  => 'mobile-',
+            'mini'   => null,
+        ),
+        // Width of labels for horizontal forms expressed as viewport => grid columns
+        'labelWidths'         => array(
+            'large' => 2,
+            'small' => 4,
+        ),
+        // Classes to be applied to wrapped labels in horizontal forms
+        'wrappedLabelClasses' => array('right', 'inline'),
+        // HTML markup and classes used by Foundation 3 for icons
+        'icon'                => array(
+            'tag'    => 'i',
+            'set'    => null,
+            'prefix' => 'fi',
+        ),
+        // CSS for inline validation errors
+        // should work for Zurb 2 and 3
+        'error_classes'       => array('class' => 'alert-box alert error'),
+    ),
 
 
 );