Merge pull request #66 from drupol/Submodule-Service-Container-Doctrine

Issue #2504025 by Pol, Fabianx: Support Drupal 8 plugins via annotation parsing

Author: LionsAd

HACK.md

@@ -1,8 +1,11 @@
-## List of service and class that we've altered ##
+## List of classes that we've altered ##
  - Database:
    - Drupal\Core\Database\Connection
    - Drupal\Core\Database\Database
    - Drupal\Core\Database\Query\Merge
+ - FileCache:
+   - Drupal\Component\FileCacheFactory (PHP 5.3 friendly)
+   - Drupal\Component\NullFileCache (PHP 5.3 friendly)
  - KeyValueStore:
    - Drupal\Core\KeyValueStore\DatabaseStorage
  - StringTranslation:

lib/Drupal/Component/FileCache/FileCacheFactory.php

@@ -38,15 +38,15 @@ class FileCacheFactory {
    * @return \Drupal\Component\FileCache\FileCacheInterface
    *   The initialized FileCache object.
    */
-  public static function get($collection, $default_configuration = []) {
-    $default_configuration += [
+  public static function get($collection, $default_configuration = array()) {
+    $default_configuration += array(
       'class' => '\Drupal\Component\FileCache\FileCache',
       'collection' => $collection,
       'cache_backend_class' => NULL,
-      'cache_backend_configuration' => [],
-    ];
+      'cache_backend_configuration' => array(),
+    );
 
-    $configuration = [];
+    $configuration = array();
     if (isset(static::$configuration[$collection])) {
       $configuration = static::$configuration[$collection];
     }

lib/Drupal/Component/FileCache/NullFileCache.php

@@ -26,7 +26,7 @@ class NullFileCache implements FileCacheInterface {
    * @param array $cache_backend_configuration
    *   (optional) The configuration for the backend class.
    */
-  public function __construct($prefix, $collection, $cache_backend_class = NULL, array $cache_backend_configuration = []) {
+  public function __construct($prefix, $collection, $cache_backend_class = NULL, array $cache_backend_configuration = array()) {
   }
 
   /**
@@ -40,7 +40,7 @@ public function get($filepath) {
    * {@inheritdoc}
    */
   public function getMultiple(array $filepaths) {
-    return [];
+    return array();
   }
 
   /**

lib/Drupal/Core/Annotation/Translation.php

@@ -0,0 +1,99 @@
+<?php
+
+/**
+ * @file
+ * Definition of Drupal\Core\Annotation\Translation.
+ */
+
+namespace Drupal\Core\Annotation;
+
+use Drupal\Component\Annotation\AnnotationBase;
+use Drupal\Core\StringTranslation\TranslationWrapper;
+
+/**
+ * @defgroup plugin_translatable Annotation for translatable text
+ * @{
+ * Describes how to put translatable UI text into annotations.
+ *
+ * When providing plugin annotation, properties whose values are displayed in
+ * the user interface should be made translatable. Much the same as how user
+ * interface text elsewhere is wrapped in t() to make it translatable, in plugin
+ * annotation, wrap translatable strings in the @ Translation() annotation.
+ * For example:
+ * @code
+ *   title = @ Translation("Title of the plugin"),
+ * @endcode
+ * Remove spaces after @ in your actual plugin - these are put into this sample
+ * code so that it is not recognized as annotation.
+ *
+ * To provide replacement values for placeholders, use the "arguments" array:
+ * @code
+ *   title = @ Translation("Bundle !title", arguments = {"!title" = "Foo"}),
+ * @endcode
+ *
+ * It is also possible to provide a context with the text, similar to t():
+ * @code
+ *   title = @ Translation("Bundle", context = "Validation"),
+ * @endcode
+ * Other t() arguments like language code are not valid to pass in. Only
+ * context is supported.
+ *
+ * @see i18n
+ * @see annotation
+ * @}
+ */
+
+/**
+ * Defines a translatable annotation object.
+ *
+ * Some metadata within an annotation needs to be translatable. This class
+ * supports that need by allowing both the translatable string and, if
+ * specified, a context for that string. The string (with optional context)
+ * is passed into t().
+ *
+ * @ingroup plugin_translatable
+ *
+ * @Annotation
+ */
+class Translation extends AnnotationBase {
+
+  /**
+   * The string translation object.
+   *
+   * @var \Drupal\Core\StringTranslation\TranslationWrapper
+   */
+  protected $translation;
+
+  /**
+   * Constructs a new class instance.
+   *
+   * Parses values passed into this class through the t() function in Drupal and
+   * handles an optional context for the string.
+   *
+   * @param array $values
+   *   Possible array keys:
+   *   - value (required): the string that is to be translated.
+   *   - arguments (optional): an array with placeholder replacements, keyed by
+   *     placeholder.
+   *   - context (optional): a string that describes the context of "value";
+   */
+  public function __construct(array $values) {
+    $string = $values['value'];
+    $arguments = isset($values['arguments']) ? $values['arguments'] : array();
+    $options = array();
+    if (!empty($values['context'])) {
+      $options = array(
+        'context' => $values['context'],
+      );
+    }
+    $this->translation = new TranslationWrapper($string, $arguments, $options);
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function get() {
+    return $this->translation;
+  }
+
+}

lib/Drupal/Core/Block/Annotation/Block.php

@@ -0,0 +1,53 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\Core\Block\Annotation\Block.
+ */
+
+namespace Drupal\Core\Block\Annotation;
+
+use Drupal\Component\Annotation\Plugin;
+
+/**
+ * Defines a Block annotation object.
+ *
+ * @ingroup block_api
+ *
+ * @Annotation
+ */
+class Block extends Plugin {
+
+  /**
+   * The plugin ID.
+   *
+   * @var string
+   */
+  public $id;
+
+  /**
+   * The administrative label of the block.
+   *
+   * @var \Drupal\Core\Annotation\Translation
+   *
+   * @ingroup plugin_translatable
+   */
+  public $admin_label = '';
+
+  /**
+   * The category in the admin UI where the block will be listed.
+   *
+   * @var \Drupal\Core\Annotation\Translation
+   *
+   * @ingroup plugin_translatable
+   */
+  public $category = '';
+
+  /**
+   * Class used to retrieve derivative definitions of the block.
+   *
+   * @var string
+   */
+  public $derivative = '';
+
+}

modules/service_container_doctrine/lib/Doctrine/annotations/lib/Doctrine/Common/Annotations/Annotation.php renamed to modules/providers/service_container_annotation_discovery/lib/Doctrine/annotations/lib/Doctrine/Common/Annotations/Annotation.php

@@ -0,0 +1,79 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\service_container_annotation_discovery\Tests\ServiceContainerBlockIntegrationTest.
+ */
+
+namespace Drupal\service_container_annotation_discovery\Tests;
+
+use Drupal\Component\Plugin\PluginBase;
+use Drupal\service_container\Tests\ServiceContainerIntegrationTestBase;
+use Mockery\CountValidator\Exception;
+use Symfony\Component\Yaml\Exception\RuntimeException;
+
+class ServiceContainerBlockIntegrationTest extends ServiceContainerIntegrationTestBase {
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function setUp() {
+    parent::setUp('service_container_annotation_discovery_test');
+
+    $this->container = \Drupal::getContainer();
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function getInfo() {
+    return array(
+      'name' => 'ServiceContainerAnnotationDirectoryIntegrationTest',
+      'description' => 'Tests the \ServiceContainer Annotation Discovery class',
+      'group' => 'service_container',
+    );
+  }
+
+  /**
+   * Tests if plugins with annotations are available as services.
+   */
+  public function testDoctrinePlugin() {
+    $plugins = array(
+      array(
+        'owner' => 'sc_doctrine_test',
+        'type' => 'Plugin1',
+        'name' => 'Plugin1A',
+      ),
+      array(
+        'owner' => 'sc_doctrine_test',
+        'type' => 'Plugin2',
+        'name' => 'Plugin2B',
+      ),
+    );
+    foreach($plugins as $plugin) {
+      $plugin_manager = $this->container->get($plugin['owner'] . '.' . $plugin['type']);
+      $this->assertTrue($plugin_manager->hasDefinition($plugin['name']));
+      $object = $plugin_manager->createInstance($plugin['name']);
+      $this->assertTrue($object instanceof PluginBase);
+    }
+
+    $plugin = array(
+      'owner' => 'sc_doctrine_test',
+      'type' => 'Plugin3',
+      'name' => 'Plugin1C',
+    );
+    try {
+      $this->container->get($plugin['owner'] . '.' . $plugin['type']);
+    }  catch (\RuntimeException $e) {
+      $this->pass('Bad input correctly threw an exception');
+    }
+
+    $plugin = array(
+      'owner' => 'sc_doctrine_test',
+      'type' => 'Plugin1',
+      'name' => 'Plugin3A',
+    );
+    $plugin_manager = $this->container->get($plugin['owner'] . '.' . $plugin['type']);
+    $this->assertFalse($plugin_manager->hasDefinition($plugin['name']));
+  }
+}

modules/service_container_doctrine/lib/Doctrine/annotations/lib/Doctrine/Common/Annotations/Annotation/Attribute.php renamed to modules/providers/service_container_annotation_discovery/lib/Doctrine/annotations/lib/Doctrine/Common/Annotations/Annotation/Attribute.php

@@ -0,0 +1,11 @@
+name = Services Container Annotation Discovery
+description = Services Container Annotation discovery integration.
+package = Utility
+core = 7.x
+php = 5.3.10
+
+; Dependencies
+dependencies[] = service_container_symfony
+
+registry_autoload[] = PSR-0
+registry_autoload[] = PSR-4

modules/service_container_doctrine/lib/Doctrine/annotations/lib/Doctrine/Common/Annotations/Annotation/Attributes.php renamed to modules/providers/service_container_annotation_discovery/lib/Doctrine/annotations/lib/Doctrine/Common/Annotations/Annotation/Attributes.php

@@ -0,0 +1,22 @@
+<?php
+/**
+ * @file
+ * Main module file for the service_container_annotation_discovery module.
+ */
+
+// -----------------------------------------------------------------------
+// Contrib Hooks
+
+/**
+ * Implements hook_ctools_plugin_directory().
+ */
+function service_container_annotation_discovery_ctools_plugin_directory($owner, $plugin_type) {
+  if ($owner == 'service_container') {
+    return 'src/ServiceContainer/' . $plugin_type;
+  }
+
+  return NULL;
+}
+
+// -----------------------------------------------------------------------
+// Public API