class views_plugin_style_summary

The default style plugin for summaries.

Hierarchy

Expanded class hierarchy of views_plugin_style_summary

Related topics

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

File

plugins/views_plugin_style_summary.inc, line 13

View source
class views_plugin_style_summary extends views_plugin_style {
    
    /**
     * {@inheritdoc}
     */
    public function option_definition() {
        $options = parent::option_definition();
        $options['base_path'] = array(
            'default' => '',
        );
        $options['count'] = array(
            'default' => TRUE,
            'bool' => TRUE,
        );
        $options['override'] = array(
            'default' => FALSE,
            'bool' => TRUE,
        );
        $options['items_per_page'] = array(
            'default' => 25,
        );
        return $options;
    }
    
    /**
     * {@inheritdoc}
     */
    public function query() {
        if (!empty($this->options['override'])) {
            $this->view
                ->set_items_per_page(intval($this->options['items_per_page']));
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function options_form(&$form, &$form_state) {
        $form['base_path'] = array(
            '#type' => 'textfield',
            '#title' => t('Base path'),
            '#default_value' => $this->options['base_path'],
            '#description' => t('Define the base path for links in this summary
        view, i.e. http://example.com/<strong>your_view_path/archive</strong>.
        Do not include beginning and ending forward slash. If this value
        is empty, views will use the first path found as the base path,
        in page displays, or / if no path could be found.'),
        );
        $form['count'] = array(
            '#type' => 'checkbox',
            '#default_value' => !empty($this->options['count']),
            '#title' => t('Display record count with link'),
        );
        $form['override'] = array(
            '#type' => 'checkbox',
            '#default_value' => !empty($this->options['override']),
            '#title' => t('Override number of items to display'),
        );
        $form['items_per_page'] = array(
            '#type' => 'textfield',
            '#title' => t('Items to display'),
            '#default_value' => $this->options['items_per_page'],
            '#dependency' => array(
                'edit-options-summary-options-' . str_replace('_', '-', $this->definition['name']) . '-override' => array(
                    1,
                ),
            ),
        );
    }
    
    /**
     * {@inheritdoc}
     */
    public function render() {
        $rows = array();
        foreach ($this->view->result as $row) {
            // @todo Include separator as an option.
            $rows[] = $row;
        }
        return theme($this->theme_functions(), array(
            'view' => $this->view,
            'options' => $this->options,
            'rows' => $rows,
        ));
    }

}

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::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&#039;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::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_summary::options_form public function Provide a form to edit options for this plugin. Overrides views_plugin_style::options_form 1
views_plugin_style_summary::option_definition public function Information about options for all kinds of purposes will be held here. Overrides views_plugin_style::option_definition 1
views_plugin_style_summary::query public function Add anything to the query that we might need to. Overrides views_plugin_style::query
views_plugin_style_summary::render public function Render the display in this style. Overrides views_plugin_style::render