class views_plugin_style_table

Style plugin to render each item as a row in a table.

Hierarchy

Expanded class hierarchy of views_plugin_style_table

Related topics

1 string reference to 'views_plugin_style_table'
views_views_plugins in includes/plugins.inc
Implements hook_views_plugins().

File

plugins/views_plugin_style_table.inc, line 13

View source
class views_plugin_style_table extends views_plugin_style {
    
    /**
     * Contains the current active sort column.
     *
     * @var string
     */
    public $active;
    
    /**
     * Contains the current active sort order, either desc or asc.
     *
     * @var string
     */
    public $order;
    
    /**
     * {@inheritdoc}
     */
    public function option_definition() {
        $options = parent::option_definition();
        $options['columns'] = array(
            'default' => array(),
        );
        $options['class'] = array(
            'default' => array(),
        );
        $options['default'] = array(
            'default' => '',
        );
        $options['info'] = array(
            'default' => array(),
        );
        $options['override'] = array(
            'default' => TRUE,
            'bool' => TRUE,
        );
        $options['sticky'] = array(
            'default' => FALSE,
            'bool' => TRUE,
        );
        $options['order'] = array(
            'default' => 'asc',
        );
        $options['caption'] = array(
            'default' => '',
            'translatable' => TRUE,
        );
        $options['summary'] = array(
            'default' => '',
            'translatable' => TRUE,
        );
        $options['empty_table'] = array(
            'default' => FALSE,
            'bool' => TRUE,
        );
        return $options;
    }
    
    /**
     * Determine if we should provide sorting based upon $_GET inputs.
     *
     * @return bool
     */
    public function build_sort() {
        if (!isset($_GET['order']) && ($this->options['default'] == -1 || empty($this->view->field[$this->options['default']]))) {
            return TRUE;
        }
        // If a sort we don't know anything about gets through, exit gracefully.
        if (isset($_GET['order']) && empty($this->view->field[$_GET['order']])) {
            return TRUE;
        }
        // Let the builder know whether or not we're overriding the default sorts.
        return empty($this->options['override']);
    }
    
    /**
     * Add our actual sort criteria.
     */
    public function build_sort_post() {
        if (!isset($_GET['order'])) {
            // Check for a 'default' clicksort. If there isn't one, exit gracefully.
            if (empty($this->options['default'])) {
                return;
            }
            $sort = $this->options['default'];
            if (!empty($this->options['info'][$sort]['default_sort_order'])) {
                $this->order = $this->options['info'][$sort]['default_sort_order'];
            }
            else {
                $this->order = !empty($this->options['order']) ? $this->options['order'] : 'asc';
            }
        }
        else {
            $sort = $_GET['order'];
            // Store the $order for later use.
            $this->order = !empty($_GET['sort']) ? strtolower($_GET['sort']) : 'asc';
        }
        // If a sort we don't know anything about gets through, exit gracefully.
        if (empty($this->view->field[$sort])) {
            return;
        }
        // Ensure $this->order is valid.
        if ($this->order != 'asc' && $this->order != 'desc') {
            $this->order = 'asc';
        }
        // Store the $sort for later use.
        $this->active = $sort;
        // Tell the field to click sort.
        $this->view->field[$sort]
            ->click_sort($this->order);
    }
    
    /**
     * Normalize a list of columns based upon the fields that are
     * available. This compares the fields stored in the style handler
     * to the list of fields actually in the view, removing fields that
     * have been removed and adding new fields in their own column.
     *
     * - Each field must be in a column.
     * - Each column must be based upon a field, and that field
     *   is somewhere in the column.
     * - Any fields not currently represented must be added.
     * - Columns must be re-ordered to match the fields.
     *
     * @param array $columns
     *   An array of all fields; the key is the id of the field and the
     *   value is the id of the column the field should be in.
     * @param array $fields
     *   The fields to use for the columns. If not provided, they will
     *   be requested from the current display. The running render should
     *   send the fields through, as they may be different than what the
     *   display has listed due to access control or other changes.
     *
     * @return array
     *   An array of all the sanitized columns.
     */
    public function sanitize_columns($columns, $fields = NULL) {
        $sanitized = array();
        if ($fields === NULL) {
            $fields = $this->display->handler
                ->get_option('fields');
        }
        // Preconfigure the sanitized array so that the order is retained.
        foreach ($fields as $field => $info) {
            // Set to itself so that if it isn't touched, it gets column
            // status automatically.
            $sanitized[$field] = $field;
        }
        foreach ($columns as $field => $column) {
            // first, make sure the field still exists.
            if (!isset($sanitized[$field])) {
                continue;
            }
            // If the field is the column, mark it so, or the column
            // it's set to is a column, that's ok.
            if ($field == $column || $columns[$column] == $column && !empty($sanitized[$column])) {
                $sanitized[$field] = $column;
            }
            // Since we set the field to itself initially, ignoring
            // the condition is ok; the field will get its column
            // status back.
        }
        return $sanitized;
    }
    
    /**
     * Render the given style.
     */
    public function options_form(&$form, &$form_state) {
        parent::options_form($form, $form_state);
        $handlers = $this->display->handler
            ->get_handlers('field');
        if (empty($handlers)) {
            $form['error_markup'] = array(
                '#markup' => '<div class="error messages">' . t('You need at least one field before you can configure your table settings') . '</div>',
            );
            return;
        }
        $form['override'] = array(
            '#type' => 'checkbox',
            '#title' => t('Override normal sorting if click sorting is used'),
            '#default_value' => !empty($this->options['override']),
        );
        $form['sticky'] = array(
            '#type' => 'checkbox',
            '#title' => t('Enable Drupal style "sticky" table headers (JavaScript)'),
            '#default_value' => !empty($this->options['sticky']),
            '#description' => t('(Sticky header effects will not be active for preview below, only on live output.)'),
        );
        $form['caption'] = array(
            '#type' => 'textfield',
            '#title' => t('Short description of table'),
            '#description' => t('Include a caption for better accessibility of your table.'),
            '#default_value' => $this->options['caption'],
            '#maxlength' => 255,
        );
        $form['summary'] = array(
            '#type' => 'textfield',
            '#title' => t('Table summary'),
            '#description' => t('This value will be displayed as table-summary attribute in the html. Use this to give a summary of complex tables.'),
            '#default_value' => $this->options['summary'],
            '#maxlength' => 255,
        );
        $form['class'] = array(
            '#type' => 'textfield',
            '#title' => t('CSS classes'),
            '#description' => t('Add CSS classes to the table; multiple classes may be separated by spaces.'),
            '#default_value' => $this->options['class'],
            '#maxlength' => 255,
        );
        // Note: views UI registers this theme handler on our behalf. Your module
        // will have to register your theme handlers if you do stuff like this.
        $form['#theme'] = 'views_ui_style_plugin_table';
        $columns = $this->sanitize_columns($this->options['columns']);
        // Create an array of allowed columns from the data we know.
        $field_names = $this->display->handler
            ->get_field_labels();
        if (isset($this->options['default'])) {
            $default = $this->options['default'];
            if (!isset($columns[$default])) {
                $default = -1;
            }
        }
        else {
            $default = -1;
        }
        foreach ($columns as $field => $column) {
            $safe = str_replace(array(
                '][',
                '_',
                ' ',
            ), '-', $field);
            // The $id of the column for dependency checking.
            $id = 'edit-style-options-columns-' . $safe;
            $form['columns'][$field] = array(
                '#type' => 'select',
                '#options' => $field_names,
                '#default_value' => $column,
            );
            if ($handlers[$field]->click_sortable()) {
                $form['info'][$field]['sortable'] = array(
                    '#type' => 'checkbox',
                    '#default_value' => !empty($this->options['info'][$field]['sortable']),
                    '#dependency' => array(
                        $id => array(
                            $field,
                        ),
                    ),
                );
                $form['info'][$field]['default_sort_order'] = array(
                    '#type' => 'select',
                    '#options' => array(
                        'asc' => t('Ascending'),
                        'desc' => t('Descending'),
                    ),
                    '#default_value' => !empty($this->options['info'][$field]['default_sort_order']) ? $this->options['info'][$field]['default_sort_order'] : 'asc',
                    '#dependency_count' => 2,
                    '#dependency' => array(
                        $id => array(
                            $field,
                        ),
                        'edit-style-options-info-' . $safe . '-sortable' => array(
                            1,
                        ),
                    ),
                );
                // Provide an ID so we can have such things.
                $radio_id = drupal_html_id('edit-default-' . $field);
                $form['default'][$field] = array(
                    '#type' => 'radio',
                    '#return_value' => $field,
                    '#parents' => array(
                        'style_options',
                        'default',
                    ),
                    '#id' => $radio_id,
                    // Because 'radio' doesn't fully support '#id' =(.
'#attributes' => array(
                        'id' => $radio_id,
                    ),
                    '#default_value' => $default,
                    '#dependency' => array(
                        $id => array(
                            $field,
                        ),
                    ),
                );
            }
            $form['info'][$field]['align'] = array(
                '#type' => 'select',
                '#default_value' => !empty($this->options['info'][$field]['align']) ? $this->options['info'][$field]['align'] : '',
                '#options' => array(
                    '' => t('None'),
                    'views-align-left' => t('Left'),
                    'views-align-center' => t('Center'),
                    'views-align-right' => t('Right'),
                ),
                '#dependency' => array(
                    $id => array(
                        $field,
                    ),
                ),
            );
            $form['info'][$field]['separator'] = array(
                '#type' => 'textfield',
                '#size' => 10,
                '#default_value' => isset($this->options['info'][$field]['separator']) ? $this->options['info'][$field]['separator'] : '',
                '#dependency' => array(
                    $id => array(
                        $field,
                    ),
                ),
            );
            $form['info'][$field]['empty_column'] = array(
                '#type' => 'checkbox',
                '#default_value' => isset($this->options['info'][$field]['empty_column']) ? $this->options['info'][$field]['empty_column'] : FALSE,
                '#dependency' => array(
                    $id => array(
                        $field,
                    ),
                ),
            );
            // Markup for the field name.
            $form['info'][$field]['name'] = array(
                '#markup' => $field_names[$field],
            );
        }
        // Provide a radio for no default sort.
        $form['default'][-1] = array(
            '#type' => 'radio',
            '#return_value' => -1,
            '#parents' => array(
                'style_options',
                'default',
            ),
            '#id' => 'edit-default-0',
            '#default_value' => $default,
        );
        $form['empty_table'] = array(
            '#type' => 'checkbox',
            '#title' => t('Show the empty text in the table'),
            '#default_value' => $this->options['empty_table'],
            '#description' => t('Per default the table is hidden for an empty view. With this option it is possible to show an empty table with the text in it.'),
        );
        $form['description_markup'] = array(
            '#markup' => '<div class="description form-item">' . t('Place fields into columns; you may combine multiple fields into the same column. If you do, the separator in the column specified will be used to separate the fields. Check the sortable box to make that column click sortable, and check the default sort radio to determine which column will be sorted by default, if any. You may control column order and field labels in the fields section.') . '</div>',
        );
    }
    
    /**
     *
     */
    public function even_empty() {
        return parent::even_empty() || !empty($this->options['empty_table']);
    }

}

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::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::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&#039;s initialized and the style itself supports it.
views_plugin_style::$row_tokens public property Store all available tokens row rows.
views_plugin_style::destroy public function Destructor. Overrides views_object::destroy
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_table::$active public property Contains the current active sort column.
views_plugin_style_table::$order public property Contains the current active sort order, either desc or asc.
views_plugin_style_table::build_sort public function Determine if we should provide sorting based upon $_GET inputs. Overrides views_plugin_style::build_sort
views_plugin_style_table::build_sort_post public function Add our actual sort criteria. Overrides views_plugin_style::build_sort_post
views_plugin_style_table::even_empty public function Should the output of the style plugin be rendered even if it&#039;s empty. Overrides views_plugin_style::even_empty
views_plugin_style_table::options_form public function Render the given style. Overrides views_plugin_style::options_form
views_plugin_style_table::option_definition public function Information about options for all kinds of purposes will be held here. Overrides views_plugin_style::option_definition
views_plugin_style_table::sanitize_columns public function Normalize a list of columns based upon the fields that are
available. This compares the fields stored in the style handler
to the list of fields actually in the view, removing fields that
have been removed and adding new fields in their own column.