class views_plugin_style_list

Same name in other branches
  1. 7.x-3.x plugins/views_plugin_style_list.inc \views_plugin_style_list

Style plugin to render each item in an ordered or unordered list.

Hierarchy

Expanded class hierarchy of views_plugin_style_list

Related topics

Views' style plugins
Style plugins control how a view is rendered. For example, they
can choose to display a collection of fields, node_view() output,
table output, or any kind of crazy output they want.
1 string reference to 'views_plugin_style_list'
views_views_plugins in includes/plugins.inc
Implementation of hook_views_plugins

File

plugins/views_plugin_style_list.inc, line 12

View source 
class views_plugin_style_list extends views_plugin_style {
    
    /**
     * Set default options
     */
    function option_definition() {
        $options = parent::option_definition();
        $options['type'] = array(
            'default' => 'ul',
        );
        $options['class'] = array(
            'default' => '',
        );
        $options['wrapper_class'] = array(
            'default' => 'item-list',
        );
        return $options;
    }
    
    /**
     * Render the given style.
     */
    function options_form(&$form, &$form_state) {
        parent::options_form($form, $form_state);
        $form['type'] = array(
            '#type' => 'radios',
            '#title' => t('List type'),
            '#options' => array(
                'ul' => t('Unordered list'),
                'ol' => t('Ordered list'),
            ),
            '#default_value' => $this->options['type'],
        );
        $form['wrapper_class'] = array(
            '#title' => t('Wrapper class'),
            '#description' => t('The class to provide on the wrapper, outside the list.'),
            '#type' => 'textfield',
            '#size' => '30',
            '#default_value' => $this->options['wrapper_class'],
        );
        $form['class'] = array(
            '#title' => t('List class'),
            '#description' => t('The class to provide on the list element itself.'),
            '#type' => 'textfield',
            '#size' => '30',
            '#default_value' => $this->options['class'],
        );
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
views_object::$definition property Handler's definition
views_object::$options property Except for displays, options for the object will be held here. 1
views_object::construct function Views handlers use a special construct function so that we can more
easily construct them with variable arguments. 		6
views_object::export_option function 1
views_object::export_options function
views_object::options function Set default options on this object. Called by the constructor in a
complex chain to deal with backward compatibility. 		1
views_object::set_default_options function Set default options.
For backward compatibility, it sends the options array; this is a
feature that will likely disappear at some point.
views_object::set_definition function Let the handler know what its full definition is.
views_object::unpack_options function Unpack options over our existing defaults, drilling down into arrays
so that defaults don't get totally blown away.
views_object::unpack_translatable function Unpack a single option definition.
views_object::unpack_translatables function Unpacks each handler to store translatable texts.
views_object::_set_option_defaults function
views_plugin::$display property The current used views display.
views_plugin::$plugin_type property The plugin type of this plugin, for example style or query.
views_plugin::$view property The top object of a view. Overrides views_object::$view 1
views_plugin::additional_theme_functions function Provide a list of additional theme functions for the theme information page
views_plugin::options_submit function Handle any special handling on the validate form. 9
views_plugin::options_validate function Validate the options form. 8
views_plugin::theme_functions function Provide a full list of possible theme templates used by this style.
views_plugin_style::$row_plugin property Contains the row plugin, if it's initialized
and the style itself supports it.
views_plugin_style::$row_tokens property Store all availible tokens row rows.
views_plugin_style::build_sort 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 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 function Overrides views_object::destroy
views_plugin_style::even_empty function Should the output of the style plugin be rendered even if it's a empty view. 1
views_plugin_style::get_field function Get a rendered field.
views_plugin_style::get_row_class function Return the token replaced row class for the specified row.
views_plugin_style::init function Initialize a style plugin.
views_plugin_style::pre_render function Allow the style to do stuff before each row is rendered.
views_plugin_style::query function Add anything to the query that we might need to. Overrides views_plugin::query 2
views_plugin_style::render function Render the display in this style. 4
views_plugin_style::render_fields function Render all of the fields for a given style and store them on the object.
views_plugin_style::render_grouping function Group records as needed for rendering.
views_plugin_style::tokenize_value function Take a value and apply token replacement logic to it.
views_plugin_style::uses_fields function Return TRUE if this style also uses fields.
views_plugin_style::uses_row_class function Return TRUE if this style also uses a row plugin.
views_plugin_style::uses_row_plugin function Return TRUE if this style also uses a row plugin.
views_plugin_style::uses_tokens function Return TRUE if this style uses tokens.
views_plugin_style::validate function Validate that the plugin is correct and can be saved. Overrides views_plugin::validate
views_plugin_style_list::options_form function Render the given style. Overrides views_plugin_style::options_form
views_plugin_style_list::option_definition function Set default options Overrides views_plugin_style::option_definition