You are here

Home » API reference » Permissions by Term 8.2 » permissions_by_term.behat.inc

class PermissionsByTermDrupalSubContext in Permissions by Term 8.2

Class PermissionsByTermContext

@package PermissionsByTerm

Hierarchy

  • class \Drupal\Tests\permissions_by_term\Behat\PermissionsByTermDrupalSubContext\PermissionsByTermDrupalSubContext extends \Drupal\DrupalExtension\Context\DrupalSubContextBase implements \Drupal\DrupalExtension\Context\DrupalSubContextInterface

Expanded class hierarchy of PermissionsByTermDrupalSubContext

File

tests/src/Behat/Context/permissions_by_term.behat.inc, line 21

Namespace

Drupal\Tests\permissions_by_term\Behat\PermissionsByTermDrupalSubContext
View source 
class PermissionsByTermDrupalSubContext extends DrupalSubContextBase implements DrupalSubContextInterface {
  private const MAX_DURATION_SECONDS = 1200;
  private const MAX_SHORT_DURATION_SECONDS = 20;

  /**
   * Creates one or more terms on an existing vocabulary.
   *
   * Provide term data in the following format:
   *
   * | name  | parent | description | weight | taxonomy_field_image | access_user | access_role |
   * | Snook | Fish   | Marine fish | 10     | snook-123.jpg        | Bob         | editor      |
   * | ...   | ...    | ...         | ...    | ...                  | ...         | ...         |
   *
   * Only the 'name' field is required.
   *
   * @Given restricted :vocabulary terms:
   */
  public function createTerms($vocabulary, TableNode $termsTable) {
    foreach ($termsTable
      ->getHash() as $termsHash) {
      $term = (object) $termsHash;
      $term->vocabulary_machine_name = $vocabulary;
      $this
        ->termCreate($term);
      $accessStorage = \Drupal::Service('permissions_by_term.access_storage');
      if (!empty($termsHash['access_user'])) {
        $userNames = explode(', ', $termsHash['access_user']);
        foreach ($userNames as $userName) {
          $accessStorage
            ->addTermPermissionsByUserIds([
            $accessStorage
              ->getUserIdByName($userName)['uid'],
          ], $term->tid);
        }
      }
      if (!empty($termsHash['access_role'])) {
        $rolesIds = explode(', ', $termsHash['access_role']);
        $accessStorage
          ->addTermPermissionsByRoleIds($rolesIds, $term->tid);
      }
    }
  }

  /**
   * @Given /^I create vocabulary with name "([^"]*)" and vid "([^"]*)"$/
   */
  public function createVocabulary($name, $vid) {
    $vocabulary = \Drupal::entityQuery('taxonomy_vocabulary')
      ->condition('vid', $vid)
      ->execute();
    if (empty($vocabulary)) {
      $vocabulary = Vocabulary::create([
        'name' => $name,
        'vid' => $vid,
      ]);
      $vocabulary
        ->save();
    }
  }

  /**
   * @Then I open open Permissions By Term advanced info
   */
  public function iOpenOpenPermissionsByTermAdvancedInfo() {
    $this
      ->getSession()
      ->evaluateScript("jQuery('#edit-permissions-by-term-info').attr('open', true);");
  }

  /**
   * @Given /^I create (\d+) nodes of type "([^"]*)"$/
   */
  public function iCreateNodesOfType($number, $type) {
    for ($i = 0; $i <= $number; $i++) {
      $node = new \stdClass();
      $node->type = $type;
      $node->title = $this
        ->createRandomString();
      $node->body = $this
        ->createRandomString();
      $this
        ->nodeCreate($node);
    }
  }
  private function createRandomString($length = 10) {
    return substr(str_shuffle(str_repeat("0123456789abcdefghijklmnopqrstuvwxyz", $length)), 0, $length);
  }

  /**
   * @Given node access records are rebuilt
   * @Given Node access records are rebuild
   */
  public function nodeAccessRecordsAreRebuilt() : void {
    node_access_rebuild();
  }

  /**
   * @Given node access records are disabled
   */
  public function nodeAccessRecordsAreDisabled() : void {
    \Drupal::configFactory()
      ->getEditable('permissions_by_term.settings')
      ->set('disable_node_access_records', TRUE)
      ->save();
  }

  /**
   * @Given node access records are enabled
   */
  public function nodeAccessRecordsAreEnabled() : void {
    \Drupal::configFactory()
      ->getEditable('permissions_by_term.settings')
      ->set('disable_node_access_records', FALSE)
      ->save();
  }

  /**
   * @Then /^wait (\d+) seconds$/
   */
  public function waitSeconds($secondsNumber) {
    $this
      ->getSession()
      ->wait($secondsNumber * 1000);
  }

  /**
   * @Then /^I select index (\d+) in dropdown named "([^"]*)"$/
   */
  public function selectIndexInDropdown($index, $name) {
    $this
      ->getSession()
      ->evaluateScript('document.getElementsByName("' . $name . '")[0].selectedIndex = ' . $index . ';');
  }

  /**
   * @Then /^I open node edit form by node title "([^"]*)"$/
   * @param string $title
   */
  public function openNodeEditFormByTitle($title) {
    $query = \Drupal::service('database')
      ->select('node_field_data', 'nfd')
      ->fields('nfd', [
      'nid',
    ])
      ->condition('nfd.title', $title);
    $this
      ->visitPath('/node/' . $query
      ->execute()
      ->fetchField() . '/edit');
  }

  /**
   * @Then /^I open node view by node title "([^"]*)"$/
   * @param string $title
   */
  public function openNodeViewByTitle($title) {
    $query = \Drupal::service('database')
      ->select('node_field_data', 'nfd')
      ->fields('nfd', [
      'nid',
    ])
      ->condition('nfd.title', $title);
    $this
      ->visitPath('/node/' . $query
      ->execute()
      ->fetchField());
  }

  /**
   * @Then /^I scroll to element with id "([^"]*)"$/
   * @param string $id
   */
  public function iScrollToElementWithId($id) {
    $this
      ->getSession()
      ->executeScript("\n                var element = document.getElementById('" . $id . "');\n                element.scrollIntoView( true );\n            ");
  }

  /**
   * @Then /^I check checkbox with id "([^"]*)" by JavaScript$/
   * @param string $id
   */
  public function checkCheckboxWithJS($id) {
    $this
      ->getSession()
      ->executeScript("\n                document.getElementById('" . $id . "').checked = true;\n            ");
  }

  /**
   * @Then /^I check checkbox with id "([^"]*)"$/
   * @param string $id
   */
  public function checkCheckbox($id) {
    $page = $this
      ->getSession()
      ->getPage();
    $selectElement = $page
      ->find('xpath', '//input[@id = "' . $id . '"]');
    $selectElement
      ->check();
  }

  /**
   * @Then /^I uncheck checkbox with id "([^"]*)"$/
   * @param string $id
   */
  public function uncheckCheckbox($id) {
    $page = $this
      ->getSession()
      ->getPage();
    $selectElement = $page
      ->find('xpath', '//input[@id = "' . $id . '"]');
    $selectElement
      ->uncheck();
  }

  /**
   * @Then /^I select "([^"]*)" in "([^"]*)"$/
   * @param string $label
   * @param string $id
   */
  public function selectOption($label, $id) {
    $page = $this
      ->getSession()
      ->getPage();
    $selectElement = $page
      ->find('xpath', '//select[@id = "' . $id . '"]');
    $selectElement
      ->selectOption($label);
  }

  /**
   * @Then /^I should see text matching "([^"]*)" after a while$/
   */
  public function iShouldSeeTextAfterAWhile($text) {
    try {
      $startTime = time();
      do {
        $content = $this
          ->getSession()
          ->getPage()
          ->getText();
        if (substr_count($content, $text) > 0) {
          return true;
        }
      } while (time() - $startTime < self::MAX_DURATION_SECONDS);
      throw new ResponseTextException(sprintf('Could not find text %s after %s seconds', $text, self::MAX_DURATION_SECONDS), $this
        ->getSession());
    } catch (StaleElementReference $e) {
      return true;
    }
  }

  /**
   * @Then /^I should not see text matching "([^"]*)" after a while$/
   */
  public function iShouldNotSeeTextAfterAWhile($text) {
    $startTime = time();
    do {
      $content = $this
        ->getSession()
        ->getPage()
        ->getText();
      if (substr_count($content, $text) === 0) {
        return true;
      }
    } while (time() - $startTime < self::MAX_SHORT_DURATION_SECONDS);
    throw new ResponseTextException(sprintf('Could find text %s after %s seconds', $text, self::MAX_SHORT_DURATION_SECONDS), $this
      ->getSession());
  }

  /**
   * @Then /^I click by selector "([^"]*)" via JavaScript$/
   * @param string $selector
   */
  public function clickBySelector(string $selector) {
    $this
      ->getSession()
      ->executeScript("document.querySelector('" . $selector . "').click()");
  }

  /**
   * @Given /^editor role exists$/
   */
  public function createEditorRole() {
    if (!Role::load('editor')) {
      $role = Role::create([
        'id' => 'editor',
      ]);
      $role
        ->grantPermission('edit any article content')
        ->save();
    }
  }

  /**
   * @Given /^permission mode is set$/
   */
  public function permissionModeIsSet() : void {
    \Drupal::configFactory()
      ->getEditable('permissions_by_term.settings')
      ->set('permission_mode', TRUE)
      ->save();
  }

  /**
   * @Then /^I submit the form$/
   */
  public function iSubmitTheForm() {
    $session = $this
      ->getSession();

    // get the mink session
    $element = $session
      ->getPage()
      ->find('xpath', $session
      ->getSelectorsHandler()
      ->selectorToXpath('xpath', '//*[@type="submit"]'));

    // runs the actual query and returns the element
    // errors must not pass silently
    if (null === $element) {
      throw new \InvalidArgumentException(sprintf('Could not evaluate XPath: "%s"', '//*[@type="submit"]'));
    }

    // ok, let's click on it
    $element
      ->click();
  }

  /**
   * Dumps the current page HTML.
   *
   * @When I dump the HTML
   */
  public function dumpHTML() {
    print_r($this
      ->getSession()
      ->getPage()
      ->getContent());
  }

  /**
   * @Then /^I create main menu item for node with title "([^"]*)"$/
   */
  public function createMainMenuItemForNode(string $nodeTitle) : void {
    $query = \Drupal::service('database')
      ->select('node_field_data', 'nfd')
      ->fields('nfd', [
      'nid',
    ])
      ->condition('nfd.title', $nodeTitle);
    $menuLink = MenuLinkContent::create([
      'title' => $nodeTitle,
      'link' => [
        'uri' => 'internal:/node/' . $query
          ->execute()
          ->fetchField(),
      ],
      'menu_name' => 'main',
      'expanded' => TRUE,
    ]);
    $menuLink
      ->save();
  }

  /**
   * @Then /^I should see menu item text matching "([^"]*)"$/
   */
  public function seeMenuItemMatchingText(string $text) : void {
    $xpath = '//*/ul/li/a[text() = "' . $text . '"]';
    $session = $this
      ->getSession();

    // get the mink session
    $element = $session
      ->getPage()
      ->find('xpath', $session
      ->getSelectorsHandler()
      ->selectorToXpath('xpath', $xpath));
    if ($element === NULL) {
      throw new \InvalidArgumentException(sprintf('Could not evaluate XPath: "%s"', $xpath));
    }
  }

  /**
   * @Then /^I should not see menu item text matching "([^"]*)"$/
   */
  public function seeNotMenuItemMatchingText(string $text) : void {
    $xpath = '//*/ul/li/a[text() = "' . $text . '"]';
    $session = $this
      ->getSession();

    // get the mink session
    $element = $session
      ->getPage()
      ->find('xpath', $session
      ->getSelectorsHandler()
      ->selectorToXpath('xpath', $xpath));
    if ($element !== NULL) {
      throw new \InvalidArgumentException(sprintf('Could not evaluate XPath: "%s"', $xpath));
    }
  }

  /**
   * @Then /^I am installing the "([^"]*)" module$/
   */
  public function iAmInstallingTheModule(string $moduleName) : void {
    \Drupal::service('module_installer')
      ->install([
      $moduleName,
    ]);

    // Required to import translations or other batch processes which runs after
    // a module is installed. (by default via backend which would runs a batch)
    $batch =& batch_get();
    if (empty($batch)) {
      return;
    }
    $batch['progressive'] = FALSE;
    batch_process();
  }

  /**
   * @Then /^I open taxonomy term view by term name "([^"]*)"$/
   */
  public function openTaxonomyTermPageByTermName(string $termName) {
    $query = \Drupal::service('database')
      ->select('taxonomy_term_field_data', 'ttfd')
      ->fields('ttfd', [
      'tid',
    ])
      ->condition('ttfd.name', $termName);
    $this
      ->visitPath('/taxonomy/term/' . $query
      ->execute()
      ->fetchField());
  }

}

Members

Namesort descending Modifiers Type Description Overrides
PermissionsByTermDrupalSubContext::checkCheckbox public function @Then /^I check checkbox with id "([^"]*)"$/
PermissionsByTermDrupalSubContext::checkCheckboxWithJS public function @Then /^I check checkbox with id "([^"]*)" by JavaScript$/
PermissionsByTermDrupalSubContext::clickBySelector public function @Then /^I click by selector "([^"]*)" via JavaScript$/
PermissionsByTermDrupalSubContext::createEditorRole public function @Given /^editor role exists$/
PermissionsByTermDrupalSubContext::createMainMenuItemForNode public function @Then /^I create main menu item for node with title "([^"]*)"$/
PermissionsByTermDrupalSubContext::createRandomString private function
PermissionsByTermDrupalSubContext::createTerms public function Creates one or more terms on an existing vocabulary.
PermissionsByTermDrupalSubContext::createVocabulary public function @Given /^I create vocabulary with name "([^"]*)" and vid "([^"]*)"$/
PermissionsByTermDrupalSubContext::dumpHTML public function Dumps the current page HTML.
PermissionsByTermDrupalSubContext::iAmInstallingTheModule public function @Then /^I am installing the "([^"]*)" module$/
PermissionsByTermDrupalSubContext::iCreateNodesOfType public function @Given /^I create (\d+) nodes of type "([^"]*)"$/
PermissionsByTermDrupalSubContext::iOpenOpenPermissionsByTermAdvancedInfo public function @Then I open open Permissions By Term advanced info
PermissionsByTermDrupalSubContext::iScrollToElementWithId public function @Then /^I scroll to element with id "([^"]*)"$/
PermissionsByTermDrupalSubContext::iShouldNotSeeTextAfterAWhile public function @Then /^I should not see text matching "([^"]*)" after a while$/
PermissionsByTermDrupalSubContext::iShouldSeeTextAfterAWhile public function @Then /^I should see text matching "([^"]*)" after a while$/
PermissionsByTermDrupalSubContext::iSubmitTheForm public function @Then /^I submit the form$/
PermissionsByTermDrupalSubContext::MAX_DURATION_SECONDS private constant
PermissionsByTermDrupalSubContext::MAX_SHORT_DURATION_SECONDS private constant
PermissionsByTermDrupalSubContext::nodeAccessRecordsAreDisabled public function @Given node access records are disabled
PermissionsByTermDrupalSubContext::nodeAccessRecordsAreEnabled public function @Given node access records are enabled
PermissionsByTermDrupalSubContext::nodeAccessRecordsAreRebuilt public function @Given node access records are rebuilt @Given Node access records are rebuild
PermissionsByTermDrupalSubContext::openNodeEditFormByTitle public function @Then /^I open node edit form by node title "([^"]*)"$/
PermissionsByTermDrupalSubContext::openNodeViewByTitle public function @Then /^I open node view by node title "([^"]*)"$/
PermissionsByTermDrupalSubContext::openTaxonomyTermPageByTermName public function @Then /^I open taxonomy term view by term name "([^"]*)"$/
PermissionsByTermDrupalSubContext::permissionModeIsSet public function @Given /^permission mode is set$/
PermissionsByTermDrupalSubContext::seeMenuItemMatchingText public function @Then /^I should see menu item text matching "([^"]*)"$/
PermissionsByTermDrupalSubContext::seeNotMenuItemMatchingText public function @Then /^I should not see menu item text matching "([^"]*)"$/
PermissionsByTermDrupalSubContext::selectIndexInDropdown public function @Then /^I select index (\d+) in dropdown named "([^"]*)"$/
PermissionsByTermDrupalSubContext::selectOption public function @Then /^I select "([^"]*)" in "([^"]*)"$/
PermissionsByTermDrupalSubContext::uncheckCheckbox public function @Then /^I uncheck checkbox with id "([^"]*)"$/
PermissionsByTermDrupalSubContext::waitSeconds public function @Then /^wait (\d+) seconds$/