Initial commit

.gitignore

@@ -0,0 +1,2 @@
+/vendor/
+.idea/

README.md

@@ -1,2 +1,78 @@
-# html-element
-Easily create HTML elements from PHP
+# HtmlElement
+
+This package allows you to easily create HTML elements from PHP. It's inspired by [David Walsh's blogpost](https://davidwalsh.name/create-html-elements-php-htmlelement-class) but further improved.
+
+```$php
+// Create new html element with attribute name
+$selectElement = new HtmlElement('select');
+$selectElement->setAttribute('name', 'something');
+$selectElement->generate();
+
+// Create new html element with text and attribute
+$paragraphElement = new HtmlElement('p', 'text', ['class' => 'center']);
+```
+
+## Installation
+
+This package can be used in any PHP project or with any framework. The packages is tested in PHP 5.6 and PHP 7.0.
+
+You can install the package via composer:
+
+``` bash
+composer require vdhicts/html-element
+```
+
+## Usage
+
+A new html element can be created with:
+
+```php
+$containerElement = new HtmlElement('div');
+$containerElement->setAttribute('class', 'container');
+```
+
+The element could contain text:
+
+```php
+$containerElement->setText('Hello World');
+```
+
+The element could have one or more attributes:
+
+```php
+// One attribute
+$containerElement->setAttribute('class', 'container');
+
+// Multiple attributes
+$containerElement->setAttributes(['class' => 'container', 'role' => 'container']);
+```
+
+Or the element could contain another html element:
+
+```php
+$colElement = new HtmlElement('div', '', ['class' => 'col-md-6']);
+$rowElement = new HtmlElement('div', '', ['class' => 'row']);
+
+$rowElement->inject($colElement);
+$containerElement->inject($rowElement);
+```
+
+The text and attributes can also be added, which merges with existing text or attributes.
+
+## Tests
+
+Full code coverage unit tests are available in the `tests` folder. Run via phpunit:
+
+`vendor\bin\phpunit tests`
+
+Or if you are interested in the (html) coverage report:
+
+`vendor\bin\phpunit tests --coverage-html report --whitelist src`
+
+## Contribution
+
+Any contribution is welcome, but it should be fully tested, meet the PSR-2 standard and please create one pull request per feature. In exchange you will be credited as contributor on this page.
+
+## License
+
+This package is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)

composer.json

@@ -0,0 +1,19 @@
+{
+    "name": "vdhicts/html-element",
+    "description": "Easily create HTML elements from PHP",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Dick van der Heiden",
+            "email": "[email protected]"
+        }
+    ],
+    "require": {},
+    "require-dev": {
+        "phpunit/phpunit": "^6.1",
+        "phpmd/phpmd": "^2.6"
+    },
+    "autoload": {
+        "psr-4": {"Vdhicts\\Html\\": "src/"}
+    }
+}