71 |
72 | title) && is_string($this->title) && $this->title !== '') : ?>
73 | >
82 | body ?>
83 |
84 |
85 | body_append) && is_string($this->body_append) && $this->body_append !== '') : ?>
86 | body_append ?>
87 |
88 |
89 |
90 |
91 |
92 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # FORHtml
2 |
3 | PHP HTML-Generator für REDAXO CMS
4 |
5 | ## Installation
6 |
7 | Über das REDAXO-Backend installieren oder:
8 |
9 | ```bash
10 | composer require friends-of-redaxo/for-html
11 | ```
12 |
13 | ## Grundlegende Verwendung
14 |
15 | ### HTML-Element erstellen
16 |
17 | ```php
18 | $div = FORHtml::createElement('div');
19 | echo $div; // Ausgabe:
20 |
21 | $paragraph = FORHtml::createElement('p')->text('Inhalt');
22 | echo $paragraph; // Ausgabe:
74 |
76 |
77 | body_prepend) && is_string($this->body_prepend) && $this->body_prepend !== '') : ?>
78 | body_prepend ?>
79 |
80 | body) && is_string($this->body) && $this->body !== '') : ?>
81 | title ?>
75 |Inhalt
23 | ``` 24 | 25 | ### Verschachtelte Elemente 26 | 27 | ```php 28 | $container = FORHtml::createElement('div') 29 | ->addClass('container') 30 | ->addElement('a') 31 | ->set('href', './seite.php') 32 | ->text('Mein Link') 33 | ->getParent() // Zurück zum Container 34 | ->addElement('p') 35 | ->text('Mein Text'); 36 | 37 | // Ausgabe: 38 | //
39 | // Mein Link
40 | //
42 | ```
43 |
44 | ## Attribute verwalten
45 |
46 | ### Attribute setzen
47 |
48 | ```php
49 | $link = FORHtml::createElement('a')
50 | ->set('href', './beispiel.php')
51 | ->set('id', 'meinLink')
52 | ->text('Mein Link');
53 |
54 | // Alternativ mehrere Attribute gleichzeitig:
55 | $link = FORHtml::createElement('a')
56 | ->set([
57 | 'href' => './beispiel.php',
58 | 'id' => 'meinLink',
59 | 'title' => 'Mehr Information'
60 | ])
61 | ->text('Mein Link');
62 | ```
63 |
64 | ### ID setzen (Kurzform)
65 |
66 | ```php
67 | $div = FORHtml::createElement('div')
68 | ->id('meinContainer');
69 | ```
70 |
71 | ### CSS-Klassen verwalten
72 |
73 | ```php
74 | $div = FORHtml::createElement('div')
75 | ->addClass('primär')
76 | ->addClass('hervorgehoben');
77 | // Ausgabe:
78 |
79 | $div->removeClass('hervorgehoben');
80 | // Ausgabe:
81 | ```
82 |
83 | ## REDAXO-spezifische Funktionen
84 |
85 | ### Media Manager Integration
86 |
87 | ```php
88 | $bild = FORHtml::createElement('img')
89 | ->addClass('uk-width-1-1')
90 | ->set('alt', 'Produktbild')
91 | ->mmfile('thumbnail', 'produkt.jpg');
92 |
93 | // Ausgabe:
94 | // Mein Text
41 | //
96 | ```
97 |
98 | ### Fragment-System
99 |
100 | ```php
101 | $card = FORHtml::createElement('div')
102 | ->addClass('card')
103 | ->parseFragment('/fragments/card.php', [
104 | 'title' => 'Überschrift',
105 | 'text' => 'Beschreibung',
106 | 'image' => 'bild.jpg'
107 | ]);
108 | ```
109 |
110 | ## Sicherheit und Konfiguration
111 |
112 | ### XSS-Schutz aktivieren
113 |
114 | ```php
115 | FORHtml::$avoidXSS = true;
116 |
117 | $div = FORHtml::createElement('div')
118 | ->text('');
119 | // Text wird automatisch escaped
120 | ```
121 |
122 | ### Ausgabeformat konfigurieren
123 |
124 | ```php
125 | // HTML5 (Standard)
126 | FORHtml::$outputLanguage = ENT_HTML5;
127 |
128 | // XML/XHTML
129 | FORHtml::$outputLanguage = ENT_XML1;
130 | ```
131 |
132 | ## Element-Navigation
133 |
134 | ```php
135 | $container = FORHtml::createElement('div');
136 | $first = $container->addElement('p')->text('Erster');
137 | $second = $container->addElement('p')->text('Zweiter');
138 | $third = $container->addElement('p')->text('Dritter');
139 |
140 | // Navigation
141 | $element = $second
142 | ->getFirst(); // Ersten Absatz holen
143 | ->getNext(); // Nächsten Absatz
144 | ->getPrevious(); // Vorherigen Absatz
145 | ->getLast(); // Letzten Absatz
146 | ->getParent(); // Container
147 | ->getTop(); // Wurzelelement
148 |
149 | // Element entfernen
150 | $second->remove();
151 | ```
152 |
153 | ## Praktische Beispiele
154 |
155 | ### UIkit-Cards aus YForm-Daten
156 |
157 | ```php
158 | $tableUrlaubsziele = rex_yform_manager_table::get('rex_urlaubsziele');
159 | $urlaubsziele = $tableUrlaubsziele->query()->find();
160 |
161 | foreach ($urlaubsziele as $ziel) {
162 | $mediaList = isset($ziel->media) ? array_filter(explode(",", $ziel->media)) : [];
163 |
164 | if (!empty($mediaList)) {
165 | $media = FORHtml::createElement('img')
166 | ->addClass('uk-width-1-1')
167 | ->set('alt', 'Bild: ' . $ziel->title)
168 | ->set('uk-tooltip', '')
169 | ->mmfile('card_image', $mediaList[0]);
170 | }
171 |
172 | $card = FORHtml::createElement('div')
173 | ->parseFragment('/uk3/card.php', [
174 | 'media' => $media ?? '',
175 | 'title' => $ziel->title,
176 | 'body' => $ziel->infotext,
177 | ])
178 | ->addClass('uk-card-default');
179 |
180 | $cards[] = $card;
181 | }
182 |
183 | // Container für alle Cards
184 | if ($cards) {
185 | echo FORHtml::createElement('div')
186 | ->addClass('uk-section uk-padding-large')
187 | ->addElement('div')
188 | ->addClass('uk-container')
189 | ->addElement('div')
190 | ->addClass('uk-child-width-1-3@m uk-grid-match')
191 | ->set('uk-grid', '')
192 | ->text(implode('', $cards));
193 | }
194 | ```
195 |
196 | ### Navigation mit NavigationArray
197 |
198 | ```php
199 | function generateUikit3Navigation(int $startCategoryId = 0, int $depth = 4): string
200 | {
201 | $navArray = BuildArray::create()
202 | ->setStart($startCategoryId)
203 | ->setDepth($depth)
204 | ->generate();
205 |
206 | $nav = FORHtml::createElement('ul')
207 | ->addClass('uk-nav uk-nav-default');
208 |
209 | foreach ($navArray as $item) {
210 | $li = $nav->addElement('li');
211 |
212 | if ($item['active']) {
213 | $li->addClass('uk-active');
214 | }
215 |
216 | $li->addElement('a')
217 | ->set('href', $item['url'])
218 | ->text($item['catName']);
219 |
220 | if (!empty($item['children'])) {
221 | $li->addElement(generateSubMenu($item['children']));
222 | }
223 | }
224 |
225 | return $nav->toString();
226 | }
227 |
228 | function generateSubMenu(array $children): FORHtml
229 | {
230 | $subNav = FORHtml::createElement('ul')
231 | ->addClass('uk-nav-sub');
232 |
233 | foreach ($children as $child) {
234 | $li = $subNav->addElement('li');
235 |
236 | if ($child['active']) {
237 | $li->addClass('uk-active');
238 | }
239 |
240 | $li->addElement('a')
241 | ->set('href', $child['url'])
242 | ->text($child['catName']);
243 |
244 | if (!empty($child['children'])) {
245 | $li->addElement(generateSubMenu($child['children']));
246 | }
247 | }
248 |
249 | return $subNav;
250 | }
251 | ```
252 |
253 | ## Technische Details
254 |
255 | ### Selbstschließende Tags
256 |
257 | Folgende Tags werden automatisch als selbstschließend behandelt:
258 | - img, br, hr, input, area, link, meta
259 | - param, base, col, command, keygen
260 | - source, track, wbr
261 |
262 | ```php
263 | $img = FORHtml::createElement('img')
264 | ->set('src', 'bild.jpg');
265 | // Ausgabe: 
266 | ```
267 |
268 | ---
269 |
270 | ## Credits
271 |
272 | Basierend auf [PHP HTML Generator](https://github.com/Airmanbzh/php-html-generator) von Airmanbzh.
273 |
274 | ## Support
275 |
276 | Bei Fragen oder Problemen bitte ein [GitHub Issue](https://github.com/FriendsOfREDAXO/for-html/issues) erstellen.
277 |
--------------------------------------------------------------------------------
/lib/FORHtml/FORHtml.php:
--------------------------------------------------------------------------------
1 | tag = $tag;
31 | $this->top = $top;
32 | $this->autoclosed = in_array($this->tag, $this->autocloseTagsList);
33 | }
34 |
35 | public static function __callStatic(string $tag, array $content): FORHtml
36 | {
37 | return self::createElement($tag)
38 | ->attr(count($content) && is_array($content[0]) ? array_pop($content) : [])
39 | ->text(implode('', $content));
40 | }
41 |
42 | public function __call(string $tag, array $content): FORHtml
43 | {
44 | return $this
45 | ->addElement($tag)
46 | ->attr(count($content) && is_array($content[0]) ? array_pop($content) : [])
47 | ->text(implode('', $content));
48 | }
49 |
50 | public function __invoke(): FORHtml
51 | {
52 | return $this->getParent();
53 | }
54 |
55 | public static function createElement(string $tag = ''): FORHtml
56 | {
57 | self::$instance = new static($tag);
58 | return self::$instance;
59 | }
60 |
61 | public function addElement(string $tag = ''): FORHtml
62 | {
63 | $htmlTag = (is_object($tag) && $tag instanceof self) ? clone $tag : new static($tag);
64 | $htmlTag->top = $this->getTop();
65 | $htmlTag->parent = $this;
66 | $this->content[] = $htmlTag;
67 | return $htmlTag;
68 | }
69 |
70 | public function set(array|string $attribute, ?string $value = null): FORHtml
71 | {
72 | if (is_array($attribute)) {
73 | foreach ($attribute as $key => $value) {
74 | $this[$key] = $value;
75 | }
76 | } else {
77 | $this[$attribute] = $value;
78 | }
79 | return $this;
80 | }
81 |
82 | public function attr(array|string $attribute, ?string $value = null): FORHtml
83 | {
84 | return $this->set(...func_get_args());
85 | }
86 |
87 | public function offsetExists(mixed $attribute): bool
88 | {
89 | return isset($this->attributeList[$attribute]);
90 | }
91 |
92 | public function offsetGet(mixed $attribute): mixed
93 | {
94 | return $this->attributeList[$attribute] ?? null;
95 | }
96 |
97 | public function offsetSet(mixed $attribute, mixed $value): void
98 | {
99 | $this->attributeList[$attribute] = $value;
100 | }
101 |
102 | public function offsetUnset(mixed $attribute): void
103 | {
104 | unset($this->attributeList[$attribute]);
105 | }
106 |
107 | public function text(string $value): FORHtml
108 | {
109 | $this->addElement('')->text = static::$avoidXSS ? static::unXSS($value) : $value;
110 | return $this;
111 | }
112 |
113 | public function getTop(): FORHtml
114 | {
115 | return $this->top ?? $this;
116 | }
117 |
118 | public function getParent(): ?FORHtml
119 | {
120 | return $this->parent;
121 | }
122 |
123 | public function getFirst(): ?FORHtml
124 | {
125 | return $this->parent->content[0] ?? null;
126 | }
127 |
128 | public function getPrevious(): FORHtml
129 | {
130 | $prev = $this;
131 | if ($this->parent !== null) {
132 | foreach ($this->parent->content as $c) {
133 | if ($c === $this) {
134 | break;
135 | }
136 | $prev = $c;
137 | }
138 | }
139 | return $prev;
140 | }
141 |
142 | public function getNext(): ?FORHtml
143 | {
144 | $next = null;
145 | if ($this->parent !== null) {
146 | $found = false;
147 | foreach ($this->parent->content as $c) {
148 | if ($found) {
149 | $next = $c;
150 | break;
151 | }
152 | if ($c === $this) {
153 | $found = true;
154 | }
155 | }
156 | }
157 | return $next;
158 | }
159 |
160 | public function getLast(): ?FORHtml
161 | {
162 | return $this->parent->content[array_key_last($this->parent->content)] ?? null;
163 | }
164 |
165 | public function remove(): ?FORHtml
166 | {
167 | if ($this->parent !== null) {
168 | foreach ($this->parent->content as $key => $value) {
169 | if ($value === $this) {
170 | unset($this->parent->content[$key]);
171 | }
172 | }
173 | }
174 | return null;
175 | }
176 |
177 | public function __toString(): string
178 | {
179 | return $this->getTop()->toString();
180 | }
181 |
182 | public function toString(): string
183 | {
184 | $string = '';
185 | if (!empty($this->tag)) {
186 | $string .= "<{$this->tag}" . $this->attributesToString();
187 | $string .= $this->autoclosed ? '/>' : ">{$this->contentToString()}tag}>";
188 | } else {
189 | $string .= $this->text . $this->contentToString();
190 | }
191 | return $string;
192 | }
193 |
194 | protected function attributesToString(): string
195 | {
196 | $string = '';
197 | $XMLConvention = in_array(static::$outputLanguage, [ENT_XML1, ENT_XHTML]);
198 | foreach ($this->attributeList as $key => $value) {
199 | if ($value !== null && ($value !== false || $XMLConvention)) {
200 | if (is_array($value)) {
201 | $value = implode(' ', $value);
202 | }
203 | $escapedValue = htmlspecialchars($value, ENT_QUOTES, 'UTF-8');
204 | $string .= " {$key}=\"{$escapedValue}\"";
205 | }
206 | }
207 | return $string;
208 | }
209 |
210 | protected function contentToString(): string
211 | {
212 | return array_reduce($this->content, fn($carry, $c) => $carry . $c->toString(), '');
213 | }
214 |
215 | public static function unXSS(string $input): string
216 | {
217 | return htmlentities($input, ENT_QUOTES | ENT_DISALLOWED | static::$outputLanguage);
218 | }
219 |
220 | // Methods from HtmlTag
221 | public function id(string $value): FORHtml
222 | {
223 | return $this->set('id', $value);
224 | }
225 |
226 | public function addClass(string $value): FORHtml
227 | {
228 | if (!isset($this->attributeList['class']) || is_null($this->attributeList['class'])) {
229 | $this->attributeList['class'] = [];
230 | }
231 | $this->attributeList['class'][] = $value;
232 | return $this;
233 | }
234 |
235 | public function removeClass(string $value): FORHtml
236 | {
237 | if (!is_null($this->attributeList['class'])) {
238 | unset($this->attributeList['class'][array_search($value, $this->attributeList['class'])]);
239 | }
240 | return $this;
241 | }
242 |
243 | public function mmfile(string $type = 'default', string $file =''): string
244 | {
245 | return $this->set('src', rex_media_manager::getUrl($type, $file));
246 | }
247 |
248 | public function content(string $content =''): string
249 | {
250 | return $this->text($content);
251 | }
252 |
253 | // Neue Methode für Fragmente
254 | public function parseFragment(string $template, array $vars = []): FORHtml
255 | {
256 | $fragment = new rex_fragment();
257 | foreach ($vars as $key => $value) {
258 | $fragment->setVar($key, $value, false);
259 | }
260 | $this->text($fragment->parse($template));
261 | return $this;
262 | }
263 | }
264 |
--------------------------------------------------------------------------------