Structure

A robust yet streamlined module designed to build dynamic data structures and seamlessly deploy them across your website.

Why use it?

Reusable collections are extremely useful when you need to manage repetitive blocks of data through the administration panel.

A Collection is a container that groups related fields together.

For example, imagine you have a library of books that should be easily editable by admins.

In that case, you would define the following fields:

• Title
• Year
• Description
• Author

Then, you can easily retrieve the array representation of this collection in your template using the global $structure->getCollection('..id..') method.

Getting started

Go ahead and create a new collection. Then add custom fields into it and populate with your data. Then anywhere on your website use it like this:

<div class="row">
    <?php foreach ($structure->getCollection(1) as $item): ?>
    <div class="col-lg-3">
       <img src="<?= $item['photo']; ?>" >
       <p><?= $item['name']; ?></p>
    </div>
    <?php endforeach; ?>
</div>

The method $structure->getCollection(1) takes an ID of collection and returns an array of collection's data.

The key $item holds an array with data, where each key is an alias name of a field.

You're done! That's all you need to know.

Pagination

Sometimes, when having a large dataset, you might want to render it breaking it into pages. You can do it like this:

<?php

use Krystal\Widget\Pagination\PaginationWidget;

$perPageCount = 10;

?>

<div class="row">
 <?php foreach ($structure->getPaginatedCollection(7, $perPageCount) as $item): ?>
 <div class="col-lg-3">
   <p><?= $item['...alias...']; ?></p>
 </div>
 <?php endforeach; ?>
</div>

<?= $this->widget(new PaginationWidget($structure->getPaginator())); ?>

Accessing data via API

If you need access to your collection data via API, you can retrieve it in JSON format using the built-in endpoint:

/module/structure/api/index

This endpoint accepts the following parameters:

• collection_id - The ID of your collection (required)
• lang_id - The language ID (optional). If not provided, the default language will be used.

Note

All output of getPaginatedCollection() and getCollection() are cached by default. However, the cache is reset whenever you update records.

For SQL dump exportation, verify that all Foreign Key definitions are exported; omission will result in compromised application functionality