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-2018 The SquirrelMail Project Team
  8.  * Licensed under the GNU GPL. For full terms see the file COPYING.
  9.  *
  10.  * @author Konstantin Riabitsev <icon@duke.edu>
  11.  * @version $Id: setup.php 14749 2018-01-16 23:36:07Z pdontthink $
  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. }
  31.  
  32. /**
  33.  * This function formats and adds the plugin and its description to the
  34.  * Options screen.
  35.  *
  36.  * @return void 
  37.  */
  38. function squirrelspell_optpage_register_block() {
  39.   global $optpage_blocks, $javascript_on, $squirrelmail_language;
  40.   if ($javascript_on) {
  41.     // this is a hack to avoid having to change the strings
  42.     // in all our translations for this misspelled word
  43.     if (strpos($squirrelmail_language, 'en_') === 0)
  44.         $name = 'Spell Checker Options';
  45.     else
  46.         $name = _("SpellChecker Options");
  47.     $optpage_blocks[] =
  48.       array(
  49.         'name' => $name,
  50.         'url'  => '../plugins/squirrelspell/sqspell_options.php',
  51.         '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."),
  52.         'js'   => TRUE);
  53.   }
  54. }
  55.  
  56. /**
  57.  * This function adds a "Check Spelling" link to the "Compose" row
  58.  * during message composition.
  59.  *
  60.  * @return void 
  61.  */
  62. function squirrelspell_setup() {
  63.     global $data_dir, $username, $javascript_on;
  64.     $sqspell_show_button = getPref($data_dir, $username, 'sqspell_show_button', 1);
  65.     if ($javascript_on && $sqspell_show_button) {
  66.         echo '<input type="button" value="'
  67.            . _("Check Spelling")
  68.            . '" name="check_spelling" onclick="window.open(\'../plugins/squirrelspell/sqspell_interface.php\', \'sqspell\', \'status=yes,width=550,height=370,resizable=yes\')" />';
  69.     }
  70. }

Documentation generated on Sun, 16 Dec 2018 04:25:02 +0100 by phpDocumentor 1.4.3