Cut PHP Code Review Time & Bugs into Half with CodeRabbit

Using the Laravel Optional Helper and the New Optional Closure

Published on by

Using the Laravel Optional Helper and the New Optional Closure image

The Laravel Optional class and accompanying optional helper were introduced in Laravel 5.5. This class is useful to avoid those pesky Trying to get property of non-object errors in your code.

Joseph Sibler submitted an improvement to the Laravel optional helper that we covered in Laravel 5.6.13 which now allows a closure that is only called when the object is not null:

???? The "optional" helper in @laravelphp is great for safely calling a method on an object that could be null. But what if the method is not on the actual object itself?

Well now you can pass in a closure to "optional", and it'll only call it if the given object is not null ???? pic.twitter.com/0RIbUffuOY

— Joseph Silber (@joseph_silber) April 5, 2018

His example demonstrates how the usage of the optional() helper differs slightly for use-cases where you want data from another source, but only in the case of a non-null value:

return optional(User::find($id), function ($user) {
return TwitterApi::findUser($user->twitter_id);
});

Optional vs Null Coalesce

We recently wrote about updating your Blade templates to the PHP7 null coalesce operator in preparation for Laravel 5.7, but clearly the optional() still has a place, especially for more advanced needs where you can cleanly only access the data you desire if the value isn’t null.

So when do you need the optional() or the null coalesce operator?

If you only care about returning null when a value doesn’t exist, optional is not redundant:

// null coalesce
return $user->profile->twitter_id ?? null;
 
// optional
return optional($user->profile)->twitter_id;

The two code examples accomplish the same thing. However, you must explicitly return null and use null coalesce to avoid an Undefined property notice, and the second example shows intent that the value is optionally available.

If you want a default value, null coalesce is a better choice:

return $user->profile->nickname ?? randomNickname();

The goal of the optional is to return null and avoid non-object errors in the process, without verbose code to check the object.

Learn More

We wrote about Five Laravel Helpers to Make Your Life Easier which includes the optional helper, and other useful helpers that might be helpful (pun intended).

If you want inspiration from other sources about the concept of optional, an Optional class exists in Java (introduced in Java 8), which can be used to avoid null pointer exceptions. The Java Optional API has some interesting methods you might want to explore.

Paul Redmond photo

Staff writer at Laravel News. Full stack web developer and author.

Cube

Laravel Newsletter

Join 40k+ other developers and never miss out on new tips, tutorials, and more.

image
Tinkerwell

Enjoy coding and debugging in an editor designed for fast feedback and quick iterations. It's like a shell for your application – but with multi-line editing, code completion, and more.

Visit Tinkerwell
Curotec logo

Curotec

World class Laravel experts with GenAI dev skills. LATAM-based, embedded engineers that ship fast, communicate clearly, and elevate your product. No bloat, no BS.

Curotec
Bacancy logo

Bacancy

Supercharge your project with a seasoned Laravel developer with 4-6 years of experience for just $2500/month. Get 160 hours of dedicated expertise & a risk-free 15-day trial. Schedule a call now!

Bacancy
Laravel Forge logo

Laravel Forge

Easily create and manage your servers and deploy your Laravel applications in seconds.

Laravel Forge
Tinkerwell logo

Tinkerwell

The must-have code runner for Laravel developers. Tinker with AI, autocompletion and instant feedback on local and production environments.

Tinkerwell
Cut PHP Code Review Time & Bugs into Half with CodeRabbit logo

Cut PHP Code Review Time & Bugs into Half with CodeRabbit

CodeRabbit is an AI-powered code review tool that specializes in PHP and Laravel, running PHPStan and offering automated PR analysis, security checks, and custom review features while remaining free for open-source projects.

Cut PHP Code Review Time & Bugs into Half with CodeRabbit
Join the Mastering Laravel community logo

Join the Mastering Laravel community

Connect with experienced developers in a friendly, noise-free environment. Get insights, share ideas, and find support for your coding challenges. Join us today and elevate your Laravel skills!

Join the Mastering Laravel community
Kirschbaum logo

Kirschbaum

Providing innovation and stability to ensure your web application succeeds.

Kirschbaum
Shift logo

Shift

Running an old Laravel version? Instant, automated Laravel upgrades and code modernization to keep your applications fresh.

Shift
Lucky Media logo

Lucky Media

Get Lucky Now - the ideal choice for Laravel Development, with over a decade of experience!

Lucky Media
Lunar: Laravel E-Commerce logo

Lunar: Laravel E-Commerce

E-Commerce for Laravel. An open-source package that brings the power of modern headless e-commerce functionality to Laravel.

Lunar: Laravel E-Commerce
LaraJobs logo

LaraJobs

The official Laravel job board

LaraJobs
SaaSykit: Laravel SaaS Starter Kit logo

SaaSykit: Laravel SaaS Starter Kit

SaaSykit is a Multi-tenant Laravel SaaS Starter Kit that comes with all features required to run a modern SaaS. Payments, Beautiful Checkout, Admin Panel, User dashboard, Auth, Ready Components, Stats, Blog, Docs and more.

SaaSykit: Laravel SaaS Starter Kit

The latest

View all →
Streamline Conditional Logic with Laravel's Fluent Conditionable Trait image

Streamline Conditional Logic with Laravel's Fluent Conditionable Trait

Read article
Sublime Text Releases Update With Support for Right Sidebar image

Sublime Text Releases Update With Support for Right Sidebar

Read article
Enhance Email Validation with Laravel's Fluent Email Rule Object image

Enhance Email Validation with Laravel's Fluent Email Rule Object

Read article
Locale-aware Number Parsing in Laravel 12.15 image

Locale-aware Number Parsing in Laravel 12.15

Read article
Handle Fluent Values as Arrays with Laravel's array() Method image

Handle Fluent Values as Arrays with Laravel's array() Method

Read article
Chargebee Starter Kit for Billing in Laravel image

Chargebee Starter Kit for Billing in Laravel

Read article