|
1 | 1 | # gen-html |
2 | 2 | PHP Library for generating HTML document |
| 3 | + |
| 4 | +[](https://github.com/ABGEO07/gen-html/blob/master/LICENSE) |
| 5 | + |
| 6 | +[](https://github.com/ABGEO07/gen-html/releases) |
| 7 | + |
| 8 | +[](https://packagist.org/packages/abgeo/gen-html "Packagist Version") |
| 9 | + |
| 10 | +--- |
| 11 | + |
| 12 | +## Installation |
| 13 | + |
| 14 | +You can install this library with [Composer](https://getcomposer.org/): |
| 15 | + |
| 16 | +- `composer require abgeo/gen-html` |
| 17 | + |
| 18 | +## Usage |
| 19 | + |
| 20 | +Include composer autoloader in your main file (Ex.: index.php) |
| 21 | + |
| 22 | +- `require_once __DIR__ . '/../vendor/autoload.php';` |
| 23 | + |
| 24 | +### Classes |
| 25 | + |
| 26 | +The library has two classes: |
| 27 | + |
| 28 | +* `\ABGEO\HTMLGenerator\Document` - For generating Full HTML5 Document; |
| 29 | +* `\ABGEO\HTMLGenerator\Element` - For generating HTML element; |
| 30 | + |
| 31 | +#### Class `Document` |
| 32 | + |
| 33 | +Import `ABGEO\HTMLGenerator\Document` class. |
| 34 | + |
| 35 | +##### Public Methods |
| 36 | + |
| 37 | +- `setLanguage()` - Set document content language (Document::LANG_* constants); |
| 38 | +- `setCharset()` - Set charset for document (Document::CHARSET_* constants); |
| 39 | +- `setTitle()` - Set Document title; |
| 40 | +- `setDescription()` - Set Document description; |
| 41 | +- `setKeywords()` - Set Document keywords; |
| 42 | +- `addStyle()` - Add CSS file path; |
| 43 | +- `setBody()` - Set Document body content; |
| 44 | +- `addScript()` - Set JS file path; |
| 45 | +- `getDocument()` - Get generated HTML code; |
| 46 | + |
| 47 | +**Note: See usage in [example.php](examples/example.php)** |
| 48 | + |
| 49 | +#### Class `Element` |
| 50 | + |
| 51 | +Import `ABGEO\HTMLGenerator\Element` class. |
| 52 | + |
| 53 | +##### Public Methods |
| 54 | + |
| 55 | +- `add2Content()` - Add given string to HTML content; |
| 56 | +- `getHtml()` - Get HTML Content; |
| 57 | +- `concatenateElements()` - Concatenate given elements; |
| 58 | +- `createLink()` - Generate a tag; |
| 59 | +- `createArticle()` - Generate article tag; |
| 60 | +- `createBlockquote()` - Generate blockquote tag; |
| 61 | +- `createBreak()` - Generate br tag; |
| 62 | +- `createCode()` - Generate code tag; |
| 63 | +- `createDiv()` - Generate div tag; |
| 64 | +- `createEm()` - Generate em tag; |
| 65 | +- `createForm()` - Generate form tag; |
| 66 | +- `createFooter()` - Generate footer tag; |
| 67 | +- `createHeading()` - Generate h1-h6 tags; |
| 68 | +- `createHeader()` - Generate header tag; |
| 69 | +- `createLine()` - Generate hr tag; |
| 70 | +- `createI()` - Generate i tag; |
| 71 | +- `createImg()` - Generate img tag; |
| 72 | +- `createInput()` - Generate input tag; |
| 73 | +- `createLabel()` - Generate label tag; |
| 74 | +- `createList()` - Generate ol or ul tags; |
| 75 | +- `createNav()` - Generate nav tag; |
| 76 | +- `createParagraph()` - Generate p tag; |
| 77 | +- `createPre()` - Generate pre tag; |
| 78 | +- `createProgress()` - Generate progress tag; |
| 79 | +- `createSection()` - Generate section tag; |
| 80 | +- `createSelect()` - Generate select tag; |
| 81 | +- `createSpan()` - Generate span tag; |
| 82 | +- `createStrong()` - Generate strong tag; |
| 83 | +- `createSub()` - Generate sub tag; |
| 84 | +- `createSup()` - Generate sup tag; |
| 85 | +- `createTable()` - Generate table tag; |
| 86 | +- `createTextarea()` - Generate textarea tag; |
| 87 | +- `clear()` - Clear HTML content; |
| 88 | + |
| 89 | +**Note: See usage in [example.php](examples/example.php)** |
| 90 | + |
| 91 | +## Examples |
| 92 | + |
| 93 | +See full example in [example.php](examples/example.php) and sample Bootstrap 4 page in |
| 94 | +[bootstrap.php](examples/bootstrap.php). |
| 95 | + |
| 96 | +## Authors |
| 97 | + |
| 98 | +* **Temuri Takalandze** - *Initial work* - [ABGEO](https://abgeo.dev) |
| 99 | + |
| 100 | +## License |
| 101 | + |
| 102 | +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details |
0 commit comments