Move witgets classes to layout directory. (#321)

php-forge · Feb 20, 2024 · 72d1d5e · 72d1d5e
1 parent 8cc7a94
commit 72d1d5e
Show file tree

Hide file tree

Showing 45 changed files with 178 additions and 145 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -11,29 +11,40 @@ The repository can generate basic `HTML` tags, allowing you to create `HTML` ele
 The following tags are currently supported:
 
 - [a](/docs/tag/A.md)
-- [body](/docs/tag/Body.md)
 - [button](/docs/tag/Button.md)
 - [button toggle](/docs/tag/ButtonToggle.md)
 - [div](/docs/tag/Div.md)
-- [footer](/docs/tag/Footer.md)
-- [form](/docs/tag/Form.md)
 - [h](/docs/tag/H.md)
-- [head](/docs/tag/Head.md)
-- [header](/docs/tag/Header.md)
-- [html](/docs/tag/Html.md)
 - [i](/docs/tag/I.md)
 - [img](/docs/tag/Img.md)
 - [li](/docs/tag/Li.md)
-- [meta](/docs/tag/Meta.md)
-- [nav](/docs/tag/Nav.md)
 - [ol](/docs/tag/Ol.md)
 - [p](/docs/tag/P.md)
-- [section](/docs/tag/Section.md)
 - [span](/docs/tag/Span.md)
 - [svg](/docs/tag/Svg.md)
-- [title](/docs/tag/Title.md)
 - [ul](/docs/tag/Ul.md)
 
+## Layout
+
+In web design, the `Layout` section typically refers to a collection of files or components that define the overall
+structure and arrangement of a web page. This includes elements such as headers, footers, navigation bars, sidebars, and
+other structural components that help organize and present content on the page. The 'Layout' section is essential for
+creating consistent and visually appealing designs across the entire website, as it establishes the framework
+within which individual pages are constructed.
+
+The repository provides a set of classes for creating layouts, including:
+
+- [body](/docs/layout/Body.md)
+- [footer](/docs/layout/Footer.md)
+- [head](/docs/layout/Head.md)
+- [header](/docs/layout/Header.md)
+- [html](/docs/layout/Html.md)
+- [main](/docs/layout/Main.md)
+- [meta](/docs/layout/Meta.md)
+- [nav](/docs/layout/Nav.md)
+- [section](/docs/layout/Section.md)
+- [title](/docs/layout/Title.md)
+
 ## Forms 
 
 The repository also provides a set of classes for creating forms, including:

diff --git a/docs/tag/Body.md → docs/layout/Body.md b/docs/tag/Body.md → docs/layout/Body.md
diff --git a/docs/tag/Footer.md → docs/layout/Footer.md b/docs/tag/Footer.md → docs/layout/Footer.md
diff --git a/docs/tag/Head.md → docs/layout/Head.md b/docs/tag/Head.md → docs/layout/Head.md
diff --git a/docs/tag/Header.md → docs/layout/Header.md b/docs/tag/Header.md → docs/layout/Header.md
diff --git a/docs/tag/Html.md → docs/layout/Html.md b/docs/tag/Html.md → docs/layout/Html.md
diff --git a/docs/tag/Meta.md → docs/layout/Meta.md b/docs/tag/Meta.md → docs/layout/Meta.md
diff --git a/docs/tag/Nav.md → docs/layout/Nav.md b/docs/tag/Nav.md → docs/layout/Nav.md
diff --git a/docs/tag/Section.md → docs/layout/Section.md b/docs/tag/Section.md → docs/layout/Section.md
diff --git a/docs/tag/Title.md → docs/layout/Title.md b/docs/tag/Title.md → docs/layout/Title.md
diff --git a/src/Attribute/Custom/HasContentAttribute.php b/src/Attribute/Custom/HasContentAttribute.php
@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PHPForge\Html\Attribute\Custom;
+
+use PHPForge\Html\Helper\Encode;
+
+/**
+ * Is used by widgets that implement the content attribute.
+ */
+trait HasContentAttribute
+{
+    /**
+     * Sets the content attributes.
+     *
+     * @param string $value The content value.
+     *
+     * @return static A new instance of the current class with the specified content value.
+     */
+    public function content(string $value): static
+    {
+        $new = clone $this;
+        $new->attributes['content'] = Encode::content($value);
+
+        return $new;
+    }
+}
diff --git a/src/Attribute/Tag/HasHttpEquiv.php b/src/Attribute/Tag/HasHttpEquiv.php
@@ -15,17 +15,15 @@ trait HasHttpEquiv
      * Set the name of the HTTP header to define.
      *
      * @param string $value The name of the HTTP header to define.
-     * @param string $content The value of the HTTP header to define.
      *
      * @return static A new instance of the current class with the specified http-equiv value.
      *
      * @link https://html.spec.whatwg.org/multipage/semantics.html#attr-meta-http-equiv
      */
-    public function httpEquiv(string $value, string $content): static
+    public function httpEquiv(string $value): static
     {
         $new = clone $this;
         $new->attributes['http-equiv'] = Encode::value($value);
-        $new->attributes['content'] = Encode::content($content);
 
         return $new;
     }

diff --git a/src/Base/AbstractMeta.php b/src/Base/AbstractMeta.php
diff --git a/src/Helper/Attributes.php b/src/Helper/Attributes.php
@@ -41,6 +41,7 @@ final class Attributes
         'id',
         'name',
         'type',
+        'http-equiv',
         'value',
         'href',
         'src',

diff --git a/src/Body.php → src/Layout/Body.php b/src/Body.php → src/Layout/Body.php
@@ -2,15 +2,17 @@
 
 declare(strict_types=1);
 
-namespace PHPForge\Html;
+namespace PHPForge\Html\Layout;
+
+use PHPForge\Html\Base\AbstractBlockElement;
 
 /**
  * The `<body>` `HTML` element represents the content of an HTML document.
  * There can be only one `<body>` element in a document.
  *
  * @link https://html.spec.whatwg.org/multipage/sections.html#the-body-element
  */
-final class Body extends Base\AbstractBlockElement
+final class Body extends AbstractBlockElement
 {
     protected string $tagName = 'body';
 }
diff --git a/src/Footer.php → src/Layout/Footer.php b/src/Footer.php → src/Layout/Footer.php
@@ -2,15 +2,17 @@
 
 declare(strict_types=1);
 
-namespace PHPForge\Html;
+namespace PHPForge\Html\Layout;
+
+use PHPForge\Html\Base\AbstractBlockElement;
 
 /**
  * Represents a footer for its nearest ancestor sectioning content or sectioning root element.
  * A footer typically contains information about the author of the section, copyright data or links to related documents.
  *
  * @link https://html.spec.whatwg.org/multipage/sections.html#the-footer-element
  */
-final class Footer extends Base\AbstractBlockElement
+final class Footer extends AbstractBlockElement
 {
     protected string $tagName = 'footer';
 }
diff --git a/src/Head.php → src/Layout/Head.php b/src/Head.php → src/Layout/Head.php
@@ -2,15 +2,17 @@
 
 declare(strict_types=1);
 
-namespace PHPForge\Html;
+namespace PHPForge\Html\Layout;
+
+use PHPForge\Html\Base\AbstractBlockElement;
 
 /**
  * The `<head>` HTML element contains machine-readable information (metadata) about the document, like its title,
  * scripts, and style sheets.
  *
  * @link https://html.spec.whatwg.org/multipage/semantics.html#the-head-element
  */
-final class Head extends Base\AbstractBlockElement
+final class Head extends AbstractBlockElement
 {
     protected string $tagName = 'head';
 }
diff --git a/src/Header.php → src/Layout/Header.php b/src/Header.php → src/Layout/Header.php
@@ -2,15 +2,17 @@
 
 declare(strict_types=1);
 
-namespace PHPForge\Html;
+namespace PHPForge\Html\Layout;
+
+use PHPForge\Html\Base\AbstractBlockElement;
 
 /**
  * The `<header>` HTML element represents introductory content, typically a group of introductory or navigational aids.
  * It may contain some heading elements but also a logo, a search form, an author name, and other elements.
  *
  * @link https://html.spec.whatwg.org/multipage/sections.html#the-header-element
  */
-final class Header extends Base\AbstractBlockElement
+final class Header extends AbstractBlockElement
 {
     protected string $tagName = 'header';
 }
diff --git a/src/Html.php → src/Layout/Html.php b/src/Html.php → src/Layout/Html.php
@@ -2,15 +2,17 @@
 
 declare(strict_types=1);
 
-namespace PHPForge\Html;
+namespace PHPForge\Html\Layout;
+
+use PHPForge\Html\Base\AbstractBlockElement;
 
 /**
  * The `<html>` HTML element represents the root (top-level element) of an HTML document, so it is also referred to as
  * the root element. All other elements must be descendants of this element.
  *
  * @link https://html.spec.whatwg.org/multipage/semantics.html#the-html-element
  */
-final class Html extends Base\AbstractBlockElement
+final class Html extends AbstractBlockElement
 {
     protected string $tagName = 'html';
 }
diff --git a/src/Layout/Meta.php b/src/Layout/Meta.php
@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PHPForge\Html\Layout;
+
+use PHPForge\Html\Attribute\Custom\HasAttributes;
+use PHPForge\Html\Attribute\Custom\HasContentAttribute;
+use PHPForge\Html\Attribute\Input\HasName;
+use PHPForge\Html\Attribute\Tag\{HasCharset, HasHttpEquiv};
+use PHPForge\Html\Attribute\{HasClass, HasId, HasLang, HasStyle};
+use PHPForge\Html\Tag;
+use PHPForge\Widget\Element;
+
+/**
+ * The `<meta>` HTML element represents metadata that cannot be represented by other HTML meta-related elements,
+ * like `<base>`, `<link>`, `<script>`, `<style>`, or `<title>`.
+ *
+ * @link https://html.spec.whatwg.org/multipage/semantics.html#the-meta-element
+ */
+final class Meta extends Element
+{
+    use HasAttributes;
+    use HasCharset;
+    use HasClass;
+    use HasContentAttribute;
+    use HasHttpEquiv;
+    use HasId;
+    use HasLang;
+    use HasName;
+    use HasStyle;
+
+    private array $attributes = [];
+
+    /**
+     * Generate the HTML representation of the element.
+     *
+     * @return string The HTML representation of the element.
+     */
+    protected function run(): string
+    {
+        return Tag::widget()->attributes($this->attributes)->id($this->id)->tagName('meta')->render();
+    }
+}
diff --git a/src/Nav.php → src/Layout/Nav.php b/src/Nav.php → src/Layout/Nav.php
@@ -2,7 +2,9 @@
 
 declare(strict_types=1);
 
-namespace PHPForge\Html;
+namespace PHPForge\Html\Layout;
+
+use PHPForge\Html\Base\AbstractBlockElement;
 
 /**
  * The `<nav>` HTML element represents a section of a page whose purpose is to provide navigation links, either within
@@ -11,7 +13,7 @@
  *
  * @link https://html.spec.whatwg.org/multipage/sections.html#the-nav-element
  */
-final class Nav extends Base\AbstractBlockElement
+final class Nav extends AbstractBlockElement
 {
     protected string $tagName = 'nav';
 }
diff --git a/src/Section.php → src/Layout/Section.php b/src/Section.php → src/Layout/Section.php
@@ -2,15 +2,17 @@
 
 declare(strict_types=1);
 
-namespace PHPForge\Html;
+namespace PHPForge\Html\Layout;
+
+use PHPForge\Html\Base\AbstractBlockElement;
 
 /**
  * The `<section>` HTML element represents a generic standalone section of a document, which doesn't have a more
  * specific semantic element to represent it. Sections should always have a heading, with very few exceptions.
  *
  * @link https://html.spec.whatwg.org/multipage/sections.html#the-section-element
  */
-final class Section extends Base\AbstractBlockElement
+final class Section extends AbstractBlockElement
 {
     protected string $tagName = 'section';
 }
diff --git a/src/Title.php → src/Layout/Title.php b/src/Title.php → src/Layout/Title.php
@@ -2,15 +2,17 @@
 
 declare(strict_types=1);
 
-namespace PHPForge\Html;
+namespace PHPForge\Html\Layout;
+
+use PHPForge\Html\Base\AbstractBlockElement;
 
 /**
  * The `<title>` HTML element defines the document's title shown in a browser's title bar or a page's tab.
  * It only contains text; tags within the element are ignored.
  *
  * @link https://html.spec.whatwg.org/multipage/semantics.html#the-title-element
  */
-final class Title extends Base\AbstractBlockElement
+final class Title extends AbstractBlockElement
 {
     protected string $tagName = 'title';
 }
diff --git a/src/Meta.php b/src/Meta.php