Tinyissue\Form\Issue

Complexity

Total Complexity

53

Size/Duplication

Total Lines	492
Duplicated Lines	9.76 %

Coupling/Cohesion

Components	1
Dependencies	7

Test Coverage

Coverage

99.18%

Importance

Changes	15
Bugs	4	Features	2

17 Methods

Rating	Name	Duplication	Size	Complexity
A	getTags()	12	12	3
A	getIssueTagId()	0	15	3
A	setup()	0	7	2
A	actions()	0	6	2
A	fields()	0	20	3
B	issueModifyFields()	0	29	1
A	fieldTitle()	0	9	1
A	fieldBody()	0	9	1
C	fieldStatusTags()	12	68	10
B	fieldTypeTags()	12	58	8
C	fieldResolutionTags()	12	70	8
A	fieldAssignedTo()	0	11	1
A	fieldUpload()	0	8	2
B	fieldTimeQuote()	0	24	1
A	rules()	0	9	1
A	getRedirectUrl()	0	8	2
A	extractQuoteValue()	0	15	4

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

use Tinyissue\Model;

/**
 * Issue is a class to defines fields & rules for add/edit issue form.
 *
 * @author Mohamed Alsharaf <mohamed.alsharaf@gmail.com>
 */
class Issue extends FormAbstract
{

    /**
     * An instance of project model.
     *
     * @var Model\Project
     */
    protected $project;

    /**
     * Collection of all tags.
     *
     * @var \Illuminate\Database\Eloquent\Collection
     */
    protected $tags = null;

    /**
     * @param string $type
     *
     * @return \Illuminate\Database\Eloquent\Collection|null
     */
    protected function getTags($type = null)

This method seems to be duplicated in your project.

    {
        if ($this->tags === null) {
            $this->tags = (new Model\Tag())->getGroupTags();
        }

        if ($type) {

The expression $type of type string|null is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

            return $this->tags->where('name', $type)->first()->tags;
        }

        return $this->tags;
    }

    /**
     * Get issue tag for specific type/group.
     *
     * @param string $type
     *
     * @return int
     */
    protected function getIssueTagId($type)
    {
        if (!$this->isEditing()) {
            return 0;
        }

        $groupId     = $this->getTags($type)->first()->parent_id;
        $selectedTag = $this->getModel()->tags->where('parent_id', $groupId);

        if ($selectedTag->count() === 0) {
            return 0;
        }

        return $selectedTag->last()->id;
    }

    /**
     * @param array $params
     *
     * @return void
     */
    public function setup(array $params)
    {
        $this->project = $params['project'];
        if (!empty($params['issue'])) {
            $this->editingModel($params['issue']);
        }
    }

    /**
     * @return array
     */
    public function actions()
    {
        return [
            'submit' => $this->isEditing() ? 'update_issue' : 'create_issue',
        ];
    }

    /**
     * @return array
     */
    public function fields()
    {
        $issueModify = \Auth::user()->permission('issue-modify');

        $fields = $this->fieldTitle();
        $fields += $this->fieldBody();
        $fields += $this->fieldTypeTags();

        // Only on creating new issue
        if (!$this->isEditing()) {
            $fields += $this->fieldUpload();
        }

        // Show fields for users with issue modify permission
        if ($issueModify) {
            $fields += $this->issueModifyFields();
        }

        return $fields;
    }

    /**
     * Return a list of fields for users with issue modify permission.
     *
     * @return array
     */
    protected function issueModifyFields()
    {
        $fields = [];

        $fields['internal_status'] = [
            'type' => 'legend',
        ];

        // Status tags
        $fields += $this->fieldStatusTags();

		/*
		$fields['You_have_currently_no_permission_to_change_the_status'] = [
            'type' => 'label',
        ];
		*/


        // Assign users
        $fields += $this->fieldAssignedTo();

        // Quotes
        $fields += $this->fieldTimeQuote();

        // Resolution tags
        $fields += $this->fieldResolutionTags();

        return $fields;
    }

    /**
     * Returns title field.
     *
     * @return array
     */
    protected function fieldTitle()
    {
        return [
            'title' => [
                'type'  => 'text',
                'label' => 'title',
            ],
        ];
    }

    /**
     * Returns body field.
     *
     * @return array
     */
    protected function fieldBody()
    {
        return [
            'body' => [
                'type'  => 'textarea',
                'label' => 'issue',
            ],
        ];
    }

    /**
     * Returns status tag field.
     *
     * @return array
     */
    protected function fieldStatusTags()
    {

		/**
		 * Let the user only select from tags he may access
		 * according to the tags VIEW_LIMIT_ROLE - nickbe
		**/

		$current_tag = $this->getIssueTagId('status');
		$tags = $this->project->getKanbanTags();


		$single_tag = false;
		foreach ($tags as $position => $tag) {

This code seems to be duplicated across your project.

			/**
			 * Let's check if the user can access the current tag
			 * if not then this is the only tag he will see
			**/

			if ( $current_tag == $tag->id && \Auth::user()->role_id < $tag->role_limit ) {
				$single_tag = true;
				break;
			}
		}


		/**
		 * Show tags as usual and according to role
		 * or simply show one single active (locked) tag
		**/

		if ($single_tag) {

			foreach ($tags as $position => $tag) {
				if ($current_tag !== $tag->id) {
						unset($tags[$position]);
					}
			}

		} else {

			$tags = $tags->filter(function (Model\Tag $tag) {
				return !(\Auth::user()->role_id < $tag->role_limit || $tag->name == Model\Tag::STATUS_OPEN || $tag->name == Model\Tag::STATUS_CLOSED);

The property role_limit does not exist on object<Tinyissue\Model\Tag>. Since you implemented __get, maybe consider adding a @property annotation.

			});

		}


        $options = [];
        foreach ($tags as $tag) {
            $options[ucwords($tag->name)] = [
                'name'      => 'tag_status',
                'value'     => $tag->id,
                'data-tags' => $tag->id,
                'color'     => $tag->bgcolor,
            ];
        }

        $fields['tag_status'] = [

$fields was never initialized. Although not strictly required by PHP, it is generally a good practice to add $fields = array(); before regardless.

            'label'  => 'status',
            'type'   => 'radioButton',
            'radios' => $options,
            'check'  => $this->getIssueTagId('status'),
        ];

        return $fields;
    }
    /**
     * Returns tags field.
     *
     * @return array
     */
    protected function fieldTypeTags()
    {
        $tags    = $this->getTags('type');


		$current_tag = $this->getIssueTagId('type');
		$single_tag = false;

		foreach ($tags as $position => $tag) {

The expression $tags of type object<Illuminate\Database\Eloquent\Collection>|null is not guaranteed to be traversable. How about adding an additional type check?

This code seems to be duplicated across your project.

			/**
			 * Let's check if the user can access the current tag
			 * if not then this is the only tag he will see
			**/

			if ( $current_tag == $tag->id && \Auth::user()->role_id < $tag->role_limit ) {
				$single_tag = true;
				break;
			}
		}

		if ($single_tag) {

			foreach ($tags as $position => $tag) {

The expression $tags of type object<Illuminate\Database\Eloquent\Collection>|null is not guaranteed to be traversable. How about adding an additional type check?

				if ($current_tag !== $tag->id) {
						unset($tags[$position]);
					}
			}

		} else {

			$tags = $tags->filter(function (Model\Tag $tag) {
				return !(\Auth::user()->role_id < $tag->role_limit );

The property role_limit does not exist on object<Tinyissue\Model\Tag>. Since you implemented __get, maybe consider adding a @property annotation.

			});

		}



        $options = [];
        foreach ($tags as $tag) {
            $options[ucwords($tag->name)] = [
                'name'      => 'tag_type',
                'value'     => $tag->id,
                'data-tags' => $tag->id,
                'color'     => $tag->bgcolor,
            ];
        }

        $fields['tag_type'] = [

$fields was never initialized. Although not strictly required by PHP, it is generally a good practice to add $fields = array(); before regardless.

            'label'  => 'type',
            'type'   => 'radioButton',
            'radios' => $options,
            'check'  => $this->getIssueTagId('type'),
        ];

        return $fields;
    }

    /**
     * Returns tags field.
     *
     * @return array
     */
    protected function fieldResolutionTags()
    {
        $tags    = $this->getTags('resolution');


		$current_tag = $this->getIssueTagId('resolution');
		$single_tag = false;

		foreach ($tags as $position => $tag) {

The expression $tags of type object<Illuminate\Database\Eloquent\Collection>|null is not guaranteed to be traversable. How about adding an additional type check?

This code seems to be duplicated across your project.

			/**
			 * Let's check if the user can access the current tag
			 * if not then this is the only tag he will see
			**/

			if ( $current_tag == $tag->id && \Auth::user()->role_id < $tag->role_limit ) {
				$single_tag = true;
				break;
			}
		}


		/**
		 * Show tags as usual and according to role
		 * or simply show one single active (locked) tag
		**/

		if ($single_tag) {

			foreach ($tags as $position => $tag) {

The expression $tags of type object<Illuminate\Database\Eloquent\Collection>|null is not guaranteed to be traversable. How about adding an additional type check?

				if ($current_tag !== $tag->id) {
						unset($tags[$position]);
					}
			}

		} else {

			$tags = $tags->filter(function (Model\Tag $tag) {
				return !(\Auth::user()->role_id < $tag->role_limit );

The property role_limit does not exist on object<Tinyissue\Model\Tag>. Since you implemented __get, maybe consider adding a @property annotation.

			});

			$options = [
				trans('tinyissue.none') => [
					'name'      => 'tag_resolution',
					'value'     => 0,
					'data-tags' => 0,
					'color'     => '#62CFFC',
				],
			];

		}

        foreach ($tags as $tag) {
            $options[ucwords($tag->name)] = [

The variable $options does not seem to be defined for all execution paths leading up to this point.

                'name'      => 'tag_resolution',
                'value'     => $tag->id,
                'data-tags' => $tag->id,
                'color'     => $tag->bgcolor,
            ];
        }

        $fields['tag_resolution'] = [

$fields was never initialized. Although not strictly required by PHP, it is generally a good practice to add $fields = array(); before regardless.

            'label'  => 'resolution',
            'type'   => 'radioButton',
            'radios' => $options,
            'check'  => $this->getIssueTagId('resolution'),
        ];

        return $fields;
    }

    /**
     * Returns assigned to field.
     *
     * @return array
     */
    protected function fieldAssignedTo()
    {
        return [
            'assigned_to' => [
                'type'    => 'select',
                'label'   => 'assigned_to',
                'options' => [0 => ''] + $this->project->usersCanFixIssue()->get()->lists('fullname', 'id')->all(),
                'value'   => (int) $this->project->default_assignee,
            ],
        ];
    }

    /**
     * Returns upload field.
     *
     * @return array
     */
    protected function fieldUpload()
    {
        $user                      = \Auth::guest() ? new Model\User() : \Auth::user();
        $fields                    = $this->projectUploadFields('upload', $this->project, $user);
        $fields['upload']['label'] = 'attachments';

        return $fields;
    }

    /**
     * Returns time quote field.
     *
     * @return array
     */
    protected function fieldTimeQuote()
    {
        return [
            'time_quote' => [
                'type'   => 'groupField',
                'label'  => 'quote',
                'fields' => [
                    'h' => [
                        'type'          => 'number',
                        'append'        => trans('tinyissue.hours'),
                        'value'         => $this->extractQuoteValue('h'),
                        'addGroupClass' => 'col-sm-12 col-md-12 col-lg-4',
                    ],
                    'm' => [
                        'type'          => 'number',
                        'append'        => trans('tinyissue.minutes'),
                        'value'         => $this->extractQuoteValue('m'),
                        'addGroupClass' => 'col-sm-12 col-md-12 col-lg-4',
                    ],
                ],
                'addClass' => 'row issue-quote',
            ],
        ];
    }

    /**
     * @return array
     */
    public function rules()
    {
        $rules = [
            'title' => 'required|max:200',
            'body'  => 'required',
        ];

        return $rules;
    }

    /**
     * @return string
     */
    public function getRedirectUrl()
    {
        if ($this->isEditing()) {
            return $this->getModel()->to('edit');
        }

        return 'project/' . $this->project->id . '/issue/new';
    }

    /**
     * Extract number of hours, or minutes, or seconds from a quote.
     *
     * @param string $part
     *
     * @return float|int
     */
    protected function extractQuoteValue($part)
    {
        if ($this->getModel() instanceof Model\Project\Issue) {
            $seconds = $this->getModel()->time_quote;
            if ($part === 'h') {
                return floor($seconds / 3600);
            }

            if ($part === 'm') {
                return ($seconds / 60) % 60;
            }
        }

        return 0;
    }
}