googleshokry/laravel-helpers

An extensive set of Laravel framework helper functions and collection macros.

dev-master 2018-10-29 05:45 UTC

Requires

• php: ^7.2
• laravel/framework: ^5.6

Requires (Dev)

• kint-php/kint: ^2.2
• mockery/mockery: ^1.1
• nesbot/carbon: ^1.25
• orchestra/testbench: ^3.6
• phpunit/phpunit: ^6.4|^7.2

Suggests

• kint-php/kint: A powerful and modern PHP debugging tool. Required for the debug collection macros.
• nesbot/carbon: A simple PHP API extension for DateTime. Required for the carbonize collection macro.

MIT

• googleshokry

• collections
• helpers
• laravel
• macros

README

An extensive set of Laravel framework helper functions and collection macros.

Table of contents

• Requirements
• How to install
• Upgrading from 1.x
• Framework helper functions
  • locale
  • is_guest
  • is_logged_in
  • me
  • user
• Collection macros
  • Carbonize
  • Between
  • transformKeys
  • transpose
  • transposeWithKeys
  • d
  • ddd
• License
• Change log
• Testing
• Contributing
• Security
• Credits
• About

Requirements

• PHP 7.2 or higher
• Laravel 5.6 or higher

How to install

Just add the package to your project using Composer and Laravel will auto-discover it:

composer require googleshokry/laravel-helpers

If you want to use the collection debug macros, install the kint-php/kint package as a dev dependency:

composer require kint-php/kint --dev

Upgrading from 1.x

All essential generic PHP helpers have been extracted to their own googleshokry/php-helpers package and some other helpers have been removed in anticipation of their own package. In effect and from now on, Laravel Helpers will only contain helpers for the Laravel framework.

In addition, the minimum requirements have been upgraded to PHP 7.2 and Laravel 5.6.

See the changelog for more information.

Framework helper functions

locale

Get the active app locale or the fallback locale if it's missing or not set.

locale();

// "en"

is_guest

Determine if the current user is a guest.

The opposite of is_logged_in.

// When not authenticated
is_guest();

// true

// When authenticated as a user
is_guest();

// false

is_logged_in

Determine if the current user is authenticated.

The opposite of is_guest.

// When not authenticated
is_logged_in();

// false

// When authenticated as a user
is_logged_in();

// true

user

Get the currently authenticated user (if there is one).

When logged in, returns your user model or object that implements \Illuminate\Contracts\Auth\Authenticatable.

// When not authenticated
user();

// null

// When authenticated as a user
user();

// Illuminate\Foundation\Auth\User {}

me

Get the currently authenticated user (if there is one).

When logged in, returns your user model or object that implements \Illuminate\Contracts\Auth\Authenticatable.

An alternative for user.

// When not authenticated
me();

// null

// When authenticated as a user
me();

// Illuminate\Foundation\Auth\User {}

Collection macros

carbonize

Create Carbon instances from items in a collection.

collect([
    'yesterday',
    'tomorrow',
    '2017-07-01',
])->carbonize();

/*
Illuminate\Support\Collection {
    all: [
        Carbon\Carbon {
            "date": "2017-07-09 00:00:00.000000",
            "timezone_type": 3,
            "timezone": "UTC",
        },
        Carbon\Carbon {
            "date": "2017-07-11 00:00:00.000000",
            "timezone_type": 3,
            "timezone": "UTC",
        },
        Carbon\Carbon {
            "date": "2017-07-01 00:00:00.000000",
            "timezone_type": 3,
            "timezone": "UTC",
        },
    ],
}
*/

between

Reduce each collection item to the value found between a given start and end string.

The second parameter is optional and falls back to the start string if null.

collect([
    '"value1"',
    '"value2"',
    '"value3"',
])->between('"', '"');

/*
Illuminate\Support\Collection {
    all: [
        "value1",
        "value2",
        "value3",
    ],
}
*/

transformKeys

Perform an operation on the collection's keys.

The callable operation can either be a globally available method or a closure.

collect([
    'a' => 'value',
    'b' => 'value',
    'c' => 'value',
])->transformKeys('strtoupper');

/*
Illuminate\Support\Collection {
    all: [
        "A" => "value",
        "B" => "value",
        "C" => "value",
    ],
}
*/

collect([
    'a' => 'value',
    'b' => 'value',
    'c' => 'value',
])->transformKeys(function (string $key) {
    return 'prefix-' . $key;
});

/*
Illuminate\Support\Collection {
    all: [
        "prefix-a" => "value",
        "prefix-b" => "value",
        "prefix-c" => "value",
    ],
}
*/

transpose

Transpose (flip) a collection matrix (array of arrays) so its columns become rows and its rows become columns.

collect([
    [1, 2, 3],
    [4, 5, 6],
    [7, 8, 9],
])->transpose();

/*
Illuminate\Support\Collection {
    all: [
        [1, 4, 7],
        [2, 5, 8],
        [3, 6, 9],
    ],
}
*/

transposeWithKeys

Flip a collection of rows and values per column so its columns become rows and its rows become columns.

Before:

After:

How to use:

collect([
    'A' => [
        'id' => 1,
        'name' => 'James',
    ],
    'B' => [
        'id' => 2,
        'name' => 'Joe',
    ],
    'C' => [
        'id' => 3,
        'name' => 'Jonas',
    ],
])->transposeWithKeys();

/*
Illuminate\Support\Collection {
    all: [
        "id" => [
            "A" => 1,
            "B" => 2,
            "C" => 3,
        ],
        "name" => [
            "A" => "James",
            "B" => "Joe",
            "C" => "Jonas",
        ],
    ],
}
*/

You can also pass some row header names if you don't want them to be automatically guessed. You'd then call the macro with transposeWithKeys(['myID', 'row2']) and the resulting rows would be myID and row2 instead of id and name respectively.

d

Display structured debug information on the collection using Kint. Can be called multiple times during a collection's method chain and outputs debug information at each point of use. Continues script execution afterwards.

Explicitly requires the kint-php/kint package.

collect([
    'id' => 6,
    'name' => 'Sebastiaan',
])
->d()
->put('role', 'author')
->d();

ddd

Display structured debug information on the collection using Kint. Halts script execution afterwards, so it can only be called once during a collection's method chain.

Explicitly requires the kint-php/kint package.

collect([
    'id' => 6,
    'name' => 'Sebastiaan',
])
->d()
->put('role', 'author')
->ddd();

License

This package operates under the MIT License (MIT). Please see LICENSE for more information.

Change log

Please see CHANGELOG for more information what has changed recently.

Testing

composer install
composer test

Contributing

Please see CONTRIBUTING and CODE OF CONDUCT for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• googleshokry
• Logo by Vitor Caneco
• All Contributors

About

My name is Sebastiaan and I'm a freelance Laravel developer specializing in building custom Laravel applications. Check out my [portfolio][link-portfolio] for more information, [my blog][link-blog] for the latest tips and tricks, and my other packages to kick-start your next project.

Have a project that could use some guidance? Send me an e-mail at [e-mail]!