BristolSU\Module\UploadFile\Http\Controllers\AdminApi\CommentController

Complexity

Total Complexity

4

Size/Duplication

Total Lines	46
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	update()	0	11	1
A	destroy()	0	9	1
A	store()	0	12	1
A	index()	0	5	1

<?php

Missing file doc comment

namespace BristolSU\Module\UploadFile\Http\Controllers\AdminApi;

use BristolSU\Module\UploadFile\Events\CommentCreated;
use BristolSU\Module\UploadFile\Events\CommentDeleted;
use BristolSU\Module\UploadFile\Events\CommentUpdated;
use BristolSU\Module\UploadFile\Http\Controllers\Controller;
use BristolSU\Module\UploadFile\Models\Comment;
use BristolSU\Module\UploadFile\Models\File;
use BristolSU\Support\Activity\Activity;
use BristolSU\Support\ActivityInstance\Contracts\ActivityInstanceResolver;
use BristolSU\Support\Authentication\Contracts\Authentication;
use BristolSU\Support\ModuleInstance\ModuleInstance;
use Illuminate\Auth\Access\AuthorizationException;
use Illuminate\Http\Request;

class CommentController extends Controller

Missing doc comment for class CommentController

{

    public function index(Request $request, Activity $activity, ModuleInstance $moduleInstance, File $file)

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

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

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

Missing doc comment for function index()

    {
        $this->authorize('admin.comment.index');

        return $file->comments;
    }

    public function store(Request $request, Activity $activity, ModuleInstance $moduleInstance, File $file)

Missing doc comment for function store()

    {
        $this->authorize('admin.comment.store');
        
        $comment = $file->comments()->create([

The opening parenthesis of a multi-line function call should be the last content on the line.

            'comment' => $request->input('comment'),
            'posted_by' => app(Authentication::class)->getUser()->id

Accessing id on the interface BristolSU\ControlDB\Contracts\Models\User suggest that you code against a concrete implementation. How about adding an instanceof check?

        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

        
        event(new CommentCreated($comment));
        
        return $comment;
    }

    public function destroy(Request $request, Activity $activity, ModuleInstance $moduleInstance, Comment $comment)

Missing doc comment for function destroy()

    {
        $this->authorize('admin.comment.destroy');
        
        $comment->delete();
        
        event(new CommentDeleted($comment));
        
        return $comment;
    }

    public function update(Request $request, Activity $activity, ModuleInstance $moduleInstance, Comment $comment)

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

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

Missing doc comment for function update()

    {
        $this->authorize('admin.comment.update');
        
        $comment->comment = $request->input('comment', $comment->comment);
        
        $comment->save();

        event(new CommentUpdated($comment));

        return $comment;
    }

}