PSR+phpDocs

Closing PHP tags removed and all tabs converted to spaces (in order to
improve compliance with PSR); Rewrote all comments contained within the
`plugin.php` file to the phpDocs format; Iterated plugin version to
"1.0.1"; No other changes.

Author: Maikuolan

notifications/plugin.php

@@ -8,37 +8,62 @@
  PLUGIN INFORMATION BEGIN
         Plugin Name: Notifications.
       Plugin Author: Caleb M / Maikuolan.
-     Plugin Version: 1.0.0
+     Plugin Version: 1.0.1
    Download Address: https://github.com/Maikuolan/phpMussel-plugin-notifications
     Min. Compatible: 0.9.0
     Max. Compatible: -
-       Tested up to: 0.9.0
-      Last Modified: 2015.11.15
+       Tested up to: 0.9.2
+      Last Modified: 2016.12.08
  Plugin Description: Receive email notifications from phpMussel whenever a file
                      upload is blocked (requires PHP "mail" function to be
                      correctly configured; for more information, please refer
                      to http://php.net/manual/en/function.mail.php).
  PLUGIN INFORMATION END */
 
+/**
+ * Notifications plugin for phpMussel.
+ *
+ * Receive email notifications from phpMussel whenever a file upload is blocked
+ * (requires PHP "mail" function to be correctly configured; for more
+ * information, please refer to http://php.net/manual/en/function.mail.php).
+ *
+ * This document and its associated package can be downloaded for free from:
+ * - GitHub <https://github.com/Maikuolan/phpMussel-plugin-notifications>.
+ *
+ * @package Maikuolan/phpMussel-plugin-notifications
+ */
+
+/**
+ * Prevents direct access (the plugin should only be called from the phpMussel
+ * plugin system).
+ */
 if(!defined('phpMussel'))die('[phpMussel] This should not be accessed directly.');
 
+/**
+ * Registers the `phpMussel_Notify()` function to the `before_html_out` hook.
+ */
 phpMussel_Register_Hook('phpMussel_Notify','before_html_out');
 
 if(!isset($MusselConfig['notifications']))$MusselConfig['notifications']=array();
 if(!isset($MusselConfig['notifications']['to_addr']))$MusselConfig['notifications']['to_addr']='';
 if(!isset($MusselConfig['notifications']['from_addr']))$MusselConfig['notifications']['from_addr']='';
 
+/**
+ * The actual plugin code (the "Notifications" plugin only has one small
+ * function; nothing else is needed).
+ *
+ * @param array $input An empty array (we don't need to send anything from the calling scope to the function, but, the plugin system nonetheless requires this parameter to exist).
+ * @return bool Returns true if everything is working correctly.
+ */
 function phpMussel_Notify($input)
-	{
-	if(!$GLOBALS['MusselConfig']['notifications']['to_addr']||!$GLOBALS['MusselConfig']['notifications']['from_addr']||empty($GLOBALS['whyflagged']))return false;
-	$NotifyLang=(!file_exists($GLOBALS['vault'].'plugins/notifications/template.'.$GLOBALS['MusselConfig']['general']['lang'].'.eml'))?'en':$GLOBALS['MusselConfig']['general']['lang'];
-	$NotifyVars=array();
-	$NotifyVars['whyflagged']=$GLOBALS['whyflagged'];
-	$NotifyVars['ipaddr']=$_SERVER[$GLOBALS['MusselConfig']['general']['ipaddr']];
-	$NotifyVars['time']=date('r');
-	$content=phpMusselV($NotifyVars,phpMusselFile($GLOBALS['vault'].'plugins/notifications/template.'.$NotifyLang.'.eml',0,true));
-	mail($GLOBALS['MusselConfig']['notifications']['to_addr'],$GLOBALS['MusselConfig']['lang']['denied'],$content,"MIME-Version: 1.0\nContent-type: text/plain; charset=iso-8859-1\nFrom: ".$GLOBALS['MusselConfig']['notifications']['from_addr'],'-f'.$GLOBALS['MusselConfig']['notifications']['from_addr']);
-	return true;
-	}
-
-?>
+    {
+    if(!$GLOBALS['MusselConfig']['notifications']['to_addr']||!$GLOBALS['MusselConfig']['notifications']['from_addr']||empty($GLOBALS['whyflagged']))return false;
+    $NotifyLang=(!file_exists($GLOBALS['vault'].'plugins/notifications/template.'.$GLOBALS['MusselConfig']['general']['lang'].'.eml'))?'en':$GLOBALS['MusselConfig']['general']['lang'];
+    $NotifyVars=array();
+    $NotifyVars['whyflagged']=$GLOBALS['whyflagged'];
+    $NotifyVars['ipaddr']=$_SERVER[$GLOBALS['MusselConfig']['general']['ipaddr']];
+    $NotifyVars['time']=date('r');
+    $content=phpMusselV($NotifyVars,phpMusselFile($GLOBALS['vault'].'plugins/notifications/template.'.$NotifyLang.'.eml',0,true));
+    mail($GLOBALS['MusselConfig']['notifications']['to_addr'],$GLOBALS['MusselConfig']['lang']['denied'],$content,"MIME-Version: 1.0\nContent-type: text/plain; charset=iso-8859-1\nFrom: ".$GLOBALS['MusselConfig']['notifications']['from_addr'],'-f'.$GLOBALS['MusselConfig']['notifications']['from_addr']);
+    return true;
+    }