class views_plugin_display_attachment

The plugin that handles an attachment display.

Attachment displays are secondary displays that are 'attached' to a primary display. Effectively they are a simple way to get multiple views within the same view. They can share some information.

Hierarchy

Expanded class hierarchy of views_plugin_display_attachment

Related topics

Views display plugins
Display plugins control how Views interact with the rest of Drupal.
1 string reference to 'views_plugin_display_attachment'
views_views_plugins in includes/plugins.inc
Implements hook_views_plugins().

File

plugins/views_plugin_display_attachment.inc, line 17

View source 
class views_plugin_display_attachment extends views_plugin_display {
    
    /**
     * {@inheritdoc}
     */
    public function option_definition() {
        $options = parent::option_definition();
        $options['show_title'] = array(
            'default' => FALSE,
            'bool' => TRUE,
        );
        $options['show_title_empty'] = array(
            'default' => FALSE,
            'bool' => TRUE,
        );
        $options['displays'] = array(
            'default' => array(),
        );
        $options['attachment_position'] = array(
            'default' => 'before',
        );
        $options['inherit_arguments'] = array(
            'default' => TRUE,
            'bool' => TRUE,
        );
        $options['inherit_exposed_filters'] = array(
            'default' => FALSE,
            'bool' => TRUE,
        );
        $options['inherit_pager'] = array(
            'default' => FALSE,
            'bool' => TRUE,
        );
        $options['render_pager'] = array(
            'default' => FALSE,
            'bool' => TRUE,
        );
        return $options;
    }
    
    /**
     * {@inheritdoc}
     */
    public function execute() {
        return $this->view
            ->render($this->display->id);
    }
    
    /**
     * {@inheritdoc}
     */
    public function attachment_positions($position = NULL) {
        $positions = array(
            'before' => t('Before'),
            'after' => t('After'),
            'both' => t('Both'),
        );
        if ($position) {
            return $positions[$position];
        }
        return $positions;
    }
    
    /**
     * Provide the summary for attachment options in the views UI.
     *
     * This output is returned as an array.
     */
    public function options_summary(&$categories, &$options) {
        // It is very important to call the parent function here.
        parent::options_summary($categories, $options);
        $categories['attachment'] = array(
            'title' => t('Attachment settings'),
            'column' => 'second',
            'build' => array(
                '#weight' => -10,
            ),
        );
        $displays = array_filter($this->get_option('displays'));
        if (count($displays) > 1) {
            $attach_to = t('Multiple displays');
        }
        elseif (count($displays) == 1) {
            $display = array_shift($displays);
            if (!empty($this->view->display[$display])) {
                $attach_to = check_plain($this->view->display[$display]->display_title);
            }
        }
        if (!isset($attach_to)) {
            $attach_to = t('Not defined');
        }
        $options['show_title'] = array(
            'category' => 'title',
            'title' => t('Show title'),
            'value' => $this->get_option('show_title') ? t('Yes') : t('No'),
        );
        $options['show_title_empty'] = array(
            'category' => 'title',
            'title' => t('Show title even if view has no results'),
            'value' => $this->get_option('show_title_empty') ? t('Yes') : t('No'),
        );
        $options['displays'] = array(
            'category' => 'attachment',
            'title' => t('Attach to'),
            'value' => $attach_to,
        );
        $options['attachment_position'] = array(
            'category' => 'attachment',
            'title' => t('Attachment position'),
            'value' => $this->attachment_positions($this->get_option('attachment_position')),
        );
        $options['inherit_arguments'] = array(
            'category' => 'attachment',
            'title' => t('Inherit contextual filters'),
            'value' => $this->get_option('inherit_arguments') ? t('Yes') : t('No'),
        );
        $options['inherit_exposed_filters'] = array(
            'category' => 'attachment',
            'title' => t('Inherit exposed filters'),
            'value' => $this->get_option('inherit_exposed_filters') ? t('Yes') : t('No'),
        );
        $options['inherit_pager'] = array(
            'category' => 'pager',
            'title' => t('Inherit pager'),
            'value' => $this->get_option('inherit_pager') ? t('Yes') : t('No'),
        );
        $options['render_pager'] = array(
            'category' => 'pager',
            'title' => t('Render pager'),
            'value' => $this->get_option('render_pager') ? t('Yes') : t('No'),
        );
    }
    
    /**
     * Provide the default form for setting options.
     */
    public function options_form(&$form, &$form_state) {
        // It is very important to call the parent function here.
        parent::options_form($form, $form_state);
        switch ($form_state['section']) {
            case 'show_title':
                $form['#title'] .= t('Title');
                $form['show_title'] = array(
                    '#type' => 'checkbox',
                    '#title' => t('Show title'),
                    '#description' => t('Do you want to show the title of the attachment?'),
                    '#default_value' => $this->get_option('show_title'),
                );
                break;
            case 'show_title_empty':
                $form['#title'] .= t('Title');
                $form['show_title_empty'] = array(
                    '#type' => 'checkbox',
                    '#title' => t('Show title for empty view'),
                    '#description' => t('Do you want to show the title of the attachment even if the view has no results?'),
                    '#default_value' => $this->get_option('show_title_empty'),
                );
                break;
            case 'inherit_arguments':
                $form['#title'] .= t('Inherit contextual filters');
                $form['inherit_arguments'] = array(
                    '#type' => 'checkbox',
                    '#title' => t('Inherit'),
                    '#description' => t('Should this display inherit its contextual filter values from the parent display to which it is attached?'),
                    '#default_value' => $this->get_option('inherit_arguments'),
                );
                break;
            case 'inherit_exposed_filters':
                $form['#title'] .= t('Inherit exposed filters');
                $form['inherit_exposed_filters'] = array(
                    '#type' => 'checkbox',
                    '#title' => t('Inherit'),
                    '#description' => t('Should this display inherit its exposed filter values from the parent display to which it is attached?'),
                    '#default_value' => $this->get_option('inherit_exposed_filters'),
                );
                break;
            case 'inherit_pager':
                $form['#title'] .= t('Inherit pager');
                $form['inherit_pager'] = array(
                    '#type' => 'checkbox',
                    '#title' => t('Inherit'),
                    '#description' => t('Should this display inherit its paging values from the parent display to which it is attached?'),
                    '#default_value' => $this->get_option('inherit_pager'),
                );
                break;
            case 'render_pager':
                $form['#title'] .= t('Render pager');
                $form['render_pager'] = array(
                    '#type' => 'checkbox',
                    '#title' => t('Render'),
                    '#description' => t('Should this display render the pager values? This is only meaningful if inheriting a pager.'),
                    '#default_value' => $this->get_option('render_pager'),
                );
                break;
            case 'attachment_position':
                $form['#title'] .= t('Position');
                $form['attachment_position'] = array(
                    '#type' => 'radios',
                    '#description' => t('Attach before or after the parent display?'),
                    '#options' => $this->attachment_positions(),
                    '#default_value' => $this->get_option('attachment_position'),
                );
                break;
            case 'displays':
                $form['#title'] .= t('Attach to');
                $displays = array();
                foreach ($this->view->display as $display_id => $display) {
                    if (!empty($display->handler) && $display->handler
                        ->accept_attachments()) {
                        $displays[$display_id] = $display->display_title;
                    }
                }
                $form['displays'] = array(
                    '#type' => 'checkboxes',
                    '#description' => t('Select which display or displays this should attach to.'),
                    '#options' => $displays,
                    '#default_value' => $this->get_option('displays'),
                );
                break;
        }
    }
    
    /**
     * 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) {
        // It is very important to call the parent function here.
        parent::options_submit($form, $form_state);
        switch ($form_state['section']) {
            case 'show_title':
            case 'show_title_empty':
            case 'inherit_arguments':
            case 'inherit_pager':
            case 'render_pager':
            case 'inherit_exposed_filters':
            case 'attachment_position':
            case 'displays':
                $this->set_option($form_state['section'], $form_state['values'][$form_state['section']]);
                break;
        }
    }
    
    /**
     * Attach to another view.
     */
    public function attach_to($display_id) {
        $displays = $this->get_option('displays');
        if (empty($displays[$display_id])) {
            return;
        }
        if (!$this->access()) {
            return;
        }
        // Get a fresh view because our current one has a lot of stuff on it
        // because it's already been executed.
        $view = $this->view
            ->clone_view();
        $view->original_args = $view->args;
        $args = $this->get_option('inherit_arguments') ? $this->view->args : array();
        $view->set_arguments($args);
        $exposed_input = $this->get_option('inherit_exposed_filters') && isset($this->view->exposed_input) ? $this->view->exposed_input : array();
        $view->set_exposed_input($exposed_input);
        $view->set_display($this->display->id);
        if ($this->get_option('inherit_pager')) {
            $view->display_handler->use_pager = $this->view->display[$display_id]->handler
                ->use_pager();
            $view->display_handler
                ->set_option('pager', $this->view->display[$display_id]->handler
                ->get_option('pager'));
        }
        $attachment_output = $view->execute_display($this->display->id, $args);
        $attachment = '';
        if ($view->display_handler
            ->get_option('show_title') && $view->display_handler
            ->get_option('title')) {
            if ($view->display_handler
                ->get_option('show_title_empty') || !empty($view->result)) {
                $attachment .= theme('html_tag', array(
                    'element' => array(
                        '#tag' => 'h2',
                        '#value' => $view->display_handler
                            ->get_option('title'),
                    ),
                ));
            }
        }
        $attachment .= $attachment_output;
        switch ($this->get_option('attachment_position')) {
            case 'before':
                $this->view->attachment_before .= $attachment;
                break;
            case 'after':
                $this->view->attachment_after .= $attachment;
                break;
            case 'both':
                $this->view->attachment_before .= $attachment;
                $this->view->attachment_after .= $attachment;
                break;
        }
        $view->destroy();
    }
    
    /**
     * Attachment displays only use exposed widgets if they are set to inherit
     * the exposed filter settings of their parent display.
     */
    public function uses_exposed() {
        if (!empty($this->options['inherit_exposed_filters']) && parent::uses_exposed()) {
            return TRUE;
        }
        return FALSE;
    }
    
    /**
     * If an attachment is set to inherit the exposed filter settings from its
     * parent display, then don't render and display a second set of exposed
     * filter widgets.
     */
    public function displays_exposed() {
        return $this->options['inherit_exposed_filters'] ? FALSE : TRUE;
    }
    
    /**
     * {@inheritdoc}
     */
    public function use_pager() {
        return !empty($this->use_pager);
    }
    
    /**
     * {@inheritdoc}
     */
    public function render_pager() {
        return !empty($this->use_pager) && $this->get_option('render_pager');
    }

}

Members

Title Deprecated Modifiers Object type Summary Overriden Title Overrides
views_object::$definition public property Handler'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'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_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'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::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_display::$extender public property Stores all available display extenders.
views_plugin_display::$handlers public property List of handlers for this display.
views_plugin_display::$view public property The top object of a view. Overrides views_plugin::$view
views_plugin_display::accept_attachments public function Can this display accept attachments?
views_plugin_display::access public function Determine if the user has access to this display of the view.
views_plugin_display::defaultable_sections public function List which sections are defaultable and what items each section contains. 1
views_plugin_display::destroy public function Destructor. Overrides views_object::destroy
views_plugin_display::export_handler public function Special method to export items that have handlers.
views_plugin_display::export_option public function Override of export_option() Overrides views_object::export_option
views_plugin_display::export_plugin public function Special handling for plugin export.
views_plugin_display::export_style public function Special handling for the style export.
views_plugin_display::format_themes public function Format a list of theme templates for output by the theme info helper.
views_plugin_display::get_arguments_tokens public function Returns to tokens for arguments.
views_plugin_display::get_argument_text public function Provide some helpful text for the arguments. 1
views_plugin_display::get_field_labels public function List of fields for the current display with the associated relationship.
views_plugin_display::get_handler public function Get the handler object for a single handler.
views_plugin_display::get_handlers public function Get a full array of handlers for $type. This caches them.
views_plugin_display::get_link_display public function Check to see which display to use when creating links.
views_plugin_display::get_option public function Intelligently get an option either from this or default display.
views_plugin_display::get_pager_text public function Provide some helpful text for pagers. 1
views_plugin_display::get_path public function Return the base path to use for this display.
views_plugin_display::get_plugin public function Get the instance of a plugin, for example style or row.
views_plugin_display::get_special_blocks public function Provide the block system with any exposed widget blocks for this display.
views_plugin_display::get_style_type public function Displays can require a certain type of style plugin. 1
views_plugin_display::get_url public function
views_plugin_display::has_path public function Check to see if the display has a 'path' field. 1
views_plugin_display::hook_block_list public function If this display creates a block, implement one of these.
views_plugin_display::hook_menu public function If this display creates a page with a menu item, implement it here.
views_plugin_display::init public function 1
views_plugin_display::is_defaulted public function Determine if a given option is set to use the default or current display.
views_plugin_display::is_default_display public function If this display is the 'default' display which contains fallback settings. 1
views_plugin_display::is_identifier_unique public function Check if the provided identifier is unique.
views_plugin_display::options_override public function If override/revert was clicked, perform the proper toggle.
views_plugin_display::options_validate public function Validate the options form. Overrides views_plugin::options_validate 1
views_plugin_display::option_link public function Because forms may be split up into sections, this provides
an easy URL to exactly the right section. Don't override this.
views_plugin_display::override_option public function Set an option and force it to be an override.
views_plugin_display::preview public function Fully render the display. 1
views_plugin_display::pre_execute public function Set up any variables on the view prior to execution.
views_plugin_display::query public function Inject anything into the query that the display handler needs. Overrides views_plugin::query
views_plugin_display::render public function Render this display. 1
views_plugin_display::render_area public function
views_plugin_display::render_empty public function
views_plugin_display::render_filters public function Not all display plugins will support filtering.
views_plugin_display::render_footer public function Render the footer of the view.
views_plugin_display::render_header public function Render the header of the view.
views_plugin_display::render_more_link public function Render the 'more' link.
views_plugin_display::set_option public function Intelligently set an option either from this display or from the
default display, if directed to do so.
views_plugin_display::set_override public function Flip the override setting for the given section.
views_plugin_display::unpack_handler public function Special method to unpack items that have handlers.
views_plugin_display::unpack_plugin public function Special handling for plugin unpacking.
views_plugin_display::unpack_style public function
views_plugin_display::uses_breadcrumb public function Check to see if the display needs a breadcrumb. 1
views_plugin_display::uses_exposed_form_in_block public function Check to see if the display can put the exposed form in a block.
views_plugin_display::uses_fields public function Determine if the display's style uses fields.
views_plugin_display::uses_link_display public function Check to see if the display has some need to link to another display. 1
views_plugin_display::use_ajax public function Does the display use AJAX?
views_plugin_display::use_group_by public function Does the display have groupby enabled?
views_plugin_display::use_more public function Does the display have a more link enabled?
views_plugin_display::use_more_always public function Should the enabled display more link be shown when no more items?
views_plugin_display::use_more_open_new_window public function Should the enabled display more link being opened in an new window?
views_plugin_display::use_more_text public function Does the display have custom link text?
views_plugin_display::validate public function Make sure the display and all associated handlers are valid. Overrides views_plugin::validate 1
views_plugin_display::view_special_blocks public function Render any special blocks provided for this display.
views_plugin_display_attachment::attachment_positions public function
views_plugin_display_attachment::attach_to public function Attach to another view. Overrides views_plugin_display::attach_to
views_plugin_display_attachment::displays_exposed public function If an attachment is set to inherit the exposed filter settings from its
parent display, then don't render and display a second set of exposed
filter widgets. 		Overrides views_plugin_display::displays_exposed
views_plugin_display_attachment::execute public function When used externally, this is how a view gets run and returns
data in the format required. 		Overrides views_plugin_display::execute
views_plugin_display_attachment::options_form public function Provide the default form for setting options. Overrides views_plugin_display::options_form
views_plugin_display_attachment::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_display::options_submit
views_plugin_display_attachment::options_summary public function Provide the summary for attachment options in the views UI. Overrides views_plugin_display::options_summary
views_plugin_display_attachment::option_definition public function Information about options for all kinds of purposes will be held here. Overrides views_plugin_display::option_definition
views_plugin_display_attachment::render_pager public function Not all display plugins will suppert pager rendering. Overrides views_plugin_display::render_pager
views_plugin_display_attachment::uses_exposed public function Attachment displays only use exposed widgets if they are set to inherit
the exposed filter settings of their parent display. 		Overrides views_plugin_display::uses_exposed
views_plugin_display_attachment::use_pager public function Does the display have a pager enabled? Overrides views_plugin_display::use_pager