Security update for permissions_by_term

[yaffs-website] / vendor / drupal / drupal-extension / src / Drupal / DrupalExtension / Context / DrupalSubContextBase.php

diff --git a/vendor/drupal/drupal-extension/src/Drupal/DrupalExtension/Context/DrupalSubContextBase.php b/vendor/drupal/drupal-extension/src/Drupal/DrupalExtension/Context/DrupalSubContextBase.php
new file mode 100644 (file)
index 0000000..8bdac83
--- /dev/null
+++ b/vendor/drupal/drupal-extension/src/Drupal/DrupalExtension/Context/DrupalSubContextBase.php
@@ -0,0 +1,85 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\DrupalExtension\Context\DrupalSubContextBase.
+ */
+
+namespace Drupal\DrupalExtension\Context;
+
+use Behat\Behat\Context\Environment\InitializedContextEnvironment;
+use Drupal\DrupalDriverManager;
+
+/**
+ * Base class for subcontexts that use the Drupal API.
+ */
+abstract class DrupalSubContextBase extends RawDrupalContext implements DrupalSubContextInterface {
+
+  /**
+   * The Drupal Driver Manager.
+   *
+   * @var \Drupal\DrupalDriverManager $drupal
+   */
+  protected $drupal;
+
+  /**
+   * Constructs a DrupalSubContextBase object.
+   *
+   * @param \Drupal\DrupalDriverManager $drupal
+   *   The Drupal driver manager.
+   */
+  public function __construct(DrupalDriverManager $drupal) {
+    $this->drupal = $drupal;
+  }
+
+  /**
+   * Get the currently logged in user from DrupalContext.
+   */
+  protected function getUser() {
+    /** @var DrupalContext $context */
+    $context = $this->getContext('\Drupal\DrupalExtension\Context\DrupalContext');
+    if (empty($context->user)) {
+      throw new \Exception('No user is logged in.');
+    }
+
+    return $context->user;
+  }
+
+  /**
+   * Returns the Behat context that corresponds with the given class name.
+   *
+   * This is inspired by InitializedContextEnvironment::getContext() but also
+   * returns subclasses of the given class name. This allows us to retrieve for
+   * example DrupalContext even if it is overridden in a project.
+   *
+   * @param string $class
+   *   A fully namespaced class name.
+   *
+   * @return \Behat\Behat\Context\Context|false
+   *   The requested context, or FALSE if the context is not registered.
+   *
+   * @throws \Exception
+   *   Thrown when the environment is not yet initialized, meaning that contexts
+   *   cannot yet be retrieved.
+   */
+  protected function getContext($class) {
+    /** @var InitializedContextEnvironment $environment */
+    $environment = $this->drupal->getEnvironment();
+    // Throw an exception if the environment is not yet initialized. To make
+    // sure state doesn't leak between test scenarios, the environment is
+    // reinitialized at the start of every scenario. If this code is executed
+    // before a test scenario starts (e.g. in a `@BeforeScenario` hook) then the
+    // contexts cannot yet be retrieved.
+    if (!$environment instanceof InitializedContextEnvironment) {
+      throw new \Exception('Cannot retrieve contexts when the environment is not yet initialized.');
+    }
+    foreach ($environment->getContexts() as $context) {
+      if ($context instanceof $class) {
+        return $context;
+      }
+    }
+
+    return FALSE;
+  }
+
+}