Installation

1. Install the Clake.DataStructutres plugin.
2. You're done :)

Usage

Include the class file for the data structure you would like to use. So far, you can use the Enum, Grid, and Lists data structures. A detailed description of what these do can be found on the overview page.

Grid

First initialize the grid with some properties. Then, call the gridify method and pass it some data. From there you can retrieve rows of data, specific row&cols of data and automatically calculated responsive CSS style sizings.

This will create a grid with 3 columns and as many rows as it needs to fit all the data. Then, it will split $data up into each slot in the grid from left to right, top to bottom.

$grid = Grid::init(3, 0)->gridify($data);

This will get the piece of data in row 2 and column 3.

$piece = $grid->getIndex(3, 2);

This will return an array of responsive CSS style measurements for small, medium, and large screens. Useful for libraries like Bootstrap and MaterialCSS.

$style = $grid->getAllColStyleSize();
<div class="col-sm-$style['s'] col-md-$style['m'] col-lg-$style['l']">Column 1</div>
<div class="col-sm-$style['s'] col-md-$style['m'] col-lg-$style['l']">Column 2</div>
<div class="col-sm-$style['s'] col-md-$style['m'] col-lg-$style['l']">Column 3</div>

Lists

First, create a new list and pass it some data.

$list = new List($data);
$list2 = List::create($data);

Enable/Disable automatic list size limiting. This if off by default.

$list->enableLimiting(15);
$list->disableLimiting();

Set the limit of the list. This will also turn on limiting.

$list2->setLimit(10);

Push more data onto the list. This will chop off the first in data to the list if limiting is turned on.

$list2->pushList($moreData);

Retrieve the list. Limits the list if limiting is turned on.

$list->getList();

Get the whole list regardless of limiting.

$list->allList();

Enum

You MUST extend the Enum class to create an Enum.

class eAppStates extends Clake\DataStructures\Classes\Enum
{
    $enum = ["LOADING", "STARTING", "EXITING"];
}

Create an Enum instance

$appState = eAppStates::LOADING();

Change what the Enum instance is set as and returns the Enum instance

$appState(STARTING);

$appState->LOADING;

Compares two Enums for equality

$appState2 = eAppState::LOADING();
if($appState->compare($appState2))
    echo "The app states are equal";