Tinyissue\Model\Traits\User\RelationTrait

Complexity

Total Complexity

9

Size/Duplication

Total Lines	97
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

60%

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	role()	0	4	1
A	comments()	0	4	1
A	issuesClosedBy()	0	4	1
A	issuesUpdatedBy()	0	4	1
A	attachments()	0	4	1
A	projects()	0	7	1
A	issues()	0	4	1
A	permissions()	0	4	1
A	issuesCreatedBy()	0	4	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\User;

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

/**
 * RelationTrait is trait class containing the relationship methods for the User 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)
 * @method Relations\BelongsTo     belongsTo($related, $foreignKey = null, $otherKey = null, $relation = null)
 */
trait RelationTrait
{
    /**
     * A user has one role (inverse relationship of Role::users).
     *
     * @return Relations\BelongsTo
     */
    public function role()
    {
        return $this->belongsTo('Tinyissue\Model\Role', 'role_id');
    }

    /**
     * User has many comments (One-many relationship of Comment::user).
     *
     * @return Relations\HasMany
     */
    public function comments()
    {
        return $this->hasMany('Tinyissue\Model\Project\Issue\Comment', 'created_by', 'id');
    }

    /**
     * Returns issues created by the user.
     *
     * @return Relations\HasMany
     */
    public function issuesCreatedBy()
    {
        return $this->hasMany('Tinyissue\Model\Project\Issue', 'created_by');
    }

    /**
     * Returns issues closed by the user.
     *
     * @return Relations\HasMany
     */
    public function issuesClosedBy()
    {
        return $this->hasMany('Tinyissue\Model\Project\Issue', 'closed_by');
    }

    /**
     * Returns issues updated by the user.
     *
     * @return Relations\HasMany
     */
    public function issuesUpdatedBy()
    {
        return $this->hasMany('Tinyissue\Model\Project\Issue', 'updated_by');
    }

    /**
     * User has many attachments (One-many relationship of Attachment::user).
     *
     * @return Relations\HasMany
     */
    public function attachments()
    {
        return $this->hasMany('Tinyissue\Model\Project\Issue\Attachment', 'uploaded_by');
    }

    /**
     * Returns all projects the user can access.
     *
     * @param int $status
     *
     * @return Relations\HasMany
     */
    public function projects($status = Project::STATUS_OPEN)
    {
        return $this
            ->belongsToMany('Tinyissue\Model\Project', 'projects_users')
            ->where('status', '=', $status)
            ->orderBy('name');
    }

    /**
     * User has many issues assigned to (One-many relationship of Issue::assigned).
     *
     * @return Relations\HasMany
     */
    public function issues()
    {
        return $this->hasMany('Tinyissue\Model\Project\Issue', 'assigned_to');
    }

    /**
     * Returns all permission for the user.
     *
     * @return Relations\HasMany
     */
    public function permissions()
    {
        return $this->hasMany('\Tinyissue\Model\Role\Permission', 'role_id', 'role_id');
    }
}