function _htmlpurifier_settings in HTML Purifier 7.2

Same name and namespace in other branches

1. 5 htmlpurifier.module \_htmlpurifier_settings()
2. 6.2 htmlpurifier.module \_htmlpurifier_settings()
3. 6 htmlpurifier.module \_htmlpurifier_settings()
4. 7 htmlpurifier.module \_htmlpurifier_settings()

Generates a settings form for configuring HTML Purifier.

Parameters

array $form: The prepopulated form array.

array $form_state: The form state of the (entire) configuration form.

object $filter: The filter object containing settings for the given format.

object $format: The format object being configured.

array $defaults: The default settings for the filter, as defined in 'default settings' in hook_filter_info().

array $filters: The complete list of filter objects that are enabled for the given format.

Return value

Form API array.

1 string reference to '_htmlpurifier_settings'

htmlpurifier_filter_info in ./htmlpurifier.module

Implements hook_filter_info().

File

./htmlpurifier.module, line 556

Implements HTML Purifier as a Drupal filter.

Code

function _htmlpurifier_settings($form, &$form_state, $filter, $format, $defaults, $filters) {
  $settings = array();
  $htmlpurifier_library = libraries_detect('htmlpurifier');
  if ($htmlpurifier_library['installed']) {

    // Dry run, testing for errors:
    _htmlpurifier_process_text('dry run text', $filter, $format, LANGUAGE_NONE, FALSE);
    $module_path = drupal_get_path('module', 'htmlpurifier');
    $infos = htmlpurifier_get_info();
    $settings['#attached']['css'][] = "{$module_path}/config-form.css";
    $settings['#attached']['js'][] = "{$module_path}/config-form.js";
    $settings['#attached']['js'][] = array(
      'data' => HTMLPurifier_Printer_ConfigForm::getJavaScript(),
      'type' => 'inline',
    );

    // An AJAX request calls the form builder function for every change.
    // Here we grab the config_name so we can grab applicable data from the htmlpurifier_info
    if (isset($form_state['values']['filters']['htmlpurifier']['settings']['htmlpurifier_config_name'])) {
      $config_name = $form_state['values']['filters']['htmlpurifier']['settings']['htmlpurifier_config_name'];
    }
    elseif (isset($filter->settings['htmlpurifier_config_name'])) {
      $config_name = $filter->settings['htmlpurifier_config_name'];
    }
    else {
      $config_name = $defaults['htmlpurifier_config_name'];
    }

    // Check if we need to reset the form
    $reset = isset($form_state['htmlpurifier']['htmlpurifier_config_reset']) ? $form_state['htmlpurifier']['htmlpurifier_config_reset'] : FALSE;
    $settings['htmlpurifier_help'] = array(
      '#type' => 'checkbox',
      '#title' => t('Display Help Text'),
      '#default_value' => isset($filter->settings['htmlpurifier_help']) && !$reset ? $filter->settings['htmlpurifier_help'] : $infos[$config_name]['htmlpurifier_help'],
      '#description' => t('If enabled, a short note will be added to the filter tips explaining that HTML will be transformed to conform with HTML standards. You may want to disable this option when the HTML Purifier is used to check the output of another filter like BBCode.'),
    );
    $settings['htmlpurifier_filter_tips'] = array(
      '#type' => 'textfield',
      '#title' => t('Help Text'),
      '#default_value' => isset($filter->settings['htmlpurifier_filter_tips']) && !$reset ? $filter->settings['htmlpurifier_filter_tips'] : $infos[$config_name]['htmlpurifier_filter_tips'],
      '#description' => t('Override the default help text to be something more useful.'),
      '#states' => array(
        // Hide the settings when the htmlpurifier_help checkbox is disabled.
        'invisible' => array(
          ':input[name="filters[htmlpurifier][settings][htmlpurifier_help]"]' => array(
            'checked' => FALSE,
          ),
        ),
      ),
    );

    // Sort the radio values by weight
    uasort($infos, '_htmlpurifier_option_cmp');
    $options = array();
    foreach ($infos as $name => $info) {
      $options += array(
        $name => t($info['name']) . ': ' . t($info['description']),
      );
    }

    // Radio buttons for the config you want to use
    $settings['htmlpurifier_config_name'] = array(
      '#title' => t("Choose an HTML Purifier Configuration"),
      '#type' => 'radios',
      '#required' => TRUE,
      '#options' => $options,
      '#default_value' => $config_name,
      '#ajax' => array(
        'callback' => '_htmlpurifer_config_form_ajax_callback',
        'wrapper' => 'htmlpurifier_config_form',
      ),
    );
    $intro = '<div class="form-item"><div class="description">' . t('Please click on a directive name for more information on what it does before enabling or changing anything!  Changes will not apply to old entries until you clear the cache (see the <a href="@url">settings page</a>).', array(
      '@url' => url('admin/config/content/htmlpurifier'),
    )) . '</div></div>';
    $allowed = $infos[$config_name]['allowed'];

    // Generate the custom HTML Purifier Config form
    $config = _htmlpurifier_get_config($format->format, $config_name, $reset);
    $config_form = new HTMLPurifier_Printer_ConfigForm($filter->name . '_config', 'http://htmlpurifier.org/live/configdoc/plain.html#%s');

    // This entire form element will be replaced whenever 'htmlpurifier_config_name' is updated.
    $settings['htmlpurifier_config_form'] = array(
      '#markup' => $intro . $config_form
        ->render($config, $allowed, FALSE),
      '#prefix' => '<div id="htmlpurifier_config_form">',
      '#suffix' => '</div>',
      '#after_build' => array(
        '_htmlpurifier_set_config',
      ),
    );

    // Adds a new button to clear the form.
    // There is no difference between the validate and submit handler
    // so they are both pointed to the same function.
    $settings['htmlpurifier_config_reset'] = array(
      '#type' => 'submit',
      '#value' => 'Reset to Defaults',
      '#validate' => array(
        '_htmlpurifier_config_reset',
      ),
      '#submit' => array(
        '_htmlpurifier_config_reset',
      ),
    );
  }
  else {
    drupal_set_message($htmlpurifier_library['error message'], 'error', FALSE);
  }
  return $settings;
}