Source for file setup.php

Documentation is available at setup.php

  1. <?php
  2.  
  3. /**
  4.  * setup.php
  5.  *
  6.  * Squirrelspell setup file, as defined by the SquirrelMail-1.2 API.
  7.  *
  8.  * @author Konstantin Riabitsev <icon at duke.edu>
  9.  * @copyright 1999-2018 The SquirrelMail Project Team
  10.  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  11.  * @version $Id: setup.php 14750 2018-01-16 23:44:07Z pdontthink $
  12.  * @package plugins
  13.  * @subpackage squirrelspell
  14.  * @todo remove sqspell_ prefix from main php scripts.
  15.  */
  16.  
  17.  
  18. /**
  19.  * Standard SquirrelMail plugin initialization API.
  20.  *
  21.  * @return void 
  22.  */
  23.   global $squirrelmail_plugin_hooks;
  24.   $squirrelmail_plugin_hooks['template_construct_compose_buttons.tpl']['squirrelspell'
  25.       'squirrelspell_setup';
  26.   $squirrelmail_plugin_hooks['optpage_register_block']['squirrelspell'=
  27.       'squirrelspell_optpage_register_block';
  28.   $squirrelmail_plugin_hooks['right_main_after_header']['squirrelspell'=
  29.       'squirrelspell_upgrade';
  30. }
  31.  
  32. /**
  33.  * Register option block
  34.  *
  35.  * This function formats and adds the plugin and its description to the
  36.  * Options screen. Code moved to internal function in order to reduce
  37.  * setup.php size.
  38.  * @return void 
  39.  */
  40.   include_once(SM_PATH 'plugins/squirrelspell/sqspell_functions.php');
  41. }
  42.  
  43. /**
  44.  * Add spell check button in compose.
  45.  *
  46.  * This function adds a "Check Spelling" link to the "Compose" row
  47.  * during message composition.
  48.  * @return void 
  49.  */
  50. function squirrelspell_setup({
  51.   include_once(SM_PATH 'plugins/squirrelspell/sqspell_functions.php');
  52. }
  53.  
  54. /**
  55.  * Upgrade dictionaries
  56.  *
  57.  * Transparently upgrades user's dictionaries when message listing is loaded
  58.  * @since 1.5.1 (sqspell 0.5)
  59.  */
  60. function squirrelspell_upgrade({
  61.   include_once(SM_PATH 'plugins/squirrelspell/sqspell_functions.php');
  62. }
  63.  
  64. /**
  65.  * Display SquirrelSpell version
  66.  * @since 1.5.1 (sqspell 0.5)
  67.  * @return string plugin's version
  68.  */
  69. function squirrelspell_version({
  70.   return '0.5';
  71. }

Documentation generated on Sun, 16 Dec 2018 04:23:20 +0100 by phpDocumentor 1.4.3