Relations in a trait will be detected as a 'magic' method

rabol

In this case the $invite is of type TeamInvite, this model is extended form a model that is in a package, and that model have a trait that defines the relationship to team like this:

class TeamInvite extends \Mpociot\Teamwork\TeamInvite

\Mpociot\Teamwork\TeamInvite has this:

 use TeamworkTeamInviteTrait;

and in the trait you have this:

    public function team()
    {
        return $this->hasOne(Config::get('teamwork.team_model'), 'id', 'team_id');
    }

JakubMisek

rabol in the screenshot, ->team is used as a property, but the trait TeamworkTeamInviteTrait defines team() as a method.

rabol

Yes, that is 'normal' in Laravel, when using the ->team() you will get a Builder object back, when using ->team you will get the related record back

https://laravel.com/docs/12.x/eloquent-relationships

JakubMisek

rabol I wasn't aware! Will be implemented.

JakubMisek

rabol Is there a common annotation that we can use to determine the type of ->team?

For example:

/**
  * @return HasOne<Team>
  */
public function team() {
    return $this->hasOne(Config::get('teamwork.team_model'), 'id', 'team_id');
}

then we could infer that ->team is of type Team.

rabol

yes this is one way.

I normally do this:

public function team(): HasOne 
{
    return $this->hasOne(Config::get('teamwork.team_model'), 'id', 'team_id');
}

JakubMisek

rabol I see. From this, we won't be able to resolve the type of $invite->team though.

rabol

If the phpdoc block works, then that's fine, that I can add to my own code, the issue is if one uses a package that does not add the phpdoc block

JakubMisek

rabol Yes, you're right. If there won't be a PHPDoc with the type, the editor won't be able to infer the type of the dynamic property.