jasonroyle/li3_element

Element helper for Lithium

Element Helper for Lithium

Installation

Composer

composer require jasonroyle/li3_element

Git

git submodule add https://github.com/jasonroyle/li3_element.git libraries/li3_element

Enable the Library

Make the application aware of the library by adding the following to app/config/bootstrap/libraries.php., _(*1)

Libraries::add('li3_element');

Render

Renders an element., _(*2)

Params

• $element (string)
• $data (array, optional)

Return

Rendered HTML (string), _(*3)

Grid

Iterates through items and renders an element per item. The elements are wrapped in row and column divs and returned as a rendered HTML string., _(*4)

Params

• $element (string)
• $data (array)
• $options (array, optional)

Return

Rendered HTML (string), _(*5)

Examples

By default the first value of the data array will be used as the items of which to iterate through., _(*6)

The following example iterates through posts, replaces the post value of the data array with the individual post and passes the data on to the element to render., _(*7)

echo $this->element->grid('post', ['post' => $posts]);

To pass more data to each of the elements simply append the data array., _(*8)

echo $this->element->grid('post', [
    'post' => $posts,
    'foo' => $foo,
    'bar' => $bar
]);

Set columns, offset and max options to control how the items are displayed., _(*9)

The following example renders 3 posts per row, ignores the first 2 posts and limits the amount of displayed posts to 9., _(*10)

echo $this->element->grid('post', ['post' => $posts], [
    'columns' => 3,
    'offset' => 2,
    'max' => 9
]);

Appling attributes to rows and columns., _(*11)

The following example applies the class="row" attribute to each row and the class="column" attribute to each column., _(*12)

echo $this->element->grid('post', ['post' => $posts], [
    'columns' => 5,
    'row' => ['class' => 'row'],
    'column' => ['class' => 'column']
]);

The following example renders the same as the last except the attribute class="column first" is applied to every first column of each row and the attribute class="column last" is applied to every last column of each row., _(*13)

echo $this->element->grid('post', ['post' => $posts], [
    'columns' => 5,
    'row' => ['class' => 'row'],
    'column' => ['class' => 'column'],
    'first_column' => ['class' => 'column first'],
    'last_column' => ['class' => 'column last']
]);

The following example renders the same as the last except the last row contains only one column. The attribute class="column first last" is applied to this column., _(*14)

echo $this->element->grid('post', ['post' => $posts], [
    'columns' => 5,
    'max' => 11,
    'row' => ['class' => 'row'],
    'column' => ['class' => 'column'],
    'first_column' => ['class' => 'column first'],
    'last_column' => ['class' => 'column last'],
    'first_and_last_column' => ['class' => 'column first last']
]);