Added the attribute type dto

Author: paquettg

.gitattributes

@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PHPHtmlParser\DTO\Tag;
+
+use stringEncode\Encode;
+use stringEncode\Exception;
+
+class AttributeDTO
+{
+    /**
+     * @var ?string
+     */
+    protected $value;
+
+    /**
+     * @var bool
+     */
+    protected $doubleQuote = true;
+
+    public function __construct(array $values)
+    {
+        $this->value = $values['value'];
+        $this->doubleQuote = $values['doubleQuote'];
+    }
+
+    /**
+     * @return string
+     */
+    public function getValue(): ?string
+    {
+        return $this->value;
+    }
+
+    /**
+     * @return bool
+     */
+    public function isDoubleQuote(): bool
+    {
+        return $this->doubleQuote;
+    }
+
+    public function htmlspecialcharsDecode(): void
+    {
+        $this->value = htmlspecialchars_decode($this->value);
+    }
+
+    /**
+     * @param Encode $encode
+     * @throws Exception
+     */
+    public function encodeValue(Encode $encode)
+    {
+        $this->value = $encode->convert($this->value);
+    }
+}

.gitignore

@@ -746,38 +746,31 @@ protected function parseTag(): array
 
             $this->content->skipByToken('blank');
             if ($this->content->char() == '=') {
-                $attr = [];
                 $this->content->fastForward(1)
                               ->skipByToken('blank');
                 switch ($this->content->char()) {
                     case '"':
-                        $attr['doubleQuote'] = true;
                         $this->content->fastForward(1);
                         $string = $this->content->copyUntil('"', true);
                         do {
                             $moreString = $this->content->copyUntilUnless('"', '=>');
                             $string .= $moreString;
                         } while ( ! empty($moreString));
-                        $attr['value'] = $string;
                         $this->content->fastForward(1);
-                        $node->getTag()->$name = $attr;
+                        $node->getTag()->setAttribute($name, $string);
                         break;
                     case "'":
-                        $attr['doubleQuote'] = false;
                         $this->content->fastForward(1);
                         $string = $this->content->copyUntil("'", true);
                         do {
                             $moreString = $this->content->copyUntilUnless("'", '=>');
                             $string .= $moreString;
                         } while ( ! empty($moreString));
-                        $attr['value'] = $string;
                         $this->content->fastForward(1);
-                        $node->getTag()->$name = $attr;
+                        $node->getTag()->setAttribute($name, $string, false);
                         break;
                     default:
-                        $attr['doubleQuote']   = true;
-                        $attr['value']         = $this->content->copyByToken('attr', true);
-                        $node->getTag()->$name = $attr;
+                        $node->getTag()->setAttribute($name, $this->content->copyByToken('attr', true));
                         break;
                 }
             } else {
@@ -787,10 +780,7 @@ protected function parseTag(): array
                     $character = $this->content->getPosition();
                     throw new StrictException("Tag '$tag' has an attribute '$name' with out a value! (character #$character)");
                 }
-                $node->getTag()->$name = [
-                    'value'       => null,
-                    'doubleQuote' => true,
-                ];
+                $node->getTag()->setAttribute($name, null);
                 if ($this->content->char() != '>') {
                     $this->content->rewind(1);
                 }

.phan/config.php

@@ -4,6 +4,7 @@
 use PHPHtmlParser\Exceptions\CircularException;
 use PHPHtmlParser\Exceptions\ParentNotFoundException;
 use PHPHtmlParser\Exceptions\ChildNotFoundException;
+use PHPHtmlParser\Exceptions\Tag\AttributeNotFoundException;
 use PHPHtmlParser\Selector\Selector;
 use PHPHtmlParser\Selector\Parser as SelectorParser;
 use stringEncode\Encode;
@@ -337,8 +338,8 @@ public function getTag(): Tag
     public function getAttributes(): array
     {
         $attributes = $this->tag->getAttributes();
-        foreach ($attributes as $name => $info) {
-            $attributes[$name] = $info['value'];
+        foreach ($attributes as $name => $attributeDTO) {
+            $attributes[$name] = $attributeDTO->getValue();
         }
 
         return $attributes;
@@ -353,10 +354,14 @@ public function getAttributes(): array
      */
     public function getAttribute(string $key): ?string
     {
-        $attribute = $this->tag->getAttribute($key);
-        $attributeValue = $attribute['value'];
-
-        return $attributeValue;
+        try {
+            $attributeDTO = $this->tag->getAttribute($key);
+        } catch (AttributeNotFoundException $e) {
+            // no attribute with this key exists, returning null.
+            unset($e);
+            return null;
+        }
+        return $attributeDTO->getValue();
     }
 
     /**
@@ -376,13 +381,14 @@ public function hasAttribute(string $key): bool
      * on the tag of this node.
      *
      * @param string $key
-     * @param string|array $value
+     * @param string|null $value
+     * @param bool $doubleQuote
      * @return AbstractNode
      * @chainable
      */
-    public function setAttribute(string $key, $value): AbstractNode
+    public function setAttribute(string $key, ?string $value, bool $doubleQuote = true): AbstractNode
     {
-        $this->tag->setAttribute($key, $value);
+        $this->tag->setAttribute($key, $value, $doubleQuote);
 
         //clear any cache
         $this->clear();

.scrutinizer.yml

@@ -1,6 +1,8 @@
 <?php declare(strict_types=1);
 namespace PHPHtmlParser\Dom;
 
+use PHPHtmlParser\DTO\Tag\AttributeDTO;
+use PHPHtmlParser\Exceptions\Tag\AttributeNotFoundException;
 use stringEncode\Encode;
 
 /**
@@ -21,7 +23,7 @@ class Tag
     /**
      * The attributes of the tag.
      *
-     * @var array
+     * @var AttributeDTO[]
      */
     protected $attr = [];
 
@@ -47,7 +49,7 @@ class Tag
     /**
      * The encoding class to... encode the tags
      *
-     * @var mixed
+     * @var Encode|null
      */
     protected $encode = null;
 
@@ -66,28 +68,6 @@ public function __construct(string $name)
         $this->name = $name;
     }
 
-    /**
-     * Magic method to get any of the attributes.
-     *
-     * @param string $key
-     * @return mixed
-     */
-    public function __get($key)
-    {
-        return $this->getAttribute($key);
-    }
-
-    /**
-     * Magic method to set any attribute.
-     *
-     * @param string $key
-     * @param mixed $value
-     */
-    public function __set($key, $value)
-    {
-        $this->setAttribute($key, $value);
-    }
-
     /**
      * Returns the name of this tag.
      *
@@ -173,23 +153,21 @@ public function noise(string $noise): Tag
      * Set an attribute for this tag.
      *
      * @param string $key
-     * @param string|array $value
+     * @param string $attributeValue
+     * @param bool $doubleQuote
      * @return Tag
      * @chainable
      */
-    public function setAttribute(string $key, $value): Tag
+    public function setAttribute(string $key, ?string $attributeValue, bool $doubleQuote = true): Tag
     {
-        $key = strtolower($key);
-        if ( ! is_array($value)) {
-            $value = [
-                'value'       => $value,
-                'doubleQuote' => true,
-            ];
-        }
+        $attributeDTO = new AttributeDTO([
+            'value' => $attributeValue,
+            'doubleQuote' => $doubleQuote,
+        ]);
         if ($this->HtmlSpecialCharsDecode) {
-            $value['value'] = htmlspecialchars_decode($value['value']);
+            $attributeDTO->htmlspecialcharsDecode();
         }
-        $this->attr[$key] = $value;
+        $this->attr[strtolower($key)] = $attributeDTO;
 
         return $this;
     }
@@ -220,9 +198,10 @@ public function setStyleAttributeValue($attr_key, $attr_value): void
      */
     public function getStyleAttributeArray(): array
     {
-        $value = $this->getAttribute('style')['value'];
-
-        if ($value === null) {
+        try {
+            $value = $this->getAttribute('style')->getValue();
+        } catch (AttributeNotFoundException $e) {
+            unset($e);
             return [];
         }
 
@@ -268,8 +247,12 @@ public function removeAllAttributes()
      */
     public function setAttributes(array $attr)
     {
-        foreach ($attr as $key => $value) {
-            $this->setAttribute($key, $value);
+        foreach ($attr as $key => $info) {
+            if (is_array($info)) {
+                $this->setAttribute($key, $info['value'], $info['doubleQuote']);
+            } else {
+                $this->setAttribute($key, $info);
+            }
         }
 
         return $this;
@@ -278,13 +261,18 @@ public function setAttributes(array $attr)
     /**
      * Returns all attributes of this tag.
      *
-     * @return array
+     * @return AttributeDTO[]
      */
-    public function getAttributes()
+    public function getAttributes(): array
     {
         $return = [];
         foreach (array_keys($this->attr) as $attr) {
-            $return[$attr] = $this->getAttribute($attr);
+            try {
+                $return[$attr] = $this->getAttribute($attr);
+            } catch (AttributeNotFoundException $e) {
+                // attribute that was in the array was not found in the array....
+                unset($e);
+            }
         }
 
         return $return;
@@ -294,21 +282,23 @@ public function getAttributes()
      * Returns an attribute by the key
      *
      * @param string $key
-     * @return array
+     * @return AttributeDTO
+     * @throws AttributeNotFoundException
+     * @throws \stringEncode\Exception
      */
-    public function getAttribute(string $key):array
+    public function getAttribute(string $key):AttributeDTO
     {
         $key = strtolower($key);
         if ( ! isset($this->attr[$key])) {
-            return ['value' => null, 'doubleQuote' => true];
+            throw new AttributeNotFoundException('Attribute with key "'.$key.'" not found.');
         }
-        $value = $this->attr[$key]['value'];
-        if (is_string($value) && ! is_null($this->encode)) {
+        $attributeDTO = $this->attr[$key];
+        if (! is_null($this->encode)) {
             // convert charset
-            $this->attr[$key]['value'] = $this->encode->convert($value);
+            $attributeDTO->encodeValue($this->encode);
         }
 
-        return $this->attr[$key];
+        return $attributeDTO;
     }
 
     /**
@@ -333,11 +323,16 @@ public function makeOpeningTag()
 
         // add the attributes
         foreach (array_keys($this->attr) as $key) {
-            $info = $this->getAttribute($key);
-            $val  = $info['value'];
+            try {
+                $attributeDTO = $this->getAttribute($key);
+            } catch (AttributeNotFoundException $e) {
+                // attribute that was in the array not found in the array... let's continue.
+                continue;
+            }
+            $val  = $attributeDTO->getValue();
             if (is_null($val)) {
                 $return .= ' '.$key;
-            } elseif ($info['doubleQuote']) {
+            } elseif ($attributeDTO->isDoubleQuote()) {
                 $return .= ' '.$key.'="'.$val.'"';
             } else {
                 $return .= ' '.$key.'=\''.$val.'\'';

.travis.yml

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PHPHtmlParser\Exceptions\Tag;
+
+/**
+ * Class AttributeNotFoundException
+ * @package PHPHtmlParser\Exceptions\Tag
+ */
+class AttributeNotFoundException extends \Exception
+{
+}

CHANGELOG.md

@@ -480,7 +480,7 @@ public function testCaseInSensitivity()
         $dom->loadStr($str);
 
         $FooBar = $dom->find('FooBar');
-        $this->assertEquals('asdf', $FooBar->attribute);
+        $this->assertEquals('asdf', $FooBar->getAttribute('attribute'));
     }
 
     public function testCaseSensitivity()