Commented the code

This commit is contained in:
Henry Whitaker
2020-06-19 14:02:38 +01:00
parent be37463604
commit 91f457c7d1
15 changed files with 258 additions and 9 deletions

View File

@@ -10,6 +10,13 @@ use Illuminate\Support\Facades\Validator;
class BackupController extends Controller
{
/**
* Get backup of speedtests
*
* @param Request $request
* @return file
*/
public function backup(Request $request)
{
$validator = Validator::make($request->all(), [ 'format' => 'in:json,csv' ]);
@@ -25,6 +32,12 @@ class BackupController extends Controller
return Storage::disk('local')->download($filename);
}
/**
* Retore from a backup
*
* @param Request $request
* @return Response
*/
public function restore(Request $request)
{
$rule = [

View File

@@ -10,16 +10,34 @@ use Illuminate\Support\Facades\Validator;
class SettingsController extends Controller
{
/**
* Return all settings
*
* @return array
*/
public function index()
{
return Setting::get()->keyBy('name');
}
/**
* Get setting by id
*
* @param Setting $setting
* @return Setting
*/
public function get(Setting $setting)
{
return $setting;
}
/**
* Store/update a setting
*
* @param Request $request
* @return Response
*/
public function store(Request $request)
{
$rule = [
@@ -49,6 +67,11 @@ class SettingsController extends Controller
], 200);
}
/**
* Returns instance config
*
* @return array
*/
public function config()
{

View File

@@ -13,6 +13,12 @@ use Illuminate\Support\Facades\Validator;
class SpeedtestController extends Controller
{
/**
* Returns paginated list of speedtests
*
* @return Response
*/
public function index()
{
$data = Speedtest::orderBy('created_at', 'desc')
@@ -24,6 +30,12 @@ class SpeedtestController extends Controller
], 200);
}
/**
* Returns speedtest going back 'x' days
*
* @param int $days
* @return void
*/
public function time($days)
{
$rule = [
@@ -50,6 +62,11 @@ class SpeedtestController extends Controller
], 200);
}
/**
* Return latest speedtest
*
* @return Response
*/
public function latest()
{
$data = SpeedtestHelper::latest();
@@ -73,6 +90,11 @@ class SpeedtestController extends Controller
}
}
/**
* Queue a new speedtest
*
* @return Response
*/
public function run()
{
try {

View File

@@ -8,6 +8,12 @@ use Illuminate\Http\Request;
class UpdateController extends Controller
{
/**
* Check for new update
*
* @return Response
*/
public function checkForUpdate()
{
return response()->json([
@@ -16,6 +22,11 @@ class UpdateController extends Controller
], 200);
}
/**
* Download new update
*
* @return Response
*/
public function downloadUpdate()
{
$dl = Updater::downloadLatest();
@@ -33,6 +44,11 @@ class UpdateController extends Controller
}
}
/**
* Trigger update extraction
*
* @return Response
*/
public function extractUpdate()
{
$ex = Updater::extractFiles();
@@ -50,6 +66,11 @@ class UpdateController extends Controller
}
}
/**
* Trigger update file move
*
* @return Response
*/
public function moveUpdate()
{
$cp = Updater::updateFiles();
@@ -60,6 +81,11 @@ class UpdateController extends Controller
], 200);
}
/**
* Get local changelog
*
* @return Response
*/
public function changelog()
{
$url = base_path() . '/changelog.json';