You are here

Home » API reference » Webform Views Select 7 » WebformViewsSelectStyle.inc

class WebformViewsSelectStyle in Webform Views Select 7

The style plugin for Webform Views Select.

Hierarchy

Expanded class hierarchy of WebformViewsSelectStyle

1 string reference to 'WebformViewsSelectStyle'
webform_views_select_views_plugins in ./webform_views_select.views.inc
Implements hook_views_plugins().

File

./WebformViewsSelectStyle.inc, line 11
Contains WebformViewsSelectStyle.

View source 
class WebformViewsSelectStyle extends views_plugin_style_mapping {

  /**
   * Implements views_plugin_style_mapping::define_mapping().
   */
  public function define_mapping() {
    return array(
      'webform_select_key' => array(
        '#title' => t('Short, raw options (keys)'),
        '#required' => TRUE,
      ),
      'webform_select_value' => array(
        '#title' => t('Full, human-readable options (values)'),
        '#required' => TRUE,
      ),
    );
  }

  /**
   * {@inheritdoc}
   */
  public function option_definition() {
    $options = parent::option_definition();
    $options['html'] = array(
      'contains' => array(
        'strip' => array(
          'default' => TRUE,
          'bool' => TRUE,
        ),
        'tags_allowed' => array(
          'default' => 'a em strong cite blockquote code ul ol li dl dt dd',
        ),
      ),
    );
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['html'] = array(
      '#type' => 'fieldset',
      '#title' => t('HTML filter'),
    );
    $form['html']['strip'] = array(
      '#type' => 'checkbox',
      '#title' => t('No HTML tags allowed.'),
      '#default_value' => $this->options['html']['strip'],
    );
    $form['html']['tags_allowed'] = array(
      '#type' => 'textfield',
      '#title' => t('Allowed HTML tags'),
      '#default_value' => $this->options['html']['tags_allowed'],
      '#description' => t('A space-separated list of HTML tags allowed. Disallowed tags are stripped from the content.'),
      '#states' => array(
        'enabled' => array(
          ':input[name="style_options[html][strip]"]' => array(
            'checked' => FALSE,
          ),
        ),
      ),
    );
  }

  /**
   * Implements views_plugin_style::render_grouping_sets().
   */
  public function render_grouping_sets($sets, $level = 0) {
    $key = $this->options['mapping']['webform_select_key'];
    $value = $this->options['mapping']['webform_select_value'];
    $output = array();
    foreach ($sets as $set) {

      // Render as a grouping set.
      if (is_array($set) && isset($set['group'])) {
        reset($set['rows']);
        $output[htmlspecialchars_decode(strip_tags($set['group']))] = $this
          ->render_grouping_sets($set['rows'], $level + 1);
      }
      else {
        $result = (array) $set;

        // We strip HTML tags from the field output because some fields (e.g.
        // Date fields) include tags in their output.
        $rendered_key = htmlspecialchars_decode(strip_tags($result[$key]), ENT_QUOTES);
        if ($this->options['html']['strip'] == FALSE) {
          $tags_allowed = explode(' ', $this->options['html']['tags_allowed']);
          $rendered_value = filter_xss($result[$value], $tags_allowed);
        }
        else {
          $rendered_value = htmlspecialchars_decode(strip_tags($result[$value]), ENT_QUOTES);
        }
        $output[$rendered_key] = $rendered_value;
      }
    }
    return $output;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
views_object::$definition public property Handler's definition.
views_object::$options public property Except for displays, options for the object will be held here. 1
views_object::altered_option_definition function Collect this handler's option definition and alter them, ready for use.
views_object::construct public function Views handlers use a special construct function. 4
views_object::export_option public function 1
views_object::export_options public function
views_object::export_option_always public function Always exports the option, regardless of the default value.
views_object::options Deprecated public function Set default options on this object. 1
views_object::set_default_options public function Set default options.
views_object::set_definition public function Let the handler know what its full definition is.
views_object::unpack_options public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable public function Unpack a single option definition.
views_object::unpack_translatables public function Unpacks each handler to store translatable texts.
views_object::_set_option_defaults public function
views_plugin::$display public property The current used views display.
views_plugin::$plugin_name public property The plugin name of this plugin, for example table or full.
views_plugin::$plugin_type public property The plugin type of this plugin, for example style or query.
views_plugin::$view public property The top object of a view. Overrides views_object::$view 1
views_plugin::additional_theme_functions public function Provide a list of additional theme functions for the theme info page.
views_plugin::options_submit public function Handle any special handling on the validate form. 9
views_plugin::plugin_title public function Return the human readable name of the display.
views_plugin::summary_title public function Returns the summary of the settings in the display. 8
views_plugin::theme_functions public function Provide a full list of possible theme templates used by this style.
views_plugin_style::$row_plugin public property The row plugin, if it's initialized and the style itself supports it.
views_plugin_style::$row_tokens public property Store all available tokens row rows.
views_plugin_style::build_sort public function Called by the view builder to see if this style handler wants to interfere with the sorts. If so it should build; if it returns any non-TRUE value, normal sorting will NOT be added to the query. 1
views_plugin_style::build_sort_post public function Called by the view builder to let the style build a second set of sorts that will come after any other sorts in the view. 1
views_plugin_style::destroy public function Destructor. Overrides views_object::destroy
views_plugin_style::even_empty public function Should the output of the style plugin be rendered even if it's empty. 1
views_plugin_style::get_field public function Get a rendered field.
views_plugin_style::get_field_value public function Get the raw field value.
views_plugin_style::get_row_class public function Return the token replaced row class for the specified row.
views_plugin_style::init public function Initialize a style plugin.
views_plugin_style::options_validate public function Validate the options form. Overrides views_plugin::options_validate
views_plugin_style::pre_render public function Allow the style to do stuff before each row is rendered.
views_plugin_style::query public function Add anything to the query that we might need to. Overrides views_plugin::query 2
views_plugin_style::render_fields public function Render all of the fields for a given style and store them on the object.
views_plugin_style::render_grouping public function Group records as needed for rendering.
views_plugin_style::tokenize_value public function Take a value and apply token replacement logic to it.
views_plugin_style::uses_fields public function Return TRUE if this style also uses fields.
views_plugin_style::uses_row_class public function Return TRUE if this style also uses a row plugin.
views_plugin_style::uses_row_plugin public function Return TRUE if this style also uses a row plugin.
views_plugin_style::uses_tokens public function Return TRUE if this style uses tokens.
views_plugin_style::validate public function Validate that the plugin is correct and can be saved. Overrides views_plugin::validate
views_plugin_style_mapping::render public function Render the display in this style. Overrides views_plugin_style::render
WebformViewsSelectStyle::define_mapping public function Implements views_plugin_style_mapping::define_mapping(). Overrides views_plugin_style_mapping::define_mapping
WebformViewsSelectStyle::options_form public function Provide a form to edit options for this plugin. Overrides views_plugin_style_mapping::options_form
WebformViewsSelectStyle::option_definition public function Information about options for all kinds of purposes will be held here. Overrides views_plugin_style_mapping::option_definition
WebformViewsSelectStyle::render_grouping_sets public function Implements views_plugin_style::render_grouping_sets(). Overrides views_plugin_style::render_grouping_sets