Tinyissue\Http\Controllers\ProjectController

Complexity

Total Complexity

32

Size/Duplication

Total Lines	375
Duplicated Lines	11.73 %

Coupling/Cohesion

Components	1
Dependencies	11

Test Coverage

Coverage

100%

Importance

Changes	8
Bugs	3	Features	1

16 Methods

Rating	Name	Duplication	Size	Complexity
A	getIndex()	0	16	1
A	getIssues()	0	14	2
A	getAssigned()	12	12	1
A	getCreated()	12	12	1
A	getNotes()	0	13	1
C	projectMainViewTabs()	0	55	12
A	getEdit()	0	8	1
A	postEdit()	0	15	2
A	getInactiveUsers()	0	6	1
A	postAssign()	10	10	2
A	postUnassign()	10	10	2
A	postAddNote()	0	8	1
A	postEditNote()	0	12	2
A	getDeleteNote()	0	6	1
A	postExportIssues()	0	23	1
A	getDownloadExport()	0	8	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\Http\Controllers;

use Illuminate\Http\Request;
use Tinyissue\Form\FilterIssue as FilterForm;
use Tinyissue\Form\Note as NoteForm;
use Tinyissue\Form\Project as Form;
use Tinyissue\Http\Requests\FormRequest;
use Tinyissue\Model\Project;
use Tinyissue\Model\Project\Issue;
use Tinyissue\Model\Project\Note;
use Tinyissue\Services\Exporter;

/**
 * ProjectController is the controller class for managing request related to a project.
 *
 * @author Mohamed Alsharaf <mohamed.alsharaf@gmail.com>
 */
class ProjectController extends Controller
{
    /**
     * Display activity for a project.
     *
     * @param Project $project
     *
     * @return \Illuminate\View\View
     */
    public function getIndex(Project $project)
    {
        $activities = $project->activities()
            ->with('activity', 'issue', 'user', 'assignTo', 'comment', 'note')
            ->orderBy('created_at', 'DESC')
            ->take(10)
            ->get();

        return view('project.index', [

The expression view('project.index', array('tabs' => $this->projectMainViewTabs($project, 'index'), 'project' => $project, 'active' => 'activity', 'activities' => $activities, 'sidebar' => 'project')); of type Illuminate\View\View|Illuminate\Contracts\View\Factory adds the type Illuminate\Contracts\View\Factory to the return on line 46 which is incompatible with the return type documented by Tinyissue\Http\Controllers\ProjectController::getIndex of type Illuminate\View\View.

            'tabs'       => $this->projectMainViewTabs($project, 'index'),
            'project'    => $project,
            'active'     => 'activity',
            'activities' => $activities,
            'sidebar'    => 'project',
        ]);
    }

    /**
     * Display issues for a project.
     *
     * @param FilterForm $filterForm
     * @param Request    $request
     * @param Project    $project
     * @param int        $status
     *
     * @return \Illuminate\View\View
     */
    public function getIssues(FilterForm $filterForm, Request $request, Project $project, $status = Issue::STATUS_OPEN)
    {
        $active = $status == Issue::STATUS_OPEN ? 'open_issue' : 'closed_issue';
        $issues = $project->listIssues($status, $request->all());

        return view('project.index', [

The expression view('project.index', array('tabs' => $this->projectMainViewTabs($project, 'issues', $issues, $status), 'project' => $project, 'active' => $active, 'issues' => $issues, 'sidebar' => 'project', 'filterForm' => $filterForm)); of type Illuminate\View\View|Illuminate\Contracts\View\Factory adds the type Illuminate\Contracts\View\Factory to the return on line 70 which is incompatible with the return type documented by Tinyissue\Http\Controllers\ProjectController::getIssues of type Illuminate\View\View.

            'tabs'       => $this->projectMainViewTabs($project, 'issues', $issues, $status),

$status is of type integer, but the function expects a boolean.

            'project'    => $project,
            'active'     => $active,
            'issues'     => $issues,
            'sidebar'    => 'project',
            'filterForm' => $filterForm,
        ]);
    }

    /**
     * Display issues assigned to current user for a project.
     *
     * @param Project $project
     *
     * @return \Illuminate\View\View
     */
    public function getAssigned(Project $project)

This method seems to be duplicated in your project.

    {
        $issues = $project->listAssignedOrCreatedIssues($this->auth->user());

$this->auth->user() is of type object<Illuminate\Contracts\Auth\Authenticatable>|null, but the function expects a object<Tinyissue\Model\User>.

        return view('project.index', [

The expression view('project.index', array('tabs' => $this->projectMainViewTabs($project, 'assigned', $issues), 'project' => $project, 'active' => 'issue_assigned_to_you', 'issues' => $issues, 'sidebar' => 'project')); of type Illuminate\View\View|Illuminate\Contracts\View\Factory adds the type Illuminate\Contracts\View\Factory to the return on line 91 which is incompatible with the return type documented by Tinyissue\Http\Controllers\ProjectController::getAssigned of type Illuminate\View\View.

            'tabs'    => $this->projectMainViewTabs($project, 'assigned', $issues),
            'project' => $project,
            'active'  => 'issue_assigned_to_you',
            'issues'  => $issues,
            'sidebar' => 'project',
        ]);
    }

    /**
     * Display issues created to current user for a project.
     *
     * @param Project $project
     *
     * @return \Illuminate\View\View
     */
    public function getCreated(Project $project)

This method seems to be duplicated in your project.

    {
        $issues = $project->listAssignedOrCreatedIssues($this->auth->user());

$this->auth->user() is of type object<Illuminate\Contracts\Auth\Authenticatable>|null, but the function expects a object<Tinyissue\Model\User>.

        return view('project.index', [

The expression view('project.index', array('tabs' => $this->projectMainViewTabs($project, 'created', $issues), 'project' => $project, 'active' => 'issue_created_by_you', 'issues' => $issues, 'sidebar' => 'project')); of type Illuminate\View\View|Illuminate\Contracts\View\Factory adds the type Illuminate\Contracts\View\Factory to the return on line 111 which is incompatible with the return type documented by Tinyissue\Http\Controllers\ProjectController::getCreated of type Illuminate\View\View.

            'tabs'    => $this->projectMainViewTabs($project, 'created', $issues),
            'project' => $project,
            'active'  => 'issue_created_by_you',
            'issues'  => $issues,
            'sidebar' => 'project',
        ]);
    }

    /**
     * Display notes for a project.
     *
     * @param Project  $project
     * @param NoteForm $form
     *
     * @return \Illuminate\View\View
     */
    public function getNotes(Project $project, NoteForm $form)
    {
        $notes = $project->notes()->with('createdBy')->get();

        return view('project.index', [

The expression view('project.index', array('tabs' => $this->projectMainViewTabs($project, 'notes', $notes), 'project' => $project, 'active' => 'notes', 'notes' => $notes, 'sidebar' => 'project', 'noteForm' => $form)); of type Illuminate\View\View|Illuminate\Contracts\View\Factory adds the type Illuminate\Contracts\View\Factory to the return on line 132 which is incompatible with the return type documented by Tinyissue\Http\Controllers\ProjectController::getNotes of type Illuminate\View\View.

            'tabs'     => $this->projectMainViewTabs($project, 'notes', $notes),
            'project'  => $project,
            'active'   => 'notes',
            'notes'    => $notes,
            'sidebar'  => 'project',
            'noteForm' => $form,
        ]);
    }

    /**
     * @param Project $project
     * @param string  $view
     * @param null    $data
     * @param bool    $status
     *
     * @return array
     */
    protected function projectMainViewTabs(Project $project, $view, $data = null, $status = false)
    {
        $notesCount = $view === 'note' ? $data->count() : $project->notes()->count();

The method count cannot be called on $data (of type null).

        $assignedIssuesCount = 0;
        if ($view !== 'assigned' && !$this->auth->guest()) {
            $method = auth()->user()->isUser()? 'createdIssuesCount' : 'assignedIssuesCount';

It seems like you code against a concrete implementation and not the interface Illuminate\Contracts\Auth\Authenticatable as the method isUser() does only exist in the following implementations of said interface: Tinyissue\Model\User.

            $assignedIssuesCount = $this->auth->user()->$method($project->id);
        } elseif ($view === 'assigned' || $view === 'created') {
            $assignedIssuesCount = $data->count();

The method count cannot be called on $data (of type null).

        }

        if ($view === 'issues') {
            if ($status == Issue::STATUS_OPEN) {
                $closedIssuesCount = $project->closedIssuesCount()->count();
                $openIssuesCount   = $data->count();

The method count cannot be called on $data (of type null).

            } else {
                $closedIssuesCount = $data->count();

The method count cannot be called on $data (of type null).

                $openIssuesCount   = $project->openIssuesCount()->count();
            }
        } else {
            $openIssuesCount   = $project->openIssuesCount()->count();
            $closedIssuesCount = $project->closedIssuesCount()->count();
        }

        $tabs   = [];
        $tabs[] = [
            'url'  => $project->to(),
            'page' => 'activity',
        ];
        $tabs[] = [
            'url'    => $project->to('issues'),
            'page'   => 'open_issue',
            'prefix' => $openIssuesCount,
        ];
        $tabs[] = [
            'url'    => $project->to('issues') . '/0',
            'page'   => 'closed_issue',
            'prefix' => $closedIssuesCount,
        ];
        if (!$this->auth->guest()) {
            $tabs[] = [
                'url'    => $project->to(auth()->user()->isUser()? 'created' : 'assigned'),

It seems like you code against a concrete implementation and not the interface Illuminate\Contracts\Auth\Authenticatable as the method isUser() does only exist in the following implementations of said interface: Tinyissue\Model\User.

                'page'   => (auth()->user()->isUser()? 'issue_created_by_you' : 'issue_assigned_to_you'),

It seems like you code against a concrete implementation and not the interface Illuminate\Contracts\Auth\Authenticatable as the method isUser() does only exist in the following implementations of said interface: Tinyissue\Model\User.

                'prefix' => $assignedIssuesCount,
            ];
        }
        $tabs[] = [
            'url'    => $project->to('notes'),
            'page'   => 'notes',
            'prefix' => $notesCount,
        ];

        return $tabs;
    }

    /**
     * Edit the project.
     *
     * @param Project $project
     * @param Form    $form
     *
     * @return \Illuminate\View\View
     */
    public function getEdit(Project $project, Form $form)
    {
        return view('project.edit', [

The expression view('project.edit', array('form' => $form, 'project' => $project, 'sidebar' => 'project')); of type Illuminate\View\View|Illuminate\Contracts\View\Factory adds the type Illuminate\Contracts\View\Factory to the return on line 216 which is incompatible with the return type documented by Tinyissue\Http\Controllers\ProjectController::getEdit of type Illuminate\View\View.

            'form'    => $form,
            'project' => $project,
            'sidebar' => 'project',
        ]);
    }

    /**
     * To update project details.
     *
     * @param Project             $project
     * @param FormRequest\Project $request
     *
     * @return \Illuminate\Http\RedirectResponse
     */
    public function postEdit(Project $project, FormRequest\Project $request)
    {
        // Delete the project
        if ($request->has('delete-project')) {
            $project->delete();

            return redirect('projects')
                ->with('notice', trans('tinyissue.project_has_been_deleted'));
        }

        $project->update($request->all());

        return redirect($project->to())
            ->with('notice', trans('tinyissue.project_has_been_updated'));
    }

    /**
     * Ajax: returns list of users that are not in the project.
     *
     * @param Project $project
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function getInactiveUsers(Project $project = null)
    {
        $users = $project->usersNotIn();

It seems like $project is not always an object, but can also be of type null. Maybe add an additional type check?

        return response()->json($users);
    }

    /**
     * Ajax: add user to the project.
     *
     * @param Project $project
     * @param Request $request
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function postAssign(Project $project, Request $request)

This method seems to be duplicated in your project.

    {
        $status = false;
        if ($request->has('user_id')) {
            $project->assignUser((int) $request->input('user_id'));
            $status = true;
        }

        return response()->json(['status' => $status]);
    }

    /**
     * Ajax: remove user from the project.
     *
     * @param Project $project
     * @param Request $request
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function postUnassign(Project $project, Request $request)

This method seems to be duplicated in your project.

    {
        $status = false;
        if ($request->has('user_id')) {
            $project->unassignUser((int) $request->input('user_id'));
            $status = true;
        }

        return response()->json(['status' => $status]);
    }

    /**
     * To add a new note to the project.
     *
     * @param Project          $project
     * @param Note             $note
     * @param FormRequest\Note $request
     *
     * @return \Illuminate\Http\RedirectResponse
     */
    public function postAddNote(Project $project, Note $note, FormRequest\Note $request)
    {
        $note->setRelation('project', $project);
        $note->setRelation('createdBy', $this->auth->user());
        $note->createNote($request->all());

        return redirect($note->to())->with('notice', trans('tinyissue.your_note_added'));
    }

    /**
     * Ajax: To update project note.
     *
     * @param Project $project
     * @param Note    $note
     * @param Request $request
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function postEditNote(Project $project, Project\Note $note, Request $request)
    {
        $body = '';
        if ($request->has('body')) {
            $note->setRelation('project', $project);
            $note->updateBody($request->input('body'), $this->auth->user());

It seems like $request->input('body') targeting Illuminate\Http\Request::input() can also be of type array; however, Tinyissue\Model\Traits\Project\Note\CrudTrait::updateBody() does only seem to accept string, maybe add an additional type check?

$this->auth->user() is of type object<Illuminate\Contracts\Auth\Authenticatable>|null, but the function expects a object<Tinyissue\Model\User>.

            $body = \Html::format($note->body);
        }

        return response()->json(['status' => true, 'text' => $body]);
    }

    /**
     * Ajax: to delete a project note.
     *
     * @param Project $project
     * @param Note    $note
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function getDeleteNote(Project $project, Project\Note $note)

The parameter $project is not used and could be removed.

    {
        $note->deleteNote($this->auth->user());

$this->auth->user() is of type object<Illuminate\Contracts\Auth\Authenticatable>|null, but the function expects a object<Tinyissue\Model\User>.

        return response()->json(['status' => true]);
    }

    /**
     * Ajax: generate the issues export file.
     *
     * @param Project  $project
     * @param Exporter $exporter
     * @param Request  $request
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function postExportIssues(Project $project, Exporter $exporter, Request $request)
    {
        // Generate export file
        $info = $exporter->exportFile(
            'Project\Issue',
            $request->input('format', Exporter::TYPE_CSV),

It seems like $request->input('format', \Tinyissue\Services\Exporter::TYPE_CSV) targeting Illuminate\Http\Request::input() can also be of type array; however, Tinyissue\Services\Exporter::exportFile() does only seem to accept string, maybe add an additional type check?

            $request->all()
        );

        // Download link
        $link = link_to(
            $project->to('download_export/' . $info['file']),
            trans('tinyissue.download_export'),

It seems like trans('tinyissue.download_export') targeting trans() can also be of type object<Symfony\Component\Translation\TranslatorInterface>; however, link_to() does only seem to accept string|null, maybe add an additional type check?

            ['class' => 'btn btn-link']
        );

        return response()->json([
            'link'  => $link,
            'title' => $info['title'],
            'file'  => $info['file'],
            'ext'   => $info['ext'],
        ]);
    }

    /**
     * Download and then delete an export file.
     *
     * @param Project $project
     * @param string  $file
     *
     * @return \Symfony\Component\HttpFoundation\BinaryFileResponse
     */
    public function getDownloadExport(Project $project, $file)

The parameter $project is not used and could be removed.

    {
        // Filter out any characters that are not in pattern
        $file = preg_replace('/[^a-z0-9\_\.]/mi', '', $file);

        // Download export
        return response()->download(storage_path('exports/' . $file), $file)->deleteFileAfterSend(true);
    }
}