Source for file setup.php

Documentation is available at setup.php

  1. <?php
  2. /**
  3.  * setup.php
  4.  * -----------
  5.  * Squirrelspell setup file, as defined by the SquirrelMail-1.2 API.
  6.  *
  7.  * Copyright (c) 1999-2006 The SquirrelMail Project Team
  8.  * Licensed under the GNU GPL. For full terms see the file COPYING.
  9.  *
  10.  * @author Konstantin Riabitsev <[email protected]>
  11.  * @version $Id: setup.php,v 1.10.2.6 2006/02/03 22:27:52 jervfors Exp $
  12.  * @package plugins
  13.  * @subpackage squirrelspell
  14.  */
  15.  
  16. /** @ignore */
  17. if (! defined('SM_PATH')) define('SM_PATH','../../');
  18.  
  19. /**
  20.  * Standard SquirrelMail plugin initialization API.
  21.  *
  22.  * @return void 
  23.  */
  24. function squirrelmail_plugin_init_squirrelspell() {
  25.   global $squirrelmail_plugin_hooks;
  26.   $squirrelmail_plugin_hooks['compose_button_row']['squirrelspell'] =
  27.       'squirrelspell_setup';
  28.   $squirrelmail_plugin_hooks['optpage_register_block']['squirrelspell'] =
  29.       'squirrelspell_optpage_register_block';
  30.   $squirrelmail_plugin_hooks['options_link_and_description']['squirrelspell'] =
  31.       'squirrelspell_options';
  32. }
  33.  
  34. /**
  35.  * This function formats and adds the plugin and its description to the
  36.  * Options screen.
  37.  *
  38.  * @return void 
  39.  */
  40. function squirrelspell_optpage_register_block() {
  41.   global $optpage_blocks;
  42.   /**
  43.    * soupNazi checks if this browser is capable of using the plugin.
  44.    */
  45.   if (!soupNazi()) {
  46.     /**
  47.      * The browser checks out.
  48.      * Register Squirrelspell with the $optionpages array.
  49.      */
  50.     $optpage_blocks[] =
  51.       array(
  52.         'name' => _("SpellChecker Options"),
  53.         'url'  => '../plugins/squirrelspell/sqspell_options.php',
  54.         'desc' => _("Here you may set up how your personal dictionary is stored, edit it, or choose which languages should be available to you when spell-checking."),
  55.         'js'   => TRUE);
  56.   }
  57. }
  58.  
  59. /**
  60.  * This function adds a "Check Spelling" link to the "Compose" row
  61.  * during message composition.
  62.  *
  63.  * @return void 
  64.  */
  65. function squirrelspell_setup() {
  66.   /**
  67.    * Check if this browser is capable of displaying SquirrelSpell
  68.    * correctly.
  69.    */
  70.   if (!soupNazi()) {
  71.     /**
  72.      * Some people may choose to disable javascript even though their
  73.      * browser is capable of using it. So these freaks don't complain,
  74.      * use document.write() so the "Check Spelling" button is not
  75.      * displayed if js is off in the browser.
  76.      */
  77.     echo "<script type=\"text/javascript\">\n".
  78.       "<!--\n".
  79.       'document.write("<input type=\"button\" value=\"'.
  80.       _("Check Spelling").
  81.       '\" name=\"check_spelling\" onclick=\"window.open(\'../plugins/squirrelspell/sqspell_'.
  82.       'interface.php\', \'sqspell\', \'status=yes,width=550,height=370,'.
  83.       'resizable=yes\')\" />");' . "\n".
  84.       "//-->\n".
  85.       "</script>\n";
  86.   }
  87. }
  88.  
  89. ?>

Documentation generated on Sat, 07 Oct 2006 16:33:39 +0300 by phpDocumentor 1.3.0RC6