App\Http\Controllers\Api\ApiSoundsController

Complexity

Total Complexity

13

Size/Duplication

Total Lines	143
Duplicated Lines	0 %

Importance

Changes	1
Bugs	1	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	updateEnabled()	0	19	2
A	index()	0	7	1
A	destroy()	0	11	1
A	updateAllSortOrder()	0	24	4
A	uploadSound()	0	35	5

<?php

namespace App\Http\Controllers\Api;

use App\Http\Controllers\Controller;
use App\Models\Sound;
use App\Services\SoundServices;
use App\Services\UserServices;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\File;
use jeremykenedy\LaravelLogger\App\Http\Traits\ActivityLogger;

class ApiSoundsController extends Controller
{
    use ActivityLogger;

The trait jeremykenedy\LaravelLogger\App\Http\Traits\ActivityLogger requires the property $id which is not provided by App\Http\Controllers\Api\ApiSoundsController.

    /**
     * Display a listing of the resource.
     *
     * @return \Illuminate\Http\Response
     */
    public function index()
    {
        $sounds = SoundServices::getEnabledSortedSounds();

        ActivityLogger::activity('All Sounds loaded from API');

        return response()->json($sounds);

The expression return response()->json($sounds) returns the type Illuminate\Http\JsonResponse which is incompatible with the documented return type Illuminate\Http\Response.

    }

    /**
     * Update the sort order.
     *
     * @param \Illuminate\Http\Request $request The request
     *
     * @return \Illuminate\Http\Response
     */
    public function updateAllSortOrder(Request $request)
    {
        UserServices::checkIsUserAdminOrHigher($request->userId);

        $this->validate($request, [
            'sounds.*.sort_order' => 'required|numeric',
        ]);

        $sounds = SoundServices::getAllSounds();

        foreach ($sounds as $sound) {
            $id = $sound->id;
            foreach ($request->sounds as $soundsNew) {
                if ($soundsNew['id'] == $id) {
                    $sound->update(['sort_order' => $soundsNew['sort_order']]);
                }
            }
        }

        ActivityLogger::activity('Sounds sort order updated');

        return response()->json([

The expression return response()->json(array('message' => trans('admin.messages.sort-order-updated')), 200) returns the type Illuminate\Http\JsonResponse which is incompatible with the documented return type Illuminate\Http\Response.

            'message' => trans('admin.messages.sort-order-updated'),
        ], 200);
    }

    /**
     * Update enabled/disabled status of a sound.
     *
     * @param \Illuminate\Http\Request $request The request
     * @param int                      $id      The identifier
     *
     * @return \Illuminate\Http\Response
     */
    public function updateEnabled(Request $request, $id)
    {
        UserServices::checkIsUserAdminOrHigher($request->userId);

        $this->validate($request, [
            'sound.enabled' => 'required|boolean',
        ]);
        $sound = SoundServices::updateSoundStatus($id, $request->sound['enabled']);
        $status = 'disabled';
        if ($sound->enabled) {
            $status = 'enabled';
        }
        $message = trans('admin.messages.status-updated', ['status' => $status, 'title' => $sound->title]);

        ActivityLogger::activity($message);

It seems like $message can also be of type array; however, parameter $description of jeremykenedy\LaravelLogger\App\Http\Traits\ActivityLogger::activity() does only seem to accept string, maybe add an additional type check?

        return response()->json([

The expression return response()->json(array('message' => $message), 200) returns the type Illuminate\Http\JsonResponse which is incompatible with the documented return type Illuminate\Http\Response.

            'message' => $message,
        ], 200);
    }

    /**
     * Remove the specified resource from storage.
     *
     * @param \Illuminate\Http\Request $request The request
     * @param int                      $id
     *
     * @return \Illuminate\Http\Response
     */
    public function destroy(Request $request, $id)
    {
        UserServices::checkIsUserAdminOrHigher($request->userId);

        $sound = SoundServices::deleteSound(SoundServices::getSound($id));

        ActivityLogger::activity('Sounds deleted: '.$sound);

        return response()->json([

The expression return response()->json(array('message' => trans('admin.messages.sound-deleted', array('title' => $sound->title))), 200) returns the type Illuminate\Http\JsonResponse which is incompatible with the documented return type Illuminate\Http\Response.

            'message' => trans('admin.messages.sound-deleted', ['title' => $sound->title]),
        ], 200);
    }

    /**
     * Handle uploads of new sound files.
     *
     * @param  Request
     *
     * @return [type]

The doc comment [type] at position 0 could not be parsed: Unknown type name '[' at position 0 in [type].

     */
    public function uploadSound(Request $request)
    {
        UserServices::checkIsUserAdminOrHigher($request->userId);

        $file = $request->file('audio_data');

        if ($request->hasFile('audio_data') && $file->isValid()) {
            $uniqueid = uniqid();

The assignment to $uniqueid is dead and can be removed.

            $original_name = $file->getClientOriginalName();
            $extension = 'wav';
            $name = $original_name.'.'.$extension;
            $path = config('soundboard.folders.uploads').'/'.config('soundboard.folders.recordings').'/';

            if (!File::exists($path)) {
                File::makeDirectory($path);
            }

            $files = scandir($path);
            if (in_array($name, array_map('strtolower', $files))) {

It seems like $files can also be of type false; however, parameter $arr1 of array_map() does only seem to accept array, maybe add an additional type check?

                return response()->json([
                    'error' => 'Filename already exists. Choose another filename.',
                ], 422);
            }
            $storedFile = $file->storeAs(config('soundboard.folders.recordings'), $name, config('soundboard.folders.uploads'));

The assignment to $storedFile is dead and can be removed.

            ActivityLogger::activity('New file recorded: '.$name);

            return response()->json([
                'message' => 'File Recorded: '.$name,
            ], 202);
        }

        return response()->json([
            'error' => 'missing file or is invalid',
        ], 422);
    }
}