HierarchyEmbed.php in Entity Reference Hierarchy 8

Contains \Drupal\entity_hierarchy_views\Plugin\views\display\HierarchyEmbed.

Namespace

Drupal\entity_hierarchy_views\Plugin\views\display

File

entity_hierarchy_views/src/Plugin/views/display/HierarchyEmbed.php

<?php

/**
 * @file
 * Contains \Drupal\entity_hierarchy_views\Plugin\views\display\HierarchyEmbed.
 */
namespace Drupal\entity_hierarchy_views\Plugin\views\display;

use Drupal\views\Plugin\views\display\DisplayPluginBase;
use Drupal\Core\Form\FormStateInterface;

/**
 * The plugin that handles an HierarchyEmbed display.
 *
 * @ingroup views_display_plugins
 *
 * @ViewsDisplay(
 *   id = "hierarchy_embed",
 *   title = @Translation("Hierarchy Embed Display"),
 *   admin = @Translation("Hierarchy Embed Source"),
 *   help = @Translation("Provides displays that may be embedded on hierarchy pages."),
 *   theme = "views_view",
 *   uses_menu_links = FALSE,
 *   hierarchy_embed_display = TRUE
 * )
 */
class HierarchyEmbed extends DisplayPluginBase {

  /**
   * Whether the display allows attachments.
   *
   * @var bool
   */
  protected $usesAttachments = TRUE;

  /**
   * Provide the summary for page options in the views UI.
   *
   * This output is returned as an array.
   */
  public function optionsSummary(&$categories, &$options) {
    parent::optionsSummary($categories, $options);
    $categories['entity_hierarchy_embed'] = array(
      'title' => t('Embed settings'),
      'column' => 'second',
      'build' => array(
        '#weight' => -10,
      ),
    );
    $name = strip_tags($this
      ->getOption('entity_hierarchy_embed_admin_name'));
    if (empty($name)) {
      $name = t('None');
    }
    $options['entity_hierarchy_embed_admin_name'] = array(
      'category' => 'entity_hierarchy_embed',
      'title' => t('Admin name'),
      'value' => views_ui_truncate($name, 24),
    );
  }

  /**
   * Provide the default form for setting options.
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    switch ($form_state
      ->get('section')) {
      case 'entity_hierarchy_embed_admin_name':
        $form['#title'] .= t('Embed admin name');
        $form['entity_hierarchy_embed_admin_name'] = array(
          '#type' => 'textfield',
          '#description' => t('This will appear as the name of this embed in the node edit screen.'),
          '#default_value' => $this
            ->getOption('entity_hierarchy_embed_admin_name'),
        );
        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 submitOptionsForm(&$form, FormStateInterface $form_state) {
    parent::submitOptionsForm($form, $form_state);
    $section = $form_state
      ->get('section');
    switch ($section) {
      case 'entity_hierarchy_embed_admin_name':
        $this
          ->setOption('entity_hierarchy_embed_admin_name', $form_state['values']['entity_hierarchy_embed_admin_name']);
        break;
    }
  }

  /**
   * The display block handler returns the structure necessary for a block.
   */
  public function execute() {

    // Prior to this being called, the $view should already be set to this
    // display, and arguments should be set on the view.
    parent::execute();
    if (!isset($this->view->override_path)) {
      $this->view->override_path = 'node';
    }
    $data = $this->view
      ->render();
    if (!empty($this->view->result) || $this
      ->getOption('empty') || !empty($this->view->style_plugin->definition['even empty'])) {
      return $data;
    }
  }

}

Classes

Name	Description
HierarchyEmbed	The plugin that handles an HierarchyEmbed display.