Fixed errors picked up by larastan

This commit is contained in:
Henry Whitaker
2020-08-03 16:22:07 +01:00
parent 4b8b4ccfa3
commit 7a62b113bf
24 changed files with 86 additions and 48 deletions

View File

@@ -34,7 +34,7 @@ class AcceptEULACommand extends Command
/** /**
* Execute the console command. * Execute the console command.
* *
* @return int * @return void
*/ */
public function handle() public function handle()
{ {

View File

@@ -34,7 +34,7 @@ class ClearQueueCommand extends Command
/** /**
* Execute the console command. * Execute the console command.
* *
* @return int * @return void
*/ */
public function handle() public function handle()
{ {

View File

@@ -34,7 +34,7 @@ class GetConfig extends Command
/** /**
* Execute the console command. * Execute the console command.
* *
* @return int * @return void
*/ */
public function handle() public function handle()
{ {

View File

@@ -34,7 +34,7 @@ class SetSlackWebhook extends Command
/** /**
* Execute the console command. * Execute the console command.
* *
* @return int * @return void
*/ */
public function handle() public function handle()
{ {

View File

@@ -36,7 +36,7 @@ class SetTelegramOptions extends Command
/** /**
* Execute the console command. * Execute the console command.
* *
* @return int * @return void
*/ */
public function handle() public function handle()
{ {

View File

@@ -34,7 +34,7 @@ class SpeedtestCommand extends Command
/** /**
* Runs a speedtest synchroonously and displays the results.. * Runs a speedtest synchroonously and displays the results..
* *
* @return null * @return void
*/ */
public function handle() public function handle()
{ {

View File

@@ -35,7 +35,7 @@ class SpeedtestLatestCommand extends Command
/** /**
* Prints the latest speedtest values. * Prints the latest speedtest values.
* *
* @return null * @return void
*/ */
public function handle() public function handle()
{ {

View File

@@ -33,7 +33,7 @@ class SpeedtestVersionCommand extends Command
/** /**
* Execute the console command. * Execute the console command.
* *
* @return mixed * @return void
*/ */
public function handle() public function handle()
{ {

View File

@@ -34,7 +34,7 @@ class TestNotification extends Command
/** /**
* Execute the console command. * Execute the console command.
* *
* @return int * @return void
*/ */
public function handle() public function handle()
{ {

View File

@@ -15,6 +15,8 @@ class SpeedtestCompleteEvent
{ {
use Dispatchable, InteractsWithSockets, SerializesModels; use Dispatchable, InteractsWithSockets, SerializesModels;
public $speedtest;
/** /**
* Create a new event instance. * Create a new event instance.
* *

View File

@@ -55,7 +55,7 @@ class BackupHelper {
* *
* @param array|string $array Backup data * @param array|string $array Backup data
* @param string $format json|csv * @param string $format json|csv
* @return boolean * @return bool
*/ */
public static function restore($array, $format) public static function restore($array, $format)
{ {
@@ -101,5 +101,7 @@ class BackupHelper {
return true; return true;
} }
return false;
} }
} }

View File

@@ -12,7 +12,7 @@ class SettingsHelper {
* Get a Setting object by name * Get a Setting object by name
* *
* @param String $name The name field in the setting table * @param String $name The name field in the setting table
* @return \App\Setting|boolean $name The Setting object. Returns false if no mathcing obj. * @return \App\Setting|bool|array $name The Setting object. Returns false if no mathcing obj.
*/ */
public static function get(String $name) public static function get(String $name)
{ {
@@ -32,7 +32,7 @@ class SettingsHelper {
* Create / update value for Setting object. * Create / update value for Setting object.
* *
* @param String $name Name of setting * @param String $name Name of setting
* @param String $value Value of setting * @param String|bool $value Value of setting
* @return \App\Setting * @return \App\Setting
*/ */
public static function set(String $name, $value) public static function set(String $name, $value)
@@ -153,7 +153,7 @@ class SettingsHelper {
* Send test notification to agents * Send test notification to agents
* *
* @param boolean|string $agent * @param boolean|string $agent
* @return void * @return bool
*/ */
public static function testNotification($agent = true) public static function testNotification($agent = true)
{ {
@@ -168,5 +168,7 @@ class SettingsHelper {
event(new TestNotificationEvent([ $agent ])); event(new TestNotificationEvent([ $agent ]));
return true; return true;
} }
return false;
} }
} }

View File

@@ -17,7 +17,7 @@ class SpeedtestHelper {
* Runs/processes speedtest output to created a Speedtest object * Runs/processes speedtest output to created a Speedtest object
* *
* @param boolean|string $output If false, new speedtest runs. If anything else, will try to parse as JSON for speedtest results. * @param boolean|string $output If false, new speedtest runs. If anything else, will try to parse as JSON for speedtest results.
* @return \App\Speedtest|boolean * @return \App\Speedtest|bool
*/ */
public static function runSpeedtest($output = false, $scheduled = true) public static function runSpeedtest($output = false, $scheduled = true)
{ {
@@ -61,7 +61,7 @@ class SpeedtestHelper {
]); ]);
} }
if(!isset($test) || $test == false) { if($test == false) {
return false; return false;
} }
@@ -142,14 +142,14 @@ class SpeedtestHelper {
/** /**
* Parses network speeds and return converted to Mbps * Parses network speeds and return converted to Mbps
* *
* @param array $input * @param string $input
* @return array * @return array
*/ */
public static function parseUnits($input) public static function parseUnits($input)
{ {
$input = explode(' ', $input); $input = explode(' ', $input);
$val = $input[0]; $val = (float)$input[0];
$unit = explode('/', $input[1])[0]; $unit = explode('/', $input[1])[0];
switch($unit) { switch($unit) {
@@ -256,7 +256,7 @@ class SpeedtestHelper {
/** /**
* Create a backup of the SQLite database * Create a backup of the SQLite database
* *
* @return boolean * @return null|boolean
*/ */
public static function dbBackup() public static function dbBackup()
{ {
@@ -277,7 +277,7 @@ class SpeedtestHelper {
/** /**
* Delete all speedtests from the database * Delete all speedtests from the database
* *
* @return boolean|string * @return array
*/ */
public static function deleteAll() public static function deleteAll()
{ {
@@ -290,7 +290,6 @@ class SpeedtestHelper {
'success' => true, 'success' => true,
]; ];
} }
} }
return [ return [

View File

@@ -13,38 +13,52 @@ class UpdateHelper {
/** /**
* URL of updates * URL of updates
* *
* @var string * @var string|bool
*/ */
public $url; public $url;
/** /**
* Current app version number * Current app version number
* *
* @var string * @var string|bool
*/ */
public $currentVersion; public $currentVersion;
/**
* Latest app version number
*
* @var string|bool
*/
public $latestVersion;
/** /**
* Username of GitHub repo * Username of GitHub repo
* *
* @var string * @var string|bool
*/ */
public $user; public $user;
/** /**
* Name of GitHub repo * Name of GitHub repo
* *
* @var string * @var string|bool
*/ */
public $repo; public $repo;
/** /**
* Branch of GitHub repo * Branch of GitHub repo
* *
* @var string * @var string|bool
*/ */
public $branch; public $branch;
/**
* Store download
*
* @var string|null
*/
public $download;
function __construct() { function __construct() {
$this->currentVersion = config('speedtest.version'); $this->currentVersion = config('speedtest.version');
$this->user = config('speedtest.user'); $this->user = config('speedtest.user');
@@ -87,7 +101,7 @@ class UpdateHelper {
/** /**
* Gets the latest version number from GitHub * Gets the latest version number from GitHub
* *
* @return array [ repo, branch, version ] * @return array|bool [ repo, branch, version ]
*/ */
public function checkLatestVersion() public function checkLatestVersion()
{ {
@@ -256,7 +270,6 @@ class UpdateHelper {
$zip->open($backupZip, ZipArchive::CREATE | ZipArchive::OVERWRITE); $zip->open($backupZip, ZipArchive::CREATE | ZipArchive::OVERWRITE);
// Create recursive directory iterator // Create recursive directory iterator
/** @var SplFileInfo[] $files */
$files = new RecursiveIteratorIterator( $files = new RecursiveIteratorIterator(
new RecursiveDirectoryIterator($rootPath), new RecursiveDirectoryIterator($rootPath),
RecursiveIteratorIterator::LEAVES_ONLY RecursiveIteratorIterator::LEAVES_ONLY

View File

@@ -7,6 +7,7 @@ use DateTime;
use Illuminate\Http\Request; use Illuminate\Http\Request;
use Illuminate\Support\Facades\Storage; use Illuminate\Support\Facades\Storage;
use Illuminate\Support\Facades\Validator; use Illuminate\Support\Facades\Validator;
use Illuminate\Http\JsonResponse;
class BackupController extends Controller class BackupController extends Controller
{ {
@@ -15,7 +16,7 @@ class BackupController extends Controller
* Get backup of speedtests * Get backup of speedtests
* *
* @param Request $request * @param Request $request
* @return file * @return mixed|JsonResponse
*/ */
public function backup(Request $request) public function backup(Request $request)
{ {
@@ -36,7 +37,7 @@ class BackupController extends Controller
* Retore from a backup * Retore from a backup
* *
* @param Request $request * @param Request $request
* @return Response * @return JsonResponse
*/ */
public function restore(Request $request) public function restore(Request $request)
{ {

View File

@@ -8,6 +8,8 @@ use App\Setting;
use Illuminate\Http\Request; use Illuminate\Http\Request;
use Illuminate\Support\Facades\Log; use Illuminate\Support\Facades\Log;
use Illuminate\Support\Facades\Validator; use Illuminate\Support\Facades\Validator;
use Illuminate\Http\JsonResponse;
use Illuminate\Support\Collection;
class SettingsController extends Controller class SettingsController extends Controller
{ {
@@ -15,7 +17,7 @@ class SettingsController extends Controller
/** /**
* Return all settings * Return all settings
* *
* @return array * @return Collection
*/ */
public function index() public function index()
{ {
@@ -37,7 +39,7 @@ class SettingsController extends Controller
* Store/update a setting * Store/update a setting
* *
* @param Request $request * @param Request $request
* @return Response * @return JsonResponse
*/ */
public function store(Request $request) public function store(Request $request)
{ {
@@ -72,7 +74,7 @@ class SettingsController extends Controller
* Bulk store/update a setting * Bulk store/update a setting
* *
* @param Request $request * @param Request $request
* @return Response * @return JsonResponse
*/ */
public function bulkStore(Request $request) public function bulkStore(Request $request)
{ {
@@ -94,7 +96,7 @@ class SettingsController extends Controller
if(!isset($d['value']) || $d['value'] == null) { if(!isset($d['value']) || $d['value'] == null) {
$d['value'] = ''; $d['value'] = '';
} }
if($d['name'] == 'speedtest_overview_time') { if($d['name'] == 'speedtest_overview_time') {
$ok = [ '00', '01', '02', '03', '04', '05', '06', '07', '08', '09', '10', '11', '12', '13', '14', '15', '16', '17', '18', '19', '20', '21', '22', '23' ]; $ok = [ '00', '01', '02', '03', '04', '05', '06', '07', '08', '09', '10', '11', '12', '13', '14', '15', '16', '17', '18', '19', '20', '21', '22', '23' ];
if(!in_array($d['value'], $ok)) { if(!in_array($d['value'], $ok)) {
@@ -134,6 +136,12 @@ class SettingsController extends Controller
return SettingsHelper::getConfig(); return SettingsHelper::getConfig();
} }
/**
* Trigger a test of all notification agents
*
* @return JsonResponse
*/
public function testNotification() public function testNotification()
{ {
SettingsHelper::testNotification(); SettingsHelper::testNotification();

View File

@@ -11,6 +11,7 @@ use Illuminate\Http\Request;
use Illuminate\Support\Facades\Cache; use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\DB; use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Validator; use Illuminate\Support\Facades\Validator;
use Illuminate\Http\JsonResponse;
class SpeedtestController extends Controller class SpeedtestController extends Controller
{ {
@@ -18,7 +19,7 @@ class SpeedtestController extends Controller
/** /**
* Returns paginated list of speedtests * Returns paginated list of speedtests
* *
* @return Response * @return JsonResponse
*/ */
public function index() public function index()
{ {
@@ -35,7 +36,7 @@ class SpeedtestController extends Controller
* Returns speedtest going back 'x' days * Returns speedtest going back 'x' days
* *
* @param int $days * @param int $days
* @return void * @return JsonResponse
*/ */
public function time($days) public function time($days)
{ {
@@ -71,7 +72,7 @@ class SpeedtestController extends Controller
* Returns speedtest failure rate going back 'x' days * Returns speedtest failure rate going back 'x' days
* *
* @param int $days * @param int $days
* @return void * @return JsonResponse
*/ */
public function fail($days) public function fail($days)
{ {
@@ -100,7 +101,7 @@ class SpeedtestController extends Controller
/** /**
* Return latest speedtest * Return latest speedtest
* *
* @return Response * @return JsonResponse
*/ */
public function latest() public function latest()
{ {
@@ -130,7 +131,7 @@ class SpeedtestController extends Controller
/** /**
* Queue a new speedtest * Queue a new speedtest
* *
* @return Response * @return JsonResponse
*/ */
public function run() public function run()
{ {
@@ -151,7 +152,7 @@ class SpeedtestController extends Controller
/** /**
* Delete all speedtests from db * Delete all speedtests from db
* *
* @return Response * @return JsonResponse
*/ */
public function deleteAll() public function deleteAll()
{ {
@@ -175,7 +176,7 @@ class SpeedtestController extends Controller
* Delete a specific speedtest from the database * Delete a specific speedtest from the database
* *
* @param Speedtest $speedtest * @param Speedtest $speedtest
* @return boolean * @return JsonResponse
*/ */
public function delete(Speedtest $speedtest) public function delete(Speedtest $speedtest)
{ {

View File

@@ -5,6 +5,7 @@ namespace App\Http\Controllers;
use Exception; use Exception;
use Updater; use Updater;
use Illuminate\Http\Request; use Illuminate\Http\Request;
use Illuminate\Http\JsonResponse;
class UpdateController extends Controller class UpdateController extends Controller
{ {
@@ -12,7 +13,7 @@ class UpdateController extends Controller
/** /**
* Check for new update * Check for new update
* *
* @return Response * @return JsonResponse
*/ */
public function checkForUpdate() public function checkForUpdate()
{ {
@@ -25,7 +26,7 @@ class UpdateController extends Controller
/** /**
* Download new update * Download new update
* *
* @return Response * @return JsonResponse
*/ */
public function downloadUpdate() public function downloadUpdate()
{ {
@@ -47,7 +48,7 @@ class UpdateController extends Controller
/** /**
* Trigger update extraction * Trigger update extraction
* *
* @return Response * @return JsonResponse
*/ */
public function extractUpdate() public function extractUpdate()
{ {
@@ -69,22 +70,22 @@ class UpdateController extends Controller
/** /**
* Trigger update file move * Trigger update file move
* *
* @return Response * @return JsonResponse
*/ */
public function moveUpdate() public function moveUpdate()
{ {
$cp = Updater::updateFiles(); Updater::updateFiles();
return response()->json([ return response()->json([
'method' => 'copy latest version', 'method' => 'copy latest version',
'success' => $cp, 'success' => null,
], 200); ], 200);
} }
/** /**
* Get local changelog * Get local changelog
* *
* @return Response * @return JsonResponse
*/ */
public function changelog() public function changelog()
{ {

View File

@@ -17,5 +17,7 @@ class Authenticate extends Middleware
if (! $request->expectsJson()) { if (! $request->expectsJson()) {
return route('auth.login'); return route('auth.login');
} }
return null;
} }
} }

View File

@@ -10,6 +10,7 @@ use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Queue\InteractsWithQueue; use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Support\Facades\Log; use Illuminate\Support\Facades\Log;
use Illuminate\Support\Facades\Notification; use Illuminate\Support\Facades\Notification;
use NotificationChannels\Telegram\TelegramChannel;
class SpeedtestFailedListener class SpeedtestFailedListener
{ {

View File

@@ -14,6 +14,8 @@ class SpeedtestCompleteTelegram extends Notification
{ {
use Queueable; use Queueable;
public $speedtest;
/** /**
* Create a new notification instance. * Create a new notification instance.
* *

View File

@@ -12,6 +12,8 @@ class SpeedtestOverviewSlack extends Notification
{ {
use Queueable; use Queueable;
public $data;
/** /**
* Create a new notification instance. * Create a new notification instance.
* *

View File

@@ -14,6 +14,8 @@ class SpeedtestOverviewTelegram extends Notification
{ {
use Queueable; use Queueable;
public $data;
/** /**
* Create a new notification instance. * Create a new notification instance.
* *

View File

@@ -78,7 +78,7 @@ class User extends Authenticatable implements JWTSubject
/** /**
* Returns a user's login sessions * Returns a user's login sessions
* *
* @return array * @return mixed
*/ */
public function sessions() public function sessions()
{ {