Laravel tips-2019-04

60 (and counting)
Laravel Quick Tips
Prepared by:
Povilas Korop / LaravelDaily Team
www.laraveldaily.com
povilas@laraveldaily.com
Last updated:
April 2019
Support our work by checking our Laravel adminpanel generator: www.quickadminpanel.com

History of changes
April 28, 2019: 10 more tips, total 60 now
November 8, 2018: 10 more tips, total 50 now
October 9, 2018: Book release with 40 tips
Tip 1. Invokable Controllers
From Laravel 5.6.28 - if you want to create a controller with just one action, you can use
__invoke() method and even create "invokable" controller.
<?php
namespace AppHttpControllers;
use AppUser;
use AppHttpControllersController;
class ShowProfile extends Controller
{
/**
* Show the profile for the given user.
*
* @param int $id
* @return Response
*/
public function __invoke($id)
{
return view('user.profile', ['user' => User::findOrFail($id)]);
}
}
Routes:
Route::get('user/{id}', 'ShowProfile');
Artisan command to generate this controller:
php artisan make:controller ShowProfile --invokable
Tip 2. Unsigned Integer
For foreign key migrations instead of integer() use unsignedInteger() type or
integer()->unsigned(), otherwise you may get SQL errors.

Schema::create('employees', function (Blueprint $table) {
$table->unsignedInteger('company_id');
$table->foreign('company_id')->references('id')->on('companies');
// ...
});
Tip 3. OrderBy on Eloquent relationships
You can specify orderBy() directly on your Eloquent relationships.
public function products()
{
return $this->hasMany(Product::class);
}
public function productsByName()
{
return $this->hasMany(Product::class)->orderBy('name');
}
Tip 4. Order of Migrations
If you want to change the order of DB migrations, just rename the file's timestamp, like from
2018_08_04_070443_create_posts_table.php to
2018_07_04_070443_create_posts_table.php (changed from 2018_08_04 to
2018_07_04). They run in alphabetical order.
Tip 5. Raw DB Queries
You can use RAW DB queries in various places, including havingRaw() function after
groupBy().
Product::groupBy('category_id')->havingRaw('COUNT(*) > 1')->get();

Tip 6. $loop variable in foreach
Inside of foreach loop, check if current entry is first/last by just using $loop variable.
@foreach ($users as $user)
@if ($loop->first)
This is the first iteration.
@endif
@if ($loop->last)
This is the last iteration.
@endif
<p>This is user {{ $user->id }}</p>
@endforeach
There are also other properties like $loop->iteration or $loop->count.
More here: https://laravel.com/docs/master/blade#the-loop-variable
Tip 7. Eloquent where date methods
In Eloquent, check the date with functions whereDay(), whereMonth(), whereYear(),
whereDate() and whereTime().
$products = Product::whereDate('created_at', '2018-01-31')->get();
$products = Product::whereMonth('created_at', '12')->get();
$products = Product::whereDay('created_at', '31')->get();
$products = Product::whereYear('created_at', date('Y'))->get();
$products = Product::whereTime('created_at', '=', '14:13:58')->get();

Tip 8. Route group within a group
in Routes, you can create a group within a group, assigning a certain middleware only to some
URLs in the "parent" group.
Route::group(['prefix' => 'account', 'as' => 'account.'], function() {
Route::get('login', 'AccountController@login');
Route::get('register', 'AccountController@register');
Route::group(['middleware' => 'auth'], function() {
Route::get('edit', 'AccountController@edit');
});
});
Tip 9. Increments and decrements
if you want to increment some DB column in some table, just use increment() function. Oh,
and you can increment not only by 1, but also by some number, like 50.
Post::find($post_id)->increment('view_count');
User::find($user_id)->increment('points', 50);
Tip 10. Does view file exist?
You can check if View file exists before actually loading it.
if (view()->exists('custom.page')) {
// Load the view
}
You can even load an array of views and only the first existing will be actually loaded.
return view()->first(['custom.dashboard', 'dashboard'], $data);

Tip 11. No timestamp columns
If your DB table doesn't contain timestamp fields created_at and updated_at, you can
specify that Eloquent model wouldn't use them, with $timestamps = false property.
class Company extends Model
{
public $timestamps = false;
}
Tip 12. Migration fields with timezones
Did you know that in migrations there's not only timestamps() but also timestampsTz(), for
the timezone?
Schema::create('employees', function (Blueprint $table) {
$table->increments('id');
$table->string('name');
$table->string('email');
$table->timestampsTz();
});
Also, there are columns dateTimeTz(), timeTz(), timestampTz(), softDeletesTz().
Tip 13. Eloquent has() deeper
You can use Eloquent has() function to query relationships even two layers deep!
// Author -> hasMany(Book::class);
// Book -> hasMany(Rating::class);
$authors = Author::has('books.ratings')->get();

Tip 14. Database migrations column types
There are interesting column types for migrations, here are a few examples.
$table->geometry('positions');
$table->ipAddress('visitor');
$table->macAddress('device');
$table->point('position');
$table->uuid('id');
See all column types: https://laravel.com/docs/master/migrations#creating-columns
Tip 15. Artisan command help
To check the options of artisan command, Run artisan commands with --help flag. For
example, php artisan make:model --help and see how many options you have:
Options:
-a, --all Generate a migration, factory, and resource controller for
the model
-c, --controller Create a new controller for the model
-f, --factory Create a new factory for the model
--force Create the class even if the model already exists.
-m, --migration Create a new migration file for the model.
-p, --pivot Indicates if the generated model should be a custom
intermediate table model.
-r, --resource Indicates if the generated controller should be a resource
controller.
-h, --help Display this help message
-q, --quiet Do not output any message
-V, --version Display this application version
--ansi Force ANSI output
--no-ansi Disable ANSI output
-n, --no-interaction Do not ask any interactive question
--env[=ENV] The environment the command should run under
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2
for more verbose output and 3 for debug

Tip 16. Default Timestamp
While creating migrations, you can use ->timestamp() column type with option
->useCurrent(), it will set CURRENT_TIMESTAMP as default value.
$table->timestamp('created_at')->useCurrent();
$table->timestamp('updated_at')->useCurrent();
Tip 17. Set logged in user with Observers
Use make:observer and fill in creating() method to automatically set up user_id field for
current logged in user.
class PostObserver
{
/**
* Handle to the post "creating" event.
*
* @param AppPost $post
* @return void
*/
public function creating(Post $post)
{
$post->user_id = auth()->id();
}
}
Tip 18. Soft-deletes: multiple restore
When using soft-deletes, you can restore multiple rows in one sentence.
Post::withTrashed()->where('author_id', 1)->restore();

Tip 19. Has Many. How many exactly?
In Eloquent hasMany() relationships, you can filter out records that have X amount of children
records.
// Author -> hasMany(Book::class)
$authors = Author::has('books', '>', 5)->get();
Tip 20. Image validation
While validating uploaded images, you can specify the dimensions you require.
'photo' => 'dimensions:max_width=4096,max_height=4096'
Tip 21. Wildcard subdomains
You can create route group by dynamic subdomain name, and pass its value to every route.
Route::domain('{username}.workspace.com')->group(function () {
Route::get('user/{id}', function ($username, $id) {
//
});
});
Tip 22. Exact Laravel version
Find out exactly what Laravel version you have in your app, by running command
php artisan --version

Tip 23. Testing email into laravel.log
If you want to test email contents in your app but unable or unwilling to set up something like
Mailgun, use .env parameter MAIL_DRIVER=log and all the email will be saved into
storage/logs/laravel.log file, instead of actually being sent.
Tip 24. Error code Blade pages
If you want to create a specific error page for some HTTP code, like 500 - just create a blade file
with this code as filename, in resources/views/errors/500.blade.php, or
403.blade.php etc, and it will automatically be loaded in case of that error code.
Tip 25. Factory callbacks
While using factories for seeding data, you can provide Factory Callback functions to perform
some action after record is inserted.
$factory->afterCreating(AppUser::class, function ($user, $faker) {
$user->accounts()->save(factory(AppAccount::class)->make());
});
Tip 26. Artisan command parameters
When creating Artisan command, you can ask the input in variety of ways: $this->confirm(),
$this->anticipate(), $this->choice().
// Yes or no?
if ($this->confirm('Do you wish to continue?')) {
//
}
// Open question with auto-complete options
$name = $this->anticipate('What is your name?', ['Taylor', 'Dayle']);
// One of the listed options with default index
$name = $this->choice('What is your name?', ['Taylor', 'Dayle'],
$defaultIndex);

Tip 27. Preview Mailables
If you use Mailables to send email, you can preview the result without sending, directly in your
browser. Just return a Mailable as route result:
Route::get('/mailable', function () {
$invoice = AppInvoice::find(1);
return new AppMailInvoicePaid($invoice);
});
Tip 28. Don't create Controllers
If you want route to just show a certain view, don't create a Controller method, just use
Route::view() function.
// Instead of this
Route::get('about', 'TextsController@about');
// And this
class TextsController extends Controller
{
public function about()
{
return view('texts.about');
}
}
// Do this
Route::view('about', 'texts.about');

Tip 29. Blade @auth
Instead of if-statement to check logged in user, use @auth directive.
Typical way:
@if(auth()->user())
// The user is authenticated.
@endif
Shorter:
@auth
// The user is authenticated.
@endauth
Tip 30. Model all: columns
When calling Eloquent's Model::all(), you can specify which columns to return.
$users = User::all(['id', 'name', 'email']);
Tip 31. Localhost in .env
Don't forget to change APP_URL in your .env file from http://localhost to real URL, cause
it will be the basis for any links in your email notifications and elsewhere.
APP_NAME=Laravel
APP_ENV=local
APP_KEY=base64:9PHz3TL5C4YrdV6Gg/Xkkmx9btaE93j7rQTUZWm2MqU=
APP_DEBUG=true
APP_URL=http://localhost

Tip 32: What's behind the routes?
Want to know what routes are actually behind Auth::routes()? Check the file
/vendor/laravel/framework/src/illuminate/Routing/Router.php.
Note that in Laravel 5.7 it also has a new option for verification emails.
public function auth(array $options = [])
{
// Authentication Routes...
$this->get('login', 'AuthLoginController@showLoginForm')->name('login');
$this->post('login', 'AuthLoginController@login');
$this->post('logout', 'AuthLoginController@logout')->name('logout');
// Registration Routes...
if ($options['register'] ?? true) {
$this->get('register',
'AuthRegisterController@showRegistrationForm')->name('register');
$this->post('register', 'AuthRegisterController@register');
}
// Password Reset Routes...
$this->get('password/reset',
'AuthForgotPasswordController@showLinkRequestForm')->name('password.request');
$this->post('password/email',
'AuthForgotPasswordController@sendResetLinkEmail')->name('password.email');
$this->get('password/reset/{token}',
'AuthResetPasswordController@showResetForm')->name('password.reset');
$this->post('password/reset',
'AuthResetPasswordController@reset')->name('password.update');
// Email Verification Routes...
if ($options['verify'] ?? false) {
$this->emailVerification();
}
}
public function emailVerification()
{
$this->get('email/verify',
'AuthVerificationController@show')->name('verification.notice');
$this->get('email/verify/{id}',
'AuthVerificationController@verify')->name('verification.verify');
$this->get('email/resend',
'AuthVerificationController@resend')->name('verification.resend');
}

Tip 33. To Fail or not to Fail
In addition to findOrFail(), there's also Eloquent method firstOrFail() which will return
404 page if no records for query are found.
$user = User::where('email',
'povilas@laraveldaily.com')->firstOrFail();
Tip 34. Column name change
in Eloquent Query Builder, you can specify "as" to return any column with a different name, just
like in plain SQL query.
$users = DB::table('users')
->select('name', 'email as user_email')
->get();
Tip 35. Logging with parameters
You can write Log::info(), or shorter info() message with additional parameters, for more
context about what happened.
Log::info('User failed to login.', ['id' => $user->id]);
Tip 36. Default Model
You can assign a default model in belongsTo relationship, to avoid fatal errors when calling it
like {{ $post->user->name }} if $post->user doesn't exist.
/**
* Get the author of the post.
*/
public function user()
{
return $this->belongsTo('AppUser')->withDefault();
}

Tip 37. Use hasMany to create Many
If you have hasMany() relationship, you can use saveMany() to save multiple "child" entries
from your "parent" object, all in one sentence.
$post = Post::find(1);
$post->comments()->saveMany([
new Comment(['message' => 'First comment']),
new Comment(['message' => 'Second comment']),
]);
Tip 38. More convenient DD
Instead of doing dd($result); you can put ->dd() as a method directly at the end of your
Eloquent sentence, or any Collection.
// Instead of
$users = User::where('name', 'Taylor')->get();
dd($users);
// Do this
$users = User::where('name', 'Taylor')->get()->dd();
Tip 39. Map query results
After Eloquent query you can modify rows by using map() function in Collections.
$users = User::where('role_id', 1)->get()->map(function (User $user) {
$user->some_column = some_function($user);
return $user;
});

Tip 40. Custom validation error messages
You can customize validation error messages per field, rule and language - just create a
specific language file resources/lang/xx/validation.php with appropriate array
structure.
'custom' => [
'email' => [
'required' => 'We need to know your e-mail address!',
],
],
Tip 41. When (NOT) to run “composer update”
Not so much about Laravel, but... Never run composer update on production, it's slow and will
"break" repository. Always run composer update locally on your computer, commit new
composer.lock to the repository, and run composer install on server.
Tip 42. Two-level $loop variable in Blade
In Blade's foreach you can use $loop variable even in two-level loop to reach parent variable.
@foreach ($user->posts as $post)
@if ($loop->parent->first)
This is first iteration of the parent loop.
@endif
@endforeach
@endforeach

Tip 43. How to avoid error in {{ $post->user->name }} if user is deleted?
You can assign a default model in belongsTo relationship, to avoid fatal errors when calling it like
{{ $post->user->name }} if $post->user doesn't exist.
/**
* Get the author of the post.
*/
public function user()
{
return $this->belongsTo('AppUser')->withDefault();
}
Tip 44. Load array of Views
You can load Blade views in array with view()->first($array), it will load only the first one
that actually exists. Useful when you may have custom file not generated for one of the "themes",
and provide a default fallback.
return view()->first(['custom.admin', 'admin'], $data);
Tip 45. Route Model Binding: You can define a key
You can do Route model binding like Route::get('api/users/{user}', function
(AppUser $user) { … } - but not only by ID field. If you want {user} to be a username
field, put this in the model:
public function getRouteKeyName() {
return 'username';
}

Tip 46. Redirect to Specific Controller Method
You can redirect() not only to URL or specific route, but to a specific Controller's specific
method, and even pass the parameters. Use this:
return redirect()->action('SomeController@method',
['param' => $value]);
Tip 47. Did you know about Auth::once()?
You can login with user only for ONE REQUEST, using method Auth::once(). No sessions or
cookies will be utilized, which means this method may be helpful when building a stateless API.
if (Auth::once($credentials)) {
//
}
Tip 48. Eager Loading with Exact Columns
You can do Laravel Eager Loading and specify the exact columns you want to get from the
relationship.
$users = AppBook::with('author:id,name')->get();
Tip 49. Validate dates with "now" or "yesterday" words
You can validate dates by rules before/after and passing various strings as a parameter, like:
"tomorrow", "now", "yesterday". Example: 'start_date' => 'after:now'. It's using
strtotime() under the hood.
$rules = [
'start_date' => 'after:tomorrow',
'end_date' => 'after:start_date'
];

Tip 50. Touch parent updated_at easily
If you are updating a record and want to update the updated_at column of parent relationship
(like, you add new post comment and want posts.updated_at to renew), just use $touches
= ['post']; property on child model.
class Comment extends Model
{
/**
* All of the relationships to be touched.
*
* @var array
*/
protected $touches = ['post'];
}
Tip 51. Quickly Navigate from Routes file to Controller
Instead of routing like this:
Route::get('page', 'PageController@action');
You can specify the Controller as a class:
Route::get('page',
[AppHttpControllersPageController::class, 'action']);
Then you will be able to click on “PageController” in PhpStorm, and navigate directly to
Controller, instead of searching for it manually.
Tip 52. Always Check if Relationship Exists
Never ever do $model->relationship->field without checking if relationship
object still exists.

It may be deleted for whatever reason, outside your code, by someone else's queued
job etc. Do if-else, or {{ $model->relationship->field ?? '' }} in
Blade.


Tip 53. Don’t Filter by NULL in Collections

You can filter by NULL in Eloquent, but if you're filtering the collection further - filter
by empty string, there's no "null" in that field anymore.

// This works
$messages = Message::where('read_at is null')->get();
// Won’t work - will return 0 messages
$messages = Message::all();
$unread_messages = $messages->where('read_at is null')->count();
// Will work
$unread_messages = $messages->where('read_at', '')->count();

Tip 54. Default Email Subject in Laravel Notifications

If you send Laravel Notification and don't specify subject in toMail(), default subject
is your notification class name, CamelCased into Spaces.

So, if you have:
class UserRegistrationEmail extends Notification { // ...

Then you will receive an email with subject “User Registration Email”.

Tip 55. Composer: Check for Newer Versions

If you want to find out which of your composer.json packages have released newer
versions, just run "composer outdated". You will get a full list with all information, like
this below.

phpdocumentor/type-resolver 0.4.0 0.7.1
phpunit/php-code-coverage 6.1.4 7.0.3 Library that provides collection, processing, and rende...
phpunit/phpunit 7.5.9 8.1.3 The PHP Unit Testing framework.
ralouphie/getallheaders 2.0.5 3.0.3 A polyfill for getallheaders.
sebastian/global-state 2.0.0 3.0.0 Snapshotting of global state


Tip 56. Route Fallback - When no Other Route is Matched

If you want to specify additional logic for not-found routes, instead of just throwing
default 404 page, you may create a special Route for that, at the very end of your
Routes file.

Route::group(['middleware' => ['auth'], 'prefix' => 'admin', 'as' =>
'admin.'], function () {
Route::get('/home', 'HomeController@index');
Route::resource('tasks', 'AdminTasksController');
});
// Some more routes....
Route::fallback(function() {
return 'Hm, why did you land here somehow?';
});

Tip 57. Create Your Own Blade Directive

It’s very easy - just add your own method in app/Providers/AppServiceProvider.php:
For example, if you want to have this for replace <br> tags with new lines:

<textarea>@br2nl($post->post_text)</textarea>

Add this directive to AppServiceProvider’s boot() method:

public function boot()
{
Blade::directive('br2nl', function ($string) {
return "<?php echo preg_replace('/<br(s*)?/?>/i', "n",
$string); ?>";
});
}


Tip 58. Use withCount() to Calculate Child Relationships Records

If you have hasMany() relationship, and you want to calculate “children” entries, don’t
write a special query. For example, if you have posts and comments on your User
model, write this withCount():

public function index()
{
$users = User::withCount(['posts', 'comments'])->get();
return view('users', compact('users'));
}

And then, in your Blade file, you will access those number with [relationship]_count
properties:

<tr>
<td>{{ $user->name }}</td>
<td class="text-center">{{ $user->posts_count }}</td>
<td class="text-center">{{ $user->comments_count }}</td>
</tr>
@endforeach

Tip 59. Use groupBy on Collections with Custom Callback Function

If you want to group result by some condition whith isn’t a direct column in your
database, you can do that by providing a closure function.

For example, if you want to group users by day of registration, here’s the code:

$users = User::all()->groupBy(function($item) {
return $item->created_at->format('Y-m-d');
});

Notice: it is done on a Collection class, so performed AFTER the results are fetched
from the database.


Tip 60. Blade Directives: IncludeIf, IncludeWhen, IncludeFirst

If you are not sure whether your Blade partial file actually would exist, you may use
these condition commands:

This will load header only if Blade file exists
@includeIf('partials.header')

This will load header only for user with role_id 1
@includeWhen(auth()->user()->role_id == 1, 'partials.header')

This will try to load adminlte.header, if missing - will load default.header
@includeFirst('adminlte.header', 'default.header')

To be continued…
Follow @DailyLaravel on Twitter for updates
Or subscribe to our weekly newsletter:
http://bit.ly/laravel-newsletter

Laravel tips-2019-04

More Related Content

What's hot (20)

Similar to Laravel tips-2019-04 (20)

Recently uploaded (20)

Laravel tips-2019-04