Merge pull request #172 from drupal-media/twig-rebase

Adding Twig extension for embedding entities in templates

Author: davereid

entity_embed.services.yml

@@ -2,3 +2,8 @@ services:
   plugin.manager.entity_embed.display:
     class: Drupal\entity_embed\EntityEmbedDisplay\EntityEmbedDisplayManager
     arguments: ['@container.namespaces', '@cache.discovery', '@module_handler']
+  entity_embed.twig.entity_embed_twig_extension:
+    class: Drupal\entity_embed\Twig\EntityEmbedTwigExtension
+    arguments: ['@entity.manager', '@module_handler', '@plugin.manager.entity_embed.display']
+    tags:
+      - { name: twig.extension }

src/Tests/EntityEmbedHooksTest.php

@@ -24,20 +24,8 @@ class EntityEmbedHooksTest extends EntityEmbedTestBase {
    */
   protected $state;
 
-  /**
-   * Modules to enable.
-   *
-   * @var array
-   */
-  public static $modules = array(
-    'entity_embed',
-    'entity_embed_test',
-    'node',
-  );
-
   protected function setUp() {
     parent::setUp();
-
     $this->state = $this->container->get('state');
   }
 

src/Tests/EntityEmbedTestBase.php

@@ -22,7 +22,7 @@ abstract class EntityEmbedTestBase extends WebTestBase {
    *
    * @var array
    */
-  public static $modules = ['entity_embed', 'node', 'ckeditor'];
+  public static $modules = ['entity_embed', 'entity_embed_test', 'node', 'ckeditor'];
 
   /**
    * The test user.

src/Tests/EntityEmbedTwigTest.php

@@ -0,0 +1,57 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\system\Tests\EntityEmbedTwigTest.
+ */
+
+namespace Drupal\entity_embed\Tests;
+
+/**
+ * Tests Twig extension provided by entity_embed.
+ *
+ * @group entity_embed
+ */
+class EntityEmbedTwigTest extends EntityEmbedTestBase {
+
+  protected function setUp() {
+    parent::setUp();
+    \Drupal::service('theme_handler')->install(array('test_theme'));
+  }
+
+  /**
+   * Tests that the provided Twig extension loads the service appropriately.
+   */
+  public function testTwigExtensionLoaded() {
+    $twig_service = \Drupal::service('twig');
+
+    $ext = $twig_service->getExtension('entity_embed.twig.entity_embed_twig_extension');
+
+    // @todo why is the string
+    // 'Drupal\\entity_embed\\Twig\\EntityEmbedTwigExtension'
+    // and not '\Drupal\entity_embed\Twig\EntityEmbedTwigExtension' ?
+    $this->assertEqual(get_class($ext), 'Drupal\\entity_embed\\Twig\\EntityEmbedTwigExtension', 'Extension loaded successfully.');
+  }
+
+  /**
+   * Tests that the Twig extension's filter produces expected output.
+   */
+  public function testEntityEmbedTwigFunction() {
+    // Test embedding a node using entity ID.
+    $this->drupalGet('entity_embed_twig_test/id');
+    $this->assertText($this->node->body->value, 'Embedded node exists in page');
+
+    // Test embedding using 'Label' display plugin.
+    $this->drupalGet('entity_embed_twig_test/label_plugin');
+    $this->assertText($this->node->title->value, 'Title of the embedded node exists in page.');
+    $this->assertNoText($this->node->body->value, 'Body of embedded node does not exists in page when "Label" plugin is used.');
+    $this->assertLinkByHref('node/' . $this->node->id(), 0, 'Link to the embedded node exists when "Label" plugin is used.');
+
+    // Test embedding using 'Label' display plugin without linking to the node.
+    $this->drupalGet('entity_embed_twig_test/label_plugin_no_link');
+    $this->assertText($this->node->title->value, 'Title of the embedded node exists in page.');
+    $this->assertNoText($this->node->body->value, 'Body of embedded node does not exists in page when "Label" plugin is used.');
+    $this->assertNoLinkByHref('node/' . $this->node->id(), 0, 'Link to the embedded node does not exists.');
+  }
+
+}

src/Twig/EntityEmbedTwigExtension.php

@@ -0,0 +1,79 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\entity_embed\Twig\EntityEmbedTwigExtension.
+ */
+
+namespace Drupal\entity_embed\Twig;
+
+use Drupal\Core\Entity\EntityManagerInterface;
+use Drupal\entity_embed\EntityHelperTrait;
+use Drupal\Core\Extension\ModuleHandlerInterface;
+use Drupal\entity_embed\EntityEmbedDisplay\EntityEmbedDisplayManager;
+
+/**
+ * Provide entity embedding function within Twig templates.
+ */
+class EntityEmbedTwigExtension extends \Twig_Extension {
+  use EntityHelperTrait;
+
+  /**
+   * Constructs a new EntityEmbedTwigExtension.
+   *
+   * @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager
+   *   The entity manager service.
+   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
+   *   The module handler.
+   * @param \Drupal\entity_embed\EntityEmbedDisplay\EntityEmbedDisplayManager $plugin_manager
+   *   The plugin manager.
+   */
+  public function __construct(EntityManagerInterface $entity_manager, ModuleHandlerInterface $module_handler, EntityEmbedDisplayManager $plugin_manager) {
+    $this->setEntityManager($entity_manager);
+    $this->setModuleHandler($module_handler);
+    $this->setDisplayPluginManager($plugin_manager);
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getName() {
+    return 'entity_embed.twig.entity_embed_twig_extension';
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getFunctions() {
+    return array(
+      new \Twig_SimpleFunction('entity_embed', array($this, 'getRenderArray')),
+    );
+  }
+
+  /**
+   * Return the render array for an entity.
+   *
+   * @param string $entity_type
+   *   The machine name of an entity_type like 'node'.
+   * @param string $entity_id
+   *   The entity ID or entity UUID.
+   * @param string $display_plugin
+   *   (optional) The display plugin to be used to render the entity.
+   * @param array $display_settings
+   *   (optional) A list of settings for the display plugin.
+   *
+   * @return array
+   *   A render array from entity_view().
+   */
+  public function getRenderArray($entity_type, $entity_id, $display_plugin = 'default', array $display_settings = []) {
+    $entity = $this->loadEntity($entity_type, $entity_id);
+    $context = array(
+      'data-entity-type' => $entity_type,
+      'data-entity-id' => $entity_id,
+      'data-entity-embed-display' => $display_plugin,
+      'data-entity-embed-settings' => $display_settings,
+    );
+    return $this->renderEntityEmbed($entity, $context);
+  }
+
+}

tests/modules/entity_embed_test/entity_embed_test.module

@@ -7,6 +7,23 @@
 
 use Drupal\Core\Entity\EntityInterface;
 
+/**
+ * Implements hook_theme().
+ */
+function entity_embed_test_theme($existing, $type, $theme, $path) {
+  $items['entity_embed_twig_test'] = array(
+    'template' => 'entity_embed_twig_test',
+    'variables' => array(
+      'entity_type' => '',
+      'id' => '',
+      'display_plugin' => 'default',
+      'display_settings' => array(),
+    ),
+  );
+  return $items;
+}
+
+
 /**
  * Implements hook_entity_embed_display_plugins_alter().
  */

tests/modules/entity_embed_test/entity_embed_test.routing.yml

@@ -0,0 +1,20 @@
+entity_embed_test.entity_embed_twig_test.id:
+  path: '/entity_embed_twig_test/id'
+  defaults:
+    _controller: '\Drupal\entity_embed_test\EntityEmbedTestTwigController::idRender'
+  requirements:
+    _access: 'TRUE'
+
+entity_embed_test.entity_embed_twig_test.label_plugin:
+  path: '/entity_embed_twig_test/label_plugin'
+  defaults:
+    _controller: '\Drupal\entity_embed_test\EntityEmbedTestTwigController::labelPluginRender'
+  requirements:
+    _access: 'TRUE'
+
+entity_embed_test.entity_embed_twig_test.label_plugin_no_link:
+  path: '/entity_embed_twig_test/label_plugin_no_link'
+  defaults:
+    _controller: '\Drupal\entity_embed_test\EntityEmbedTestTwigController::labelPluginNoLinkRender'
+  requirements:
+    _access: 'TRUE'

tests/modules/entity_embed_test/src/EntityEmbedTestTwigController.php

@@ -0,0 +1,51 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\entity_embed_test\EntityEmbedTestTwigController.
+ */
+
+namespace Drupal\entity_embed_test;
+
+/**
+ * Controller routines for Twig theme test routes.
+ */
+class EntityEmbedTestTwigController {
+
+  /**
+   * Menu callback for testing entity_embed twig extension using entity ID.
+   */
+  public function idRender() {
+    return array(
+      '#theme' => 'entity_embed_twig_test',
+      '#entity_type' => 'node',
+      '#id' => '1',
+    );
+  }
+
+  /**
+   * Menu callback for testing entity_embed twig extension using 'label' display plugin.
+   */
+  public function labelPluginRender() {
+    return array(
+      '#theme' => 'entity_embed_twig_test',
+      '#entity_type' => 'node',
+      '#id' => '1',
+      '#display_plugin' => 'entity_reference:entity_reference_label',
+    );
+  }
+
+  /**
+   * Menu callback for testing entity_embed twig extension using 'label' display plugin without linking to the node.
+   */
+  public function labelPluginNoLinkRender() {
+    return array(
+      '#theme' => 'entity_embed_twig_test',
+      '#entity_type' => 'node',
+      '#id' => '1',
+      '#display_plugin' => 'entity_reference:entity_reference_label',
+      '#display_settings' => array('link' => 0),
+    );
+  }
+
+}

tests/modules/entity_embed_test/templates/entity_embed_twig_test.html.twig

@@ -0,0 +1,11 @@
+{#
+/**
+  * Template for testing entity_embed twig extension.
+  *
+  * Available variables:
+  * - entity_type: Machine name of the entity type.
+  * - id: ID or UUID of the entity to be embedded.
+  * - display_plugin: Machine name of the display plugin.
+  * - display_settings: An array of settings to be passed to the selected plugin.
+#}
+{{ entity_embed(entity_type, id, display_plugin, display_settings) }}