Getting all users with a specific role when using teams

[mohammad-azzam-dev]

I was using the teams feature in spatie's roles and permissions but I figured out that when using this function:
Users::role('role1')->get();

it only returns the users with role1 who are associated with the team id set in the session

my question: how can I get all of the users of different teams?

[erikn69]

Make your own relation

// User model
public function roles_all(): BelongsToMany
{
    return $this->morphToMany(
        config('permission.models.role'),
        'model',
        config('permission.table_names.model_has_roles'),
        config('permission.column_names.model_morph_key'),
        PermissionRegistrar::$pivotRole
    );
}
// get all users with a specific role
Users::whereHas('roles_all', fn($query) => $query->whereIn("name", ['role1']))->get();
// or 
Users::whereRelation('roles_all', "name", 'role1')->get();
// Also, you could get all roles, from all teams with this
Users::with('roles_all')->get();

[mohammad-azzam-dev]

thank you

[mohammad-azzam-dev]

yes off course I'll try it and get back with you

[mohammad-azzam-dev]

it worked, but you should remove the expected return BelongsToMany and assign it to morphToMany and it works or remove it

please modify the function so I can set that its the answer and thank you

[erikn69]

remove the expected return BelongsToMany

It's PHP 8 best practice, you're supposed to add the declaration, not remove the return type

laravel-permission/src/Traits/HasRoles.php

Line 6 in 6a3ed62

use Illuminate\Database\Eloquent\Relations\BelongsToMany;

laravel-permission/src/Traits/HasRoles.php

Line 43 in 6a3ed62

public function roles(): BelongsToMany

[mohammad-azzam-dev]

ok great and thanks

[sts-ryan-holton]

@erikn69 How could I join the "team ID" model to this via my controller? I thought something like this might work but it doesn't:

$user = $user->load([
    'roles_all' => function ($query) {
        $query->join('companies', function ($join) {
            $join->on('roles_all.company_id', '=', 'companies.id');
        });
    }
]);

[erikn69]

$user = $user->load([
    'roles_all' => function ($query) {
        $query->leftJoin('companies', function ($join) {
            $join->on(config('permission.table_names.roles').'.company_id', '=', 'companies.id');
        });
    }
]);

[erikn69]

Any ideas why I don't see my company relationship within the role?

Add a select to the query for get the data,
or if you want the company model make a relationship on Role Model, and nest it

[sts-ryan-holton]

@erikn69 Thanks for your reply. I've given this a go, it doesn't give me any errors, this is my code now:

$user = $user->load([
    'roles_all' => function ($query) {
        $query->leftJoin('companies', function ($join) {
            $join->on(config('permission.table_names.roles').'.company_id', '=', 'companies.id');
        });
    }
]);

Any ideas why I don't see my company relationship within the role?