Refactoring Loaders & Renders

bamboo_twig.services.yml

@@ -1,4 +1,10 @@
 services:
+    bamboo_twig.twig.base:
+        private: true
+        class: Drupal\bamboo_twig\TwigExtension\TwigExtensionBase
+        calls:
+            - [setContainer, ['@service_container']]
+
     # Custom Twig extensions
     bamboo_twig.twig.dates:
         class: Drupal\bamboo_twig\TwigExtension\Dates

bamboo_twig_loader/bamboo_twig_loader.info.yml

@@ -0,0 +1,8 @@
+name: Bamboo Twig - Loaders
+description: 'Several "Loaders & Render" Twig extensions.'
+package: Bamboo Twig
+type: module
+core: 8.x
+
+dependencies:
+ - drupal:disrupt_tools

bamboo_twig_loader/bamboo_twig_loader.services.yml

@@ -0,0 +1,12 @@
+services:
+    # Custom Twig extensions
+    bamboo_twig_loader.twig.loader:
+        class: Drupal\bamboo_twig_loader\TwigExtension\Loader
+        tags:
+            - { name: twig.extension }
+        parent: bamboo_twig.twig.base
+    bamboo_twig_loader.twig.render:
+        class: Drupal\bamboo_twig_loader\TwigExtension\Render
+        tags:
+            - { name: twig.extension }
+        parent: bamboo_twig.twig.base

bamboo_twig_loader/src/TwigExtension/Loader.php

@@ -0,0 +1,122 @@
+<?php
+
+namespace Drupal\bamboo_twig_loader\TwigExtension;
+
+use Drupal\bamboo_twig\TwigExtension\TwigExtensionBase;
+
+/**
+ * Provides some loaders as Twig Extensions.
+ */
+class Loader extends TwigExtensionBase {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getFunctions() {
+    return [
+      new \Twig_SimpleFunction('bamboo_load_entity', [$this, 'loadEntity']),
+      new \Twig_SimpleFunction('bamboo_load_field', [$this, 'loadField']),
+      new \Twig_SimpleFunction('bamboo_load_currentuser', [$this, 'loadCurrentUser']),
+      new \Twig_SimpleFunction('bamboo_load_image', [$this, 'loadImage']),
+    ];
+  }
+
+  /**
+   * Unique identifier for this Twig extension.
+   */
+  public function getName() {
+    return 'bamboo_twig_loader.twig.loader';
+  }
+
+  /**
+   * Returns an entity object.
+   *
+   * @param string $entity_type
+   *   The entity type.
+   * @param mixed $id
+   *   (optional) The ID of the entity to load.
+   *
+   * @return null|Drupal\Core\Entity\EntityInterface
+   *   An entity object for the entity or NULL if the entity does not exist.
+   */
+  public function loadEntity($entity_type, $id = NULL) {
+    $entity = $id ?
+      $this->getEntityTypeManager()->getStorage($entity_type)->load($id) :
+      $this->getCurrentRouteMatch()->getParameter($entity_type);
+
+    if (!$entity) {
+      return NULL;
+    }
+
+    return $entity;
+  }
+
+  /**
+   * Returns the field object for a single entity field.
+   *
+   * @param string $field_name
+   *   The field name.
+   * @param string $entity_type
+   *   The entity type.
+   * @param mixed $id
+   *   (optional) The ID of the entity to render.
+   * @param string $langcode
+   *   (optional) Language code to load translation.
+   *
+   * @return null|Drupal\Core\Field\FieldItemListInterface
+   *   A field object for the entity or NULL if the value does not exist.
+   */
+  public function loadField($field_name, $entity_type, $id = NULL, $langcode = NULL) {
+    $entity = $this->loadEntity($entity_type, $id);
+
+    if ($entity && $langcode && $entity->hasTranslation($langcode)) {
+      $entity = $entity->getTranslation($langcode);
+    }
+
+    // Ensure the entity has the requested field.
+    if (!$entity->hasField($field_name)) {
+      return NULL;
+    }
+
+    // Do not continue if the field is empty.
+    if ($entity->get($field_name)->isEmpty()) {
+      return NULL;
+    }
+
+    if (isset($entity->{$field_name})) {
+      return $entity->{$field_name};
+    }
+
+    return NULL;
+  }
+
+  /**
+   * Return the current user object.
+   *
+   * @return \Drupal\user\Entity\User|null
+   *   The current user object or NULL when anonymous.
+   */
+  public function loadCurrentUser() {
+    $currentUser = $this->getCurrentUser();
+
+    if ($currentUser->isAnonymous()) {
+      return NULL;
+    }
+
+    return $this->getUserStorage()->load($currentUser->id());
+  }
+
+  /**
+   * Load a ImageInterface object for an original image path or URI.
+   *
+   * @param string $path
+   *   The path or URI to the original image.
+   *
+   * @return \Drupal\Core\Image\ImageInterface
+   *   An Image object.
+   */
+  public function loadImage($path) {
+    return $this->getImageFactory()->get($path);
+  }
+
+}