PHPDoc fixes (#12687)

LibreNMS/Alerting/QueryBuilderParser.php

@@ -255,7 +255,7 @@ class QueryBuilderParser implements \JsonSerializable
     /**
      * Parse a rule group
      *
-     * @param $rule
+     * @param array $rule
      * @param bool $expand Expand macros?
      * @param bool $wrap Wrap in parenthesis
      * @return string

LibreNMS/Authentication/ActiveDirectoryCommon.php

@@ -178,7 +178,7 @@ trait ActiveDirectoryCommon
      * Must have the attributes: objectsid, samaccountname, displayname, mail
      * @internal
      *
-     * @param $entry
+     * @param array $entry
      * @return array
      */
     protected function userFromAd($entry)

LibreNMS/Cache/PermissionsCache.php

@@ -238,7 +238,7 @@ class PermissionsCache
     }
 
     /**
-     * @param $user
+     * @param mixed $user
      * @return int|null
      */
     private function getUserId($user)
@@ -247,7 +247,7 @@ class PermissionsCache
     }
 
     /**
-     * @param $device
+     * @param Demixed $device
      * @return int
      */
     private function getDeviceId($device)
@@ -256,7 +256,7 @@ class PermissionsCache
     }
 
     /**
-     * @param $port
+     * @param mixed $port
      * @return int
      */
     private function getPortId($port)
@@ -265,7 +265,7 @@ class PermissionsCache
     }
 
     /**
-     * @param $bill
+     * @param mixed $bill
      * @return int
      */
     private function getBillId($bill)

LibreNMS/Config.php

@@ -476,8 +476,8 @@ class Config
     /**
      * Copy data from old variables to new ones.
      *
-     * @param $old
+     * @param string $old
-     * @param $new
+     * @param string $new
      */
     private static function deprecatedVariable($old, $new)
     {
@@ -493,7 +493,7 @@ class Config
     /**
      * Locate the actual path of a binary
      *
-     * @param $binary
+     * @param string $binary
      * @return mixed
      */
     public static function locateBinary($binary)

LibreNMS/DB/Schema.php

@@ -124,7 +124,7 @@ class Schema
     /**
      * Return all columns for the given table
      *
-     * @param $table
+     * @param string $table
      * @return array
      */
     public function getColumns($table)

LibreNMS/Data/Store/Graphite.php

@@ -122,9 +122,9 @@ class Graphite extends BaseDatastore
     }
 
     /**
-     * @param $metric
+     * @param string $metric
-     * @param $value
+     * @param mixed $value
-     * @param $timestamp
+     * @param mixed $timestamp
      */
     private function writeData($metric, $value, $timestamp)
     {

LibreNMS/Data/Store/Rrd.php

@@ -260,9 +260,9 @@ class Rrd extends BaseDatastore
     /**
      * Generates a filename for a proxmox cluster rrd
      *
-     * @param $pmxcluster
+     * @param string $pmxcluster
-     * @param $vmid
+     * @param string $vmid
-     * @param $vmport
+     * @param string $vmport
      * @return string full path to the rrd.
      */
     public function proxmoxName($pmxcluster, $vmid, $vmport)
@@ -562,7 +562,7 @@ class Rrd extends BaseDatastore
     /**
      * Only track update and create primarily, just put all others in an "other" bin
      *
-     * @param $type
+     * @param string $type
      * @return string
      */
     private function coalesceStatisticType($type)

LibreNMS/Device/Processor.php

@@ -65,7 +65,7 @@ class Processor extends Model implements DiscoveryModule, PollerModule, Discover
      * @param int $warn_percent
      * @param int $entPhysicalIndex
      * @param int $hrDeviceIndex
-     * @return Processor
+     * @return static
      */
     public static function discover(
         $type,
@@ -295,6 +295,9 @@ class Processor extends Model implements DiscoveryModule, PollerModule, Discover
         return array_diff_key($array, array_flip($exclude));
     }
 
+    /**
+     * @param Processor $processor
+     */
     public static function onCreate($processor)
     {
         $message = "Processor Discovered: {$processor->processor_type} {$processor->processor_index} {$processor->processor_descr}";
@@ -303,6 +306,9 @@ class Processor extends Model implements DiscoveryModule, PollerModule, Discover
         parent::onCreate($processor);
     }
 
+    /**
+     * @param Processor $processor
+     */
     public static function onDelete($processor)
     {
         $message = "Processor Removed: {$processor->processor_type} {$processor->processor_index} {$processor->processor_descr}";

LibreNMS/Device/Sensor.php

@@ -241,7 +241,7 @@ class Sensor implements DiscoveryModule, PollerModule
      * Escape null values so dbFacile doesn't mess them up
      * honestly, this should be the default, but could break shit
      *
-     * @param $array
+     * @param array $array
      * @return array
      */
     private function escapeNull($array)
@@ -377,8 +377,8 @@ class Sensor implements DiscoveryModule, PollerModule
      * Process the snmp data for the specified sensors
      * Returns an array sensor_id => value
      *
-     * @param $sensors
+     * @param array $sensors
-     * @param $prefetch
+     * @param array $prefetch
      * @return array
      * @internal param $device
      */
@@ -425,7 +425,7 @@ class Sensor implements DiscoveryModule, PollerModule
     /**
      * Get a list of unique oids from an array of sensors and break it into chunks.
      *
-     * @param $sensors
+     * @param array $sensors
      * @param int $chunk How many oids per chunk.  Default 10.
      * @return array
      */
@@ -606,9 +606,9 @@ class Sensor implements DiscoveryModule, PollerModule
     /**
      * Record sensor data in the database and data stores
      *
-     * @param $os
+     * @param OS $os
-     * @param $sensors
+     * @param array $sensors
-     * @param $data
+     * @param array $data
      */
     protected static function recordSensorData(OS $os, $sensors, $data)
     {

LibreNMS/Device/WirelessSensor.php

@@ -248,7 +248,7 @@ class WirelessSensor extends Sensor
     /**
      * Convert a WiFi channel to a Frequency in MHz
      *
-     * @param $channel
+     * @param int $channel
      * @return int
      */
     public static function channelToFrequency($channel)

LibreNMS/Device/YamlDiscovery.php

@@ -35,7 +35,7 @@ class YamlDiscovery
     /**
      * @param OS $os
      * @param DiscoveryItem|string $class
-     * @param $yaml_data
+     * @param array $yaml_data
      * @return array
      */
     public static function discover(OS $os, $class, $yaml_data)

LibreNMS/Modules/PrinterSupplies.php

@@ -224,7 +224,7 @@ class PrinterSupplies implements Module
      * @param array $device
      * @param int|string $raw_value The value returned from snmp
      * @param int $capacity the normalized capacity
-     * @return int the toner level as a percentage
+     * @return int|float|bool the toner level as a percentage
      */
     private static function getTonerLevel($device, $raw_value, $capacity)
     {

LibreNMS/OS.php

@@ -138,7 +138,7 @@ class OS implements ProcessorDiscovery, OSDiscovery, MempoolsDiscovery
      * @param string $oid textual oid
      * @param string $mib mib for this oid
      * @param string $snmpflags snmpflags for this oid
-     * @return array array indexed by the snmp index with the value as the data returned by snmp
+     * @return array|null array indexed by the snmp index with the value as the data returned by snmp
      */
     public function getCacheByIndex($oid, $mib = null, $snmpflags = '-OQUs')
     {
@@ -164,7 +164,7 @@ class OS implements ProcessorDiscovery, OSDiscovery, MempoolsDiscovery
      * @param string $oid textual oid
      * @param string $mib mib for this oid (optional)
      * @param int $depth depth for snmpwalk_group (optional)
-     * @return array array indexed by the snmp index with the value as the data returned by snmp
+     * @return array|null array indexed by the snmp index with the value as the data returned by snmp
      */
     public function getCacheTable($oid, $mib = null, $depth = 1)
     {

LibreNMS/OS/Dnos.php

@@ -99,7 +99,7 @@ class Dnos extends OS implements ProcessorDiscovery
      * @param string $mib MIB
      * @param string $num_oid Numerical OID
      * @param string $name Name prefix to display to user
-     * @param string custom type (if there are multiple in one chassis)
+     * @param string $type custom type (if there are multiple in one chassis)
      */
     private function findProcessors(&$processors, $oid, $mib, $num_oid, $name, $type = null)
     {

LibreNMS/OS/Lcos.php

@@ -49,7 +49,7 @@ class Lcos extends OS implements
     /**
      * Convert String to decimal encoded string notation
      *
-     * @param string
+     * @param string $index
      * @return string decimal encoded OID string
      */
     private function strToDecOid($index)

LibreNMS/Proc.php

@@ -110,7 +110,7 @@ class Proc
      * process is not synchronous
      * If the command isn't terminated with a newline, add one
      *
-     * @param $command
+     * @param string $command
      * @return array
      */
     public function sendCommand($command)

app/Http/Controllers/Auth/TwoFactorController.php

@@ -96,7 +96,7 @@ class TwoFactorController extends Controller
      * Show the form for creating a new resource.
      *
      * @param Request $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\RedirectResponse.
      */
     public function create(Request $request)
     {
@@ -123,7 +123,7 @@ class TwoFactorController extends Controller
      * Remove the specified resource from storage.
      *
      * @param Request $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\RedirectResponse.
      */
     public function destroy(Request $request)
     {
@@ -137,7 +137,7 @@ class TwoFactorController extends Controller
      * Remove the specified resource from storage.
      *
      * @param Request $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\RedirectResponse.
      */
     public function cancelAdd(Request $request)
     {

app/Http/Controllers/DeviceGroupController.php

@@ -20,7 +20,7 @@ class DeviceGroupController extends Controller
     /**
      * Display a listing of the resource.
      *
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\View\View
      */
     public function index()
     {
@@ -39,7 +39,7 @@ class DeviceGroupController extends Controller
     /**
      * Show the form for creating a new resource.
      *
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\View\View
      */
     public function create()
     {
@@ -53,7 +53,7 @@ class DeviceGroupController extends Controller
      * Store a newly created resource in storage.
      *
      * @param \Illuminate\Http\Request $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\RedirectResponse
      */
     public function store(Request $request)
     {
@@ -82,7 +82,7 @@ class DeviceGroupController extends Controller
      * Display the specified resource.
      *
      * @param \App\Models\DeviceGroup $deviceGroup
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\RedirectResponse
      */
     public function show(DeviceGroup $deviceGroup)
     {
@@ -93,7 +93,7 @@ class DeviceGroupController extends Controller
      * Show the form for editing the specified resource.
      *
      * @param \App\Models\DeviceGroup $deviceGroup
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\View\View
      */
     public function edit(DeviceGroup $deviceGroup)
     {
@@ -114,7 +114,7 @@ class DeviceGroupController extends Controller
      *
      * @param \Illuminate\Http\Request $request
      * @param \App\Models\DeviceGroup $deviceGroup
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\RedirectResponse
      */
     public function update(Request $request, DeviceGroup $deviceGroup)
     {

app/Http/Controllers/LocationController.php

@@ -40,7 +40,7 @@ class LocationController extends Controller
      *
      * @param \Illuminate\Http\Request $request
      * @param Location $location
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse
      * @throws \Illuminate\Auth\Access\AuthorizationException
      */
     public function update(Request $request, Location $location)
@@ -63,7 +63,7 @@ class LocationController extends Controller
      * Remove the specified resource from storage.
      *
      * @param  Location $location
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse
      * @throws \Exception
      */
     public function destroy(Request $request, Location $location)

app/Http/Controllers/PaginatedAjaxController.php

@@ -185,13 +185,13 @@ abstract class PaginatedAjaxController extends Controller
      * @param  array $rules
      * @param  array $messages
      * @param  array $customAttributes
-     * @return void
+     * @return array
      */
     public function validate(Request $request, array $rules = [], array $messages = [], array $customAttributes = [])
     {
         $full_rules = array_replace($this->baseRules(), $rules);
 
-        parent::validate($request, $full_rules, $messages, $customAttributes);
+        return parent::validate($request, $full_rules, $messages, $customAttributes);
     }
 
     /**

app/Http/Controllers/Table/SimpleTableController.php

@@ -44,12 +44,13 @@ abstract class SimpleTableController extends Controller
      * @param  array $rules
      * @param  array $messages
      * @param  array $customAttributes
-     * @return void
+     * @return array
      */
     public function validate(Request $request, array $rules = [], array $messages = [], array $customAttributes = [])
     {
         $full_rules = array_replace(self::$base_rules, $rules);
-        parent::validate($request, $full_rules, $messages, $customAttributes);
+
+        return parent::validate($request, $full_rules, $messages, $customAttributes);
     }
 
     /**

app/Http/Controllers/UserController.php

@@ -46,7 +46,7 @@ class UserController extends Controller
     /**
      * Display a listing of the resource.
      *
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\View\View
      * @throws \Illuminate\Auth\Access\AuthorizationException
      */
     public function index()
@@ -62,7 +62,7 @@ class UserController extends Controller
     /**
      * Show the form for creating a new resource.
      *
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\View\View
      * @throws \Illuminate\Auth\Access\AuthorizationException
      */
     public function create()
@@ -83,7 +83,7 @@ class UserController extends Controller
      * Store a newly created resource in storage.
      *
      * @param StoreUserRequest $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\RedirectResponse
      */
     public function store(StoreUserRequest $request)
     {
@@ -112,7 +112,7 @@ class UserController extends Controller
      * Display the specified resource.
      *
      * @param User $user
-     * @return \Illuminate\Http\Response
+     * @return string
      * @throws \Illuminate\Auth\Access\AuthorizationException
      */
     public function show(User $user)
@@ -126,7 +126,7 @@ class UserController extends Controller
      * Show the form for editing the specified resource.
      *
      * @param User $user
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\View\View
      * @throws \Illuminate\Auth\Access\AuthorizationException
      */
     public function edit(User $user)
@@ -157,7 +157,7 @@ class UserController extends Controller
      *
      * @param UpdateUserRequest $request
      * @param User $user
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\RedirectResponse
      */
     public function update(UpdateUserRequest $request, User $user)
     {
@@ -188,7 +188,7 @@ class UserController extends Controller
      * Remove the specified resource from storage.
      *
      * @param User $user
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse
      * @throws \Illuminate\Auth\Access\AuthorizationException
      */
     public function destroy(User $user)

app/Http/Controllers/UserPreferencesController.php

@@ -49,7 +49,7 @@ class UserPreferencesController extends Controller
      * Display a listing of the resource.
      *
      * @param \Illuminate\Http\Request $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\View\View
      */
     public function index(Request $request)
     {
@@ -94,7 +94,7 @@ class UserPreferencesController extends Controller
      * Store a newly created resource in storage.
      *
      * @param \Illuminate\Http\Request $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse
      */
     public function store(Request $request)
     {

app/Http/Controllers/Widgets/WidgetController.php

@@ -44,7 +44,7 @@ abstract class WidgetController extends Controller
 
     /**
      * @param Request $request
-     * @return View
+     * @return View|string
      */
     abstract public function getView(Request $request);