Prologue Support

Prologue Support is an extension for Illuminate Support. It provides you with extra helper functionality for your application.

Maintained by Dries Vints
@driesvints
driesvints.com

Installation
Usage
Changelog
License

Installation

You can install Prologue Support for your project through Composer.

Require the package in your composer.json.

"prologue/support": "dev-master"

Run composer to install or update the package.

$ composer update

Usage

Collection

The Collection.php class in Prologue Support comes with some additional functions.

filterBy($key, $value)

Used to filter for records which have a specific value set for a given key.

$data = array(
	array('name' => 'foo', 'age' => 21),
	array('name' => 'bar', 'age' => 20),
	array('name' => 'baz', 'age' => 9),
);

$collection = new Prologue\Support\Collection($data);

// Will return only records with an age of 20.
$items = $collection->filterBy('age', 20)->all();

orderBy($key, $direction)

Used to order records by a given key.

$data = array(
	array('name' => 'foo', 'age' => 21),
	array('name' => 'bar', 'age' => 20),
	array('name' => 'baz', 'age' => 9),
);

$collection = new Prologue\Support\Collection($data);

// Will order the records by its age in ascending order.
$items = $collection->orderBy('age')->all();

You can also order in a descending way.

$items = $collection->orderBy('age', 'desc')->all();

MessageBag

The MessageBag class in Prologue Support offers the ability to add arrays or other MessageBags as messages.

$bag = new Prologue\Support\MessageBag;
$bag->add('error', array(
	'email' => 'Incorrect email address',
	'url'   => 'Incorrect url',
));
$messages = $bag->get('error');

Now $messages equals to:

array(
	array(
		'email' => 'Incorrect email address',
		'url'   => 'Incorrect url',
	)
);

You see? One of the messages is the array we added.

The same goes for instances of Illuminate\Support\MessageBag.

$bag->add('error', new Illuminate\Support\MessageBag);

Helper Functions

is_true($value)

Determine if a value is true.

$result = is_true(true) // true
$result = is_true(null) // false

is_false($value)

Determine if a value is false.

$result = is_false(false) // true
$result = is_false(null) // false

last_key(array $value)

Get the last key from an array.

$data = array('foo' => 'bar', 'baz' => 'foz');
$result = last_key($data); // 'baz'

Changelog

You view the changelog for this package here.

License

Prologue Support is licensed under the MIT License.

xreal / Support