Helpers
In This Article
HtmlList
htmlList($items, $ordered, $attribs, $escape)
generates unordered and ordered
lists based on the $items
passed to it. If $items
is a multidimensional
array, a nested list will be built. If the $escape
flag is true
(default),
individual items will be escaped using the view objects registered escaping
mechanisms; pass a false
value if you want to allow markup in your lists.
Basic Usage
Unordered list
$items = [
'Level one, number one',
[
'Level two, number one',
'Level two, number two',
[
'Level three, number one'
],
'Level two, number three',
],
'Level one, number two',
];
echo $this->htmlList($items);
Output:
<ul>
<li>Level one, number one
<ul>
<li>Level two, number one</li>
<li>Level two, number two
<ul>
<li>Level three, number one</li>
</ul>
</li>
<li>Level two, number three</li>
</ul>
</li>
<li>Level one, number two</li>
</ul>
Ordered list
echo $this->htmlList($items, true);
Output:
<ol>
<li>Level one, number one
<ol>
<li>Level two, number one</li>
<li>Level two, number two
<ol>
<li>Level three, number one</li>
</ol>
</li>
<li>Level two, number three</li>
</ol>
</li>
<li>Level one, number two</li>
</ol>
HTML attributes
$attribs = ['class' => 'foo'];
echo $this->htmlList($items, false, $attribs);
Output:
<ul class="foo">
<li>Level one, number one
<ul class="foo">
<li>Level two, number one</li>
<li>Level two, number two
<ul class="foo">
<li>Level three, number one</li>
</ul>
</li>
<li>Level two, number three</li>
</ul>
</li>
<li>Level one, number two</li>
</ul>
Escape Output
$items = [
'Level one, number <strong>one</strong>',
'Level one, number <em>two</em>',
];
// Escape output (default)
echo $this->htmlList($items);
// Don't escape output
echo $this->htmlList($items, false, false, false);
Output:
<!-- Escape output (default) -->
<ul class="foo">
<li>Level one, number <strong>one</strong></li>
<li>Level one, number <em>two</em></li>
</ul>
<!-- Don't escape output -->
<ul class="foo">
<li>Level one, number <strong>one</strong></li>
<li>Level one, number <em>two</em></li>
</ul>
Found a mistake or want to contribute to the documentation? Edit this page on GitHub!