More PHPDoc changes (#12674)

* PHPDoc

* Override type hint

app/Http/Controllers/Select/DeviceGroupController.php

@@ -38,6 +38,9 @@ class DeviceGroupController extends SelectController
         return DeviceGroup::hasAccess($request->user())->select('id', 'name');
     }
 
+    /**
+     * @param DeviceGroup $device_group
+     */
     public function formatItem($device_group)
     {
         return [

app/Http/Controllers/Select/MuninPluginController.php

@@ -43,6 +43,9 @@ class MuninPluginController extends SelectController
             ->select('mplug_id', 'mplug_type', 'device_id');
     }
 
+    /**
+     * @param MuninPlugin $munin_plugin
+     */
     public function formatItem($munin_plugin)
     {
         return [

app/Http/Controllers/Select/ServiceController.php

@@ -43,6 +43,9 @@ class ServiceController extends SelectController
             ->select('service_id', 'service_type', 'service_desc', 'device_id');
     }
 
+    /**
+     * @param Service $service
+     */
     public function formatItem($service)
     {
         return [

app/Http/Controllers/Table/EventlogController.php

@@ -74,6 +74,9 @@ class EventlogController extends TableController
             });
     }
 
+    /**
+     * @param Eventlog $eventlog
+     */
     public function formatItem($eventlog)
     {
         return [

app/Http/Controllers/Table/FdbTablesController.php

@@ -147,6 +147,9 @@ class FdbTablesController extends TableController
         return $query;
     }
 
+    /**
+     * @param PortsFdb $fdb_entry
+     */
     public function formatItem($fdb_entry)
     {
         $ip_info = $this->findIps($fdb_entry->mac_address);

app/Http/Controllers/Table/MempoolsController.php

@@ -65,6 +65,9 @@ class MempoolsController extends TableController
         return $query;
     }
 
+    /**
+     * @param Device|Mempool $mempool
+     */
     public function formatItem($mempool)
     {
         if ($mempool instanceof Device) {

app/Http/Controllers/Table/OutagesController.php

@@ -70,6 +70,9 @@ class OutagesController extends TableController
             });
     }
 
+    /**
+     * @param DeviceOutage $outage
+     */
     public function formatItem($outage)
     {
         $start = $this->formatDatetime($outage->going_down);

app/Http/Controllers/Table/PortNacController.php

@@ -73,6 +73,9 @@ class PortNacController extends TableController
         return PortsNac::where('device_id', $request->device_id)->hasAccess($request->user())->with('port');
     }
 
+    /**
+     * @param PortsNac $nac
+     */
     public function formatItem($nac)
     {
         $item = $nac->toArray();

app/Http/Controllers/Table/SyslogController.php

@@ -80,6 +80,9 @@ class SyslogController extends TableController
             });
     }
 
+    /**
+     * @param Syslog $syslog
+     */
     public function formatItem($syslog)
     {
         $device = $syslog->device;

app/Http/Controllers/Table/VminfoController.php

@@ -57,6 +57,9 @@ class VminfoController extends TableController
             });
     }
 
+    /**
+     * @param Vminfo $vm
+     */
     public function formatItem($vm)
     {
         return [

app/Http/Controllers/Widgets/TopDevicesController.php

@@ -182,7 +182,6 @@ class TopDevicesController extends WidgetController
     {
         $settings = $this->getSettings();
 
-        /** @var Builder $query */
         $query = Port::hasAccess(Auth::user())->with(['device' => function ($query) {
             $query->select('device_id', 'hostname', 'sysName', 'status', 'os');
         }])
@@ -236,7 +235,7 @@ class TopDevicesController extends WidgetController
     {
         $settings = $this->getSettings();
 
-        /** @var Builder $query */
+        /** @var Processor $query */
         $query = $this->withDeviceQuery(Processor::hasAccess(Auth::user()), (new Processor)->getTable())
             ->orderByRaw('AVG(`processor_usage`) ' . $sort)
             ->limit($settings['device_count']);
@@ -252,7 +251,7 @@ class TopDevicesController extends WidgetController
     {
         $settings = $this->getSettings();
 
-        /** @var Builder $query */
+        /** @var Mempool $query */
         $query = $this->withDeviceQuery(Mempool::hasAccess(Auth::user()), (new Mempool)->getTable())
             ->orderBy('mempool_perc', $sort)
             ->limit($settings['device_count']);
@@ -268,7 +267,6 @@ class TopDevicesController extends WidgetController
     {
         $settings = $this->getSettings();
 
-        /** @var Builder $query */
         $query = $this->deviceQuery()->orderBy('last_polled_timetaken', $sort)->limit($settings['device_count']);
 
         $results = $query->get()->map(function ($device) {
@@ -282,7 +280,6 @@ class TopDevicesController extends WidgetController
     {
         $settings = $this->getSettings();
 
-        /** @var Builder $query */
         $query = Storage::hasAccess(Auth::user())->with(['device' => function ($query) {
             $query->select('device_id', 'hostname', 'sysName', 'status', 'os');
         }])

app/Http/Controllers/Widgets/WorldMapController.php

@@ -68,7 +68,9 @@ class WorldMapController extends WidgetController
                 }
 
                 // add extra data
+                /** @phpstan-ignore-next-line */
                 $device->markerIcon = 'greenMarker';
+                /** @phpstan-ignore-next-line */
                 $device->zOffset = 0;
 
                 if ($device->status == 0) {

app/Models/UserPref.php

@@ -29,6 +29,7 @@ class UserPref extends BaseModel
     public $timestamps = false;
     public $incrementing = false;
     protected $table = 'users_prefs';
+    /** @var array */
     protected $primaryKey = ['user_id', 'pref'];
     protected $fillable = ['user_id', 'pref', 'value'];
 
@@ -91,6 +92,7 @@ class UserPref extends BaseModel
      */
     protected function setKeysForSaveQuery($query)
     {
+        /** @var array */
         $keys = $this->getKeyName();
         if (! is_array($keys)) {
             return parent::setKeysForSaveQuery($query);

app/Providers/LegacyUserProvider.php

@@ -98,6 +98,7 @@ class LegacyUserProvider implements UserProvider
      */
     public function updateRememberToken(Authenticatable $user, $token)
     {
+        /** @var User $user */
         $user->setRememberToken($token);
         $timestamps = $user->timestamps;
         $user->timestamps = false;

app/Providers/TokenUserProvider.php

@@ -72,6 +72,7 @@ class TokenUserProvider extends LegacyUserProvider implements UserProvider
 
         // missing user for existing token, create it assuming legacy auth_id
         $api_token = ApiToken::where('token_hash', $credentials['api_token'])->first();
+        /** @var \App\Models\User */
         $user = $this->retrieveByLegacyId($api_token->user_id);
 
         // update token user_id
@@ -92,6 +93,7 @@ class TokenUserProvider extends LegacyUserProvider implements UserProvider
      */
     public function validateCredentials(Authenticatable $user, array $credentials)
     {
+        /** @var \App\Models\User $user */
         return ApiToken::isValid($credentials['api_token'], $user->user_id);
     }
 }