class 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
Implements hook_views_plugins().

File

plugins/views_plugin_row_fields.inc, line 16

View source
class views_plugin_row_fields extends views_plugin_row {
    
    /**
     * {@inheritdoc}
     */
    public function option_definition() {
        $options = parent::option_definition();
        $options['inline'] = array(
            'default' => array(),
        );
        $options['separator'] = array(
            'default' => '',
        );
        $options['hide_empty'] = array(
            'default' => FALSE,
            'bool' => TRUE,
        );
        $options['default_field_elements'] = array(
            'default' => TRUE,
            'bool' => TRUE,
        );
        return $options;
    }
    
    /**
     * Provide a form for setting options.
     */
    public 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.'),
            '#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.'),
            '#dependency' => array(
                'edit-row-options-default-field-elements' => array(
                    1,
                ),
            ),
        );
        $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.
     */
    public function options_submit(&$form, &$form_state) {
        $form_state['values']['row_options']['inline'] = array_filter($form_state['values']['row_options']['inline']);
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
views_object::$definition public property Handler&#039;s definition.
views_object::$options public property Except for displays, options for the object will be held here. 1
views_object::altered_option_definition public function Collect this handler&#039;s option definition and alter them, ready for use.
views_object::construct public function Views handlers use a special construct function. 4
views_object::destroy public function Destructor. 2
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&#039;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::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::validate public function Validate that the plugin is correct and can be saved. 3
views_plugin_row::init public function 2
views_plugin_row::options_validate public function Validate the options form. Overrides views_plugin::options_validate
views_plugin_row::pre_render public function Allow the style to do stuff before each row is rendered. 5
views_plugin_row::query public function Add anything to the query that we might need to. Overrides views_plugin::query
views_plugin_row::render public function Render a row object. This usually passes through to a theme template
of some form, but not always.
7
views_plugin_row::uses_fields public function
views_plugin_row_fields::options_form public function Provide a form for setting options. Overrides views_plugin_row::options_form
views_plugin_row_fields::options_submit public 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 public function Information about options for all kinds of purposes will be held here. Overrides views_plugin_row::option_definition