Summary

The article advises against using the empty function to check if a Laravel collection is empty and recommends using the isEmpty or isNotEmpty methods instead.

Abstract

The Laravel collection is a versatile data structure that enhances PHP arrays with a variety of methods to facilitate operations such as searching, filtering, and looping. However, developers should be cautious when checking for an empty collection. Instead of using the empty function, which may not work as expected due to the collection's internal structure, it is recommended to use the isEmpty or isNotEmpty methods provided by the Laravel collection class. These methods directly check the collection's items, ensuring accurate results. Additionally, the article suggests using collection-specific methods like toArray for conversion and count for determining the number of items, instead of relying on PHP's native array functions. The article emphasizes that understanding how collection functions work is crucial for effective use of Laravel collections.

Opinions

The author believes that using the empty function on a Laravel collection can lead to incorrect assumptions about whether the collection is empty.
It is implied that using collection-specific methods like isEmpty, isNotEmpty, and count is more reliable and idiomatic in Laravel applications.
The author suggests that developers should avoid using native PHP array functions such as empty and count on collections, as they may not interact correctly with the collection's internal array of items.
The author encourages developers to refer to the Laravel collection documentation and the source code for a deeper understanding of how collection methods are implemented.
There is an emphasis on the benefits of using Laravel collections, highlighting their convenience and the additional functionality they provide over standard PHP arrays.

Don’t do this mistake in the Laravel collection

Avoid using the empty function in the Laravel collection

Photo by Mark Fletcher-Brown on Unsplash

The Laravel collection is a wrapper of a PHP array. In Laravel world, it was a new data type created based on the array. The Illuminate\Support\Collection class provides the Laravel collection. Also, the Laravel Eloquent methods will return the collection instance.

The results of Eloquent queries are always returned as Collection instances.

Compare to the array, the collection methods make your life easier. Click here to check the available collection methods on the Laravel document.

Thecollect helper is used to creating the collection based on the given array.

$collection = collect([1, 2, 3]);

dd($collection);

If will get the below result when you print the collection.

Before checking the empty function issue, I am going to clarify some common questions in the Laravel collection.

Can we use foreach iterators?

Yes, we can use foreach instead of each method for the collection.

$collection = collect([1, 2, 3]);

foreach ($collection as $data) {
    echo $data;
}

$collection->each(function ($item) {
    echo $item;
});

Try Medium new feature of a code block with Syntax highlighter

Syntax highlighter on Medium

balajidharma.medium.com

How to convert the PHP collection to an array?

The toArray() function converts the collection into a plain PHP array.

$collection = collect([1, 2, 3]);
$array_colection = $collection->toArray();
dd($array_colection);

We know the array method foreach is working fine with the collection. But all the array methods we can't use with the collection.

Don’t use the empty

The most common mistake is checking collection is empty by using the empty method. Below the example, created an empty collection and added an if statement to check the collection is empty.

$collection = collect([]);

if(empty($collection)) {
    dd('collection is empty');
}

Also, don’t use the empty for Eloquent result

$users = User::where('active', 1)->get();

if(empty($users)) {
    dd('collection is empty');
}

The collection is empty but it does not pass the conditional statement. Because the collection is not empty, because it has the empty items array. Let’s print the empty collection.

$collection = collect([]);
dd($collection);

So use the isEmpty() or isNotEmpty() collection methods to check the collections.

$collection = collect([]);

if($collection->isEmpty()) {
    dd('collection is empty');
}

if($collection->isNotEmpty()) {
    dd('collection is empty');
}

Can we use count and isset?

I faced an issue with an empty function. So I decided to test with count and isset functions.

$collection = collect(['name' => 'Balaji']);

if(isset($collection['name'])) {
    dd($collection);
}

The isset() function is working as expected.

$collection = collect([1, 2, 3]);

if(count($collection) > 2) {
    dd(count($collection));
}

Yes, the array count method also worked fine. But better to use the collection count() to get the count.

$collection = collect([1, 2, 3]);

if($collection->count() > 2) {
    dd($collection->count());
}

Conclusion

We know the collection is a wrapper of the array. Also, the collection has a lot of functions and it makes it easy to search, filter, loop, find, etc.,

So my suggestion is don’t try the empty, count, and isset with collections. Use the corresponding collection functions like $collection->isEmpty() $collection->count()

How are collection functions are working?

Do you think how is collection function $collection->isEmpty() $collection->count() is working? The answer is collection also uses array functions, but they use array functions for collection items.

This below collection function is declared on Illuminate\Support\Collection

   /**
     * Determine if the collection is empty or not.
     *
     * @return bool
     */
    public function isEmpty()
    {
        return empty($this->items);
    }


    /**
     * Count the number of items in the collection.
     *
     * @return int
     */
    public function count(): int
    {
        return count($this->items);
    }

Refer to the file: https://github.com/laravel/framework/blob/master/src/Illuminate/Collections/Collection.php

Thank you for reading.

Stay tuned for more!

Follow me at balajidharma.medium.com.