Laravel PHP Traits with models

Question

I have a PHP trait that I will use in any model that can do a certain set of actions. For example one of these actions is completion where completed_at is marked with a timestamp.

The trait method is:

/**
 * @return $this
 * @throws Exception
 */
public function markCompleted(){
    if($this->canDoAction('complete')){
        $this->completed_at = Carbon::now();
        return $this;
    }
}

In my controller I am calling this on a model that can do this action like below.

$app->markCompleted()->save();

The $app when I view its contents it is not null.

Running this command returns an error like

local.ERROR: Call to a member function save() on null

Wouldn't $this represent the model that uses this trait?

If the condition doesn't meet then null will be returned.

The Alpha
– The Alpha

2018-06-01 20:48:04 +00:00
Commented Jun 1, 2018 at 20:48 — The Alpha
– The Alpha, Commented Jun 1, 2018 at 20:48

Turtle1363 · Accepted Answer · 2018-06-01 23:26:15Z

1

Another variation on what The Alpha said.

/**
 * @return $this
 * @throws Exception
 */
public function markCompleted(){
    if($this->canDoAction('complete')){
        $this->completed_at = Carbon::now();
    }
    return $this;
}

This way you always return a model, and you can chain other functions before the save is performed if you needed.

answered Jun 1, 2018 at 23:26

Turtle1363

3316 silver badges16 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

The Alpha · Accepted Answer · 2018-06-01 20:53:50Z

0

If the condition doesn't meet then null will be returned, so instead of calling the save separately, do that inside that method, for example:

public function markCompleted()
{
    if ($this->canDoAction('complete')) {
        $this->completed_at = Carbon::now();
        return $this->save(); // true/false
    }
}

Then use it like:

$app->markCompleted();

The way way, you coded, the save method will be called even if the condition doesn't match and that's a side effect.

answered Jun 1, 2018 at 20:53

The Alpha

147k30 gold badges294 silver badges313 bronze badges

Collectives™ on Stack Overflow

Laravel PHP Traits with models

2 Answers 2

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related