Add PHP5-style constructor
[squirrelmail.git] / plugins / bug_report / setup.php
index e36f9becb64dac642333ac88bffa6842a6f5b7f5..28a7aca5cc36f83d81f62b219afe92708d50289c 100644 (file)
@@ -1,77 +1,82 @@
 <?php
-
 /**
- * setup.php
- *
- * Copyright (c) 1999-2003 The SquirrelMail development team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
- *
- * This is a standard Squirrelmail-1.2 API for plugins.
+ * Bug Report plugin - setup script
  *
- * $Id$
+ * @copyright 1999-2016 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
  * @package plugins
  * @subpackage bug_report
  */
 
-/* This button fills out a form with your setup information already
-   gathered -- all you have to do is type. */
-
-
 /**
  * Initialize the bug report plugin
+ *
  * @return void
+ *
+ * @access private
+ *
  */
 function squirrelmail_plugin_init_bug_report() {
     global $squirrelmail_plugin_hooks;
 
-    $squirrelmail_plugin_hooks['menuline']['bug_report'] = 'bug_report_button';
-    $squirrelmail_plugin_hooks['options_display_inside']['bug_report'] = 'bug_report_options';
-    $squirrelmail_plugin_hooks['options_display_save']['bug_report'] = 'bug_report_save';
-    $squirrelmail_plugin_hooks['loading_prefs']['bug_report'] = 'bug_report_load';
+    $squirrelmail_plugin_hooks['template_construct_page_header.tpl']['bug_report']
+        = 'bug_report_button';
+    $squirrelmail_plugin_hooks['optpage_loadhook_display']['bug_report']
+        = 'bug_report_block';
 }
 
 
-/* Show the button in the main bar */
+/**
+ * Show the button in the main bar
+ *
+ * @access private
+ *
+ */
 function bug_report_button() {
-    global $color, $bug_report_visible;
-
-    if (! $bug_report_visible) {
-        return;
-    }
-
-    displayInternalLink('plugins/bug_report/bug_report.php', 'Bug', '');
-    echo "&nbsp;&nbsp;\n";
+    include_once(SM_PATH . 'plugins/bug_report/functions.php');
+    return bug_report_button_do();
 }
 
-
-function bug_report_save() {
-    global $username,$data_dir;
-
-    if( sqgetGlobalVar('bug_report_bug_report_visible', $vis, SQ_POST) ) {
-        setPref($data_dir, $username, 'bug_report_visible', '1');
-    } else {
-        setPref($data_dir, $username, 'bug_report_visible', '');
-    }
-}
-
-
-function bug_report_load() {
-    global $username, $data_dir;
-    global $bug_report_visible;
-
-    $bug_report_visible = getPref($data_dir, $username, 'bug_report_visible');
+/**
+ *
+ * Register bug report option block
+ *
+ * @since 1.5.1
+ *
+ * @access private
+ *
+ */
+function bug_report_block() {
+    include_once(SM_PATH.'plugins/bug_report/functions.php');
+    bug_report_block_do();
 }
 
+/**
+ * Returns info about this plugin
+ *
+ */
+function bug_report_info() { 
+    return array(
+        'english_name' => 'Bug Report',
+        'authors' => array(
+            'SquirrelMail Team' => array(),
+        ),
+        'version' => 'CORE',
+        'required_sm_version' => 'CORE',
+        'requires_configuration' => 0,
+        'summary' => 'Helps with sending bug reports to the SquirrelMail Developers.  Collects a lot of useful information about your system.',
+        'details' => 'When people stumble across a bug, which may happen in a work-in-progress, often times they would like to help out the software and get rid of the bug.  Sometimes, these people don\'t know much about the system and how it is set up -- they know enough to make the bug happen for them.  This bug report plugin is designed to gather all of the non-private information for the user automatically, so that the user doesn\'t need to know more than how to trigger the bug.',
+    );
+} 
 
-function bug_report_options() {
-    global $bug_report_visible;
 
-    echo '<tr><td align=right nowrap>' . _("Bug Reports:") . "</td>\n" .
-         '<td><input name="bug_report_bug_report_visible" type=CHECKBOX';
-    if ($bug_report_visible) {
-        echo ' CHECKED';
-    }
-    echo '> ' . _("Show button in toolbar") . "</td></tr>\n";
-}
 
-?>
+/**
+ * Returns version info about this plugin
+ *
+ */
+function bug_report_version() {
+    $info = bug_report_info();
+    return $info['version'];
+}