imliam/laravel-macros

A collection of miscellaneous methods to extend some of Laravel's core classes through the use of macros and mixins

v0.1.0 2018-07-13 23:25 UTC

README

Latest Version on Packagist Total Downloads License

A collection of miscellaneous methods to extend some of Laravel's core classes through the use of macros and mixins.

Installation

You can install the package with Composer using the following command:

composer require imliam/laravel-macros:^0.1.0

Usage

Once installed, all macros will automatically be registered and methods will immediately be available for use.

Illuminate\Support\Collection

Collection@sortByDate($key = null)

Sort the values in a collection by a datetime value.

To sort a simple list of dates, call the method without passing any arguments to it.

collect(['2018-01-04', '1995-07-15', '2000-01-01'])->sortByDate();
// return collect(['1995-07-15', '2000-01-01', '2018-01-04'])

To sort a collection where the date is in a specific key, pass the key name when calling the method.

collect([
    ['date' => '2018-01-04', 'name' => 'Banana'],
    ['date' => '1995-07-15', 'name' => 'Apple'],
    ['date' => '2000-01-01', 'name' => 'Orange']
])->sortByDate('date')
  ->all();

// [
//    ['date' => '1995-07-15', 'name' => 'Apple'],
//    ['date' => '2000-01-01', 'name' => 'Orange'],
//    ['date' => '2018-01-04', 'name' => 'Banana']
// ]

Additionally, you can pass a callback to the method to choose more precisely what is sorted.

$users = User::all();

$users->sortByDate(function(User $user) {
    return $user->created_at;
})->toArray();

// [
//    ['id' => 12, 'username' => 'spatie', 'created_at' => '1995-07-15'],
//    ['id' => 15, 'username' => 'taylor', 'created_at' => '2000-01-01'],
//    ['id' => 2, 'username' => 'jeffrey', 'created_at' => '2018-01-04']
// ]

Collection@sortByDateDesc($key = null)

This method has the same signature as the sortByDate method, but will sort the collection in the opposite order.

Collection@keysToValues()

Change the collection so that all values are equal to the corresponding key.

collect(['a' => 'b', 'c' => 'd'])->keysToValues();
// ['a' => 'a', 'c' => 'c']

Collection@valuesToKeys()

Change the collection so that all keys are equal to their corresponding value.

collect(['a' => 'b', 'c' => 'd'])->valuesToKeys();
// ['b' => 'b', 'd' => 'd']

Illuminate\Database\Query\Builder

Builder@if($condition, $column, $operator, $value)

Conditionally add where clause to the query builder. See Mohamed Said's blog post for more information.

Keep chaining methods onto a query being built without having to break it up. Take code like this:

$results = DB::table('orders')
    ->where('branch_id', Auth::user()->branch_id);

if($request->customer_id){
    $results->where('customer_id', $request->customer_id);
}

$results = $results->get();

And clean it up into this:

$results = DB::table('orders')
    ->where('branch_id', Auth::user()->branch_id)
    ->if($request->customer_id, 'customer_id', '=', $request->customer_id)
    ->get();

Illuminate\Http\Request

Request@replace($key, $value)

Manipulate the request object by replacing a value, or even adding a new one.

class Middleware
{
    public function handle($request, \Closure $next)
    {
        $request->replace('key', 'value');

        return $next($request);
    }
}

Illuminate\Support\Facades\Route

Route@viewDir($path, $viewDirectory = '', $data = [])

Mimics the functionality offered by Route::view() method but extends it by rerouting requested the URI at any number of sub-levels to match a view directory in the code base.

This makes it possible to create views with static content and not need to worry about updating routes to match them or using a CMS-style solution to manage them.

For an example, to see how it works, imagine the following route definition:

Route::viewDir('/pages', 'pages');

And the following directory structure for the views:

views/
├── auth/
├── errors/
├── layouts/
├── pages/
│   ├── about-us.blade.php
│   ├── faq.blade.php
│   ├── privacy-policy.blade.php
│   ├── team/
│   │   ├── developers.blade.php
│   │   ├── index.blade.php
│   │   ├── management.blade.php
│   │   └── marketing.blade.php
│   └── terms-of-service.blade.php
└── partials/

The following routes will be generated to match each of the views in the given directory:

/pages/about-us
/pages/faq
/pages/privacy-policy
/pages/team
/pages/team/developers
/pages/team/management
/pages/team/marketing
/pages/terms-of-service

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email liam@liamhammett.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.