#6 Eloquence

Eloquence is a package to extend Laravel 5’s base Eloquent models and functionality. It provides a number of utilities and classes to work with Eloquent in new and useful ways, such as camel cased attributes (for JSON apis), count caching, uuids and more.

Installation

Install the package via composer:

composer 

For Laravel 4, please install the 1.1.4 release. Please note that this is no longer supported and won’t receive any new features, only security updates.

composer 

Usage

First, add the eloquence service provider to your config/app.php file:

'EloquenceEloquenceServiceProvider',

It’s important to note that this will automatically re-bind the Model class that Eloquent uses for many-to-many relationships. This is necessary because when the Pivot model is instantiated, we need it to utilise the parent model’s information and traits that may be needed.

You should now be good to go with your models.

use SigepEloquentEnhancementsTraitsError

setErrors(IlluminateSupportMessageBag $errors)

errors()

use SigepEloquentEnhancementsTraitsSaveAll;

class User extends Eloquent
{
    use SigepEloquentEnhancementsTraitsErrors;
    use SigepEloquentEnhancementsTraitsSaveAll;

    public function phones()
    {
        return $this->hasMany('Phone');
    }
}

class Phone extends Eloquent
{
    public function user()
    {
        return $this->belongsTo('User');
    }
}

$input = array(
    'name' => 'Bob',
    'email' => '[email protected]',
    'phones' => array (
        array('number' => '1111111'),
        array('number' => '2222222'),
    ),
);

$bob = new User();
$bob->createAll($input);

$input = array(
    'name' => 'Bob',
    'email' => '[email protected]',
    'phones' => array (
        array('id' => 1, 'number' => '111-1111'),
        array('id' => 2, 'number' => '222-2222'),
    ),
);

$bob = User::find(1); // assuming bob have the id = 1
$bob->saveAll($input);

$input = array(
    'name' => 'Bob',
    'email' => '[email protected]',
    'phones' => array (
        array('id' => 1, '_delete' => true),
    ),
);

$bob = User::find(1); // assuming bob have the id = 1
$bob->saveAll($input);

"require": {
    "mayoz/eloquent-filterable": "~1.0"
}

composer require mayoz/eloquent-filterable ~1.0

<?php namespace AppFilters;

use MayozFilterFilter;

class PublishedFilter extends Filter
{
    /**
     * The first executable filter clause.
     *
     * @param  mixed  $query
     * @return void
     */
    public static function before($query)
    {
        $query->where('published', '=', 1);
    }
}

<?php namespace AppFilters;

use MayozFilterFilter;

class StatusActiveFilter extends Filter
{
    /**
     * The last executable filter clause.
     *
     * @param  mixed  $query
     * @return void
     */
    public static function after($query)
    {
        $query->where('status', '=', 'active');
    }
}

<?php namespace App;

use IlluminateDatabaseEloquentModel;
use MayozFilterFilterable;

class Post extends Model
{
    use Filterable;

    /**
     * The attributes that should be filter.
     *
     * @var array
     */
    protected $filters = [
        'AppFiltersStatusActiveFilter',
        'AppFiltersPublishedFilter'
    ];

    // other things...
}

$model = AppPost::where('views', '>', 100)->get();

SELECT *
FROM   `posts`
WHERE  `published` = 1     # added by automatic filter.
  AND  `views` > 100       # user defined where clause
  AND  `status` = 'active' # added by automatic filter.

<?php namespace AppFilters;

use Auth;
use MayozFilterFilter;

class StatusActiveFilter extends Filter
{
    /**
     * The last executable filter clause.
     *
     * @param  mixed  $query
     * @return void
     */
    public static function after($query)
    {
        # assume, the `users` table has `role` field.
        if (array_get(Auth::user(), 'role') != 'administrator')
        {
            $query->where('status', '=', 'active');
        }
    }
}

var table = $('#example').DataTable({
  "processing": true,
  "serverSide": true,
  "ajax": {
    "url": "<url to datatable route>",
    "type": "POST"
  }
});

$users = new ModelsUser();
$dataTable = new LiveControlEloquentDataTableDataTable($users, ['email', 'firstname', 'lastname']);
echo json_encode($dataTable->make());

$dataTable->setVersionTransformer(new LiveControlEloquentDataTableVersionTransformersVersion109Transformer());

{
    "require": {
        "niclasleonbock/eloquent-activatable": "dev-master"
    },
}

<?php
$table->datetime('activated_at')->nullable();

<?php
use niclasleonbockEloquentActivatableTrait;

class Topic extends Eloquent
{
    use ActivatableTrait;

    // ...
}

<?php
$allTopics = Topic::withDeactivated()->get();

<?php
$onlyDeactivatedTopics = Topic::onlyDeactivated()->get();

<?php
echo 'My topic is ' . ($topic->activated() ? 'activated' : 'deactivated');

<?php
$topic->activate();
$topic->save();

echo 'My topic is now ' . ($topic->activated() ? 'activated' : 'deactivated');

<?php
$topic->deactivate();
$topic->save();

echo 'My topic is now ' . ($topic->activated() ? 'activated' : 'deactivated');

protected $activatedAtColumn = 'my_column_name';

// or

public getActivatedAtColumn()
{
    return 'my_column_name';
}