You are here

Home » API reference » Views Delimited List 7 » views_plugin_style_delimited_list.inc

class views_plugin_style_delimited_list in Views Delimited List 7

Same name and namespace in other branches
  1. 6 views_plugin_style_delimited_list.inc \views_plugin_style_delimited_list

Delimited list display style.

Hierarchy

Expanded class hierarchy of views_plugin_style_delimited_list

2 string references to 'views_plugin_style_delimited_list'
views_delimited_list_preprocess_views_view_fields in ./views_delimited_list.module
Implements hook_preprocess_HOOK() for views_view_fields.
views_delimited_list_views_plugins in ./views_delimited_list.views.inc
Implements hook_views_plugins().

File

./views_plugin_style_delimited_list.inc, line 5

View source 
class views_plugin_style_delimited_list extends views_plugin_style {

  /**
   * Default options.
   */
  function option_definition() {
    $options = parent::option_definition();
    $options['delimiter'] = array(
      'default' => ', ',
    );
    $options['conjunctive'] = array(
      'default' => ' and ',
    );
    $options['long_count'] = array(
      'default' => 3,
    );
    $options['separator_two'] = array(
      'default' => 'conjunctive',
    );
    $options['separator_long'] = array(
      'default' => 'both',
    );
    $options['prefix'] = array(
      'default' => '',
    );
    $options['suffix'] = array(
      'default' => '',
    );
    return $options;
  }

  /**
   * Add widgets for selecting fields for the feature rotator.
   */
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['delimiter'] = array(
      '#type' => 'textfield',
      '#title' => t('Delimiter text'),
      '#default_value' => $this->options['delimiter'],
      '#description' => t('This is the text that will be used for delimiting the list. Include leading and/or trailing spaces as desired. Default value: ", ".'),
    );
    $form['conjunctive'] = array(
      '#type' => 'textfield',
      '#title' => t('Conjunctive text'),
      '#default_value' => $this->options['conjunctive'],
      '#description' => t('What to use as the conjunctive for the list. Include leading and/or trailing spaces as desired. When used with the delimiter in a list of three or more items, the leading space in the conjunctive is typically collapsed with the trailing space in the final delimier. Default value: " and ".'),
    );
    $form['length_behavior'] = array(
      '#type' => 'fieldset',
      '#title' => t('List length-dependent behavior'),
      '#tree' => FALSE,
    );
    $form['length_behavior']['separator_two'] = array(
      '#type' => 'radios',
      '#parents' => array(
        'style_options',
        'separator_two',
      ),
      '#title' => t('Separator between two items'),
      '#options' => array(
        'delimiter' => t('Delimiter'),
        'conjunctive' => t('Conjunctive'),
        'both' => t('Both'),
      ),
      '#default_value' => $this->options['separator_two'],
      '#description' => t('When there are two items in the list, this option specifies what goes between the items. Default value: Conjunctive.'),
    );
    $form['length_behavior']['long_count'] = array(
      '#type' => 'select',
      '#parents' => array(
        'style_options',
        'long_count',
      ),
      '#title' => t('Long list count'),
      '#options' => array(
        2 => '2',
        3 => '3',
      ),
      '#default_value' => $this->options['long_count'],
      '#description' => t('At least how many items must be in the list for it to be considered a long list. This determines when to use the option below. If "2" is selected, the following option will override the previous option. Default value: 3.'),
    );
    $form['length_behavior']['separator_long'] = array(
      '#type' => 'radios',
      '#parents' => array(
        'style_options',
        'separator_long',
      ),
      '#title' => t('Separator before last item in long list'),
      '#options' => array(
        'delimiter' => t('Delimiter'),
        'conjunctive' => t('Conjunctive'),
        'both' => t('Both'),
      ),
      '#default_value' => $this->options['separator_long'],
      '#description' => t('In a long list (see above), this option specifies what goes before the final item. This is useful for distinguishing between U.S. English and U.K. English. Default value: Both.'),
    );
    $form['additional'] = array(
      '#type' => 'fieldset',
      '#title' => t('Additional text'),
      '#description' => t('These additional text options do not pertain particularly to the delimited list. However, they are useful beyond regular Views configuration.'),
      '#tree' => FALSE,
    );
    $form['additional']['prefix'] = array(
      '#type' => 'textfield',
      '#parents' => array(
        'style_options',
        'prefix',
      ),
      '#title' => t('Prefix'),
      '#default_value' => $this->options['prefix'],
      '#description' => t('Text to insert inline before the delimited list.'),
    );
    $form['additional']['suffix'] = array(
      '#type' => 'textfield',
      '#parents' => array(
        'style_options',
        'suffix',
      ),
      '#title' => t('Suffix'),
      '#default_value' => $this->options['suffix'],
      '#description' => t('Text to insert inline after the delimited list.'),
    );
  }

}

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 public function Render the display in this style. 5
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::render_grouping_sets public function Render the grouping sets.
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_delimited_list::options_form function Add widgets for selecting fields for the feature rotator. Overrides views_plugin_style::options_form
views_plugin_style_delimited_list::option_definition function Default options. Overrides views_plugin_style::option_definition