Source for file setup.php

Documentation is available at setup.php

  1. <?php
  2.  
  3. /**
  4.   * SquirrelMail Demo Plugin
  5.   * @copyright 2006-2020 The SquirrelMail Project Team
  6.   * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  7.   * @version $Id: setup.php 14840 2020-01-07 07:42:38Z pdontthink $
  8.   * @package plugins
  9.   * @subpackage demo
  10.   */
  11.  
  12.  
  13.  
  14. /**
  15.   * Register this plugin with SquirrelMail
  16.   *
  17.   * @return void 
  18.   *
  19.   */
  20. function squirrelmail_plugin_init_demo() 
  21. {
  22. //FIXME: put *ALL* SM hooks in here... and put them in the right order
  23. //FIXME: many hooks have examples in the original demo plugin in trunk/plugins/demo
  24.  
  25.    global $squirrelmail_plugin_hooks;
  26.  
  27. //FIXME: this hook not yet implemented below 
  28.    $squirrelmail_plugin_hooks['login_cookie']['demo']
  29.       = 'demo_login_cookie';
  30.  
  31. //FIXME: this hook not yet implemented below 
  32.    $squirrelmail_plugin_hooks['login_top']['demo']
  33.       = 'demo_login_top';
  34.  
  35. //FIXME: this hook not yet implemented below 
  36.    $squirrelmail_plugin_hooks['login_form']['demo']
  37.       = 'demo_login_form';
  38.  
  39. //FIXME: this hook not yet implemented below 
  40.    $squirrelmail_plugin_hooks['login_bottom']['demo']
  41.       = 'demo_login_bottom';
  42.  
  43.    $squirrelmail_plugin_hooks['menuline']['demo']
  44.       = 'demo_menuline';
  45.  
  46.    $squirrelmail_plugin_hooks['optpage_register_block']['demo']
  47.       = 'demo_option_link';
  48.  
  49.    $squirrelmail_plugin_hooks['configtest']['demo']
  50.       = 'demo_check_configuration';
  51. }
  52.  
  53.  
  54.  
  55. /**
  56.   * Returns info about this plugin
  57.   *
  58.   * @return array An array of plugin information.
  59.   *
  60.   */
  61. function demo_info()
  62. {
  63.  
  64.    return array(
  65.              'english_name' => 'Demo',
  66.              'version' => 'CORE',
  67.              'summary' => 'This plugin provides test/sample code for many of the hook points in the SquirrelMail core.',
  68.              'details' => 'This plugin provides test/sample code for many of the hook points in the SquirrelMail core.', 
  69.              'requires_configuration' => 0,
  70.              'requires_source_patch' => 0,
  71.           );
  72.  
  73. }
  74.  
  75.  
  76.  
  77. /**
  78.   * Returns version info about this plugin
  79.   *
  80.   */
  81. function demo_version()
  82. {
  83.    $info = demo_info();
  84.    return $info['version'];
  85. }
  86.  
  87.  
  88.  
  89. /**
  90.   * Add link to menu at top of content pane
  91.   *
  92.   * @return void 
  93.   *
  94.   */
  95. function demo_menuline() 
  96. {
  97.    include_once(SM_PATH . 'plugins/demo/functions.php');
  98.    demo_menuline_do();
  99. }
  100.  
  101.  
  102.  
  103. /**
  104.   * Inserts an option block in the main SM options page
  105.   *
  106.   * @return void 
  107.   *
  108.   */
  109. function demo_option_link()
  110. {
  111.    include_once(SM_PATH . 'plugins/demo/functions.php');
  112.    demo_option_link_do();
  113. }
  114.  
  115.  
  116.  
  117. /**
  118.   * Validate that this plugin is configured correctly
  119.   *
  120.   * @return boolean Whether or not there was a
  121.   *                  configuration error for this plugin.
  122.   *
  123.   */
  124. function demo_check_configuration()
  125. {
  126.    include_once(SM_PATH . 'plugins/demo/functions.php');
  127.    return demo_check_configuration_do();
  128. }

Documentation generated on Mon, 13 Jan 2020 04:25:19 +0100 by phpDocumentor 1.4.3