UserHasTeams - Code Metrics - Inspection of "Merge branch 'teamwork-stubs'" - mpociot/teamwork - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( dc40d0...a009a1 )

by Marcel

created 2016-05-22 18:40 UTC

UserHasTeams A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	252
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	10
Bugs	1	Features	4

Metric	Value
wmc	35
c	10
b	1
f	4
lcom	1
cbo	3
dl	0
loc	252
rs	9

14 Methods

Rating	Name	Size	Complexity
A	teams()	4	1
A	currentTeam()	4	1
A	ownedTeams()	4	1
A	invites()	4	1
A	isOwner()	4	2
A	isTeamOwner()	4	1
A	retrieveTeamId()	12	4
A	bootUserHasTeams()	11	2
A	isOwnerOfTeam()	10	2
B	attachTeam()	31	5
B	detachTeam()	25	5
A	attachTeams()	8	2
A	detachTeams()	8	2
B	switchTeam()	29	6

<?php namespace Mpociot\Teamwork\Traits;

/**
 * This file is part of Teamwork,
 *
 * @license MIT
 * @package Teamwork
 */

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Support\Facades\Config;
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        = $this->retrieveTeamId( $team );
        $teamModel   = Config::get( 'teamwork.team_model' );
        $teamKeyName = ( new $teamModel() )->getKeyName();
        return ( ( new $teamModel )
            ->where( "owner_id", "=", $this->getKey() )
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            ->where( $teamKeyName, "=", $team )->first()
        ) ? true : false;
    }

    /**
     * Alias to eloquent many-to-many relation's attach() method.
     *
     * @param mixed $team
     * @return $this
     */
    public function attachTeam( $team )
    {
        $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 );

            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 );

        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|integer $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 namespace Mpociot\Teamwork\Traits;
2
3			/**
4			* This file is part of Teamwork,
5			*
6			* @license MIT
7			* @package Teamwork
8			*/
9
10			use Illuminate\Database\Eloquent\Model;
11			use Illuminate\Database\Eloquent\ModelNotFoundException;
12			use Illuminate\Support\Facades\Config;
13			use Mpociot\Teamwork\Exceptions\UserNotInTeamException;
14
15			trait UserHasTeams
16			{
17			/**
18			* Many-to-Many relations with the user model.
19			*
20			* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
21			*/
22			public function teams()
23			{
24			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...
25			}
26
27			/**
28			* has-one relation with the current selected team model.
29			*
30			* @return \Illuminate\Database\Eloquent\Relations\HasOne
31			*/
32			public function currentTeam()
33			{
34			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...
35			}
36
37			/**
38			* @return mixed

mpociot / teamwork

Push — master ( dc40d0...a009a1 )

UserHasTeams A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

14 Methods

Duplication Side-by-Side

Filter issues like