function throttle_help in Drupal 4

Same name and namespace in other branches

1. 5 modules/throttle/throttle.module \throttle_help()
2. 6 modules/throttle/throttle.module \throttle_help()

Implementation of hook_help().

File

modules/throttle.module, line 103

Allows configuration of congestion control auto-throttle mechanism.

Code

function throttle_help($section) {
  switch ($section) {
    case 'admin/help#throttle':
      $output = '<p>' . t('The throttle module provides a congestion control throttling mechanism for automatically detecting a surge in incoming traffic. If the site gets linked to by a popular website, or otherwise comes under a "Denial of Service" (DoS) attack, your webserver might become overwhelmed. This mechanism is utilized by other modules to automatically optimize their performance by temporarily disabling CPU-intensive functionality.  For example, in the site theme, you might choose to disable pictures when the site is too busy (reducing bandwidth), or in modules, you might choose to disable some complicated logic (reducing CPU utilization).') . '</p>';
      $output .= '<p>' . t('The congestion control throttle can be automatically enabled when the number of anonymous or authenticated users currently visiting the site exceeds the specified threshold. ') . '</p>';
      $output .= t('<p>You can</p>
<ul>
<li>enable throttle for modules at <a href="%admin-modules">administer &gt;&gt; module</a>.</li>
<li>enable throttle for blocks at <a href="%admin-block">administer &gt;&gt; block</a>.</li>
<li>administer throttle at <a href="%admin-settings-throttle">administer &gt;&gt; settings &gt;&gt; throttle</a>.</li>
</ul>
', array(
        '%admin-modules' => url('admin/modules'),
        '%admin-block' => url('admin/block'),
        '%admin-settings-throttle' => url('admin/settings/throttle'),
      ));
      $output .= '<p>' . t('For more information please read the configuration and customization handbook <a href="%throttle">Throttle page</a>.', array(
        '%throttle' => 'http://drupal.org/handbook/modules/throttle/',
      )) . '</p>';
      return $output;
    case 'admin/modules#description':
      return t('Handles the auto-throttling mechanism, to control site congestion.');
    case 'admin/settings/throttle':
      return t('If your site gets linked to by a popular website, or otherwise comes under a "Denial of Service" (DoS) attack, your webserver might become overwhelmed.  This module provides a congestion control throttling mechanism for automatically detecting a surge in incoming traffic.  This mechanism is utilized by other Drupal modules to automatically optimize their performance by temporarily disabling CPU-intensive functionality.');
  }
}