librenms / librenms

includes/alerts.inc.php

Doc Comments +3 added lines, -3 removed lines

@@ -26,7 +26,7 @@ 
 /**
  * Generate SQL from Rule
  * @param string $rule Rule to generate SQL for
- * @return string|boolean
+ * @return false|string
  */
 function GenSQL($rule)
 {
@@ -147,7 +147,7 @@ 
 /**
  * Run all rules for a device
  * @param int $device Device-ID
- * @return void
+ * @return false|null
  */
 function RunRules($device)
 {
@@ -425,7 +425,7 @@ 
  * "Safely" run eval
  * @param string $code Code to run
  * @param array  $obj  Object with variables
- * @return string|mixed
+ * @return string
  */
 function RunJail($code, $obj)
 {

LibreNMS/IRCBot.php

Doc Comments +24 added lines

@@ -208,6 +208,11 @@ 
     }//end connect_alert()
 
 
+    /**
+     * @param string $buff
+     *
+     * @return string
+     */
     private function read($buff)
     {
         $r                  = fread($this->socket[$buff], 64);
@@ -381,6 +386,10 @@ 
     }//end handleCommand()
 
 
+    /**
+     * @param string $command
+     * @param string $params
+     */
     private function proceedCommand($command, $params)
     {
         $command = strtolower($command);
@@ -405,6 +414,9 @@ 
     }//end respond()
 
 
+    /**
+     * @param string $param
+     */
     private function getChan($param)
     {
         $data = explode('PRIVMSG ', $this->data, 3);
@@ -419,6 +431,11 @@ 
         return str_replace(':', '', $arrData[0]);
     }//end getUser()
 
+    /**
+     * @param string $param
+     *
+     * @return string
+     */
     private function getUserHost($param)
     {
         $arrData = explode(' ', $param, 2);
@@ -564,6 +581,9 @@ 
     }//end hostAuth
 
 
+    /**
+     * @param string $params
+     */
     private function ircRaw($params)
     {
         return fputs($this->socket['irc'], $params."\r\n");
@@ -869,6 +889,10 @@ 
         return $this->respond($msg);
     }//end _status()
 
+    /**
+     * @param string $fg_color
+     * @param string $other
+     */
     private function _color($text, $fg_color, $bg_color = null, $other = null)
     {
         $colors = array(

tests/MibTest.php

Doc Comments +2 added lines, -2 removed lines

@@ -175,8 +175,8 @@
     /**
      * Extract the mib name from a file
      *
-     * @param $file
-     * @return mixed
+     * @param string $file
+     * @return string
      * @throws Exception
      */
     private function extractMibName($file)

LibreNMS/Authentication/ActiveDirectoryAuthorizer.php

Doc Comments +3 added lines

@@ -403,6 +403,9 @@
         return str_replace('~C0mmA~', ',', $matches[0][0]);
     }
 
+    /**
+     * @param string $sid
+     */
     protected function getUseridFromSid($sid)
     {
         return preg_replace('/.*-(\d+)$/', '$1', $sid);

LibreNMS/Authentication/ADAuthorizationAuthorizer.php

Doc Comments +6 added lines

@@ -317,6 +317,9 @@ 
         return 'S-'.$revLevel.'-'.$authIdent.'-'.implode('-', $subAuths);
     }
 
+    /**
+     * @param string $attr
+     */
     protected function authLdapSessionCacheGet($attr)
     {
         $ttl = 300;
@@ -345,6 +348,9 @@ 
     }
 
 
+    /**
+     * @param string $attr
+     */
     protected function authLdapSessionCacheSet($attr, $value)
     {
         $_SESSION['auth_ldap'][$attr]['value'] = $value;

includes/snmp.inc.php

Doc Comments +19 added lines

@@ -28,6 +28,9 @@ 
 }//end string_to_oid()
 
 
+/**
+ * @param string $setting
+ */
 function prep_snmp_setting($device, $setting)
 {
     global $config;
@@ -287,6 +290,9 @@ 
     return false;
 }//end snmp_check()
 
+/**
+ * @param string $options
+ */
 function snmp_walk($device, $oid, $options = null, $mib = null, $mibdir = null)
 {
     $time_start = microtime(true);
@@ -370,6 +376,9 @@ 
 }//end snmp_cache_ifIndex()
 
 
+/**
+ * @param string $mibdir
+ */
 function snmpwalk_cache_oid($device, $oid, $array, $mib = null, $mibdir = null, $snmpflags = '-OQUs')
 {
     $data = snmp_walk($device, $oid, $snmpflags, $mib, $mibdir);
@@ -441,6 +450,9 @@ 
 }//end snmpwalk_cache_oid_num()
 
 
+/**
+ * @param string $mib
+ */
 function snmpwalk_cache_multi_oid($device, $oid, $array, $mib = null, $mibdir = null, $snmpflags = '-OQUs')
 {
     global $cache;
@@ -896,6 +908,10 @@ 
  * Load the given MIB into the database.
  * @return count of objects loaded
  */
+/**
+ * @param string $mib
+ * @param string $module
+ */
 function snmp_mib_load($mib, $module, $included_by, $mibdir = null, $device = array())
 {
     $mibs = array();
@@ -1163,6 +1179,9 @@ 
  * Validate MIBs and store the device->mib mapping in the database.
  * See includes/discovery/os/ruckuswireless.inc.php for an example of usage.
  */
+/**
+ * @param string $included_by
+ */
 function register_mibs($device, $mibs, $included_by)
 {
     if (!is_mib_poller_enabled($device)) {

tests/mocks/mock.snmp.inc.php

Doc Comments +3 added lines

@@ -257,6 +257,9 @@
     return $data;
 }
 
+/**
+ * @param string $options
+ */
 function snmp_walk($device, $oid, $options = null, $mib = null, $mibdir = null)
 {
     $community = $device['community'];

LibreNMS/Config.php

Doc Comments +2 added lines, -2 removed lines

@@ -72,7 +72,7 @@ 
      * @param array $device Device array
      * @param string $key Name of setting to fetch
      * @param string $global_prefix specify where the global setting lives in the global config
-     * @param mixed $default will be returned if the setting is not set on the device or globally
+     * @param string $default will be returned if the setting is not set on the device or globally
      * @return mixed
      */
     public static function getDeviceSetting($device, $key, $global_prefix = null, $default = null)
@@ -126,7 +126,7 @@ 
      *
      * @param string $os The os name
      * @param string $key period separated config variable name
-     * @param array $default optional array to return if the setting is not set
+     * @param boolean $default optional array to return if the setting is not set
      * @return array
      */
     public static function getCombined($os, $key, $default = array())

includes/rewrites.php

Doc Comments +3 added lines

@@ -1471,6 +1471,9 @@
     }
 }
 
+/**
+ * @param string $state
+ */
 function parse_entity_state($state, $value)
 {
     $data = array(