cleaned up generics in html interfaces to reflect attribute value typ…

…e as well as valtester data type. Removed MakeVoidTag method from TagFactoryInterface
dwilbourne · Aug 26, 2024 · d08075e · d08075e
1 parent 2214392
commit d08075e
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 21 deletions.
diff --git a/src/frmtr/html/FrmtrHtmlInterface.php b/src/frmtr/html/FrmtrHtmlInterface.php
@@ -10,20 +10,20 @@
 
 use pvc\interfaces\frmtr\FrmtrInterface;
 use pvc\interfaces\frmtr\msg\FrmtrMsgInterface;
-use pvc\interfaces\html\tag\TagInterface;
 use pvc\interfaces\html\tag\TagVoidInterface;
 use pvc\interfaces\intl\LocaleInterface;
 
 /**
  * Class FrmtrHtmlInterface
  * @template AttributeValueType
- * @extends FrmtrInterface<TagInterface|TagVoidInterface<AttributeValueType>>
+ * @template ValTesterType
+ * @extends FrmtrInterface<TagVoidInterface<AttributeValueType, ValTesterType>>
  */
 interface FrmtrHtmlInterface extends FrmtrInterface
 {
     /**
      * format
-     * @param TagInterface<AttributeValueType>|TagVoidInterface<AttributeValueType> $value
+     * @param TagVoidInterface<AttributeValueType, ValTesterType> $value
      * @return string
      */
     public function format($value): string;

diff --git a/src/html/attribute/AttributeFactoryInterface.php b/src/html/attribute/AttributeFactoryInterface.php
@@ -13,21 +13,22 @@
 /**
  * Class AttributeFactoryInterface
  * @template ValueType
+ * @template ValTesterType
  */
 interface AttributeFactoryInterface
 {
     /**
      * makeAttribute
      * @param string $attributeName
-     * @return AttributeInterface<ValueType>
+     * @return AttributeInterface<ValueType, ValTesterType>
      */
     public function makeAttribute(string $attributeName): AttributeInterface;
 
     /**
      * makeCustomData
      * @param string $name
      * @param ValTesterInterface<string>|null $valueTester
-     * @return AttributeInterface<string>
+     * @return AttributeInterface<string, string>
      */
     public function makeCustomData(
         string $name,

diff --git a/src/html/config/HtmlConfigInterface.php b/src/html/config/HtmlConfigInterface.php
@@ -36,10 +36,11 @@ public function innerTextNotAllowed(string $tagName): bool;
 
     /**
      * isValidSubtag
-     * @param string $name
+     * @param string $subTagName
+     * @param string $parentTagName
      * @return bool
      */
-    public function isValidSubTag(string $subTagName, $parentTagName): bool;
+    public function isValidSubTag(string $subTagName, string $parentTagName): bool;
 
     /**
      * isInlineTag

diff --git a/src/html/tag/TagFactoryInterface.php b/src/html/tag/TagFactoryInterface.php
@@ -11,20 +11,14 @@
 /**
  * Class TagFactoryInterface
  * @template ValueType
+ * @template ValTesterType
  */
 interface TagFactoryInterface
 {
     /**
      * makeTag
      * @param string $tagName
-     * @return TagInterface<ValueType>
+     * @return TagInterface<ValueType, ValTesterType>
      */
     public function makeTag(string $tagName): TagInterface;
-
-    /**
-     * makeTagVoid
-     * @param string $tagName
-     * @return TagVoidInterface<ValueType>
-     */
-    public function makeTagVoid(string $tagName): TagVoidInterface;
 }
diff --git a/src/html/tag/TagInterface.php b/src/html/tag/TagInterface.php
@@ -13,20 +13,21 @@
 /**
  * Class TagInterface
  * @template ValueType
- * @extends TagVoidInterface<ValueType>
+ * @template ValTesterType
+ * @extends TagVoidInterface<ValueType, ValTesterType>
  */
 interface TagInterface extends TagVoidInterface
 {
     /**
      * addInnerHtml
-     * @param TagVoidInterface<ValueType>|MsgInterface|string $innerHtml
+     * @param TagVoidInterface<ValueType, ValTesterType>|MsgInterface|string $innerHtml
      */
     public function addInnerHtml(TagVoidInterface|TagInterface|MsgInterface|string $innerHtml): void;
 
 
     /**
      * getInnerHtml
-     * @return array<TagVoidInterface<ValueType>|TagInterface<ValueType>|MsgInterface|string>
+     * @return array<TagVoidInterface<ValueType, ValTesterType>|MsgInterface|string>
      */
     public function getInnerHtml(): array;
 

diff --git a/src/html/tag/TagVoidInterface.php b/src/html/tag/TagVoidInterface.php
@@ -14,6 +14,7 @@
 /**
  * Class TagVoidInterface
  * @template ValueType
+ * @template ValTesterType
  */
 interface TagVoidInterface
 {
@@ -32,7 +33,7 @@ public function setName(string $name);
 
     /**
      * setAttribute
-     * @param AttributeInterface $attribute
+     * @param AttributeInterface<ValueType, ValTesterType> $attribute
      */
     public function setAttribute(AttributeInterface $attribute): void;
 
@@ -48,13 +49,13 @@ public function setCustomData(string $name, string $value, ValTesterInterface $t
     /**
      * getAttribute
      * @param string $name
-     * @return AttributeInterface<ValueType>|null
+     * @return AttributeInterface<ValueType, ValTesterType>|null
      */
     public function getAttribute(string $name): ?AttributeInterface;
 
     /**
      * getAttributes
-     * @return array<AttributeInterface<ValueType>>
+     * @return array<AttributeInterface<ValueType, ValTesterType>>
      */
     public function getAttributes(int $attributeTypes): array;