falon / RBL

contrib/ipImap/function.php

Doc Comments +34 added lines

@@ -1,4 +1,7 @@ 
 <?php
+/**
+ * @param string $header
+ */
 function getIP($header,$mxserver,$msa) {
 /* Get submission server's IP from header's mail */
 /* Each line must end with /r/n			 */
@@ -28,11 +31,23 @@ 
 	return array($ip,$host,$dateR,$dateC['date'],$mid['mid']);
 }
 
+/**
+ * @param string $hostname
+ * @param string $dateC
+ * @param string|null $msgid
+ * @param string|false $dateL
+ */
 function updateReport ($ip,$uid,$ipcount,$uidcount,$hostname,$dateC,$msgid,$dateL) {
 
 	return sprintf ('<tr><td nowrap>%s</td><td nowrap>%s</td><td>%s</td><td>%s</td><td>%u</td><td>%u</td><td>%s</td><td>%s</td></tr>'."\n",$dateL,$dateC,$uid,$ip,$uidcount,$ipcount,$hostname,htmlentities($msgid) );
 }
 
+/**
+ * @param string $dateC
+ * @param string|null $msgid
+ * @param false|string $dateL
+ * @param string $text
+ */
 function updatebadReport ( $uid,$dateC,$msgid,$dateL,$text ) {
 	return sprintf ('<tr><td nowrap>%s</td><td nowrap>%s</td><td>%s</td><td>%s</td><td nowrap>%s</td></tr>'."\n",$dateL,$dateC,$uid,htmlentities($msgid),$text );
 }
@@ -84,6 +99,10 @@ 
 }
 
 
+/**
+ * @param null|mysqli $myconn
+ * @param string $key
+ */
 function summaryReportAndList ($cf,$myconn,$tables,$category,$vet,$key) {
 	$nk = $vet['count'];
 
@@ -160,6 +179,10 @@ 
 }
 
 
+/**
+ * @param string $message_id
+ * @param string $date
+ */
 function splunksearch ($service,$message_id,$date) {
 
 	// Run a blocking search
@@ -272,6 +295,9 @@ 
 }
 /***********************************/
 
+/**
+ * @param string $text
+ */
 function getDomains ($text) {
 	/* Pattern from http://blog.mattheworiordan.com/post/13174566389/url-regular-expression-for-links-with-or-without */
 	$pattern = '/((?:(?:[A-Za-z]{3,9}:(?:\/\/)?)(?:[\-;:&=\+\$,\w]+@)?[A-Za-z0-9\.\-]+|(?:www\.|[\-;:&=\+\$,\w]+@)[A-Za-z0-9\.\-]+)(?:(?:\/[\+~%\/\.\w\-_]*)?\??(?:[\-\+=&;%@\.\w_]*)#?(?:[\.\!\/\\\w]*))?)/';
@@ -325,6 +351,9 @@ 
 	return array();
 }
 
+/**
+ * @return string
+ */
 function humanKey($key) {
 	switch($key) {
 		case 'ip':
@@ -335,6 +364,11 @@ 
 	return $key;
 }
 
+/**
+ * @param resource $f
+ * @param string $key
+ * @param string $rtime
+ */
 function writeFileHeader($f,$conf,$key,$type,$rtime) {
         fwrite( $f, file_get_contents(dirname(__FILE__) . '/' . $conf['report']['reportTemplateHeader']) );
         fwrite( $f,sprintf('<h1> Report of %s %s</h1><h5>%s</h5><h2>Detailed Report</h2>',$type, strtoupper(humanKey($key)),$rtime) );