laravel: function in model must return a relationship instance

I try to build a path for a model on laravel

I created a function in my model:

public function path()
{
    return App\Helper\GeneralController::getURL($this);
}

with dd(App\Helper\GeneralController::getURL($this)) test I got the right answer. (output is a URL)

but in view with the call: $article->path I get this error:

App\Article:: path must return a relationship instance.

What is wrong?

Solution 1:

You need to call it:

$article->path()

When you do $article->path, you're trying to use Eloquent relationship which you don't have.

Solution 2:

I know this has already been answered and accepted. However, if the OP did want to use a property accessor rather than a method use the "get{property name}Attribute" syntax of Laravel to create a custom attribute.

Here is what it would look like for this specific case:

public function getPathAttribute()
{
    return App\Helper\GeneralController::getURL($this);
}

using this approach "path" can now be called as an attribute and will not be resolved to a relationship using the syntax:

$article->path;