jeremykenedy / laravel-soundboard

app/Services/SoundServices.php

<?php

namespace App\Services;

use App\Models\Sound;
use Illuminate\Support\Facades\File;

class SoundServices
{
    /**
     * Get the Sounds from Database.
     *
     * @param int $id Sound Id
     *
     * @return Collection The Sound

The type App\Services\Collection was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    public static function getSound($id)
    {
        if (!$id) {
            return abort(404);

Are you sure the usage of abort(404) is correct as it seems to always return null.

The expression return abort(404) returns the type void which is incompatible with the documented return type App\Services\Collection.

        }

        return Sound::findOrFail($id);
    }

    public static function getAllSounds()
    {
        return Sound::all();
    }

    /**
     * Gets the sorted sounds.
     *
     * @return collection The sorted sounds.

The type App\Services\collection was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    public static function getSortedSounds()
    {
        return Sound::sortedSounds()->get();

The expression return App\Models\Sound::sortedSounds()->get() returns the type Illuminate\Database\Eloquent\Collection which is incompatible with the documented return type App\Services\collection.

    }

    /**
     * Gets the enabled and sorted sounds.
     *
     * @return collection The enabled sorted sounds.
     */
    public static function getEnabledSortedSounds()
    {
        return Sound::enabledSounds()->sortedSounds()->get();

The expression return App\Models\Sound::enabledSounds()->sortedSounds()->get() returns the type Illuminate\Database\Eloquent\Collection which is incompatible with the documented return type App\Services\collection.

    }

    /**
     * Gets the blank sound.
     *
     * @return Empty Sound Collection.

The type App\Services\Empty was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    public static function getBlankSound()
    {
        return new Sound();

The expression return new App\Models\Sound() returns the type App\Models\Sound which is incompatible with the documented return type App\Services\Empty.

    }

    /**
     * Update a sound.
     *
     * @param collection $sound     The sound
     * @param array      $soundData The sound data
     *
     * @return Collection Sound
     */
    public static function updateSound(Sound $sound, $soundData)
    {
        $sound->fill($soundData);
        $sound->save();

        return $sound;

The expression return $sound returns the type App\Models\Sound which is incompatible with the documented return type App\Services\Collection.

    }

    /**
     * Update a sound enabled/disabled.
     *
     * @param int  $soundId The sound identifier
     * @param bool $status  The status
     *
     * @return collection \App\Models\Sound\Sound $sound
     */
    public static function updateSoundStatus($soundId, $status)
    {
        $sound = self::getSound($soundId);
        $sound->enabled = $status;
        $sound->save();

        return $sound;
    }

    /**
     * Stores a new sound.
     *
     * @param array $soundData The sound data
     *
     * @return collection $newSound The newly stored sound
     */
    public static function storeNewSound($soundData)
    {
        $lastSound = collect(Sound::sortedSounds()->get())->last();
        $sort_order = ['sort_order' => $lastSound->sort_order + 1];
        $newSound = Sound::create(array_merge($soundData, $sort_order));

        return $newSound;

The expression return $newSound returns the type App\Models\Sound which is incompatible with the documented return type App\Services\collection.

    }

    /**
     * Delete a sound.
     *
     * @param collection $sound The sound
     *
     * @return Collection of deleted Sound
     */
    public static function deleteSound(Sound $sound)
    {
        $sound->delete();

        return $sound;

The expression return $sound returns the type App\Models\Sound which is incompatible with the documented return type App\Services\Collection.

    }

    /**
     * Check for sounds and recording file directory existance and get any files contained within.
     *
     * @return array of collections
     */
    public static function checkAndPullSoundsAndRecordings()
    {
        $uploadedFilePath = config('soundboard.folders.uploads').'/';
        $recordedFilePath = $uploadedFilePath.config('soundboard.folders.recordings').'/';
        $fileTypes = 'wav';

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

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

        $uploadfilesNames = collect(preg_grep('~\.('.$fileTypes.')$~', scandir($uploadedFilePath)));

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

        $recordedfilesNames = collect(preg_grep('~\.('.$fileTypes.')$~', scandir($recordedFilePath)));

        $data = [
            'uploadfilesNames'    => $uploadfilesNames,
            'recordedfilesNames'  => $recordedfilesNames,
        ];

        return $data;
    }
}