Tinyissue\Model\Traits\Project\RelationTrait

Complexity

Total Complexity

8

Size/Duplication

Total Lines	86
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Test Coverage

Coverage

88.89%

Importance

Changes	6
Bugs	1	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	issues()	0	4	1
A	issuesByUser()	0	4	1
A	users()	0	4	1
A	user()	0	4	1
A	projectUsers()	0	4	1
A	activities()	0	4	1
A	notes()	0	4	1
A	kanbanTags()	0	6	1

<?php

/*
 * This file is part of the Tinyissue package.
 *
 * (c) Mohamed Alsharaf <mohamed.alsharaf@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Tinyissue\Model\Traits\Project;

use Illuminate\Database\Eloquent\Relations;
use Tinyissue\Model\Project;
use Tinyissue\Model\Tag;

/**
 * RelationTrait is trait class containing the relationship methods for the Project model.
 *
 * @author Mohamed Alsharaf <mohamed.alsharaf@gmail.com>
 *
 * @method Relations\HasMany       hasMany($related, $foreignKey = null, $localKey = null)
 * @method Relations\BelongsToMany belongsToMany($related, $table = null, $foreignKey = null, $otherKey = null, $relation = null)
 */
trait RelationTrait
{
    /**
     * Returns all issues related to project.
     *
     * @return Relations\HasMany
     */
    public function issues()
    {
        return $this->hasMany('Tinyissue\Model\Project\Issue', 'project_id');
    }

    /**
     * Returns issues in the project with user details eager loaded.
     *
     * @return Relations\HasMany
     */
    public function issuesByUser()
    {
        return $this->hasMany('Tinyissue\Model\Project\Issue', 'project_id')->with('user')->get();
    }

    /**
     * Returns all users assigned in the current project.
     *
     * @return Relations\BelongsToMany
     */
    public function users()
    {
        return $this->belongsToMany('\Tinyissue\Model\User', 'projects_users', 'project_id', 'user_id');
    }

    /**
     * Return a user that is member of a project.
     *
     * @param int $userId
     *
     * @return Relations\BelongsToMany
     */
    public function user($userId)
    {
        return $this->users()->where('user_id', '=', (int) $userId);
    }

    /**
     * Project has many project users.
     *
     * @return Relations\HasMany
     */
    public function projectUsers()
    {
        return $this->hasMany('Tinyissue\Model\Project\User', 'project_id');
    }

    /**
     * Returns project activities.
     *
     * @return Relations\HasMany
     */
    public function activities()
    {
        return $this->hasMany('Tinyissue\Model\User\Activity', 'parent_id');
    }

    /**
     * Returns notes in the project.
     *
     * @return Relations\HasMany
     */
    public function notes()
    {
        return $this->hasMany('Tinyissue\Model\Project\Note', 'project_id');
    }

    /**
     * Project have many kanban tags.
     *
     * @return Relations\BelongsToMany
     */
    public function kanbanTags()
    {
        return $this->belongsToMany('Tinyissue\Model\Tag', 'projects_kanban_tags', 'project_id', 'tag_id')
            ->whereNotIn('name', [Tag::STATUS_OPEN, Tag::STATUS_CLOSED])
            ->orderBy('position');
    }
}