librenms / librenms

includes/functions.php

Doc Comments +37 added lines

@@ -37,6 +37,9 @@ 
     include_once($config['install_dir'] . "/includes/phpmailer/class.smtp.php");
 }
 
+/**
+ * @param string $on
+ */
 function array_sort($array, $on, $order=SORT_ASC) {
     $new_array = array();
     $sortable_array = array();
@@ -246,6 +249,9 @@ 
     return $ret;
 }
 
+/**
+ * @param string $snmpver
+ */
 function addHost($host, $snmpver, $port = '161', $transport = 'udp', $quiet = '0', $poller_group = '0', $force_add = '0', $port_assoc_mode = 'ifIndex') {
     global $config;
 
@@ -623,6 +629,9 @@ 
     }
 }
 
+/**
+ * @param string $domain
+ */
 function isDomainResolves($domain) {
     return (gethostbyname($domain) != $domain || count(dns_get_record($domain)) != 0);
 }
@@ -631,6 +640,9 @@ 
     return dbFetchCell("SELECT `status` FROM `devices` WHERE `device_id` = ?", array($id));
 }
 
+/**
+ * @param string $ip
+ */
 function match_network($nets, $ip, $first=false) {
     $return = false;
     if (!is_array ($nets)) $nets = array ($nets);
@@ -751,6 +763,10 @@ 
     return $result;
 }
 
+/**
+ * @param string $subject
+ * @param string $message
+ */
 function send_mail($emails,$subject,$message,$html=false) {
     global $config;
     if( is_array($emails) || ($emails = parse_email($emails)) ) {
@@ -986,6 +1002,9 @@ 
     }
 }
 
+/**
+ * @param string $json
+ */
 function _json_format($json, $options = 448) {
     $prettyPrint = (bool) ($options & JSON_PRETTY_PRINT);
     $unescapeUnicode = (bool) ($options & JSON_UNESCAPED_UNICODE);
@@ -1026,6 +1045,10 @@ 
             if ($unescapeUnicode && function_exists('mb_convert_encoding')) {
                 // 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');
                     }, $buffer);
@@ -1086,6 +1109,9 @@ 
     return $result;
 }
 
+/**
+ * @param string $delay
+ */
 function convert_delay($delay) {
     $delay = preg_replace('/\s/','',$delay);
     if(strstr($delay, 'm',TRUE)) {
@@ -1117,6 +1143,9 @@ 
     return vsprintf('%s%s-%s-%s-%s-%s%s%s', str_split(bin2hex($data), 4));
 }
 
+/**
+ * @param resource $post
+ */
 function set_curl_proxy($post) {
     global $config;
     if (isset($_ENV['https_proxy'])) {
@@ -1204,6 +1233,11 @@ 
     return true;
 }
 
+/**
+ * @param string $host
+ * @param string $params
+ * @param integer $address_family
+ */
 function fping($host,$params,$address_family = AF_INET) {
 
     global $config;
@@ -1248,6 +1282,9 @@ 
     return $response;
 }
 
+/**
+ * @param string $function
+ */
 function function_check($function) {
     return function_exists($function);
 }