Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?

UsedByTeams Model Trait For Laravel Spark

Automatically limit your models to the current team

So you're using spark, and you have teams enabled. You start creating models and want to have them be team specific. Instead of writing, Model::where('team_id', auth()->user()->currentTeam->id)->get(); use this trait to add that behind the scenes so that every time you call on your model, it's assumed that you mean for the current team.

This assumes that the model has a team_id, while it adds a scope of where team_id = currentTeam->id.

Note: Implicit Route Model Binding in 5.2, auth session doesn't exist at the point of this trait causing issue. fixed in 5.3


Setup

Make a file, namespaced etc Add use UsedByTeams to your model

<?php

namespace App\Traits;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;

trait UsedByTeams
{
	protected static function boot()
    {
        parent::boot();
            
        static::addGlobalScope('team', function(Builder $builder)
        {
            static::teamGuard();

            $builder->where('team_id', auth()->user()->currentTeam->id);
        });

        static::saving(function (Model $model)
        {
            static::teamGuard();
            
            if( ! isset($model->team_id))
            {
                $model->team_id = auth()->user()->currentTeam->id;                
            }
        });
    }

    public function scopeAllTeams($query)
    {
    	return $query->withoutGlobalScope('team');
    }

    public function team()
    {
    	return $this->belongsTo('App\Team');
    }

    protected static function teamGuard()
    {
        if(auth()->guest() || ! auth()->user()->currentTeam)
        {
            throw new \Exception('No Auth User/Team');
        }
    }
}

Usage


<?php

namespace App;

use App\Traits\UsedByTeams;
use Illuminate\Database\Eloquent\Model;

class Task extends Model
{
	use UsedByTeams;
}

Methods

// gets current teams tasks

Task::all();

// automaticly adds current team_id 

Task::create();

// gets all tasks / all teams globally

Task::allTeams()->get();

// get all tasks with task's team eagerloaded

Task::allTeams()->with('team')->get();
@tnorthcutt

This comment has been minimized.

Copy link

commented Aug 25, 2016

First off: thanks for sharing this, it's been super helpful!

I've run into an issue with it where trying to do things via API or with artisan commands returns this:

[Exception]
  No Auth User/Team

Commenting out most of UsedByTeams.php resolves the issue, but obviously that's a kludgy workaround that is best avoided. Do you have any tips on how to more selectively apply or disable the trait so this isn't an issue?

@parweb

This comment has been minimized.

Copy link

commented Nov 18, 2016

@tnorthcutt i think it's because when you do ajax it doesn't know that your are loggin.
In other words it can't read the session variable.

You need to pass the api_key or the internal TOKEN like vuejs do in spark kiosks

@xplodedthemes

This comment has been minimized.

Copy link

commented Dec 23, 2017

What about queued jobs ? Since jobs do not care about Authentication or sessions, if a job requires to perform some action on scoped models, it will fail. Not sure if it's a good idea to pass the user & team id to the job and authenticate before each job handling. Especially if jobs are being processed under a daemon, it's not reliable at all to use sessions within a job.
This has been driving me crazy for weeks now, any help on what should be the proper way of using this with queued jobs would be very much appreciated :/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.