views_handler_area_view.inc

<?php


/**
 * @file
 * Definition of views_handler_area_view.
 */

/**
 * Views area handlers. Insert a view inside of an area.
 *
 * @ingroup views_area_handlers
 */
class views_handler_area_view extends views_handler_area {
    
    /**
     * {@inheritdoc}
     */
    public function option_definition() {
        $options = parent::option_definition();
        $options['view_to_insert'] = array(
            'default' => '',
        );
        $options['inherit_arguments'] = array(
            'default' => FALSE,
            'bool' => TRUE,
        );
        return $options;
    }
    
    /**
     * Default options form; provides the label widget all fields should have.
     */
    public function options_form(&$form, &$form_state) {
        parent::options_form($form, $form_state);
        $view_display = $this->view->name . ':' . $this->view->current_display;
        $options = array(
            '' => t('-Select-'),
        );
        $options += views_get_views_as_options(FALSE, 'all', $view_display, FALSE, TRUE);
        $form['view_to_insert'] = array(
            '#type' => 'select',
            '#title' => t('View to insert'),
            '#default_value' => $this->options['view_to_insert'],
            '#description' => t('The view to insert into this area.'),
            '#options' => $options,
        );
        $form['inherit_arguments'] = array(
            '#type' => 'checkbox',
            '#title' => t('Inherit contextual filters'),
            '#default_value' => $this->options['inherit_arguments'],
            '#description' => t('If checked, this view will receive the same contextual filters as its parent.'),
        );
    }
    
    /**
     * Render the area.
     */
    public function render($empty = FALSE) {
        if ($view = $this->loadView()) {
            if (!empty($this->options['inherit_arguments']) && !empty($this->view->args)) {
                return $view->preview(NULL, $this->view->args);
            }
            else {
                return $view->preview(NULL);
            }
        }
        return '';
    }
    
    /**
     * Loads the used view for rendering.
     *
     * @return \view|null
     *   The loaded view or NULL, in case the view was not loadable / recursion
     *   got detected / access got denied.
     */
    protected function loadView() {
        if (empty($this->options['view_to_insert'])) {
            return NULL;
        }
        list($view_name, $display_id) = explode(':', $this->options['view_to_insert']);
        $view = views_get_view($view_name);
        if (empty($view) || !$view->access($display_id)) {
            return NULL;
        }
        $view->set_display($display_id);
        // Avoid recursion.
        $view->parent_views += $this->view->parent_views;
        $view->parent_views[] = "{$view_name}:{$display_id}";
        // Check if the view is part of the parent views of this view.
        $search = "{$view_name}:{$display_id}";
        if (in_array($search, $this->view->parent_views)) {
            drupal_set_message(t("Recursion detected in view @view display @display.", array(
                '@view' => $view_name,
                '@display' => $display_id,
            )), 'error');
            return NULL;
        }
        return $view;
    }

}