Updated typing

Author: quentin.schmick

database/migrations/2019_09_25_103421_update_task_results_duration_type.php

@@ -28,7 +28,7 @@ public function down()
     }
 
     /**
-     * @param bool $toFloat
+     * @param  bool  $toFloat
      */
     private function migrateDurationValues(bool $toFloat = true)
     {

src/Console/Commands/ListSchedule.php

@@ -32,7 +32,7 @@ class ListSchedule extends Command
     /**
      * Create a new command instance.
      *
-     * @param Schedule $schedule
+     * @param  Schedule  $schedule
      * @return void
      */
     public function __construct(Schedule $schedule)

src/Contracts/TaskInterface.php

@@ -2,65 +2,70 @@
 
 namespace Studio\Totem\Contracts;
 
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Collection;
+use Studio\Totem\Task;
+
 interface TaskInterface
 {
     /**
      * Returns Eloquent Builder.
      *
-     * @return \Illuminate\Database\Eloquent\Builder
+     * @return Builder
      */
-    public function builder();
+    public function builder(): Builder;
 
     /**
      * Returns a task by its primary key.
      *
-     * @param  int|\Studio\Totem\Task  $id
-     * @return \Studio\Totem\Task
+     * @param int|Task $id
+     * @return Task
      */
-    public function find($id);
+    public function find(Task|int $id): Task;
 
     /**
      * Returns all tasks.
-     * @return \Illuminate\Database\Eloquent\Collection
+     * @return Collection
      */
-    public function findAll();
+    public function findAll(): Collection;
 
     /**
      * Returns all active tasks.
-     * @return \Illuminate\Database\Eloquent\Collection
+     *
+     * @return Collection
      */
-    public function findAllActive();
+    public function findAllActive(): Collection;
 
     /**
      * Creates a new task with the given data.
      *
-     * @param  array $input
-     * @return \Studio\Totem\Task
+     * @param  array  $input
+     * @return Task
      */
     public function store(array $input);
 
     /**
      * Updates the given task with the given data.
      *
-     * @param  array $input
-     * @param  \Studio\Totem\Task  $task
-     * @return \Studio\Totem\Task
+     * @param  array  $input
+     * @param  Task  $task
+     * @return Task
      */
-    public function update(array $input, $task);
+    public function update(array $input, Task $task): Task;
 
     /**
      * Deletes the given task.
      *
-     * @param  int|\Studio\Totem\Task  $id
+     * @param int|Task $id
      * @return bool
      */
-    public function destroy($id);
+    public function destroy(Task|int $id): bool;
 
     /**
      * Executes the given task.
      *
-     * @param  int|\Studio\Totem\Task  $id
+     * @param int|Task $id
      * @return bool
      */
-    public function execute($id);
+    public function execute(Task|int $id): bool;
 }

src/Events/BroadcastingEvent.php

@@ -13,9 +13,9 @@ class BroadcastingEvent extends TaskEvent implements ShouldBroadcast
     /**
      * Get the channels the event should broadcast on.
      *
-     * @return \Illuminate\Broadcasting\Channel|\Illuminate\Broadcasting\Channel[]|PrivateChannel
+     * @return PrivateChannel
      */
-    public function broadcastOn()
+    public function broadcastOn(): PrivateChannel
     {
         return new PrivateChannel(config('totem.broadcasting.channel'));
     }
@@ -25,7 +25,7 @@ public function broadcastOn()
      *
      * @return bool
      */
-    public function broadcastWhen()
+    public function broadcastWhen(): bool
     {
         return config('totem.broadcasting.enabled');
     }

src/Events/Creating.php

@@ -2,7 +2,6 @@
 
 namespace Studio\Totem\Events;
 
-use Illuminate\Broadcasting\Channel;
 use Illuminate\Broadcasting\InteractsWithSockets;
 use Illuminate\Broadcasting\PrivateChannel;
 use Illuminate\Contracts\Broadcasting\ShouldBroadcast;
@@ -16,7 +15,7 @@ class Creating implements ShouldBroadcast
     /**
      * @var array
      */
-    private $input;
+    private array $input;
 
     /**
      * Create a new event instance.
@@ -31,9 +30,9 @@ public function __construct(array $input)
     /**
      * Get the channels the event should broadcast on.
      *
-     * @return Channel|array
+     * @return PrivateChannel
      */
-    public function broadcastOn()
+    public function broadcastOn(): PrivateChannel
     {
         return new PrivateChannel('channel-name');
     }

src/Events/Deleted.php

@@ -7,8 +7,6 @@ class Deleted extends Event
     /**
      * Create a new event instance.
      *
-     * @param array $input
-     * @param Task $task
      */
     public function __construct()
     {

src/Events/Executed.php

@@ -11,7 +11,8 @@ class Executed extends BroadcastingEvent
      * Executed constructor.
      *
      * @param Task $task
-     * @param string $started
+     * @param string|float|int $started
+     * @param $output
      */
     public function __construct(Task $task, $started, $output)
     {

src/Events/TaskEvent.php

@@ -13,7 +13,7 @@ class TaskEvent extends Event
     /**
      * @var Task
      */
-    public $task;
+    public Task $task;
 
     /**
      * Constructor.

src/Events/Updating.php

@@ -2,7 +2,6 @@
 
 namespace Studio\Totem\Events;
 
-use Illuminate\Broadcasting\Channel;
 use Illuminate\Broadcasting\PrivateChannel;
 use Studio\Totem\Task;
 
@@ -11,7 +10,7 @@ class Updating extends BroadcastingEvent
     /**
      * @var array
      */
-    private $input;
+    private array $input;
 
     /**
      * Create a new event instance.
@@ -28,9 +27,9 @@ public function __construct(array $input, Task $task)
     /**
      * Get the channels the event should broadcast on.
      *
-     * @return Channel|array
+     * @return PrivateChannel
      */
-    public function broadcastOn()
+    public function broadcastOn(): PrivateChannel
     {
         return new PrivateChannel('channel-name');
     }

src/Frequency.php

@@ -2,6 +2,7 @@
 
 namespace Studio\Totem;
 
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Studio\Totem\Traits\HasParameters;
 
 class Frequency extends TotemModel
@@ -17,9 +18,9 @@ class Frequency extends TotemModel
     ];
 
     /**
-     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     * @return BelongsTo
      */
-    public function task()
+    public function task(): BelongsTo
     {
         return $this->belongsTo(Task::class);
     }

src/Http/Controllers/ActiveTasksController.php

@@ -2,6 +2,7 @@
 
 namespace Studio\Totem\Http\Controllers;
 
+use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Request;
 use Studio\Totem\Contracts\TaskInterface;
 
@@ -10,7 +11,7 @@ class ActiveTasksController extends Controller
     /**
      * @var TaskInterface
      */
-    private $tasks;
+    private TaskInterface $tasks;
 
     /**
      * @param TaskInterface $tasks
@@ -25,10 +26,10 @@ public function __construct(TaskInterface $tasks)
     /**
      * Store a newly active task in storage.
      *
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
+     * @param Request $request
+     * @return JsonResponse
      */
-    public function store(Request $request)
+    public function store(Request $request): JsonResponse
     {
         $task = $this->tasks->activate($request->all());
 
@@ -39,9 +40,9 @@ public function store(Request $request)
      * Remove the specified resource from storage.
      *
      * @param  int  $id
-     * @return \Illuminate\Http\Response
+     * @return JsonResponse
      */
-    public function destroy($id)
+    public function destroy(int $id): JsonResponse
     {
         $task = $this->tasks->deactivate($id);
 

src/Http/Controllers/DashboardController.php

@@ -2,14 +2,16 @@
 
 namespace Studio\Totem\Http\Controllers;
 
+use Illuminate\Http\RedirectResponse;
+
 class DashboardController extends Controller
 {
     /**
      * Single page application catch-all route.
      *
-     * @return \Illuminate\Http\Response
+     * @return RedirectResponse
      */
-    public function index()
+    public function index(): RedirectResponse
     {
         return redirect()->route('totem.tasks.all');
     }

src/Http/Controllers/ExecuteTasksController.php

@@ -10,13 +10,15 @@ class ExecuteTasksController extends Controller
     /**
      * @var TaskInterface
      */
-    private $tasks;
+    private TaskInterface $tasks;
 
     /**
      * @param TaskInterface $tasks
      */
     public function __construct(TaskInterface $tasks)
     {
+        parent::__construct();
+
         $this->tasks = $tasks;
     }
 

src/Http/Controllers/ExportTasksController.php

@@ -3,13 +3,14 @@
 namespace Studio\Totem\Http\Controllers;
 
 use Studio\Totem\Contracts\TaskInterface;
+use Symfony\Component\HttpFoundation\StreamedResponse;
 
 class ExportTasksController extends Controller
 {
     /**
      * @var TaskInterface
      */
-    private $tasks;
+    private TaskInterface $tasks;
 
     /**
      * ExportTasksController constructor.
@@ -25,9 +26,9 @@ public function __construct(TaskInterface $tasks)
     /**
      * Export all tasks to a json file.
      *
-     * @return \Symfony\Component\HttpFoundation\StreamedResponse
+     * @return StreamedResponse
      */
-    public function index()
+    public function index() : StreamedResponse
     {
         $headers = [
             'Content-Type' => 'text/json',

src/Http/Controllers/ImportTasksController.php

@@ -2,6 +2,7 @@
 
 namespace Studio\Totem\Http\Controllers;
 
+use Illuminate\Contracts\Filesystem\FileNotFoundException;
 use Studio\Totem\Contracts\TaskInterface;
 use Studio\Totem\Http\Requests\ImportRequest;
 
@@ -10,7 +11,7 @@ class ImportTasksController extends Controller
     /**
      * @var TaskInterface
      */
-    private $tasks;
+    private TaskInterface $tasks;
 
     /**
      * ImportTasksController constructor.
@@ -25,8 +26,8 @@ public function __construct(TaskInterface $tasks)
 
     /**
      * Import tasks from a json file.
-     * @param \Studio\Totem\Http\Requests\ImportRequest $request
-     * @throws \Illuminate\Contracts\Filesystem\FileNotFoundException
+     * @param ImportRequest $request
+     * @throws FileNotFoundException
      */
     public function index(ImportRequest $request)
     {