Tinyissue\Model\Tag

Complexity

Total Complexity

13

Size/Duplication

Total Lines	164
Duplicated Lines	0 %

Coupling/Cohesion

Components	4
Dependencies	6

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	updater()	0	4	1
A	to()	0	4	2
A	getFullNameAttribute()	0	4	1
A	canView()	0	4	1
A	isReadOnly()	0	8	3
A	toShortArray()	0	10	1
A	getCoreGroups()	0	8	1
A	allowMessagesToUser()	0	8	3

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

use Illuminate\Database\Eloquent\Collection;
use Tinyissue\Extensions\Auth\LoggedUser;
use URL;

/**
 * Tag is model class for tags.
 *
 * @author Mohamed Alsharaf <mohamed.alsharaf@gmail.com>
 *
 * @property int $id
 * @property int $parent_id
 * @property string $name
 * @property string $fullname
 * @property string $bgcolor
 * @property bool $group
 * @property Tag $parent
 * @property int $role_limit
 * @property int $message_limit
 * @property int $readonly
 * @property Tag $parent
 * @property Collection $tags
 * @property Collection $issues
 * @property Collection $projects
 *
 * @method  Collection getGroupWithTags()
 * @method  array getGroupsDropdown()
 * @method  Collection getGroups()
 * @method  Collection getStatusTags()
 * @method  Collection getTypeTags()
 * @method  Collection getResolutionTags()
 * @method  int countNumberOfTags()
 * @method  $this groupOnly()
 * @method  $this notGroup()
 * @method  $this ofType($type)
 * @method  $this accessibleToUser(User $user)
 * @method  $this accessibleToLoggedUser()
 */
class Tag extends ModelAbstract
{
    use TagRelations, TagScopes, LoggedUser;

    /**
     * Core tag: Open.
     *
     * @var string
     */
    const STATUS_OPEN = 'open';

    /**
     * Core tag: Closed.
     *
     * @var string
     */
    const STATUS_CLOSED = 'closed';

    /**
     * Core tag group: Status.
     *
     * @var string
     */
    const GROUP_STATUS = 'status';

    /**
     * Core tag group: Type.
     *
     * @var string
     */
    const GROUP_TYPE = 'type';

    /**
     * Core tag group: Resolution.
     *
     * @var string
     */
    const GROUP_RESOLUTION = 'resolution';

    /**
     * Timestamp enabled.
     *
     * @var bool
     */
    public $timestamps = true;

    /**
     * List of allowed columns to be used in $this->fill().
     *
     * @var array
     */
    public $fillable = ['parent_id', 'name', 'bgcolor', 'group', 'role_limit', 'message_limit', 'readonly'];

    /**
     * Name of database table.
     *
     * @var string
     */
    protected $table = 'tags';

    /**
     * @param User|null $user
     *
     * @return \Tinyissue\Repository\Tag\Updater
     */
    public function updater(User $user = null)
    {
        return parent::updater($user);
    }

    /**
     * Generate a URL for the tag.
     *
     * @param string $url
     *
     * @return mixed
     */
    public function to($url)
    {
        return URL::to('administration/tag/' . $this->id . (($url) ? '/' . $url : ''));
    }

    /**
     * Returns tag full name with prefix group name and ":" in between.
     *
     * @return string
     */
    public function getFullNameAttribute()
    {
        return ucwords($this->attributes['name']);
    }

    /**
     * Whether or not the current user can view this tag.
     *
     * @return bool
     */
    public function canView()
    {
        return $this->getLoggedUser()->role_id >= $this->role_limit;
    }

    /**
     * Whether or not the tag to mark issue as ready only.
     *
     * @param User $user
     *
     * @return bool
     */
    public function isReadOnly(User $user = null)
    {
        if (is_null($user)) {
            return (boolean) $this->readonly;
        }

        return (boolean) $this->readonly && $user->role_id <= $this->readonly;
    }

    /**
     * Return an array of tag details.
     *
     * @return array
     */
    public function toShortArray()
    {
        return [
            'id'            => $this->id,
            'name'          => $this->fullname,
            'bgcolor'       => $this->bgcolor,
            'message_limit' => $this->message_limit,
            'group'         => $this->parent->fullname,
        ];
    }

    /**
     * Returns an array of core groups.
     *
     * @return array
     */
    public static function getCoreGroups()
    {
        return [
            self::GROUP_STATUS,
            self::GROUP_TYPE,
            self::GROUP_RESOLUTION,
        ];
    }

    /**
     * Whether or not the user is allowed to receive messages that contains the current tag.
     *
     * @param User $user
     *
     * @return bool
     */
    public function allowMessagesToUser(User $user)
    {
        if (!$this->message_limit || $this->message_limit <= $user->role_id) {
            return true;
        }

        return false;
    }
}