mirror/librenms-librenms
1
0
Fork 0
mirror of https://github.com/librenms/librenms.git synced 2024-10-07 16:52:45 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Apply fixes from StyleCI (#13208)

Browse Source
This commit is contained in:
Jellyfrog
2021-09-08 23:35:56 +02:00
committed by GitHub
parent c6d2385c3a
commit 26b95c0ccc
370 changed files with 1667 additions and 1667 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
LibreNMS/Interfaces/Alert/Transport.php
View File

@@ -29,8 +29,8 @@ interface Transport
/**
* Gets called when an alert is sent
*
* @param array $alert_data An array created by DescribeAlert
* @param array|true $opts The options from the alert_transports transport_config column
* @param array $alert_data An array created by DescribeAlert
* @param array|true $opts The options from the alert_transports transport_config column
* @return mixed Returns if the call was successful
*/
public function deliverAlert($alert_data, $opts);

44
LibreNMS/Interfaces/Authentication/Authorizer.php
View File

@@ -10,7 +10,7 @@ interface Authorizer
* Authenticate the user and password.
* Some Authorizer methods may only check username.
*
* @param array $credentials
* @param array $credentials
* @return true throws an Exception on failure
* @throws AuthenticationException thrown if the username or password is invalid
*/
@@ -19,8 +19,8 @@ interface Authorizer
/**
* Check if a $username exists.
*
* @param string $username
* @param bool $throw_exception Allows for a message to be sent to callers in case the user does not exist
* @param string $username
* @param bool $throw_exception Allows for a message to be sent to callers in case the user does not exist
* @return bool
*/
public function userExists($username, $throw_exception = false);
@@ -28,7 +28,7 @@ interface Authorizer
/**
* Get the userlevel of $username
*
* @param string $username The username to check
* @param string $username The username to check
* @return int
*/
public function getUserlevel($username);
@@ -36,7 +36,7 @@ interface Authorizer
/**
* Get the user_id of $username
*
* @param string $username
* @param string $username
* @return int
*/
public function getUserid($username);
@@ -53,7 +53,7 @@ interface Authorizer
* level
* can_modify_passwd
*
* @param int $user_id
* @param int $user_id
* @return array|false
*/
public function getUser($user_id);
@@ -61,13 +61,13 @@ interface Authorizer
/**
* Add a new user.
*
* @param string $username
* @param string $password
* @param int $level
* @param string $email
* @param string $realname
* @param int $can_modify_passwd If this user is allowed to edit their password
* @param string $description
* @param string $username
* @param string $password
* @param int $level
* @param string $email
* @param string $realname
* @param int $can_modify_passwd If this user is allowed to edit their password
* @param string $description
* @return int|false Returns the added user_id or false if adding failed
*/
public function addUser($username, $password, $level = 0, $email = '', $realname = '', $can_modify_passwd = 0, $description = '');
@@ -75,18 +75,18 @@ interface Authorizer
/**
* Update the some of the fields of a user
*
* @param int $user_id The user_id to update
* @param string $realname
* @param int $level
* @param int $can_modify_passwd
* @param string $email
* @param int $user_id The user_id to update
* @param string $realname
* @param int $level
* @param int $can_modify_passwd
* @param string $email
* @return bool If the update was successful
*/
public function updateUser($user_id, $realname, $level, $can_modify_passwd, $email);
/**
* @param string $username The $username to update
* @param string $newpassword
* @param string $username The $username to update
* @param string $newpassword
* @return bool If the update was successful
*/
public function changePassword($username, $newpassword);
@@ -94,7 +94,7 @@ interface Authorizer
/**
* Delete a user.
*
* @param int $user_id
* @param int $user_id
* @return bool If the deletion was successful
*/
public function deleteUser($user_id);
@@ -126,7 +126,7 @@ interface Authorizer
/**
* Check if this Authorizer can set new passwords.
*
* @param string $username Optionally, check if $username can set their own password
* @param string $username Optionally, check if $username can set their own password
* @return bool
*/
public function canUpdatePasswords($username = '');

10
LibreNMS/Interfaces/Data/Datastore.php
View File

@@ -63,11 +63,11 @@ interface Datastore
* rrd_oldname array|string: old rrd filename to rename, will be processed with rrd_name()
* rrd_step int: rrd step, defaults to 300
*
* @param array $device
* @param string $measurement Name of this measurement
* @param array $tags tags for the data (or to control rrdtool)
* @param array|mixed $fields The data to update in an associative array, the order must be consistent with rrd_def,
* single values are allowed and will be paired with $measurement
* @param array $device
* @param string $measurement Name of this measurement
* @param array $tags tags for the data (or to control rrdtool)
* @param array|mixed $fields The data to update in an associative array, the order must be consistent with rrd_def,
* single values are allowed and will be paired with $measurement
*/
public function put($device, $measurement, $tags, $fields);
}

6
LibreNMS/Interfaces/Discovery/DiscoveryItem.php
View File

@@ -23,9 +23,9 @@ interface DiscoveryItem
* Generate an instance of this class from yaml data.
* The data is processed and any snmp data is filled in
*
* @param OS $os
* @param int $index the index of the current entry
* @param array $data
* @param OS $os
* @param int $index the index of the current entry
* @param array $data
* @return static
*/
public static function fromYaml(OS $os, $index, array $data);

8
LibreNMS/Interfaces/Discovery/MplsDiscovery.php
View File

@@ -34,7 +34,7 @@ interface MplsDiscovery
public function discoverMplsLsps();
/**
* @param Collection $lsps collecton of synchronized lsp objects from discoverMplsLsps()
* @param Collection $lsps collecton of synchronized lsp objects from discoverMplsLsps()
* @return Collection MplsLspPath objects
*/
public function discoverMplsPaths($lsps);
@@ -50,14 +50,14 @@ interface MplsDiscovery
public function discoverMplsServices();
/**
* @param Collection $svcs collecton of synchronized lsp objects from discoverMplsServices()
* @param Collection $svcs collecton of synchronized lsp objects from discoverMplsServices()
* @return Collection MplsSap objects
*/
public function discoverMplsSaps($svcs);
/**
* @param Collection $sdps collecton of synchronized sdp objects from discoverMplsSdps()
* @param Collection $svcs collecton of synchronized service objects from discoverMplsServices()
* @param Collection $sdps collecton of synchronized sdp objects from discoverMplsSdps()
* @param Collection $svcs collecton of synchronized service objects from discoverMplsServices()
* @return Collection MplsSdpBind objects
*/
public function discoverMplsSdpBinds($sdps, $svcs);

2
LibreNMS/Interfaces/Discovery/OSDetection.php
View File

@@ -33,7 +33,7 @@ interface OSDetection
* $device->sysObjectID and $device->sysDescr will be pre-populated
* Please avoid additional snmp queries if possible
*
* @param Device $device
* @param Device $device
* @return bool
*/
public static function detectOS(Device $device): bool;

2
LibreNMS/Interfaces/Discovery/OSDiscovery.php
View File

@@ -33,7 +33,7 @@ interface OSDiscovery
* Discover additional information about the OS.
* Primarily this is just version, hardware, features, serial, but could be anything
*
* @param \App\Models\Device $device
* @param \App\Models\Device $device
*/
public function discoverOS(Device $device): void;
}

2
LibreNMS/Interfaces/Exceptions/UpgradeableException.php
View File

@@ -30,7 +30,7 @@ interface UpgradeableException
* Try to convert the given Exception to this exception
* It should return null if the Exception cannot be upgraded.
*
* @param \Exception $exception
* @param \Exception $exception
* @return static|null
*/
public static function upgrade($exception);

2
LibreNMS/Interfaces/Geocoder.php
View File

@@ -30,7 +30,7 @@ interface Geocoder
* Try to get the coordinates of a given address.
* If unsuccessful, the returned array will be empty
*
* @param string $address
* @param string $address
* @return array ['lat' => 0, 'lng' => 0]
*/
public function getCoordinates($address);

6
LibreNMS/Interfaces/Module.php
View File

@@ -32,7 +32,7 @@ interface Module
* Discover this module. Heavier processes can be run here
* Run infrequently (default 4 times a day)
*
* @param OS $os
* @param OS $os
*/
public function discover(OS $os);
@@ -41,7 +41,7 @@ interface Module
* Try to keep this efficient and only run if discovery has indicated there is a reason to run.
* Run frequently (default every 5 minutes)
*
* @param OS $os
* @param OS $os
*/
public function poll(OS $os);
@@ -49,7 +49,7 @@ interface Module
* Remove all DB data for this module.
* This will be run when the module is disabled.
*
* @param OS $os
* @param OS $os
*/
public function cleanup(OS $os);
}

2
LibreNMS/Interfaces/Polling/IsIsPolling.php
View File

@@ -28,7 +28,7 @@ namespace LibreNMS\Interfaces\Polling;
interface IsIsPolling
{
/**
* @param \Illuminate\Support\Collection $adjacencies \App\Models\IsIsAdjacency
* @param \Illuminate\Support\Collection $adjacencies \App\Models\IsIsAdjacency
* @return \Illuminate\Support\Collection \App\Models\IsIsAdjacency
*/
public function pollIsIs($adjacencies);

2
LibreNMS/Interfaces/Polling/MempoolsPolling.php
View File

@@ -28,7 +28,7 @@ namespace LibreNMS\Interfaces\Polling;
interface MempoolsPolling
{
/**
* @param \Illuminate\Support\Collection $mempools \App\Models\Mempool
* @param \Illuminate\Support\Collection $mempools \App\Models\Mempool
* @return \Illuminate\Support\Collection \App\Models\Mempool
*/
public function pollMempools($mempools);

8
LibreNMS/Interfaces/Polling/MplsPolling.php
View File

@@ -34,7 +34,7 @@ interface MplsPolling
public function pollMplsLsps();
/**
* @param Collection $lsps collecton of synchronized lsp objects from pollMplsLsps()
* @param Collection $lsps collecton of synchronized lsp objects from pollMplsLsps()
* @return Collection MplsLspPath objects
*/
public function pollMplsPaths($lsps);
@@ -50,14 +50,14 @@ interface MplsPolling
public function pollMplsServices();
/**
* @param Collection $svcs collecton of synchronized service objects from pollMplsServices()
* @param Collection $svcs collecton of synchronized service objects from pollMplsServices()
* @return Collection MplsSap objects
*/
public function pollMplsSaps($svcs);
/**
* @param Collection $sdps collecton of synchronized sdp objects from pollMplsSdps()
* @param Collection $svcs collecton of synchronized service objects from pollMplsServices()
* @param Collection $sdps collecton of synchronized sdp objects from pollMplsSdps()
* @param Collection $svcs collecton of synchronized service objects from pollMplsServices()
* @return Collection MplsSdpBind objects
*/
public function pollMplsSdpBinds($sdps, $svcs);

2
LibreNMS/Interfaces/Polling/ProcessorPolling.php
View File

@@ -29,7 +29,7 @@ interface ProcessorPolling
/**
* Poll processor data. This can be implemented if custom polling is needed.
*
* @param array $processors Array of processor entries from the database that need to be polled
* @param array $processors Array of processor entries from the database that need to be polled
* @return array of polled data
*/
public function pollProcessors(array $processors);

2
LibreNMS/Interfaces/Polling/Sensors/WirelessApCountPolling.php
View File

@@ -30,7 +30,7 @@ interface WirelessApCountPolling
* Poll wireless AP count
* The returned array should be sensor_id => value pairs
*
* @param array $sensors Array of sensors needed to be polled
* @param array $sensors Array of sensors needed to be polled
* @return array of polled data
*/
public function pollWirelessApCount(array $sensors);

2
LibreNMS/Interfaces/Polling/Sensors/WirelessCapacityPolling.php
View File

@@ -30,7 +30,7 @@ interface WirelessCapacityPolling
* Poll wireless capacity as a percent
* The returned array should be sensor_id => value pairs
*
* @param array $sensors Array of sensors needed to be polled
* @param array $sensors Array of sensors needed to be polled
* @return array of polled data
*/
public function pollWirelessCapacity(array $sensors);

2
LibreNMS/Interfaces/Polling/Sensors/WirelessCcqPolling.php
View File

@@ -30,7 +30,7 @@ interface WirelessCcqPolling
* Poll wireless client connection quality as a percent
* The returned array should be sensor_id => value pairs
*
* @param array $sensors Array of sensors needed to be polled
* @param array $sensors Array of sensors needed to be polled
* @return array of polled data
*/
public function pollWirelessCcq(array $sensors);

2
LibreNMS/Interfaces/Polling/Sensors/WirelessCellPolling.php
View File

@@ -30,7 +30,7 @@ interface WirelessCellPolling
* Poll wireless Cellular Cell. Type is cell.
* The returned array should be sensor_id => value pairs
*
* @param array $sensors Array of sensors needed to be polled
* @param array $sensors Array of sensors needed to be polled
* @return array of polled data
*/
public function pollWirelessCell(array $sensors);

2
LibreNMS/Interfaces/Polling/Sensors/WirelessChannelPolling.php
View File

@@ -30,7 +30,7 @@ interface WirelessChannelPolling
* Poll Wireless Channel. Type is channel.
* The returned array should be sensor_id => value pairs
*
* @param array $sensors Array of sensors needed to be polled
* @param array $sensors Array of sensors needed to be polled
* @return array of polled data
*/
public function pollWirelessChannel(array $sensors);

2
LibreNMS/Interfaces/Polling/Sensors/WirelessClientsPolling.php
View File

@@ -30,7 +30,7 @@ interface WirelessClientsPolling
* Poll wireless client counts
* The returned array should be sensor_id => value pairs
*
* @param array $sensors Array of sensors needed to be polled
* @param array $sensors Array of sensors needed to be polled
* @return array of polled data
*/
public function pollWirelessClients(array $sensors);

2
LibreNMS/Interfaces/Polling/Sensors/WirelessDistancePolling.php
View File

@@ -30,7 +30,7 @@ interface WirelessDistancePolling
* Poll wireless frequency as kilometers
* The returned array should be sensor_id => value pairs
*
* @param array $sensors Array of sensors needed to be polled
* @param array $sensors Array of sensors needed to be polled
* @return array of polled data
*/
public function pollWirelessDistance(array $sensors);

2
LibreNMS/Interfaces/Polling/Sensors/WirelessErrorRatePolling.php
View File

@@ -30,7 +30,7 @@ interface WirelessErrorRatePolling
* Poll wireless bit error rate as bps
* The returned array should be sensor_id => value pairs
*
* @param array $sensors Array of sensors needed to be polled
* @param array $sensors Array of sensors needed to be polled
* @return array of polled data
*/
public function pollWirelessErrorRatio(array $sensors);

2
LibreNMS/Interfaces/Polling/Sensors/WirelessErrorRatioPolling.php
View File

@@ -30,7 +30,7 @@ interface WirelessErrorRatioPolling
* Poll wireless bit/packet error ratio as percent
* The returned array should be sensor_id => value pairs
*
* @param array $sensors Array of sensors needed to be polled
* @param array $sensors Array of sensors needed to be polled
* @return array of polled data
*/
public function pollWirelessErrorRatio(array $sensors);

2
LibreNMS/Interfaces/Polling/Sensors/WirelessErrorsPolling.php
View File

@@ -30,7 +30,7 @@ interface WirelessErrorsPolling
* Poll wireless bit errors as total bits
* The returned array should be sensor_id => value pairs
*
* @param array $sensors Array of sensors needed to be polled
* @param array $sensors Array of sensors needed to be polled
* @return array of polled data
*/
public function pollWirelessErrors(array $sensors);

2
LibreNMS/Interfaces/Polling/Sensors/WirelessFrequencyPolling.php
View File

@@ -30,7 +30,7 @@ interface WirelessFrequencyPolling
* Poll wireless frequency as MHz
* The returned array should be sensor_id => value pairs
*
* @param array $sensors Array of sensors needed to be polled
* @param array $sensors Array of sensors needed to be polled
* @return array of polled data
*/
public function pollWirelessFrequency(array $sensors);

2
LibreNMS/Interfaces/Polling/Sensors/WirelessMsePolling.php
View File

@@ -30,7 +30,7 @@ interface WirelessMsePolling
* Poll wireless MSE in dB
* The returned array should be sensor_id => value pairs
*
* @param array $sensors Array of sensors needed to be polled
* @param array $sensors Array of sensors needed to be polled
* @return array of polled data
*/
public function pollWirelessMse(array $sensors);

2
LibreNMS/Interfaces/Polling/Sensors/WirelessNoiseFloorPolling.php
View File

@@ -30,7 +30,7 @@ interface WirelessNoiseFloorPolling
* Poll wireless noise floor
* The returned array should be sensor_id => value pairs
*
* @param array $sensors Array of sensors needed to be polled
* @param array $sensors Array of sensors needed to be polled
* @return array of polled data
*/
public function pollWirelessNoiseFloor(array $sensors);

2
LibreNMS/Interfaces/Polling/Sensors/WirelessPowerPolling.php
View File

@@ -30,7 +30,7 @@ interface WirelessPowerPolling
* Poll wireless tx or rx power
* The returned array should be sensor_id => value pairs
*
* @param array $sensors Array of sensors needed to be polled
* @param array $sensors Array of sensors needed to be polled
* @return array of polled data
*/
public function pollWirelessPower(array $sensors);

2
LibreNMS/Interfaces/Polling/Sensors/WirelessQualityPolling.php
View File

@@ -30,7 +30,7 @@ interface WirelessQualityPolling
* Poll wireless quality as a percent
* The returned array should be sensor_id => value pairs
*
* @param array $sensors Array of sensors needed to be polled
* @param array $sensors Array of sensors needed to be polled
* @return array of polled data
*/
public function pollWirelessQuality(array $sensors);

2
LibreNMS/Interfaces/Polling/Sensors/WirelessRatePolling.php
View File

@@ -30,7 +30,7 @@ interface WirelessRatePolling
* Poll wireless rates in bps
* The returned array should be sensor_id => value pairs
*
* @param array $sensors Array of sensors needed to be polled
* @param array $sensors Array of sensors needed to be polled
* @return array of polled data
*/
public function pollWirelessRate(array $sensors);

2
LibreNMS/Interfaces/Polling/Sensors/WirelessRsrpPolling.php
View File

@@ -30,7 +30,7 @@ interface WirelessRsrpPolling
* Poll wireless RSRP (Reference Signal Received Power) in dBm
* The returned array should be sensor_id => value pairs
*
* @param array $sensors Array of sensors needed to be polled
* @param array $sensors Array of sensors needed to be polled
* @return array of polled data
*/
public function pollWirelessRsrp(array $sensors);

2
LibreNMS/Interfaces/Polling/Sensors/WirelessRsrqPolling.php
View File

@@ -30,7 +30,7 @@ interface WirelessRsrqPolling
* Poll wireless RSRQ (Quality of the received signal) in dB
* The returned array should be sensor_id => value pairs
*
* @param array $sensors Array of sensors needed to be polled
* @param array $sensors Array of sensors needed to be polled
* @return array of polled data
*/
public function pollWirelessRsrq(array $sensors);

2
LibreNMS/Interfaces/Polling/Sensors/WirelessRssiPolling.php
View File

@@ -30,7 +30,7 @@ interface WirelessRssiPolling
* Poll wireless RSSI (Received Signal Strength Indicator) in dBm
* The returned array should be sensor_id => value pairs
*
* @param array $sensors Array of sensors needed to be polled
* @param array $sensors Array of sensors needed to be polled
* @return array of polled data
*/
public function pollWirelessRssi(array $sensors);

2
LibreNMS/Interfaces/Polling/Sensors/WirelessSinrPolling.php
View File

@@ -30,7 +30,7 @@ interface WirelessSinrPolling
* Poll wireless SINR in dB
* The returned array should be sensor_id => value pairs
*
* @param array $sensors Array of sensors needed to be polled
* @param array $sensors Array of sensors needed to be polled
* @return array of polled data
*/
public function pollWirelessSinr(array $sensors);

2
LibreNMS/Interfaces/Polling/Sensors/WirelessSnrPolling.php
View File

@@ -30,7 +30,7 @@ interface WirelessSnrPolling
* Poll wireless SNR in dB
* The returned array should be sensor_id => value pairs
*
* @param array $sensors Array of sensors needed to be polled
* @param array $sensors Array of sensors needed to be polled
* @return array of polled data
*/
public function pollWirelessSnr(array $sensors);

2
LibreNMS/Interfaces/Polling/Sensors/WirelessSsrPolling.php
View File

@@ -30,7 +30,7 @@ interface WirelessSsrPolling
* Poll wireless SSR in dB
* The returned array should be sensor_id => value pairs
*
* @param array $sensors Array of sensors needed to be polled
* @param array $sensors Array of sensors needed to be polled
* @return array of polled data
*/
public function pollWirelessSsr(array $sensors);

2
LibreNMS/Interfaces/Polling/Sensors/WirelessUtilizationPolling.php
View File

@@ -30,7 +30,7 @@ interface WirelessUtilizationPolling
* Poll wireless utilization
* The returned array should be sensor_id => value pairs
*
* @param array $sensors Array of sensors needed to be polled
* @param array $sensors Array of sensors needed to be polled
* @return array of polled data
*/
public function pollWirelessUtilization(array $sensors);

2
LibreNMS/Interfaces/Polling/Sensors/WirelessXpiPolling.php
View File

@@ -30,7 +30,7 @@ interface WirelessXpiPolling
* Poll wireless Cross Polar Interference.
* The returned array should be sensor_id => value pairs
*
* @param array $sensors Array of sensors needed to be polled
* @param array $sensors Array of sensors needed to be polled
* @return array of polled data
*/
public function pollWirelessApCount(array $sensors);

2
LibreNMS/Interfaces/Polling/SlaPolling.php
View File

@@ -31,7 +31,7 @@ interface SlaPolling
/**
* Poll Sla data for Sla in database.
*
* @param Collection $slas
* @param Collection $slas
*/
public function pollSlas(Collection $slas);
}

4
LibreNMS/Interfaces/SnmptrapHandler.php
View File

@@ -33,8 +33,8 @@ interface SnmptrapHandler
* Handle snmptrap.
* Data is pre-parsed and delivered as a Trap.
*
* @param Device $device
* @param Trap $trap
* @param Device $device
* @param Trap $trap
* @return void
*/
public function handle(Device $device, Trap $trap);

4
LibreNMS/Interfaces/UI/DeviceTab.php
View File

@@ -30,7 +30,7 @@ interface DeviceTab
{
/**
* Check if the tab is visible
* @param Device $device
* @param Device $device
* @return bool
*/
public function visible(Device $device): bool;
@@ -55,7 +55,7 @@ interface DeviceTab
/**
* Collect data to send to the view
* @param Device $device
* @param Device $device
* @return array
*/
public function data(Device $device): array;

2
LibreNMS/Interfaces/ValidationGroup.php
View File

@@ -32,7 +32,7 @@ interface ValidationGroup
* Validate this module.
* To return ValidationResults, call ok, warn, fail, or result methods on the $validator
*
* @param Validator $validator
* @param Validator $validator
*/
public function validate(Validator $validator);