UserHasTeams::teams() - Code Metrics - mpociot/teamwork - Measure and Improve Code Quality continuously with Scrutinizer

UserHasTeams::teams() A
last analyzed 2021-02-16 10:30 UTC

↳ Parent: UserHasTeams

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

namespace Mpociot\Teamwork\Traits;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Support\Facades\Config;
use Mpociot\Teamwork\Events\UserJoinedTeam;
use Mpociot\Teamwork\Events\UserLeftTeam;
use Mpociot\Teamwork\Exceptions\UserNotInTeamException;

trait UserHasTeams
{
    /**
     * Many-to-Many relations with the user model.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
     */
    public function teams()
    {
        return $this->belongsToMany(Config::get('teamwork.team_model'), Config::get('teamwork.team_user_table'), 'user_id', 'team_id')->withTimestamps();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * has-one relation with the current selected team model.
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasOne
     */
    public function currentTeam()
    {
        return $this->hasOne(Config::get('teamwork.team_model'), 'id', 'current_team_id');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * @return mixed
     */
    public function ownedTeams()
    {
        return $this->teams()->where('owner_id', '=', $this->getKey());
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * One-to-Many relation with the invite model.
     * @return mixed
     */
    public function invites()
    {
        return $this->hasMany(Config::get('teamwork.invite_model'), 'email', 'email');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Boot the user model
     * Attach event listener to remove the many-to-many records when trying to delete
     * Will NOT delete any records if the user model uses soft deletes.
     *
     * @return void|bool
     */
    public static function bootUserHasTeams()
    {
        static::deleting(function (Model $user) {
            if (! method_exists(Config::get('teamwork.user_model'), 'bootSoftDeletes')) {
                $user->teams()->sync([]);
            }

            return true;
        });
    }

    /**
     * Returns if the user owns a team.
     *
     * @return bool
     */
    public function isOwner()
    {
        return ($this->teams()->where('owner_id', '=', $this->getKey())->first()) ? true : false;
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Wrapper method for "isOwner".
     *
     * @return bool
     */
    public function isTeamOwner()
    {
        return $this->isOwner();
    }

    /**
     * @param $team
     * @return mixed
     */
    protected function retrieveTeamId($team)
    {
        if (is_object($team)) {
            $team = $team->getKey();
        }
        if (is_array($team) && isset($team['id'])) {
            $team = $team['id'];
        }

        return $team;
    }

    /**
     * Returns if the user owns the given team.
     *
     * @param mixed $team
     * @return bool
     */
    public function isOwnerOfTeam($team)
    {
        $team_id = $this->retrieveTeamId($team);

        return ($this->teams()
            ->where('owner_id', $this->getKey())
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            ->where('team_id', $team_id)->first()
        ) ? true : false;
    }

    /**
     * Alias to eloquent many-to-many relation's attach() method.
     *
     * @param mixed $team
     * @param array $pivotData
     * @return $this
     */
    public function attachTeam($team, $pivotData = [])
    {
        $team = $this->retrieveTeamId($team);
        /*
         * If the user has no current team,
         * use the attached one
         */
        if (is_null($this->current_team_id)) {
            $this->current_team_id = $team;
class MyClass { }

$x = new MyClass();
$x->foo = true;
            $this->save();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

            if ($this->relationLoaded('currentTeam')) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                $this->load('currentTeam');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            }
        }

        // Reload relation
        $this->load('teams');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        if (! $this->teams->contains($team)) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
            $this->teams()->attach($team, $pivotData);

            event(new UserJoinedTeam($this, $team));

            if ($this->relationLoaded('teams')) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                $this->load('teams');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            }
        }

        return $this;
    }

    /**
     * Alias to eloquent many-to-many relation's detach() method.
     *
     * @param mixed $team
     * @return $this
     */
    public function detachTeam($team)
    {
        $team = $this->retrieveTeamId($team);
        $this->teams()->detach($team);

        event(new UserLeftTeam($this, $team));

        if ($this->relationLoaded('teams')) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            $this->load('teams');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }

        /*
         * If the user has no more teams,
         * unset the current_team_id
         */
        if ($this->teams()->count() === 0 || $this->current_team_id === $team) {
            $this->current_team_id = null;
            $this->save();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

            if ($this->relationLoaded('currentTeam')) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                $this->load('currentTeam');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            }
        }

        return $this;
    }

    /**
     * Attach multiple teams to a user.
     *
     * @param mixed $teams
     * @return $this
     */
    public function attachTeams($teams)
    {
        foreach ($teams as $team) {
            $this->attachTeam($team);
        }

        return $this;
    }

    /**
     * Detach multiple teams from a user.
     *
     * @param mixed $teams
     * @return $this
     */
    public function detachTeams($teams)
    {
        foreach ($teams as $team) {
            $this->detachTeam($team);
        }

        return $this;
    }

    /**
     * Switch the current team of the user.
     *
     * @param object|array|int $team
     * @return $this
     * @throws ModelNotFoundException
     * @throws UserNotInTeamException
     */
    public function switchTeam($team)
    {
        if ($team !== 0 && $team !== null) {
            $team = $this->retrieveTeamId($team);
            $teamModel = Config::get('teamwork.team_model');
            $teamObject = ( new $teamModel() )->find($team);
            if (! $teamObject) {
                $exception = new ModelNotFoundException();
                $exception->setModel($teamModel);
                throw $exception;
            }
            if (! $teamObject->users->contains($this->getKey())) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                $exception = new UserNotInTeamException();
                $exception->setTeam($teamObject->name);
                throw $exception;
            }
        }
        $this->current_team_id = $team;
        $this->save();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        if ($this->relationLoaded('currentTeam')) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            $this->load('currentTeam');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }

        return $this;
    }
}


1			<?php
2
3			namespace Mpociot\Teamwork\Traits;
4
5			use Illuminate\Database\Eloquent\Model;
6			use Illuminate\Database\Eloquent\ModelNotFoundException;
7			use Illuminate\Support\Facades\Config;
8			use Mpociot\Teamwork\Events\UserJoinedTeam;
9			use Mpociot\Teamwork\Events\UserLeftTeam;
10			use Mpociot\Teamwork\Exceptions\UserNotInTeamException;
11
12			trait UserHasTeams
13			{
14			/**
15			* Many-to-Many relations with the user model.
16			*
17			* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
18			*/
19			public function teams()
20			{
21			return $this->belongsToMany(Config::get('teamwork.team_model'), Config::get('teamwork.team_user_table'), 'user_id', 'team_id')->withTimestamps();
			0 ignored issues – show Bug introduced 2016-01-04 21:47 UTC by Report Bug Copy Issue Report It seems like `belongsToMany()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
22			}
23
24			/**
25			* has-one relation with the current selected team model.
26			*
27			* @return \Illuminate\Database\Eloquent\Relations\HasOne
28			*/
29			public function currentTeam()
30			{
31			return $this->hasOne(Config::get('teamwork.team_model'), 'id', 'current_team_id');
			0 ignored issues – show Bug introduced 2016-01-04 21:47 UTC by Report Bug Copy Issue Report It seems like `hasOne()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
32			}
33
34			/**
35			* @return mixed
36			*/
37			public function ownedTeams()
38			{

mpociot / teamwork

UserHasTeams::teams() A last analyzed 2021-02-16 10:30 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

UserHasTeams::teams() A
last analyzed 2021-02-16 10:30 UTC