librenms / librenms

alerts.php

Doc Comments +1 added lines, -1 removed lines

@@ -522,7 +522,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) {
     $ret = '';

html/includes/authentication/ldap.inc.php

Doc Comments +3 added lines

@@ -202,6 +202,9 @@
 }
 
 
+/**
+ * @return string
+ */
 function get_membername($username) {
     global $config, $ds;
     if ($config['auth_ldap_groupmembertype'] == 'fulldn') {

html/includes/collectd/functions.php

Doc Comments +6 added lines, -1 removed lines

@@ -277,7 +277,7 @@ 
  * @pinst Plugin instance
  * @type Type name
  * @tinst Type instance
- * @return Identifier that collectd's FLUSH command understands
+ * @return string that collectd's FLUSH command understands
  */
 function collectd_identifier($host, $plugin, $pinst, $type, $tinst) {
     global $config;
@@ -477,6 +477,7 @@ 
 /**
  * Helper function to strip quotes from RRD output
  * @str RRD-Info generated string
+ * @param string $str
  * @return String with one surrounding pair of quotes stripped
  */
 function rrd_strip_quotes($str) {
@@ -493,6 +494,7 @@ 
 /**
  * Determine useful information about RRD file
  * @file Name of RRD file to analyse
+ * @param string $file
  * @return Array describing the RRD file
  */
 function rrd_info($file) {
@@ -557,6 +559,9 @@ 
 }//end rrd_info()
 
 
+/**
+ * @param integer $code
+ */
 function rrd_get_color($code, $line=true) {
     global $config;
     $name = ($line ? 'f_' : 'h_').$code;

html/includes/functions.inc.php

Doc Comments +15 added lines

@@ -276,6 +276,10 @@ 
 }//end generate_device_link()
 
 
+/**
+ * @param string $url
+ * @param string|null $class
+ */
 function overlib_link($url, $text, $contents, $class) {
     global $config;
 
@@ -505,6 +509,14 @@ 
 }//end generate_graph_js_state()
 
 
+/**
+ * @param integer $width
+ * @param integer $height
+ * @param string $left_colour
+ * @param string $right_text
+ * @param string $right_colour
+ * @param string $right_background
+ */
 function print_percentage_bar($width, $height, $percent, $left_text, $left_colour, $left_background, $right_text, $right_colour, $right_background) {
     if ($percent > '100') {
         $size_percent = '100';
@@ -1022,6 +1034,9 @@ 
 }//end get_client_ip()
 
 
+/**
+ * @param string $string
+ */
 function shorten_interface_type($string) {
     return str_ireplace(
         array(

html/includes/graphs/device/collectd.inc.php

Doc Comments +6 added lines

@@ -22,6 +22,10 @@ 
 require 'includes/collectd/definitions.php';
 
 
+/**
+ * @param integer $fontsize
+ * @param integer $width
+ */
 function makeTextBlock($text, $fontfile, $fontsize, $width) {
     // TODO: handle explicit line-break!
     $words       = explode(' ', $text);
@@ -50,6 +54,8 @@ 
  * @code_msg Short text description of HTTP error code
  * @title Title for fake RRD graph
  * @msg Complete error message to display in place of graph content
+ * @param integer $code
+ * @param string $code_msg
  */
 function error($code, $code_msg, $title, $msg) {
     global $config;

html/includes/PasswordHash.php

Doc Comments +19 added lines

@@ -30,6 +30,10 @@ 
 	var $portable_hashes;
 	var $random_state;
 
+	/**
+	 * @param integer $iteration_count_log2
+	 * @param boolean $portable_hashes
+	 */
 	function PasswordHash($iteration_count_log2, $portable_hashes)
 	{
 		$this->itoa64 = './0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz';
@@ -45,6 +49,9 @@ 
 			$this->random_state .= getmypid();
 	}
 
+	/**
+	 * @param integer $count
+	 */
 	function get_random_bytes($count)
 	{
 		$output = openssl_random_pseudo_bytes($count,$strong);
@@ -73,6 +80,9 @@ 
 		return $output;
 	}
 
+	/**
+	 * @param integer $count
+	 */
 	function encode64($input, $count)
 	{
 		$output = '';
@@ -96,6 +106,9 @@ 
 		return $output;
 	}
 
+	/**
+	 * @param string $input
+	 */
 	function gensalt_private($input)
 	{
 		$output = '$P$';
@@ -151,6 +164,9 @@ 
 		return $output;
 	}
 
+	/**
+	 * @param string $input
+	 */
 	function gensalt_extended($input)
 	{
 		$count_log2 = min($this->iteration_count_log2 + 8, 24);
@@ -169,6 +185,9 @@ 
 		return $output;
 	}
 
+	/**
+	 * @param string $input
+	 */
 	function gensalt_blowfish($input)
 	{
 		# This one needs to use a different order of characters and a

includes/billing.php

Doc Comments +3 added lines

@@ -63,6 +63,9 @@
 }//end getDates()
 
 
+/**
+ * @param string $inout
+ */
 function getValue($host, $port, $id, $inout) {
     global $config;
 

includes/common.php

Doc Comments +13 added lines

@@ -16,6 +16,10 @@ 
  * the source code distribution for details.
  */
 
+/**
+ * @param double $number
+ * @param string $sf
+ */
 function format_number_short($number, $sf) {
     // This formats a number so that we only send back three digits plus an optional decimal point.
     // Example: 723.42 -> 723    72.34 -> 72.3    2.23 -> 2.23
@@ -32,6 +36,9 @@ 
     return $number;
 }
 
+/**
+ * @param string $command
+ */
 function external_exec($command) {
     d_echo($command."\n");
     $output = shell_exec($command);
@@ -396,6 +403,9 @@ 
     return $os;
 }
 
+/**
+ * @return string
+ */
 function safename($name) {
     return preg_replace('/[^a-zA-Z0-9,._\-]/', '_', $name);
 }
@@ -450,6 +460,9 @@ 
     }
 }
 
+/**
+ * @param string $attrib
+ */
 function is_dev_attrib_enabled($device, $attrib, $default = true) {
     $val = get_dev_attrib($device, $attrib);
     if ($val != NULL) {

includes/functions.php

Doc Comments +34 added lines

@@ -238,6 +238,9 @@ 
     return $ret;
 }
 
+/**
+ * @param string $snmpver
+ */
 function addHost($host, $snmpver, $port = '161', $transport = 'udp', $quiet = '0', $poller_group = '0', $force_add = '0') {
     global $config;
 
@@ -601,6 +604,9 @@ 
     }
 }
 
+/**
+ * @param string $domain
+ */
 function isDomainResolves($domain) {
     return (gethostbyname($domain) != $domain || count(dns_get_record($domain)) != 0);
 }
@@ -609,6 +615,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);
@@ -729,6 +738,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)) ) {
@@ -964,6 +977,9 @@ 
     }
 }
 
+/**
+ * @param string $json
+ */
 function _json_format($json, $options = 448) {
     $prettyPrint = (bool) ($options & JSON_PRETTY_PRINT);
     $unescapeUnicode = (bool) ($options & JSON_UNESCAPED_UNICODE);
@@ -1004,6 +1020,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);
@@ -1064,6 +1084,9 @@ 
     return $result;
 }
 
+/**
+ * @param string $delay
+ */
 function convert_delay($delay) {
     $delay = preg_replace('/\s/','',$delay);
     if(strstr($delay, 'm',TRUE)) {
@@ -1095,6 +1118,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'])) {
@@ -1182,6 +1208,11 @@ 
     return true;
 }
 
+/**
+ * @param string $host
+ * @param string $params
+ * @param integer $address_family
+ */
 function fping($host,$params,$address_family = AF_INET) {
 
     global $config;
@@ -1226,6 +1257,9 @@ 
     return $response;
 }
 
+/**
+ * @param string $function
+ */
 function function_check($function) {
     return function_exists($function);
 }