Add exclude functionality to addFilter() method

popphp · Jun 17, 2016 · de184bc · de184bc
1 parent 33c29d8
commit de184bc
Show file tree

Hide file tree

Showing 44 changed files with 185 additions and 135 deletions.
diff --git a/src/AbstractForm.php b/src/AbstractForm.php
@@ -23,7 +23,7 @@
  * @author     Nick Sagona, III <[email protected]>
  * @copyright  Copyright (c) 2009-2016 NOLA Interactive, LLC. (http://www.nolainteractive.com)
  * @license    http://www.popphp.org/license     New BSD License
- * @version    2.0.1
+ * @version    2.0.2
  */
 abstract class AbstractForm extends Child implements \ArrayAccess
 {
@@ -46,6 +46,18 @@ abstract class AbstractForm extends Child implements \ArrayAccess
      */
     protected $filters = [];
 
+    /**
+     * Fields to exclude filtering by type
+     * @var array
+     */
+    protected $filterExcludeByType = [];
+
+    /**
+     * Fields to exclude filtering by name
+     * @var array
+     */
+    protected $filterExcludeByName = [];
+
     /**
      * Form field groups
      * @var array
@@ -129,14 +141,41 @@ public function setMethod($method)
      *
      * @param  mixed $call
      * @param  mixed $params
+     * @param  mixed $excludeByType
+     * @param  mixed $excludeByName
      * @return AbstractForm
      */
-    public function addFilter($call, $params = null)
+    public function addFilter($call, $params = null, $excludeByType = null, $excludeByName = null)
     {
         $this->filters[] = [
             'call'   => $call,
             'params' => $params
         ];
+
+        if (null !== $excludeByType) {
+            if (!is_array($excludeByType)) {
+                $excludeByType = [$excludeByType];
+            }
+            foreach ($excludeByType as $type) {
+                if (!isset($this->filterExcludeByType[$type])) {
+                    $this->filterExcludeByType[$type] = [];
+                }
+                $this->filterExcludeByType[$type][] = $call;
+            }
+        }
+
+        if (null !== $excludeByName) {
+            if (!is_array($excludeByName)) {
+                $excludeByName = [$excludeByName];
+            }
+            foreach ($excludeByName as $name) {
+                if (!isset($this->filterExcludeByName[$name])) {
+                    $this->filterExcludeByName[$name] = [];
+                }
+                $this->filterExcludeByName[$name][] = $call;
+            }
+        }
+
         return $this;
     }
 
@@ -145,16 +184,18 @@ public function addFilter($call, $params = null)
      *
      * @param  array $filters
      * @throws Exception
+     * @param  mixed $excludeByType
+     * @param  mixed $excludeByName
      * @return AbstractForm
      */
-    public function addFilters(array $filters)
+    public function addFilters(array $filters, $excludeByType = null, $excludeByName = null)
     {
         foreach ($filters as $filter) {
             if (!isset($filter['call'])) {
                 throw new Exception('Error: The \'call\' key must be set.');
             }
             $params = (isset($filter['params'])) ? $filter['params'] : null;
-            $this->addFilter($filter['call'], $params);
+            $this->addFilter($filter['call'], $params, $excludeByType, $excludeByName);
         }
         return $this;
     }
@@ -220,6 +261,92 @@ public function getFields()
         return $this->fields;
     }
 
+    /**
+     * Alias method to getElements())
+     *
+     * @return array
+     */
+    public function elements()
+    {
+        return $this->getElements();
+    }
+
+    /**
+     * Get the elements of the form object.
+     *
+     * @return array
+     */
+    public function getElements()
+    {
+        $children = $this->getChildren();
+        $elements = [];
+
+        foreach ($children as $child) {
+            if ($child instanceof Element\AbstractElement){
+                $elements[] = $child;
+            }
+        }
+
+        return $elements;
+    }
+
+    /**
+     * Alias method to getElement()
+     *
+     * @param string $elementName
+     * @return Element\AbstractElement
+     */
+    public function element($elementName)
+    {
+        return $this->getElement($elementName);
+    }
+
+    /**
+     * Get an element object of the form by name.
+     *
+     * @param string $elementName
+     * @return Element\AbstractElement
+     */
+    public function getElement($elementName)
+    {
+        $i = $this->getElementIndex($elementName);
+        return (null !== $i) ? $this->getChild($this->getElementIndex($elementName)) : null;
+    }
+
+    /**
+     * Get the index of an element object of the form by name.
+     *
+     * @param string $elementName
+     * @return int
+     */
+    public function getElementIndex($elementName)
+    {
+        $name  = null;
+        $elem  = null;
+        $index = null;
+        $elems = $this->getChildren();
+
+        foreach ($elems as $i => $e) {
+            if ($e->getNodeName() == 'fieldset') {
+                $children = $e->getChildren();
+                foreach ($children as $c) {
+                    if ($c->getNodeName() == 'input') {
+                        $attribs = $c->getAttributes();
+                        $name = str_replace('[]', '', $attribs['name']);
+                    }
+                }
+            } else {
+                $attribs = $e->getAttributes();
+                $name = $attribs['name'];
+            }
+            if ($name == $elementName) {
+                $index = $i;
+            }
+        }
+
+        return $index;
+    }
+
     /**
      * Get fieldConfig
      *
@@ -316,8 +443,17 @@ protected function filterValues(array $values = null)
     protected function applyFilter(&$array, $call, $params = [])
     {
         array_walk_recursive($array, function(&$value, $key, $userdata) {
-            $params = array_merge([$value], $userdata[1]);
-            $value  = call_user_func_array($userdata[0], $params);
+            $element = $this->getElement($key);
+            $type    = ((null !== $element) && ($element instanceof \Pop\Form\Element\AbstractElement)) ?
+                $element->getType() : -1;
+
+            if (((!isset($this->filterExcludeByType[$type])) ||
+                    (isset($this->filterExcludeByType[$type]) && !in_array($userdata[0], $this->filterExcludeByType[$type]))) &&
+                ((!isset($this->filterExcludeByName[$key])) ||
+                    (isset($this->filterExcludeByName[$key]) && !in_array($userdata[0], $this->filterExcludeByName[$key])))) {
+                $params = array_merge([$value], $userdata[1]);
+                $value = call_user_func_array($userdata[0], $params);
+            }
         }, [$call, $params]);
     }
 

diff --git a/src/Element/AbstractElement.php b/src/Element/AbstractElement.php
@@ -24,7 +24,7 @@
  * @author     Nick Sagona, III <[email protected]>
  * @copyright  Copyright (c) 2009-2016 NOLA Interactive, LLC. (http://www.nolainteractive.com)
  * @license    http://www.popphp.org/license     New BSD License
- * @version    2.0.1
+ * @version    2.0.2
  */
 abstract class AbstractElement extends Child implements ElementInterface
 {

diff --git a/src/Element/Button.php b/src/Element/Button.php
@@ -21,7 +21,7 @@
  * @author     Nick Sagona, III <[email protected]>
  * @copyright  Copyright (c) 2009-2016 NOLA Interactive, LLC. (http://www.nolainteractive.com)
  * @license    http://www.popphp.org/license     New BSD License
- * @version    2.0.1
+ * @version    2.0.2
  */
 
 class Button extends AbstractElement

diff --git a/src/Element/CheckboxSet.php b/src/Element/CheckboxSet.php
@@ -23,7 +23,7 @@
  * @author     Nick Sagona, III <[email protected]>
  * @copyright  Copyright (c) 2009-2016 NOLA Interactive, LLC. (http://www.nolainteractive.com)
  * @license    http://www.popphp.org/license     New BSD License
- * @version    2.0.1
+ * @version    2.0.2
  */
 
 class CheckboxSet extends AbstractElement

diff --git a/src/Element/ElementInterface.php b/src/Element/ElementInterface.php
@@ -21,7 +21,7 @@
  * @author     Nick Sagona, III <[email protected]>
  * @copyright  Copyright (c) 2009-2016 NOLA Interactive, LLC. (http://www.nolainteractive.com)
  * @license    http://www.popphp.org/license     New BSD License
- * @version    2.0.1
+ * @version    2.0.2
  */
 interface ElementInterface
 {

diff --git a/src/Element/Exception.php b/src/Element/Exception.php
@@ -21,6 +21,6 @@
  * @author     Nick Sagona, III <[email protected]>
  * @copyright  Copyright (c) 2009-2016 NOLA Interactive, LLC. (http://www.nolainteractive.com)
  * @license    http://www.popphp.org/license     New BSD License
- * @version    2.0.1
+ * @version    2.0.2
  */
 class Exception extends \Exception {}
diff --git a/src/Element/Input.php b/src/Element/Input.php
@@ -21,7 +21,7 @@
  * @author     Nick Sagona, III <[email protected]>
  * @copyright  Copyright (c) 2009-2016 NOLA Interactive, LLC. (http://www.nolainteractive.com)
  * @license    http://www.popphp.org/license     New BSD License
- * @version    2.0.1
+ * @version    2.0.2
  */
 
 class Input extends AbstractElement

diff --git a/src/Element/Input/Button.php b/src/Element/Input/Button.php
@@ -23,7 +23,7 @@
  * @author     Nick Sagona, III <[email protected]>
  * @copyright  Copyright (c) 2009-2016 NOLA Interactive, LLC. (http://www.nolainteractive.com)
  * @license    http://www.popphp.org/license     New BSD License
- * @version    2.0.1
+ * @version    2.0.2
  */
 
 class Button extends Element\Input

diff --git a/src/Element/Input/Captcha.php b/src/Element/Input/Captcha.php
@@ -21,7 +21,7 @@
  * @author     Nick Sagona, III <[email protected]>
  * @copyright  Copyright (c) 2009-2016 NOLA Interactive, LLC. (http://www.nolainteractive.com)
  * @license    http://www.popphp.org/license     New BSD License
- * @version    2.0.1
+ * @version    2.0.2
  */
 
 class Captcha extends Text

diff --git a/src/Element/Input/Checkbox.php b/src/Element/Input/Checkbox.php
@@ -23,7 +23,7 @@
  * @author     Nick Sagona, III <[email protected]>
  * @copyright  Copyright (c) 2009-2016 NOLA Interactive, LLC. (http://www.nolainteractive.com)
  * @license    http://www.popphp.org/license     New BSD License
- * @version    2.0.1
+ * @version    2.0.2
  */
 
 class Checkbox extends Element\Input

diff --git a/src/Element/Input/Color.php b/src/Element/Input/Color.php
@@ -23,7 +23,7 @@
  * @author     Nick Sagona, III <[email protected]>
  * @copyright  Copyright (c) 2009-2016 NOLA Interactive, LLC. (http://www.nolainteractive.com)
  * @license    http://www.popphp.org/license     New BSD License
- * @version    2.0.1
+ * @version    2.0.2
  */
 
 class Color extends Element\Input

diff --git a/src/Element/Input/Csrf.php b/src/Element/Input/Csrf.php
@@ -21,7 +21,7 @@
  * @author     Nick Sagona, III <[email protected]>
  * @copyright  Copyright (c) 2009-2016 NOLA Interactive, LLC. (http://www.nolainteractive.com)
  * @license    http://www.popphp.org/license     New BSD License
- * @version    2.0.1
+ * @version    2.0.2
  */
 
 class Csrf extends Hidden

diff --git a/src/Element/Input/Datalist.php b/src/Element/Input/Datalist.php
@@ -23,7 +23,7 @@
  * @author     Nick Sagona, III <[email protected]>
  * @copyright  Copyright (c) 2009-2016 NOLA Interactive, LLC. (http://www.nolainteractive.com)
  * @license    http://www.popphp.org/license     New BSD License
- * @version    2.0.1
+ * @version    2.0.2
  */
 
 class Datalist extends Text

diff --git a/src/Element/Input/Date.php b/src/Element/Input/Date.php
@@ -23,7 +23,7 @@
  * @author     Nick Sagona, III <[email protected]>
  * @copyright  Copyright (c) 2009-2016 NOLA Interactive, LLC. (http://www.nolainteractive.com)
  * @license    http://www.popphp.org/license     New BSD License
- * @version    2.0.1
+ * @version    2.0.2
  */
 
 class Date extends Element\Input

diff --git a/src/Element/Input/DateTime.php b/src/Element/Input/DateTime.php
@@ -23,7 +23,7 @@
  * @author     Nick Sagona, III <[email protected]>
  * @copyright  Copyright (c) 2009-2016 NOLA Interactive, LLC. (http://www.nolainteractive.com)
  * @license    http://www.popphp.org/license     New BSD License
- * @version    2.0.1
+ * @version    2.0.2
  */
 
 class DateTime extends Element\Input

diff --git a/src/Element/Input/DateTimeLocal.php b/src/Element/Input/DateTimeLocal.php
@@ -23,7 +23,7 @@
  * @author     Nick Sagona, III <[email protected]>
  * @copyright  Copyright (c) 2009-2016 NOLA Interactive, LLC. (http://www.nolainteractive.com)
  * @license    http://www.popphp.org/license     New BSD License
- * @version    2.0.1
+ * @version    2.0.2
  */
 
 class DateTimeLocal extends Element\Input

diff --git a/src/Element/Input/Email.php b/src/Element/Input/Email.php
@@ -23,7 +23,7 @@
  * @author     Nick Sagona, III <[email protected]>
  * @copyright  Copyright (c) 2009-2016 NOLA Interactive, LLC. (http://www.nolainteractive.com)
  * @license    http://www.popphp.org/license     New BSD License
- * @version    2.0.1
+ * @version    2.0.2
  */
 
 class Email extends Element\Input

diff --git a/src/Element/Input/Exception.php b/src/Element/Input/Exception.php
@@ -21,6 +21,6 @@
  * @author     Nick Sagona, III <[email protected]>
  * @copyright  Copyright (c) 2009-2016 NOLA Interactive, LLC. (http://www.nolainteractive.com)
  * @license    http://www.popphp.org/license     New BSD License
- * @version    2.0.1
+ * @version    2.0.2
  */
 class Exception extends \Exception {}
diff --git a/src/Element/Input/File.php b/src/Element/Input/File.php
@@ -23,7 +23,7 @@
  * @author     Nick Sagona, III <[email protected]>
  * @copyright  Copyright (c) 2009-2016 NOLA Interactive, LLC. (http://www.nolainteractive.com)
  * @license    http://www.popphp.org/license     New BSD License
- * @version    2.0.1
+ * @version    2.0.2
  */
 
 class File extends Element\Input

diff --git a/src/Element/Input/Hidden.php b/src/Element/Input/Hidden.php
@@ -23,7 +23,7 @@
  * @author     Nick Sagona, III <[email protected]>
  * @copyright  Copyright (c) 2009-2016 NOLA Interactive, LLC. (http://www.nolainteractive.com)
  * @license    http://www.popphp.org/license     New BSD License
- * @version    2.0.1
+ * @version    2.0.2
  */
 
 class Hidden extends Element\Input

diff --git a/src/Element/Input/Month.php b/src/Element/Input/Month.php
@@ -23,7 +23,7 @@
  * @author     Nick Sagona, III <[email protected]>
  * @copyright  Copyright (c) 2009-2016 NOLA Interactive, LLC. (http://www.nolainteractive.com)
  * @license    http://www.popphp.org/license     New BSD License
- * @version    2.0.1
+ * @version    2.0.2
  */
 
 class Month extends Element\Input

diff --git a/src/Element/Input/Number.php b/src/Element/Input/Number.php
@@ -23,7 +23,7 @@
  * @author     Nick Sagona, III <[email protected]>
  * @copyright  Copyright (c) 2009-2016 NOLA Interactive, LLC. (http://www.nolainteractive.com)
  * @license    http://www.popphp.org/license     New BSD License
- * @version    2.0.1
+ * @version    2.0.2
  */
 
 class Number extends Element\Input