librenms / librenms

includes/functions.php

Doc Comments +45 added lines, -2 removed lines

@@ -34,6 +34,9 @@ 
     }
 }//end set_debug()
 
+/**
+ * @param string $on
+ */
 function array_sort($array, $on, $order = SORT_ASC)
 {
     $new_array = array();
@@ -68,6 +71,9 @@ 
     return $new_array;
 }
 
+/**
+ * @param string $mac
+ */
 function mac_clean_to_readable($mac)
 {
     return rtrim(chunk_split($mac, 2, ':'), ':');
@@ -335,6 +341,9 @@ 
     return $device['icon'] ? str_replace(array('.svg', '.png'), '', $device['icon']) : $device['os'];
 }
 
+/**
+ * @return string
+ */
 function getImageName($device, $use_database = true, $dir = 'images/os/')
 {
     global $config;
@@ -545,6 +554,10 @@ 
     throw $host_unreachable_exception;
 }
 
+/**
+ * @param string $host
+ * @param string $snmpver
+ */
 function deviceArray($host, $community, $snmpver, $port = 161, $transport = 'udp', $v3 = array(), $port_assoc_mode = 'ifIndex')
 {
     $device = array();
@@ -789,6 +802,9 @@ 
     throw new \Exception("Failed to add host to the database, please run ./validate.php");
 }
 
+/**
+ * @param string $domain
+ */
 function isDomainResolves($domain)
 {
     if (gethostbyname($domain) != $domain) {
@@ -1008,12 +1024,18 @@ 
 }
 
 # Convert an SNMP hex string to regular string
+/**
+ * @param string $hex
+ */
 function snmp_hexstring($hex)
 {
     return hex2str(str_replace(' ', '', str_replace(' 00', '', $hex)));
 }
 
 # Check if the supplied string is an SNMP hex string
+/**
+ * @param string $str
+ */
 function isHexString($str)
 {
     return (bool)preg_match("/^[a-f0-9][a-f0-9]( [a-f0-9][a-f0-9])*$/is", trim($str));
@@ -1179,6 +1201,9 @@ 
     }
 }
 
+/**
+ * @param string $json
+ */
 function _json_format($json, $options = 448)
 {
     $prettyPrint = (bool) ($options & JSON_PRETTY_PRINT);
@@ -1220,6 +1245,10 @@ 
                 // http://stackoverflow.com/questions/2934563/how-to-decode-unicode-escape-sequences-like-u00ed-to-proper-utf-8-encoded-cha
                 $buffer = preg_replace_callback(
                     '/\\\\u([0-9a-f]{4})/i',
+
+                    /**
+                     * @param string $match
+                     */
                     function ($match) {
                         return mb_convert_encoding(pack('H*', $match[1]), 'UTF-8', 'UCS-2BE');
                     },
@@ -1279,6 +1308,9 @@ 
     return $result;
 }
 
+/**
+ * @param string $delay
+ */
 function convert_delay($delay)
 {
     $delay = preg_replace('/\s/', '', $delay);
@@ -1309,7 +1341,7 @@ 
 }
 
 /**
- * @param $curl
+ * @param resource $curl
  */
 function set_curl_proxy($curl)
 {
@@ -1325,7 +1357,7 @@ 
 /**
  * Return the proxy url
  *
- * @return array|bool|false|string
+ * @return string
  */
 function get_proxy()
 {
@@ -1384,6 +1416,9 @@ 
     return $return;
 }
 
+/**
+ * @param string $ip
+ */
 function ip_exists($ip)
 {
     // Function to check if an IP exists in the DB already
@@ -1399,6 +1434,11 @@ 
     return false;
 }
 
+/**
+ * @param string $host
+ * @param string $params
+ * @param integer $address_family
+ */
 function fping($host, $params, $address_family = AF_INET)
 {
 
@@ -1451,6 +1491,9 @@ 
     return $response;
 }
 
+/**
+ * @param string $function
+ */
 function function_check($function)
 {
     return function_exists($function);