Difference between method calls $model->relation(); and $model->relation;

by

Short answer

$model->relation() returns the relationship object

$model->relation returns the result of the relationship

Long answer

$model->relation() can be explained pretty simple. You’re calling the actual function you defined your relation with. Yours for distributor probably looks somewhat like this:

public function distributors(){
    return $this->hasMany('Distributor');
}

So when calling $store->distributors() you just get the return value of $this->hasMany('Distributor') which is an instance of Illuminate\Database\Eloquent\Relations\HasMany

When do you use it?

You usually would call the relationship function if you want to further specify the query before you run it. For example add a where statement:

$distributors = $store->distributors()->where('priority', '>', 4)->get();

Of course you can also just do this: $store->distributors()->get() but that has the same result as $store->distributors.

Which brings me to the explanation of the dynamic relationship property.

Laravel does some things under the hood to allow you to directly access the results of a relationship as property. Like: $model->relation.

Here’s what happens in Illuminate\Database\Eloquent\Model

1) The properties don’t actually exist. So if you access $store->distributors the call will be proxied to __get()

2) This method then calls getAttribute with the property name getAttribute('distributors')

public function __get($key)
{
    return $this->getAttribute($key);
}

3) In getAttribute it checks if the relationship is already loaded (exists in relations). If not and if a relationship method exists it will load the relation (getRelationshipFromMethod)

public function getAttribute($key)
{
    // code omitted for brevity

    if (array_key_exists($key, $this->relations))
    {
        return $this->relations[$key];
    }

    $camelKey = camel_case($key);

    if (method_exists($this, $camelKey))
    {
        return $this->getRelationshipFromMethod($key, $camelKey);
    }
}

4) In the end Laravel calls getResults() on the relation which then results in a get() on the query builder instance. (And that gives the same result as $model->relation()->get().

More Related Contents:

  1. Get first and second element of array [duplicate]
  2. Json array to json php
  3. Passing an Array as Arguments, not an Array, in PHP
  4. array_unique for objects?
  5. laravel collection to array
  6. PHP create new array by value
  7. count how many duplicate keys are in array of objects?
  8. Property Property Property [title] does not exist on this collection instance does not exist on this collection instance does not exist on this collection instance
  9. PHP Sort Array By SubArray Value
  10. Using a string path to set nested array data [duplicate]
  11. Laravel Eloquent Query Using WHERE with OR AND OR?
  12. How to get random value out of an array?
  13. Visual Studio Code PHP Intelephense Keep Showing Not Necessary Error
  14. How do I redirect after download in Laravel?
  15. Get the keys for duplicate values in an array
  16. Efficiently pick n random elements from PHP array (without shuffle)
  17. How to sort an array of arrays in php?
  18. PHP get index of last inserted item in array
  19. “No such file or directory” or “No such host is known” when running migrations
  20. Search and replace multiple values with multiple/different values in PHP5?
  21. Laravel form html with PUT method for PUT routes
  22. How to create a subquery using Laravel Eloquent?
  23. Efficiency of using foreach loops to clear a PHP array’s values
  24. Eloquent model mass update
  25. how to sort a multidemensional array by an inner key
  26. Find or Create with Eloquent
  27. PHP – How to send an array to another page?
  28. laravel – Can’t get session in controller constructor
  29. Array size limit in PHP
  30. Method Chains PHP OOP

Leave a Comment