Merge pull request #94 from chadicus/master

Add Json, Phone and Xml filter aliases
traderinteractive · Jul 10, 2020 · 2252d5e · 2252d5e
2 parents 3590bf1 + b03696b
commit 2252d5e
Show file tree

Hide file tree

Showing 5 changed files with 222 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -619,6 +619,121 @@ The following checks that `$value` is a timezone
 $timezone = \TraderInteractive\Filter\DateTimeZone::filter('America/New_York');
 ```
 
+#### Json::validate
+Aliased in the filter as `json`, checks that the JSON is valid and returns the original value.
+
+The following ensures that `$value` is valid JSON
+```php
+$value = \TraderInteractive\Filter\Json::validate('{"foo": "bar"}');
+```
+
+#### Json::parse
+Aliased in the filter as `json-decode`, checks that the JSON is valid and returns the decoded result.
+
+The following decodes the given value and returns the result.
+```php
+$value = \TraderInteractive\Filter\Json::parse('{"foo": "bar"}');
+assert($value === ['foo' => 'bar']);
+```
+
+#### PhoneFilter::filter
+Aliased in the filter as `phone`, this will filter a given value as a phone. Returning the phone in the specified format.
+
+The following filters the given string into a formatted phone string
+```php
+$value = \TraderInteractive\Filter\PhoneFilter::filter('234.567.8901', false, '({area}) {exchange}-{station}');
+assert($value === '(234) 567-8901');
+```
+
+#### XmlFilter::filter
+Aliased in the filter as `xml`, this will ensure the given string value is valid XML, returning the original value.
+
+The following ensures the given string is valid xml.
+```php
+$value = <<<XML
+<?xml version="1.0"?>
+<books>
+    <book id="bk101">
+        <author>Gambardella, Matthew</author>
+        <title>XML Developers Guide</title>
+        <genre>Computer</genre>
+        <price>44.95</price>
+        <publish_date>2000-10-01</publish_date>
+        <description>An in-depth look at creating applications with XML.</description>
+    </book>
+    <book id="bk102">
+        <author>Ralls, Kim</author>
+        <title>Midnight Rain</title>
+        <genre>Fantasy</genre>
+        <price>5.95</price>
+        <publish_date>2000-12-16</publish_date>
+        <description>A former architect battles corporate zombies</description>
+    </book>
+</books>
+XML;
+$xml = \TraderInteractive\Filter\XmlFilter::filter($value);
+```
+
+#### XmlFilter::extract
+Aliased in the filter as `xml-extract`, this will ensure the given string value is valid XML then extract and return the element found at the given xpath.
+
+The following ensures the given string is valid xml and returns the title element of the first book.
+```php
+$value = <<<XML
+<?xml version="1.0"?>
+<books>
+    <book id="bk101">
+        <author>Gambardella, Matthew</author>
+        <title>XML Developers Guide</title>
+        <genre>Computer</genre>
+        <price>44.95</price>
+        <publish_date>2000-10-01</publish_date>
+        <description>An in-depth look at creating applications with XML.</description>
+    </book>
+    <book id="bk102">
+        <author>Ralls, Kim</author>
+        <title>Midnight Rain</title>
+        <genre>Fantasy</genre>
+        <price>5.95</price>
+        <publish_date>2000-12-16</publish_date>
+        <description>A former architect battles corporate zombies</description>
+    </book>
+</books>
+XML;
+$xpath = "/books/book[@id='bk101']/title";
+$titleXml = \TraderInteractive\Filter\XmlFilter::extract($value, $xpath);
+assert($titleXml === '<title>XML Developers Guide</title>');
+```
+
+#### XmlFilter::validate
+Aliased in the filter as `xml-validate`, this will ensure the given string value is valid XML and also confirms to the given XSD file. The original value is returned.
+
+The following ensures the given string is valid xml and matches books.xsd.
+```php
+$value = <<<XML
+<?xml version="1.0"?>
+<books>
+    <book id="bk101">
+        <author>Gambardella, Matthew</author>
+        <title>XML Developers Guide</title>
+        <genre>Computer</genre>
+        <price>44.95</price>
+        <publish_date>2000-10-01</publish_date>
+        <description>An in-depth look at creating applications with XML.</description>
+    </book>
+    <book id="bk102">
+        <author>Ralls, Kim</author>
+        <title>Midnight Rain</title>
+        <genre>Fantasy</genre>
+        <price>5.95</price>
+        <publish_date>2000-12-16</publish_date>
+        <description>A former architect battles corporate zombies</description>
+    </book>
+</books>
+XML;
+$xml = \TraderInteractive\Filter\XmlFilter::validate($value, 'books.xsd');
+```
+
 ## Contact
 Developers may be contacted at:
 

diff --git a/composer.json b/composer.json
@@ -36,7 +36,7 @@
         "traderinteractive/filter-dates": "^3.0",
         "traderinteractive/filter-floats": "^3.0",
         "traderinteractive/filter-ints": "^3.0",
-        "traderinteractive/filter-strings": "^3.3.2"
+        "traderinteractive/filter-strings": "^3.5"
     },
     "require-dev": {
         "php-coveralls/php-coveralls": "^2.0",

diff --git a/src/Filterer.php b/src/Filterer.php
@@ -6,6 +6,9 @@
 use InvalidArgumentException;
 use Throwable;
 use TraderInteractive\Exceptions\FilterException;
+use TraderInteractive\Filter\Json;
+use TraderInteractive\Filter\PhoneFilter;
+use TraderInteractive\Filter\XmlFilter;
 
 /**
  * Class to filter an array of input.
@@ -30,16 +33,22 @@ final class Filterer implements FiltererInterface
         'float' => '\\TraderInteractive\\Filter\\Floats::filter',
         'in' => '\\TraderInteractive\\Filter\\Arrays::in',
         'int' => '\\TraderInteractive\\Filter\\Ints::filter',
+        'json' => Json::class . '::validate',
+        'json-decode' => Json::class . '::parse',
         'ofArray' => '\\TraderInteractive\\Filterer::ofArray',
         'ofArrays' => '\\TraderInteractive\\Filterer::ofArrays',
         'ofScalars' => '\\TraderInteractive\\Filterer::ofScalars',
+        'phone' => PhoneFilter::class . '::filter',
         'redact' => '\\TraderInteractive\\Filter\\Strings::redact',
         'string' => '\\TraderInteractive\\Filter\\Strings::filter',
         'strip-tags' => '\\TraderInteractive\\Filter\\Strings::stripTags',
         'timezone' => '\\TraderInteractive\\Filter\\DateTimeZone::filter',
         'translate' => '\\TraderInteractive\\Filter\\Strings::translate',
         'uint' => '\\TraderInteractive\\Filter\\UnsignedInt::filter',
         'url' => '\\TraderInteractive\\Filter\\Url::filter',
+        'xml' => XmlFilter::class . '::filter',
+        'xml-extract' => XmlFilter::class . '::extract',
+        'xml-validate' => XmlFilter::class . '::validate',
     ];
 
     /**

diff --git a/tests/FiltererTest.php b/tests/FiltererTest.php
@@ -18,6 +18,31 @@
  */
 final class FiltererTest extends TestCase
 {
+    /**
+     * @var string
+     */
+    const FULL_XML = (''
+        . "<?xml version=\"1.0\"?>\n"
+            . '<books>'
+                . '<book id="bk101">'
+                    . '<author>Gambardella, Matthew</author>'
+                    . "<title>XML Developer's Guide</title>"
+                    . '<genre>Computer</genre>'
+                    . '<price>44.95</price>'
+                    . '<publish_date>2000-10-01</publish_date>'
+                    . '<description>An in-depth look at creating applications with XML.</description>'
+            . '</book>'
+        . '<book id="bk102">'
+                    . '<author>Ralls, Kim</author>'
+                    . '<title>Midnight Rain</title>'
+                    . '<genre>Fantasy</genre>'
+                    . '<price>5.95</price>'
+                    . '<publish_date>2000-12-16</publish_date>'
+                    . '<description>A former architect battles corporate zombies</description>'
+            . '</book>'
+        . "</books>\n"
+    );
+
     public function setUp()
     {
         Filterer::setFilterAliases(Filterer::DEFAULT_FILTER_ALIASES);
@@ -384,6 +409,58 @@ function (int $input, int $fieldOneValue) : int {
                 'options' => [],
                 'result' => [true, ['field' => null], null, []],
             ],
+            'phone alias' => [
+                'spec' => ['field' => [['phone']]],
+                'input' => ['field' => '(234) 567 8901'],
+                'options' => [],
+                'result' => [true, ['field' => '2345678901'], null, []],
+            ],
+            'json alias' => [
+                'spec' => ['field' => [['json']]],
+                'input' => ['field' => '{"foo": "bar"}'],
+                'options' => [],
+                'result' => [true, ['field' => '{"foo": "bar"}'], null, []],
+            ],
+            'json-decode alias' => [
+                'spec' => ['field' => [['json-decode']]],
+                'input' => ['field' => '{"foo": "bar"}'],
+                'options' => [],
+                'result' => [true, ['field' => ['foo' => 'bar']], null, []],
+            ],
+            'xml alias' => [
+                'spec' => ['field' => [['xml']]],
+                'input' => ['field' => self::FULL_XML],
+                'options' => [],
+                'result' => [true, ['field' => self::FULL_XML], null, []],
+            ],
+            'xml-validate alias' => [
+                'spec' => ['field' => [['xml-validate', __DIR__ . '/_files/books.xsd']]],
+                'input' => ['field' => self::FULL_XML],
+                'options' => [],
+                'result' => [true, ['field' => self::FULL_XML], null, []],
+            ],
+            'xml-extract alias' => [
+                'spec' => ['field' => [['xml-extract', "/books/book[@id='bk101']"]]],
+                'input' => ['field' => self::FULL_XML],
+                'options' => [],
+                'result' => [
+                    true,
+                    [
+                        'field' => (''
+                            . '<book id="bk101">'
+                                . '<author>Gambardella, Matthew</author>'
+                                . "<title>XML Developer's Guide</title>"
+                                . '<genre>Computer</genre>'
+                                . '<price>44.95</price>'
+                                . '<publish_date>2000-10-01</publish_date>'
+                                . '<description>An in-depth look at creating applications with XML.</description>'
+                            . '</book>'
+                        ),
+                    ],
+                    null,
+                    []
+                ],
+            ],
         ];
     }
 

diff --git a/tests/_files/books.xsd b/tests/_files/books.xsd
@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="utf-8"?>
+<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+    <xsd:complexType name="BookType">
+        <xsd:sequence>
+            <xsd:element name="author" type="xsd:string" minOccurs="1"/>
+            <xsd:element name="title" type="xsd:string" minOccurs="1"/>
+            <xsd:element name="genre" type="xsd:string"/>
+            <xsd:element name="price" type="xsd:float" />
+            <xsd:element name="publish_date" type="xsd:date" />
+            <xsd:element name="description" type="xsd:string"/>
+        </xsd:sequence>
+        <xsd:attribute name="id" type="xsd:string" use="required"/>
+    </xsd:complexType>
+    <xsd:complexType name="BooksType">
+        <xsd:sequence>
+            <xsd:element name="book" type="BookType" minOccurs="0" maxOccurs="unbounded"/>
+        </xsd:sequence>
+    </xsd:complexType>
+    <xsd:element name="books" type="BooksType"/>
+</xsd:schema>