PHPDoc for conditional polymorphic call

Question

For $item there's a polymorphic loggable relationship. In the database this is stored in items as loggable_type and loggable_id (for PHP 8+ in and Laravel).

for($items as $item) {
    // ...

    if ($item->loggable_type === Comment::class) {
        $item->loggable->resetDates();
    }

    // ...
}

I'm trying to type hint that loggable within the condition is a Comment. I think I might be able to user @var but doing something like /* @var $item->loggable Comment */ doesn't work and I can't do /* @var $item Comment */ since that sets it to $item and not its property.

I'm thinking of changing the condition to if ($item->loggable instance of Comment), however I'd rather not since that requires loading and creating the Comment even if it's not used.

Is there a way to type hint $item->loggable as Comment?

Justinas · Accepted Answer · 2023-07-28 12:56:12Z

1

Assign it to variable

for($items as $item) {
    if ($item->loggable_type === Comment::class) {
        /** @var Comment $loggable */
        $loggable = $item->loggable;
        
        $loggable->resetDates();
    }
}

answered Jul 28, 2023 at 12:56

Justinas

43.9k5 gold badges72 silver badges108 bronze badges

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

Comments

matiaslauriti · Accepted Answer · 2023-07-28 23:58:38Z

1

As @Justinas stated, either assign it to a variable:

for ($items as $item) {
    if ($item->loggable_type === Comment::class) {
        /** @var Comment $loggable */
        $loggable = $item->loggable;
        
        $loggable->resetDates();
    }
}

Or set the possible values you could have (if they are fixed and known) on the model itself like this:

/**
 * @property Comment|WhateverModel|Model $loggable
 */
class Item extends Model
{
   // ...
}

That will tell the IDE that the property loggable is possibly a Comment object, WhateverModel object, or Model object (so you still have normal Model's methods auto-completion).

If you can narrow down which classes you could have there, then add them, else I would go with the first option (assign a value and use a PHPDoc block for a variable)

answered Jul 28, 2023 at 23:58

matiaslauriti

8,2004 gold badges37 silver badges48 bronze badges

1 Comment

Patrick Nomad Over a year ago

Interesting second approach. Having a kind of ide helper/stub to type hint.

Collectives™ on Stack Overflow

PHPDoc for conditional polymorphic call

2 Answers 2

Comments

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related