/[drupal]/contributions/modules/wordfilter/wordfilter.module

Diff of /contributions/modules/wordfilter/wordfilter.module

Parent Directory | Revision Log | View Revision Graph Revision Graph | View Patch Patch

-revision 1.7.2.18,
Wed Dec 10 16:00:05 2008 UTC
+revision 1.7.2.19,
Tue Apr 14 09:35:18 2009 UTC
 Line 1
  <?php
- // $Id: wordfilter.module,v 1.7.2.13 2008/06/23 16:06:09 jaydub Exp $
+ // $Id: wordfilter.module,v 1.7.2.18 2008/12/10 16:00:05 jaydub Exp $
  /**
   * @file
 Line 271 
 function wordfilter_block($op = 'list',
      switch ($delta) {
        case 0:
          $block['subject'] = t('Filtered words');
-         $block['content'] = $GLOBALS['display_wordfilter_block'] ? wordfilter_table() : '';
+         $block['content'] = $GLOBALS['display_wordfilter_block'] ? _wordfilter_table() : '';
          return $block;
      }
    }
  }
  /**
-  * @return string
+  * Displays a list of words that will be filtered as an HTML table.
   */
- function wordfilter_filter_tips($delta, $format, $long = FALSE) {
+ function _wordfilter_table() {
-   if ($long) {
-     return t('If you include a word in your post that\'s filtered (usually foul language), it will be replaced by the filtered version of the word.') .'<br />';
-   }
-   else {
-     $GLOBALS['display_wordfilter_block'] = TRUE;
-     return t('Filtered words will be replaced with the filtered version of the word.');
-   }
- }
- function wordfilter_table() {
    $content .= '<div align="center">';
    $content .= '<table border="0" cellspacing="1" cellpadding="0">';
    $list = _wordfilter_list();
-Line 302 
 function wordfilter_table() {
+Line 292 
 function wordfilter_table() {
    return $content;
  }
+ /**
+  * Implementation of hook_filter_tips().
+  */
+ function wordfilter_filter_tips($delta, $format, $long = FALSE) {
+   if ($long) {
+     return t("If you include a word in your post that's filtered (usually foul language), it will be replaced by the filtered version of the word.") .'<br />';
+   }
+   else {
+     $GLOBALS['display_wordfilter_block'] = TRUE;
+     return t('Filtered words will be replaced with the filtered version of the word.');
+   }
+ }
+ /**
+  * Implementation of hook_filter().
+  */
  function wordfilter_filter($op, $delta = 0, $format = -1, $text = '') {
    switch ($op) {
      case 'list':
-Line 312 
 function wordfilter_filter($op, $delta =
+Line 318 
 function wordfilter_filter($op, $delta =
        $form['word_filter'] = array(
          '#type' => 'fieldset',
          '#title' => t('Word filter'),
-         '#description' => t('You can define a global list of words to be filtered on the <a href="@url">wordfilter settings page</a>.', array('@url' => url('admin/settings/wordfilter'))),
+         '#description' => t('You can define a global list of words or phrases to be filtered on the <a href="@url">wordfilter settings page</a>.', array('@url' => url('admin/settings/wordfilter'))),
        );
        return $form;
      case 'process':
-Line 322 
 function wordfilter_filter($op, $delta =
+Line 328 
 function wordfilter_filter($op, $delta =
    }
  }
+ /**
+  * hook_filter process operation callback.
+  */
  function wordfilter_filter_process($text) {
    $text = ' '. $text .' ';
    $list = _wordfilter_list();
-Line 375 
 function _wordfilter_admin_list($header)
+Line 384 
 function _wordfilter_admin_list($header)
  }
  /**
-  * wordfilter admin settings page
+  * Wordfilter admin settings page callback.
   */
  function wordfilter_admin_list() {
    $header = array(
-Line 402 
 function wordfilter_admin_list() {
+Line 411 
 function wordfilter_admin_list() {
    return $output;
  }
+ /**
+  * Edit word filter form.
+  */
  function wordfilter_admin_edit_form($word_id = NULL) {
    if (!isset($word_id) || !is_numeric($word_id)) {
      drupal_set_message(t('The wordfilter ID of the word or phrase you are trying to edit is missing or is not a number.'), 'error');
-Line 437 
 function wordfilter_admin_edit_form($wor
+Line 449 
 function wordfilter_admin_edit_form($wor
      '#type' => 'checkbox',
      '#title' => t('Stand-alone'),
      '#default_value' => $word->standalone,
-     '#description' => t('When checked, the word or phrase will only be filtered when found as a separate word or phrase (i.e. prefixed and suffixed by spaces or "whitespace"). A period one character after a word or phrase will exclude the words or phrases from replacement in stand-alone mode. This is useful for preventing accidental word filtering with short or common words or phrases.'),
+     '#description' => t('When checked, the word or phrase will only be filtered when found as a separate word or phrase (i.e. prefixed and suffixed by spaces or "whitespace"). A period one character after a word or phrase will exclude the words or phrases from replacement in stand-alone mode. This is useful for preventing accidental word or phrase filtering with short or common words or phrases.'),
    );
    $form['Save word filter'] = array(
-Line 452 
 function wordfilter_admin_edit_form($wor
+Line 464 
 function wordfilter_admin_edit_form($wor
    return $form;
  }
+ /**
+  * Edit word filter form submit handler.
+  */
  function wordfilter_admin_edit_form_submit($form_id, $form_values) {
    db_query("UPDATE {wordfilter} SET words = '%s', replacement = '%s', standalone = %d WHERE id = %d", $form_values['words'], $form_values['replacement'], $form_values['standalone'], $form_values['id']);
    $message = t('Updated filter for: %words', array('%words' => $form_values['words']));
-Line 460 
 function wordfilter_admin_edit_form_subm
+Line 475 
 function wordfilter_admin_edit_form_subm
    return 'admin/settings/wordfilter';
  }
+ /**
+  * Add word filter form.
+  */
  function wordfilter_admin_add_form() {
    $form = array();
    $form['help'] = array(
      '#type' => 'markup',
-     '#value' => t("Enter a word or phrase you want to filter followed by '|' and the replacement word or phrase. You can enter multiple word and replacement word pairs by hitting return and adding more word pairs. Any word or phrases that do not have a replacement word or phrase will use the default replacement word below."),
+     '#value' => t("<p>Enter a word or phrase you want to filter followed by '|' and the replacement word or phrase. You can enter multiple word and replacement word pairs by hitting return and adding more word pairs. Any word or phrases that do not have a replacement word or phrase will use the default replacement word below.</p>
+ <p><strong>Examples:</strong><br />
+ bar|baz - Replace 'bar' with 'baz'<br />
+ baz - Replace 'baz' with the default replacement below<br />
+ </p>"),
    );
    $form['words'] = array(
      '#type' => 'textarea',
      '#title' => t('Words'),
-     '#description' => t("Enter a word or phrase you want to filter followed by '|' and the replacement word or phrase."),
+     '#description' => t("Enter a word or phrase you want to filter followed by '|' and the replacement word or phrase if any."),
      '#required' => TRUE,
    );
    $form['replacement'] = array(
-Line 500 
 function wordfilter_admin_add_form() {
+Line 522 
 function wordfilter_admin_add_form() {
    return $form;
  }
+ /**
+  * Add word filter form submit handler.
+  */
  function wordfilter_admin_add_form_submit($form_id, $form_values) {
    $pairs = explode("\n", $form_values['words']);
    $pairs = array_map('trim', $pairs);
-Line 517 
 function wordfilter_admin_add_form_submi
+Line 542 
 function wordfilter_admin_add_form_submi
    return 'admin/settings/wordfilter';
  }
+ /**
+  * Test word filter form.
+  */
  function wordfilter_admin_test_filter_form($form_values = NULL) {
    $form = array();
    $form['#multistep'] = TRUE;
-Line 548 
 function wordfilter_admin_test_filter_fo
+Line 576 
 function wordfilter_admin_test_filter_fo
    return $form;
  }
+ /**
+  * Test word filter page callback.
+  */
  function _wordfilter_test_filter($word) {
    $filtered_word = wordfilter_filter_process($word);
    if ($word == $filtered_word) {

 Legend:



Removed from v.1.7.2.18
 


changed lines


 
Added in v.1.7.2.19
 Legend:



Removed from v.1.7.2.18
 


changed lines


 
Added in v.1.7.2.19
-Removed from v.1.7.2.18
+Added in v.1.7.2.19

	ViewVC Help
Powered by ViewVC 1.1.2