class views_plugin_row_fields

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

The basic 'fields' row plugin

This displays fields one after another, giving options for inline or not.

Hierarchy

Expanded class hierarchy of views_plugin_row_fields

Related topics

1 string reference to 'views_plugin_row_fields'
views_views_plugins in includes/plugins.inc
Implementation of hook_views_plugins

File

plugins/views_plugin_row_fields.inc, line 15

View source
class views_plugin_row_fields extends views_plugin_row {
    function option_definition() {
        $options = parent::option_definition();
        $options['inline'] = array(
            'default' => array(),
        );
        $options['separator'] = array(
            'default' => '',
        );
        $options['hide_empty'] = array(
            'default' => FALSE,
        );
        $options['default_field_elements'] = array(
            'default' => TRUE,
        );
        return $options;
    }
    
    /**
     * Provide a form for setting options.
     */
    function options_form(&$form, &$form_state) {
        parent::options_form($form, $form_state);
        $options = $this->display->handler
            ->get_field_labels();
        if (empty($this->options['inline'])) {
            $this->options['inline'] = array();
        }
        $form['default_field_elements'] = array(
            '#type' => 'checkbox',
            '#title' => t('Provide default field wrapper elements'),
            '#default_value' => $this->options['default_field_elements'],
            '#description' => t('If not checked, fields that are not configured to customize their HTML elements will get no wrappers at all for their field, label and field + label wrappers. You can use this to quickly reduce the amount of markup the view provides by default, at the cost of making it more difficult to apply CSS.'),
        );
        $form['inline'] = array(
            '#type' => 'checkboxes',
            '#title' => t('Inline fields'),
            '#options' => $options,
            '#default_value' => $this->options['inline'],
            '#description' => t('Inline fields will be displayed next to each other rather than one after another. Note that some fields will ignore this if they are block elements, particularly body fields and other formatted HTML.'),
            '#process' => array(
                'expand_checkboxes',
                'views_process_dependency',
            ),
            '#dependency' => array(
                'edit-row-options-default-field-elements' => array(
                    1,
                ),
            ),
            '#prefix' => '<div id="edit-row-options-inline-wrapper"><div>',
            '#suffix' => '</div></div>',
        );
        $form['separator'] = array(
            '#title' => t('Separator'),
            '#type' => 'textfield',
            '#size' => 10,
            '#default_value' => isset($this->options['separator']) ? $this->options['separator'] : '',
            '#description' => t('The separator may be placed between inline fields to keep them from squishing up next to each other. You can use HTML in this field.'),
        );
        $form['hide_empty'] = array(
            '#type' => 'checkbox',
            '#title' => t('Hide empty fields'),
            '#default_value' => $this->options['hide_empty'],
            '#description' => t('Do not display fields, labels or markup for fields that are empty.'),
        );
    }
    
    /**
     * Perform any necessary changes to the form values prior to storage.
     * There is no need for this function to actually store the data.
     */
    function options_submit($form, &$form_state) {
        $form_state['values']['row_options']['inline'] = array_filter($form_state['values']['row_options']['inline']);
    }

}

Members

Title Sort descending 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::destroy function 2
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::theme_functions function Provide a full list of possible theme templates used by this style.
views_plugin::validate function Validate that the plugin is correct and can be saved. 2
views_plugin_row::init function Initialize the row plugin. 1
views_plugin_row::options_validate function Validate the options form. Overrides views_plugin::options_validate
views_plugin_row::pre_render function Allow the style to do stuff before each row is rendered. 1
views_plugin_row::query function Add anything to the query that we might need to. Overrides views_plugin::query
views_plugin_row::render function Render a row object. This usually passes through to a theme template
of some form, but not always.
4
views_plugin_row::uses_fields function
views_plugin_row_fields::options_form function Provide a form for setting options. Overrides views_plugin_row::options_form
views_plugin_row_fields::options_submit function Perform any necessary changes to the form values prior to storage.
There is no need for this function to actually store the data.
Overrides views_plugin_row::options_submit
views_plugin_row_fields::option_definition function Information about options for all kinds of purposes will be held here. Overrides views_plugin_row::option_definition