You are here

Home » API reference » Varbase: The Ultimate Drupal CMS Starter Kit (Bootstrap Ready) 9.0.x » VarbaseContext.php

class VarbaseContext in Varbase: The Ultimate Drupal CMS Starter Kit (Bootstrap Ready) 9.0.x

Same name and namespace in other branches
  1. 8.8 tests/features/bootstrap/VarbaseContext.php \VarbaseContext
  2. 8.4 tests/features/bootstrap/VarbaseContext.php \VarbaseContext
  3. 8.5 tests/features/bootstrap/VarbaseContext.php \VarbaseContext
  4. 8.6 tests/features/bootstrap/VarbaseContext.php \VarbaseContext
  5. 8.7 tests/features/bootstrap/VarbaseContext.php \VarbaseContext

Defines application features from the specific context.

Hierarchy

  • class \VarbaseContext extends \Drupal\DrupalExtension\Context\RawDrupalContext implements \Behat\Behat\Context\SnippetAcceptingContext

Expanded class hierarchy of VarbaseContext

File

tests/features/bootstrap/VarbaseContext.php, line 11

View source 
class VarbaseContext extends RawDrupalContext implements SnippetAcceptingContext {

  /**
   * Hold the user name and password from drupal_users parameters.
   *
   * @var array
   */
  protected $users = [];

  /**
   * Hold the user name and password from varbase_users parameters.
   *
   * @var array
   */
  protected $varbaseUsers = [];

  /**
   * Hold all passed parameters.
   *
   * @var array
   */
  protected $parameters = [];

  /**
   * Initializes context.
   *
   * @param array $parameters
   *   Context parameters (set them up through behat.yml or behat.local.yml).
   */
  public function __construct(array $parameters) {

    // Set the list of parameters.
    $this->parameters = $parameters;
    if (isset($parameters['varbase_users'])) {
      $this->varbaseUsers = $parameters['varbase_users'];
      foreach ($parameters['varbase_users'] as $varbaseUsername => $varbaseUser) {
        $this->users[$varbaseUsername] = $varbaseUser['password'];
      }
    }
    else {
      throw new \Exception('behat.yml config files should include "varbase_users" property.');
    }
  }

  /**
   * Clean users.
   */
  public function cleanUsers() {
  }

  /**
   * Authenticate a user with password from varbase configuration.
   *
   * Varbase Context #varbase. If you want to see the list of users or add yours you can go and
   * edit the behat.varbase.yml file under the varbase_users list.
   *
   * Example: I am a logged in user with the username "test_content_admin"
   *
   * @Given /^I am a logged in user with (?:|the )"(?P<username>[^"]*)"(?:| user)$/
   * @Then /^I login with (?:|the )"(?P<username>[^"]*)"(?:| user)$/
   */
  public function iAmloggedInUserWithTheUser($username) {
    if (isset($this->users[$username])) {
      try {
        $password = $this->users[$username];
      } catch (Exception $e) {
        throw new \Exception("Password not found for '{$username}'.");
      }
      if ($this
        ->loggedIn()) {
        $this
          ->logout();
      }
      $this
        ->getSession()
        ->visit($this
        ->locatePath('/user/login'));
      $page = $this
        ->getSession()
        ->getPage();
      if ($this
        ->matchingElementAfterWait('css', '[data-drupal-selector="edit-name"]', 6000)) {
        $page
          ->fillField('name', $username);
        $page
          ->fillField('pass', $password);
        $submit = $page
          ->findButton('op');
        $submit
          ->click();
      }
    }
    else {
      throw new \Exception("The '{$username}' user name is wrong or it was not listed in the list of default testing users.");
    }
  }

  /**
   * Authenticate a user with a given username and password on the spot.
   *
   * Varbase Context #varbase.
   *
   * Example: I am a logged in user with the username "testing" and password "testing user password"
   *
   * @Given /^I am a logged in user with (?:|the )username "(?P<username>[^"]*)" and password "(?P<password>[^"]*)"$/
   */
  public function iAmLoggedInUserWithTheUsernameAndPassword($username, $password) {

    // Logout if I am logged in.
    if ($this
      ->loggedIn()) {
      $this
        ->logout();
    }

    // Login with the.
    $this
      ->getSession()
      ->visit($this
      ->locatePath('/user/login'));
    $page = $this
      ->getSession()
      ->getPage();
    if ($this
      ->matchingElementAfterWait('css', '[data-drupal-selector="edit-name"]', 6000)) {
      $page
        ->fillField('name', $username);
      $page
        ->fillField('pass', $password);
      $submit = $page
        ->findButton('op');
      $submit
        ->click();
    }
  }

  /**
   * Logout from the current session.
   *
   * Varbase Context #varbase.
   *
   * Example: When I logout.
   *
   * @When /^I logout$/
   */
  public function iLogout() {

    // Logout if I am logged in.
    if ($this
      ->loggedIn()) {
      $this
        ->logout();
    }
  }

  /**
   * Navigate directly to an external web site.
   *
   * Varbase Context #varbase.
   *
   * Example: When I go to "https://www.google.com" website.
   *
   * @When /^I go to "(?P<domain>[^"]*)" website$/
   */
  public function iGoToWebsite($domain) {
    $this
      ->getSession()
      ->visit($domain);
  }

  /**
   * Wait for seconds before going to the next step.
   *
   * Varbase Context #varbase.
   *
   * Example 1:  And wait for "1" second
   * Example 2: When I wait for "5" seconds
   * Example 3:  And wait 1 second
   * Example 4: When I wait for 60 seconds
   * Example 5:  And wait 1s
   * Example 6: When I wait for 60s.
   *
   * @When /^(?:|I )wait (?:|for )"(?P<seconds>\d+)" second(?:|s)$/
   * @When /^(?:|I )wait (?:|for )(?P<seconds>\d+) second(?:|s)$/
   * @When /^(?:|I )wait (?:|for )(?P<seconds>\d+)s$/
   */
  public function iWaitForSeconds($seconds = 1) {
    $this
      ->getSession()
      ->wait($seconds * 1000);
  }

  /**
   * Wait for minutes before going to the next step.
   *
   * Varbase Context #varbase.
   *
   * Example 1:  And I wait for "1" minute
   * Example 2: When I wait for "2" minutes
   * Example 3:  And wait 1 minute
   * Example 4: When I wait for 3 minutes
   * Example 5:  And wait 1m
   * Example 6: When I wait for 3m.
   *
   * @When /^(?:|I )wait (?:|for )"(?P<minutes>\d+)" minute(?:|s)$/
   * @When /^(?:|I )wait (?:|for )(?P<minutes>\d+) minute(?:|s)$/
   * @When /^(?:|I )wait (?:|for )(?P<minutes>\d+)m$/
   */
  public function iWaitForMinutes($minutes = 1) {
    $this
      ->getSession()
      ->wait($minutes * 60 * 1000);
  }

  /**
   * Wait max of seconds for the page to be ready and loaded.
   *
   * Varbase Context #varbase.
   *
   * Example 1: And wait
   * Example 2: And I wait
   * Example 3: And wait for the page
   * Example 4: And I wait for the page
   * Example 5: And wait max of 5 seconds
   * Example 6: And wait max of 5s
   * Example 7: And I wait max of 5s
   * Example 8: And I wait max of "5" seconds
   * Example 9: And I wait max of "5" seconds for the page to be ready and loaded.
   *
   * @Given /^(?:|I )wait max of "(?P<time>\d+)" second(?:|s)(?:| for the page to be ready and loaded)$/
   * @Given /^(?:|I )wait max of (?P<time>\d+) second(?:|s)(?:| for the page to be ready and loaded)$/
   * @Given /^(?:|I )wait max of (?P<time>\d+)s(?:| for the page to be ready and loaded)$/
   * @Given /^(?:|I )wait(?:| for the page)$/
   *
   * @throws \WebDriver\Exception
   *   If timeout is reached.
   */
  public function iWaitMaxOfSecondsForThePageToBeReadyAndLoaded($time = 10000) {
    if (!$this
      ->getSession()
      ->getDriver() instanceof Selenium2Driver) {
      return;
    }
    $start = microtime(TRUE);
    $end = $start + $time / 1000.0;
    $conditions = [
      // Page is ready.
      "document.readyState == 'complete'",
      // jQuery is loaded.
      "typeof \$ != 'undefined'",
      // No ajax request is active.
      "!\$.active",
      // Page is displayed (no progress bar)
      "\$('#page').css('display') == 'block'",
      // Page is not loading (no black mask loading page)
      "\$('.loading-mask').css('display') == 'none'",
      // Jstree has finished loading.
      "\$('.jstree-loading').length == 0",
    ];
    $condition = implode(' && ', $conditions);

    // Make sure the AJAX calls are fired up before checking the condition.
    $this
      ->getSession()
      ->wait(100, FALSE);
    $this
      ->getSession()
      ->wait($time, $condition);

    // Check if we reached the timeout unless the condition is false to explicitly wait the specified time.
    if ($condition !== FALSE && microtime(TRUE) > $end) {
      throw new \Exception(sprintf('Timeout of %d reached when checking on %s', $time, $condition));
    }
  }

  /**
   * Editor Media Browser functions.
   *
   * ==========================================================================.
   */

  /**
   * Click the editor media browser command button.
   *
   * Varbase Context #varbase.
   *
   * Example 1: When I click the editor media browser command button.
   *
   * @When /^I click the editor media browser command button$/
   */
  public function iClickTheEditorMediaBrowserCommandButton() {
    $editorMediaBrowserButton = $this
      ->getSession()
      ->getPage()
      ->find('css', '.cke_button.cke_button__media');
    if (empty($editorMediaBrowserButton)) {
      throw new \Exception('The editor media browser button dose not exist.');
    }
    $editorMediaBrowserButton
      ->click();
  }

  /**
   * Check if the editor media browser is open.
   *
   * Varbase Context #varbase.
   *
   * @Then /^the editor media browser should be open$/
   */
  public function theEitorMediaBrowserIsOpen() {
    if (!($elem = $this
      ->getSession()
      ->getPage()
      ->find('css', '.ui-dialog.media-wrapper') || !$this
      ->getSession()
      ->getPage()
      ->find('css', '.ui-dialog.media-wrapper .media-browser-panes'))) {
      throw new \Exception('The editor media browser failed to open.');
    }
  }

  /**
   * Press a button in the filter form under the editor media browser.
   *
   * Varbase Context #varbase.
   *
   * Example 1: When I press the "Apply" button under the editor media browser
   * Example 2:  And I press the "Submit" button under the editor media browser.
   *
   * @When /^I press (?:|the )"([^"]*)" button under the editor media browser$/
   */
  public function iPressTheButtonUnderTheEditorMediaBrowser($button) {

    // Switch to the "entity_browser_iframe_editor_media_browser" iframe.
    $this
      ->getSession()
      ->switchToIFrame('entity_browser_iframe_editor_media_browser');
    try {
      $this
        ->getSession()
        ->wait(1000, 'typeof(jQuery)=="undefined" || jQuery("#autocomplete").length === 0');
    } catch (UnsupportedDriverActionException $e) {
    }
    $this
      ->getSession()
      ->getPage()
      ->pressButton($button);

    // Switch back too the page from the "entity_browser_iframe_editor_media_browser" iframe.
    $this
      ->getSession()
      ->switchToIFrame(NULL);
  }

  /**
   * Click on a link or button under the editor media browser.
   *
   * Varbase Context #varbase.
   *
   * Example 1: When I click "Submit" button under the media browser
   * Example 2: When I click "Submit" under media browser
   * Example 3: When I click "Upload" under the media browser.
   *
   * @When /^I click "([^"]*)" (?:|button )under (?:|the )editor media browser$/
   */
  public function iClickButtonUnderTheEditorMediaBrowser($text) {

    // Switch to the "mediaBrowser" iframe.
    $this
      ->getSession()
      ->switchToIFrame('entity_browser_iframe_editor_media_browser');

    // Find the Tab by txt.
    $element = $this
      ->getSession()
      ->getPage()
      ->find('xpath', "//*[contains(@class, 'button') and text() = '{$text}']");
    if (empty($element)) {
      throw new \Exception('The editor media browser dose not have [ ' . $text . ' ] button.');
    }
    $element
      ->click();

    // Switch back too the page from the "entity_browser_iframe_editor_media_browser" iframe.
    $this
      ->getSession()
      ->switchToIFrame(NULL);
  }

  /**
   * Click on a tab under the editor media browser.
   *
   * Varbase Context #varbase.
   *
   * Example 1: When I click on the "Library" tab under the editor media browser
   * Example 2: When I click on the "My files" tab under the editor media browser.
   *
   * @When /^I click on the "([^"]*)" tab under the editor media browser$/
   */
  public function iClickOnTheTabUnderTheMediaBrowser($text) {

    // Switch to the "entity_browser_iframe_editor_media_browser" iframe.
    $this
      ->getSession()
      ->switchToIFrame('entity_browser_iframe_editor_media_browser');

    // Find the Tab by txt.
    $element = $this
      ->getSession()
      ->getPage()
      ->find('xpath', "//*[contains(@class, 'ui-tabs-anchor') and text() = '{$text}']");
    if (empty($element)) {
      throw new \Exception('The editor media browser dose not have [ ' . $text . ' ] tab.');
    }
    $element
      ->click();

    // Switch back too the page from the "mediaBrowser" iframe.
    $this
      ->getSession()
      ->switchToIFrame(NULL);
  }

  /**
   * Select the file under the editor media browser.
   *
   * Varbase Context #varbase.
   *
   * Example 1: When I click on the "Flag Earth" file under the editor media browser.
   *
   * @When /^I select (?:|the )"([^"]*)" file under (?:|the )editor media browser$/
   */
  public function iSelectTheFileUnderTheEditorMediaBrowser($text) {

    // Switch to the "entity_browser_iframe_editor_media_browser" iframe.
    $this
      ->getSession()
      ->switchToIFrame('entity_browser_iframe_editor_media_browser');

    // Find the file by text.
    $element = $this
      ->getSession()
      ->getPage()
      ->find('xpath', "//div[contains(@class, 'media-item') and contains(@title, '{$text}')]");
    if (empty($element)) {
      throw new \Exception('The editor media browser dose not have [ ' . $text . ' ] file.');
    }
    $element
      ->click();

    // Switch back too the page from the "entity_browser_iframe_editor_media_browser" iframe.
    $this
      ->getSession()
      ->switchToIFrame(NULL);
  }

  /**
   * Fill in a form field with id|name|title|alt|value.
   *
   * Under the editor media browser.
   * Varbase Context #varbase.
   *
   * Example: I fill in "flag earth" for "File name" under the editor media browser.
   *
   * @When /^(?:|I )fill in "(?P<field>(?:[^"]|\\")*)" with "(?P<value>(?:[^"]|\\")*)" under (?:|the )editor media browser$/
   * @When /^(?:|I )fill in "(?P<field>(?:[^"]|\\")*)" with: under (?:|the )editor media browser$/
   * @When /^(?:|I )fill in "(?P<value>(?:[^"]|\\")*)" for "(?P<field>(?:[^"]|\\")*)" under (?:|the )editor media browser$/
   */
  public function iFillInFieldUnderTheEditorMediaBrowser($field, $value) {

    // Switch to the "entity_browser_iframe_editor_media_browser" iframe.
    $this
      ->getSession()
      ->switchToIFrame('entity_browser_iframe_editor_media_browser');
    $field = str_replace('\\"', '"', $field);
    $value = str_replace('\\"', '"', $value);
    $this
      ->getSession()
      ->getPage()
      ->fillField($field, $value);

    // Switch back too the page from the "entity_browser_iframe_editor_media_browser" iframe.
    $this
      ->getSession()
      ->switchToIFrame(NULL);
  }

  /**
   * Check if we can see a text under the editor media browser.
   *
   * Varbase Context #varbase.
   *
   * Example 1: Then I should see "this text" under editor media browser
   * Example 2: Then I should see "this text" under the editormedia browser modal window.
   *
   * @Then /^I should see "([^"]*)" under (?:|the )editor media browser(?:| modal window)$/
   */
  public function iShouldSeeTextUnderTheEditorMediaBrowser($text) {

    // Switch to the "entity_browser_iframe_editor_media_browser" iframe.
    $this
      ->getSession()
      ->switchToIFrame('entity_browser_iframe_editor_media_browser');
    $actual = $this
      ->getSession()
      ->getPage()
      ->getText();
    $actual = preg_replace('/\\s+/u', ' ', $actual);
    $regex = '/' . preg_quote($text, '/') . '/ui';
    if (!preg_match($regex, $actual)) {
      throw new \Exception(sprintf('The text "%s" was not found anywhere in the text of the current page.', $text));
    }

    // Switch back too the page from the "entity_browser_iframe_editor_media_browser" iframe.
    $this
      ->getSession()
      ->switchToIFrame(NULL);
  }

  /**
   * Find an image with the title text attribute.
   *
   * Varbase Context #varbase.
   *
   * Example 1: Then I should see image with the "Flag Earth" title text.
   *
   * @Then /^I should see image with the "([^"]*)" title text under (?:|the )editor media browser(?:| modal window)$/
   */
  public function iShouldSeeImageWithTheTitleTextUnderTheEditorMediaBrowser($titleText) {

    // Switch to the "entity_browser_iframe_editor_media_browser" iframe.
    $this
      ->getSession()
      ->switchToIFrame('entity_browser_iframe_editor_media_browser');

    // Find an image with the title.
    $element = $this
      ->getSession()
      ->getPage()
      ->find('xpath', "//img[contains(@title, '{$titleText}')]");
    if (empty($element)) {
      throw new \Exception('The editor media browser dose not have an image with the [ ' . $titleText . ' ] title text.');
    }

    // Switch back too the page from the "entity_browser_iframe_editor_media_browser" iframe.
    $this
      ->getSession()
      ->switchToIFrame(NULL);
  }

  /**
   * Check if we can NOT see a text under the editor media browser.
   *
   * Varbase Context #varbase.
   *
   * Example 1: Then I should not see "this text" under editor media browser
   * Example 2: Then I should not see "this text" under the editor media browser modal window.
   *
   * @Then /^I should not see "([^"]*)" under (?:|the )editor media browser(?:| modal window)$/
   */
  public function iShouldNotSeeTextUnderTheeEitorMediaBrowser($text) {

    // Switch to the "entity_browser_iframe_editor_media_browser" iframe.
    $this
      ->getSession()
      ->switchToIFrame('entity_browser_iframe_editor_media_browser');
    $actual = $this
      ->getSession()
      ->getPage()
      ->getText();
    $actual = preg_replace('/\\s+/u', ' ', $actual);
    $regex = '/' . preg_quote($text, '/') . '/ui';
    if (preg_match($regex, $actual)) {
      throw new \Exception(sprintf('The text "%s" was not found anywhere in the text of the current page.', $text));
    }

    // Switch back too the page from the "entity_browser_iframe_editor_media_browser" iframe.
    $this
      ->getSession()
      ->switchToIFrame(NULL);
  }

  /*
   * ===========================================================================
   * Rich text editor Functions CKEditor.
   * ===========================================================================
   */

  /**
   * Fill in a rich text editor field  WYSIWYG with content.
   *
   * Using the name of the field.
   * Varbase Context #varbase.
   *
   *  Example: When I fill in the rich text editor field "Body" with "Test Body text"
   *
   * @When /^I fill in the rich text editor field "([^"]*)" with "([^"]*)"$/
   */
  public function iFillInTheRichTextEditorField($locator, $value) {
    $el = $this
      ->getSession()
      ->getPage()
      ->findField($locator);
    $fieldId = $el
      ->getAttribute('id');
    if ($fieldId == NULL) {

      // If the WYSIWYG is in an ifream with no id.
      $iFreamID = $this
        ->getAttributeByOtherAttributeValue('id', 'title', "Rich Text Editor, " . $el
        ->getAttribute('id'), 'iframe');
      if (!empty($iFreamID)) {
        $fieldId = $iFreamID;
      }
    }
    if (empty($fieldId)) {
      throw new \Exception('Could not find an id for the rich text editor field : ' . $locator);
    }
    $this
      ->getSession()
      ->executeScript("CKEDITOR.instances[\"{$fieldId}\"].setData(\"{$value}\");");
  }

  /**
   * Click a command button in the rich text editor.
   *
   * Varbase Context #varbase.
   *
   * Example 1: When I click on "bold" command button in the rich text editor field "Body"
   * Example 2: When I click on "media" command button in the rich text editor field "Body".
   *
   * @When /^I click on "([^"]*)" command button in the rich text editor field "([^"]*)"$/
   */
  public function iClickOnCommandButtonInTheRichTextEditorField($selectorCommand, $locator) {
    $el = $this
      ->getSession()
      ->getPage()
      ->findField($locator);
    $fieldId = $el
      ->getAttribute('id');
    if (empty($fieldId)) {
      throw new \Exception('Could not find an id for the rich text editor field : ' . $locator);
    }
    $this
      ->getSession()
      ->executeScript("CKEDITOR.instances[\"{$fieldId}\"].execCommand( '{$selectorCommand}' );");
  }

  /**
   * Append text at the end of a rich text editor field  WYSIWYG with content.
   *
   * Using the name of the field.
   *
   * Varbase Context #varbase.
   *
   * Example #1: When I append after the rich text editor field "Body" with "Test Body text"
   * Example #2: When I append the rich text editor field "Body" with "Test Body text"
   *
   * @When /^(?:|I )append(?:| after) the rich text editor field "([^"]*)" with "([^"]*)"$/
   */
  public function appendTheRichTextEditorField($locator, $value) {
    $el = $this
      ->getSession()
      ->getPage()
      ->findField($locator);
    $fieldId = $el
      ->getAttribute('id');
    if ($fieldId == NULL) {

      // If the WYSIWYG is in an ifream with no id.
      $iFreamID = $this
        ->getAttributeByOtherAttributeValue('id', 'title', "Rich Text Editor, " . $el
        ->getAttribute('id'), 'iframe');
      if (!empty($iFreamID)) {
        $fieldId = $iFreamID;
      }
    }
    if (empty($fieldId)) {
      throw new \Exception('Could not find an id for the rich text editor field : ' . $locator);
    }
    $this
      ->getSession()
      ->executeScript("CKEDITOR.instances[\"{$fieldId}\"].setData(CKEDITOR.instances[\"{$fieldId}\"].getData()+\"{$value}\");");
  }

  /**
   * Add append text at the end of rich text editor field WYSIWYG with content.
   *
   * Using the name of the field.
   * Varbase Context #varbase.
   *
   * Example #1: When I prepend before the rich text editor field "Body" with "Test Body text"
   * Example #2: When I prepend the rich text editor field "Body" with "Test Body text"
   *
   * @When /^(?:|I )prepend(?:| before) the rich text editor field "([^"]*)" with "([^"]*)"$/
   */
  public function prependTheRichTextEditorField($locator, $value) {
    $el = $this
      ->getSession()
      ->getPage()
      ->findField($locator);
    $fieldId = $el
      ->getAttribute('id');
    if ($fieldId == NULL) {

      // If the WYSIWYG is in an ifream with no id.
      $iFreamID = $this
        ->getAttributeByOtherAttributeValue('id', 'title', "Rich Text Editor, " . $el
        ->getAttribute('id'), 'iframe');
      if (!empty($iFreamID)) {
        $fieldId = $iFreamID;
      }
    }
    if (empty($fieldId)) {
      throw new \Exception('Could not find an id for the rich text editor field : ' . $locator);
    }
    $this
      ->getSession()
      ->executeScript("CKEDITOR.instances[\"{$fieldId}\"].setData(\"{$value}\"+CKEDITOR.instances[\"{$fieldId}\"].getData());");
  }

  /**
   * Move the focus to selected rich text editor field.
   *
   * Varbase Context #varbase.
   *
   * Example #1: When I move focus to "Title" rich text editor field
   * Example #2:  And I move focus to "Body" rich text editor field.
   *
   * @When /^(?:|I )move focus to "(?P<selectedField>[^"]*)" rich text editor field$/
   */
  public function moveFocusToTheRichTextEditorField($selectedField) {
    $el = $this
      ->getSession()
      ->getPage()
      ->findField($selectedField);
    $fieldid = $el
      ->getAttribute('id');
    if (empty($fieldid)) {
      throw new \Exception('Could not find an id for the rich text editor field : ' . $selectedField);
    }
    $this
      ->getSession()
      ->getDriver()
      ->evaluateScript("CKEDITOR.instances[\"{$fieldid}\"].focus();");
  }

  /**
   * Select all text in selected field input element.
   *
   * Varbase Context #varbase.
   *
   * Example #1: When I select all text in "Body" field
   * Example #2:  And I select all text in "Body" field.
   *
   * @When /^(?:|I )select all text in "(?P<selectedField>[^"]*)" rich text editor field$/
   */
  public function selectAllTextInTheRichTextEditorField($selectedField) {
    $el = $this
      ->getSession()
      ->getPage()
      ->findField($selectedField);
    $fieldid = $el
      ->getAttribute('id');
    if (empty($fieldid)) {
      throw new \Exception('Could not find an id for the rich text editor field : ' . $selectedField);
    }
    $this
      ->getSession()
      ->getDriver()
      ->evaluateScript("CKEDITOR.instances[\"{$fieldid}\"].execCommand('selectAll', false, null);");
    $this
      ->getSession()
      ->getDriver()
      ->evaluateScript("CKEDITOR.instances[\"{$fieldid}\"].forceNextSelectionCheck();");
    $this
      ->getSession()
      ->getDriver()
      ->evaluateScript("CKEDITOR.instances[\"{$fieldid}\"].selectionChange();");
  }

  /**
   * Images Functions.
   *
   * ==========================================================================.
   */

  /**
   * Find an image with the title text attribute.
   *
   * Varbase Context #varbase.
   *
   * Example 1: Then I should see image with the "Flag Earth" title text.
   *
   * @Then /^I should see image with the "([^"]*)" title text$/
   */
  public function iShouldSeeImageWithTheTitleText($titleText) {

    // Find an image with the title.
    $element = $this
      ->getSession()
      ->getPage()
      ->find('xpath', "//img[contains(@title, '{$titleText}')]");
    if (empty($element)) {
      throw new \Exception('The page dose not have an image with the [ ' . $titleText . ' ] title text.');
    }
  }

  /**
   * Find an image with the alt text attribute.
   *
   * Varbase Context #varbase.
   *
   * Example 1: Then I should see image with the "Flag Earth" alt text.
   *
   * @Then /^I should see image with the "([^"]*)" alt text$/
   */
  public function iShouldSeeImageWithTheAltText($altText) {

    // Find an image with the title.
    $element = $this
      ->getSession()
      ->getPage()
      ->find('xpath', "//img[contains(@alt, '{$altText}')]");
    if (empty($element)) {
      throw new \Exception('The page dose not have an image with the [ ' . $altText . ' ] Alt Text.');
    }
  }

  /**
   * Double click on an image with the provided title.
   *
   * Varbase Context #varbase.
   *
   * Example 1: I double on the image with the "Flag Earth image title" title text.
   *
   * @Given /^I double click on the image with the "([^"]*)" title text$/
   */
  public function iDoubleClickOnTheImageWithTheTitleText($titleText) {

    // Find an image with the title.
    $element = $this
      ->getSession()
      ->getPage()
      ->find('xpath', "//img[contains(@title, '{$titleText}')]");
    if (empty($element)) {
      throw new \Exception('The page dose not have an image with the [ ' . $titleText . ' ] title text.');
    }

    // Double click on the image.
    $element
      ->doubleClick();
  }

  /**
   * Click on an image with the provided title.
   *
   * Varbase Context #varbase.
   *
   * Example 1: I click on the image with the "Flag Earth image title" title text.
   *
   * @Given /^I click on the image with the "([^"]*)" title text$/
   */
  public function iClickOnTheImageWithTheTitleText($titleText) {

    // Find an image with the title.
    $element = $this
      ->getSession()
      ->getPage()
      ->find('xpath', "//img[contains(@title, '{$titleText}')]");
    if (empty($element)) {
      throw new \Exception('The page dose not have an image with the [ ' . $titleText . ' ] title text.');
    }

    // Click on the image.
    $element
      ->click();
  }

  /**
   * Double click on an image with the provided  alt Text.
   *
   * Varbase Context #varbase.
   *
   * Example 1: I double click on the image with the "Flag Earth image title" alt text.
   *
   * @Given /^I double click on the image with the "([^"]*)" alt text$/
   */
  public function iDoubleClickOnTheImageWithTheAltText($altText) {

    // Find an image with the title.
    $element = $this
      ->getSession()
      ->getPage()
      ->find('xpath', "//img[contains(@alt, '{$altText}')]");
    if (empty($element)) {
      throw new \Exception('The page dose not have an image with the [ ' . $altText . ' ] alt text.');
    }

    // Double click on the image.
    $element
      ->doubleClick();
  }

  /**
   * Click on an image with the provided alt.
   *
   * Varbase Context #varbase.
   *
   * Example 1: I click on the image with the "Flag Earth image title" alt text.
   *
   * @Given /^I click on the image with the "([^"]*)" alt text$/
   */
  public function iClickOnTheImageWithTheAltText($altText) {

    // Find an image with the title.
    $element = $this
      ->getSession()
      ->getPage()
      ->find('xpath', "//img[contains(@title, '{$altText}')]");
    if (empty($element)) {
      throw new \Exception('The page dose not have an image with the [ ' . $altText . ' ] title text.');
    }

    // Click on the image.
    $element
      ->click();
  }

  /**
   * Find an image with the title text attribute under a custom iframe.
   *
   * Varbase Context #varbase.
   *
   * Example 1: Then I should see image with the "Flag Earth" title text in the rich text editor field "Body"
   *
   * @Then /^I should see image with the "([^"]*)" title text in the rich text editor field "([^"]*)"$/
   */
  public function iShouldSeeImageWithTheTitleTextInTheRichTextEditorField($titleText, $locator) {
    $el = $this
      ->getSession()
      ->getPage()
      ->findField($locator);
    $fieldId = $el
      ->getAttribute('id');
    if (empty($fieldId)) {
      throw new \Exception('Could not find an id for the rich text editor field : ' . $locator);
    }
    $this
      ->getSession()
      ->executeScript("return CKEDITOR.instances[\"{$fieldId}\"].getData();");

    // Switch to the iframe.
    $iFreamID = $this
      ->getAttributeByOtherAttributeValue('id', 'title', $fieldId, 'iframe');
    $this
      ->getSession()
      ->switchToIFrame($iFreamID);

    // Find an image with the title.
    $element = $this
      ->getSession()
      ->getPage()
      ->findAll('xpath', "//img[contains(@title, '{$titleText}')]");
    if (empty($element)) {
      throw new \Exception('The page dose not have an image with the [ ' . $titleText . ' ] title text under [ ' . $locator . ' ].');
    }

    // Switch back too the page from the iframe.
    $this
      ->getSession()
      ->switchToIFrame(NULL);
  }

  /**
   * Find an image with the alt text attribute under a custom iframe.
   *
   * Varbase Context #varbase.
   *
   * Example 1: Then I should see image with the "Flag Earth" alt text in the rich text editor field "Body"
   *
   * @Then /^I should see image with the "([^"]*)" alt text in the rich text editor field "([^"]*)"$/
   */
  public function iShouldSeeImageWithTheAltTextUnder($altText, $filedName) {

    // Switch to the iframe.
    $iFreamID = $this
      ->getAttributeByOtherAttributeValue('id', 'title', $filedName, 'iframe');
    $this
      ->getSession()
      ->switchToIFrame($iFreamID);

    // Find an image with the title.
    $element = $this
      ->getSession()
      ->getPage()
      ->find('xpath', "//img[contains(@alt, '{$altText}')]");
    if (empty($element)) {
      throw new \Exception('The page dose not have an image with the [ ' . $altText . ' ] Alt Text under [ ' . $filedName . ' ].');
    }

    // Switch back too the page from the iframe.
    $this
      ->getSession()
      ->switchToIFrame(NULL);
  }

  /**
   * Mouse Functions.
   *
   * ==========================================================================.
   */

  /**
   * Move the mouse over an element.
   *
   * Varbase Context #varbase.
   *
   * Example #1: When I move the mouse over "header#navbar #main_menu ul.nav li a"
   * Example #2:  And I move the mouse over "hero_slider"
   *
   * @When /^I move the mouse over the "([^"]*)"$/
   */
  public function iMouseOver($selector) {
    $elem = $this
      ->getSession()
      ->getPage()
      ->find('css', $selector);
    if ($elem) {
      $elem
        ->mouseOver();
    }
    else {
      throw new \Exception("No element matching \"{$selector}\" is found.");
    }
  }

  /**
   * Double click on an element.
   *
   * Varbase Context #varbase.
   *
   * Example #1 : When I double click "Earth Flag Image"
   * Example #1 :  And I double click "input#username"
   *
   * @When /^I double click "([^"]*)"$/
   */
  public function iDoubleClick($selector) {
    $elem = $this
      ->getSession()
      ->getPage()
      ->find('css', $selector);
    if ($elem) {
      $elem
        ->doubleClick();
    }
    else {
      throw new \Exception("No element matching \"{$selector}\" is found.");
    }
  }

  /**
   * Right click on an element.
   *
   * Varbase Context #varbase.
   *
   * Example #1: When I right click "#right-click-to-configure a"
   * Example #2:  And I right click "Right click action box"
   *
   * @When /^I right click "([^"]*)"$/
   */
  public function iRightClick($selector) {
    $elem = $this
      ->getSession()
      ->getPage()
      ->find('css', $selector);
    if ($elem) {
      $elem
        ->rightClick();
    }
    else {
      throw new \Exception("No element matching \"{$selector}\" is found.");
    }
  }

  /**
   * Check if we do have the text in the selected element.
   *
   * Varbase Context #varbase.
   *
   * Example #1: Then I should see "your text" in the "ol" element with the "class" attribute set to "breadcrumb"
   * Example #2:  And I should see "your text" in the "div" element with the "id" attribute set to "right-panel"
   *
   * @Then /^I should see "(?P<text>[^"]*)" in the "(?P<htmlTagName>[^"]*)" element with the "(?P<attribute>[^"]*)" attribute set to "(?P<value>[^"]*)"$/
   */
  public function ishouldSeeTextInTheHtmlTagElement($text, $htmlTagName, $attribute, $value) {
    $elements = $this
      ->getSession()
      ->getPage()
      ->findAll('css', $htmlTagName);
    if (empty($elements)) {
      throw new \Exception(sprintf('The element "%s" was not found in the page', $htmlTagName));
    }
    $found = FALSE;
    foreach ($elements as $element) {
      $actual = $element
        ->getText();
      $actual = preg_replace('/\\s+/u', ' ', $actual);
      $regex = '/' . preg_quote($text, '/') . '/ui';
      if (preg_match($regex, $actual)) {
        $found = TRUE;
        break;
      }
    }
    if (!$found) {
      throw new \Exception(sprintf('"%s" was not found in the "%s" element', $text, $htmlTagName));
    }
    if (!empty($attribute)) {
      $attr = $element
        ->getAttribute($attribute);
      if (empty($attr)) {
        throw new \Exception(sprintf('The "%s" attribute is not present on the element "%s"', $attribute, $htmlTagName));
      }
      if (strpos($attr, "{$value}") === FALSE) {
        throw new \Exception(sprintf('The "%s" attribute does not equal "%s" on the element "%s"', $attribute, $value, $htmlTagName));
      }
    }
  }

  /**
   * Check if we do not have the text in the selected element.
   *
   * Varbase Context #varbase.
   *
   * Example #1: Then I should not see "your text" in the "ol" element with the "class" attribute set to "breadcrumb"
   * Example #2:  And I should not see "your text" in the "div" element with the "id" attribute set to "right-panel"
   *
   * @Then /^I should not see "(?P<text>[^"]*)" in the "(?P<htmlTagName>[^"]*)" element with the "(?P<attribute>[^"]*)" attribute set to "(?P<value>[^"]*)"$/
   */
  public function iShouldNotSeeTextInTheHtmlTagElement($text, $htmlTagName, $attribute, $value) {
    $elements = $this
      ->getSession()
      ->getPage()
      ->findAll('css', $htmlTagName);
    if (empty($elements)) {
      throw new \Exception(sprintf('The element "%s" was not found in the page', $htmlTagName));
    }
    $found = FALSE;
    foreach ($elements as $element) {
      $actual = $element
        ->getText();
      $actual = preg_replace('/\\s+/u', ' ', $actual);
      $regex = '/' . preg_quote($text, '/') . '/ui';
      if (preg_match($regex, $actual)) {
        $found = TRUE;
        break;
      }
    }
    if ($found) {
      throw new \Exception(sprintf('"%s" was found in the "%s" element', $text, $htmlTagName));
    }
    if (empty($attribute)) {
      $attr = $element
        ->getAttribute($attribute);
      if (empty($attr)) {
        throw new \Exception(sprintf('The "%s" attribute is present on the element "%s"', $attribute, $htmlTagName));
      }
      if (strpos($attr, "{$value}") === FALSE) {
        throw new \Exception(sprintf('The "%s" attribute does not equal "%s" on the element "%s"', $attribute, $value, $htmlTagName));
      }
    }
  }

  /**
   * Click on the text in the selected element.
   *
   * Varbase Context #varbase.
   *
   * Example #1: Then I click "your text" in the "ol" element with the "class" attribute set to "breadcrumb"
   * Example #2:  And I click "your text" in the "div" element with the "id" attribute set to "right-panel"
   *
   * @Then /^I click "(?P<text>[^"]*)" in the "(?P<htmlTagName>[^"]*)" element with the "(?P<attribute>[^"]*)" attribute set to "(?P<value>[^"]*)"$/
   */
  public function iClickTextInTheHtmlTagElement($text, $htmlTagName, $attribute, $value) {
    $elements = $this
      ->getSession()
      ->getPage()
      ->findAll('css', $htmlTagName);
    if (empty($elements)) {
      throw new \Exception(sprintf('The element "%s" was not found in the page', $htmlTagName));
    }
    $found = FALSE;
    foreach ($elements as $element) {
      $actual = $element
        ->getText();
      $actual = preg_replace('/\\s+/u', ' ', $actual);
      $regex = '/' . preg_quote($text, '/') . '/ui';
      if (preg_match($regex, $actual)) {
        $found = TRUE;
        $element
          ->click();
        break;
      }
    }
    if (!$found) {
      throw new \Exception(sprintf('"%s" was not found in the "%s" element', $text, $htmlTagName));
    }
    if (!empty($attribute)) {
      $attr = $element
        ->getAttribute($attribute);
      if (empty($attr)) {
        throw new \Exception(sprintf('The "%s" attribute is not present on the element "%s"', $attribute, $htmlTagName));
      }
      if (strpos($attr, "{$value}") === FALSE) {
        throw new \Exception(sprintf('The "%s" attribute does not equal "%s" on the element "%s"', $attribute, $value, $htmlTagName));
      }
    }
  }

  /**
   * Check if we do have a text in the input element.
   *
   * Example #1: Then I should see "your text" value in the "edit-items-2-target-id" input element
   * Example #2:  And I should see "Location property" value in the "edit-name" input element.
   *
   * @Then /^I should see "(?P<text>[^"]*)" value in the "(?P<selector>[^"]*)" input element$/
   */
  public function iShouldSeeValueInTheInputElement($text, $selector) {
    $elements = $this
      ->getSession()
      ->getPage()
      ->findAll('xpath', "//input[@id='{$selector}']");
    if (empty($elements)) {
      throw new \Exception(sprintf('The input element "%s" was not found in the page', $selector));
    }
    $found = FALSE;
    foreach ($elements as $element) {
      $elementTextValue = $element
        ->getValue();
      $actual = preg_replace('/\\s+/u', ' ', $elementTextValue);
      $regex = "/" . preg_quote($text, '/') . "/";
      if (preg_match($regex, $actual)) {
        $found = TRUE;
        break;
      }
    }
    if (!$found) {
      throw new \Exception(sprintf('"%s" value was not found in the "%s" input element', $text, $selector));
    }
  }

  /**
   * Check if we do have the text in the selected panel region.
   *
   * Using the code name of the panel region. or the html id.
   * Varbase Context #varbase.
   *
   * Example #1: Then I should see "Add new pane" in the "Center" panel region
   * Example #2: Then I should see "custom pane title" in the "Right side" panel region
   * Example #3:  And I should see "Add new pane" in the "panels-ipe-regionid-center" panel region.
   *
   * @Then /^I should see "(?P<text>[^"]*)" in the "(?P<panleRegion>[^"]*)" panel region$/
   */
  public function iShouldSeeInThePanelRegion($text, $panleRegion) {
    if (strpos($panleRegion, "panels-ipe-regionid-")) {
      $panleRegionId = $panleRegion;
    }
    else {
      $panleRegionId = "panels-ipe-regionid-" . str_replace(' ', '-', strtolower($panleRegion));
    }
    $elementPanelRegion = $this
      ->getSession()
      ->getPage()
      ->find('xpath', "//*[contains(@id, '{$panleRegionId}')]");
    if (empty($elementPanelRegion)) {
      throw new \Exception('The panle region [ ' . $panleRegion . ' ] is not in the page.');
    }
    $element = $this
      ->getSession()
      ->getPage()
      ->find('xpath', "//*[contains(@id, '{$panleRegionId}')]//*[text()='{$text}']");
    if (empty($element)) {
      throw new \Exception('The panle region "' . $panleRegion . '" dose not have "' . $text . '" in it.');
    }
  }

  /**
   * Check if we do not have the text in the selected panel region.
   *
   * Using the code name of the panel region. or the html id.
   * Varbase Context #varbase.
   *
   * Example #1: Then I should not see "Add new pane" in the "Center" panel region
   * Example #2: Then I should not see "custom pane title" in the "Right side" panel region
   * Example #3:  And I should not see "Add new pane" in the "panels-ipe-regionid-center" panel region.
   *
   * @Then /^I should not see "(?P<text>[^"]*)" in the "(?P<panleRegion>[^"]*)" panel region$/
   */
  public function iShouldNotSeeInThePanelRegion($text, $panleRegion) {
    if (strpos($panleRegion, "panels-ipe-regionid-")) {
      $panleRegionId = $panleRegion;
    }
    else {
      $panleRegionId = "panels-ipe-regionid-" . str_replace(' ', '-', strtolower($panleRegion));
    }
    $elementPanelRegion = $this
      ->getSession()
      ->getPage()
      ->find('xpath', "//*[contains(@id, '{$panleRegionId}')]");
    if (empty($elementPanelRegion)) {
      throw new \Exception('The panle region [ ' . $panleRegion . ' ] is not in the page.');
    }
    $element = $this
      ->getSession()
      ->getPage()
      ->find('xpath', "//*[contains(@id, '{$panleRegionId}')]//*[text()='{$text}']");
    if (!empty($element)) {
      throw new \Exception('The panle region "' . $panleRegion . '" dose have "' . $text . '" in it.');
    }
  }

  /**
   * Click on the text in the selected panel region.
   *
   * Using the code name of the panel region. or the html id.
   * Varbase Context #varbase.
   *
   * Example #1: When I click "Add new pane" in the "center" panel region
   * Example #2: When I click "Region style" in the "left" panel region
   * Example #3:  And I click "Add new pane" in the "panels-ipe-regionid-center" panel region.
   *
   * @When /^I click "(?P<text>[^"]*)" in the "(?P<panleRegion>[^"]*)" panel region$/
   */
  public function iClickInThePanelRegion($text, $panleRegion) {
    if (strpos($panleRegion, "panels-ipe-regionid-")) {
      $panleRegionId = $panleRegion;
    }
    else {
      $panleRegionId = "panels-ipe-regionid-" . str_replace(' ', '-', strtolower($panleRegion));
    }
    $elementpanelRegion = $this
      ->getSession()
      ->getPage()
      ->find('xpath', "//*[contains(@id, '{$panleRegionId}')]");
    if (empty($elementpanelRegion)) {
      throw new \Exception('The panle region [ ' . $panleRegion . ' ] is not in the page.');
    }
    $element = $this
      ->getSession()
      ->getPage()
      ->find('xpath', "//*[contains(@id, '{$panleRegionId}')]//*[text()='{$text}']");
    if (empty($element)) {
      throw new \Exception('The panle region "' . $panleRegion . '" dose not have "' . $text . '".');
    }
    $element
      ->click();
  }

  /**
   * Alert Functions.
   *
   * ==========================================================================.
   */

  /**
   * Accept alert if present.
   *
   * Varbase Context #varbase.
   *
   * Example #1: When I accept alert
   * Example #2: And accept alert.
   *
   * @when /^(?:|I )accept alert$/
   */
  public function acceptAlert() {
    try {
      $this
        ->getSession()
        ->getDriver()
        ->getWebDriverSession()
        ->accept_alert();
    } catch (Exception $e) {

      // no-op, alert might not be present.
    }
  }

  /**
   * Dismiss alert if present.
   *
   * Varbase Context #varbase.
   *
   * Example #1: When I dismiss alert
   * Example #2:  And dismiss alert.
   *
   * @when /^(?:|I )dismiss alert$/
   */
  public function iDismissAlert() {
    try {
      $this
        ->getSession()
        ->getDriver()
        ->getWebDriverSession()
        ->dismiss_alert();
    } catch (Exception $e) {

      // no-op, alert might not be present.
    }
  }

  /**
   * Print the text of the current alert message.
   *
   * Varbase Context #varbase.
   *
   * Example #1: When I print alert text
   * Example #2:  And print alert text.
   *
   * @When /^(?:|I ) print alert text$/
   */
  public function iPrintAlertText() {
    try {
      return $this
        ->getSession()
        ->getDriver()
        ->getWebDriverSession()
        ->getAlert_text();
    } catch (Exception $e) {

      // no-op, alert might not be present.
    }
  }

  /**
   * Fill a text in the alert message.
   *
   * Varbase Context #varbase.
   *
   * Example #1: When I fill "See this alert" in alert
   * Example #2:  And fill "See this text" in alert.
   *
   * @When /^(?:|I )fill "(?P<text>[^"]*)" in alert$/
   */
  public function iFillInAlert($message) {
    try {
      $this
        ->getSession()
        ->getDriver()
        ->getWebDriverSession()
        ->postAlert_text($message);
    } catch (Exception $e) {

      // no-op, alert might not be present.
    }
  }

  /**
   * Press a modifier and other key.
   *
   * Modifier options: { ctrl, shift, alt } key options.
   * Varbase Context #varbase.
   *
   * Example #1: When I press "ctrl" and "v"
   * Example #2: When I press "alt" and "f"
   * Example #3:  And I press "ctrl" and "r"
   *
   * @When I press :modifier and :key in :field field
   */
  public function iPressModifierAndKeys($modifier, $key, $field) {
    static $keys = [
      'backspace' => 8,
      'tab' => 9,
      'enter' => 13,
      'shift' => 16,
      'ctrl' => 17,
      'alt' => 18,
      'pause' => 19,
      'break' => 19,
      'escape' => 27,
      'esc' => 27,
      'end' => 35,
      'home' => 36,
      'left' => 37,
      'up' => 38,
      'right' => 39,
      'down' => 40,
      'insert' => 45,
      'delete' => 46,
      'pageup' => 33,
      'pagedown' => 34,
      'capslock' => 20,
    ];
    static $modifiers = [
      'shift' => 16,
      'ctrl' => 17,
      'alt' => 18,
    ];
    $key = is_numeric($key) ? $key : ord($key);
    $isCtrlKeyArg = $modifier == 'ctrl' ? "true" : "false";
    $isAltKeyArg = $modifier == 'alt' ? "true" : "false";
    $isShiftKeyArg = $modifier == 'shift' ? "true" : "false";

    // Validate the modifier keys.
    if (is_string($modifier)) {
      if (strlen($modifier) < 1) {
        throw new \Exception('Modifier parameter was empty. one of \'shift\', \'alt\', \'ctrl\'');
      }
      elseif (strlen($modifier) > 1) {

        // One of 'shift', 'alt', 'ctrl'.
        $filteredModifier = strtolower(str_replace(' ', '', $modifier));
        if (isset($modifiers[$filteredModifier])) {
          $modifier = $modifiers[$filteredModifier];
        }
        else {
          throw new \Exception('Modifier parameter must be one of \'shift\', \'alt\', \'ctrl\'');
        }
      }
    }

    // Validate the other key.
    if (is_string($key)) {
      if (strlen($key) < 1) {
        throw new \Exception('Key parameter was empty.');
      }
      elseif (strlen($key) > 1) {

        // Support for all variations, e.g. ESC, Esc, page up, pageup.
        $filteredKey = strtolower(str_replace(' ', '', $key));
        if (isset($keys[$filteredKey])) {
          $key = $keys[$filteredKey];
        }
        else {
          throw new \Exception('Key parameter must a keyboard key');
        }
      }
    }
    $elementField = $this
      ->getSession()
      ->getPage()
      ->findField($field);
    if (!$elementField) {
      throw new \Exception("Field '{$field}' not found");
    }
    $fieldid = $elementField
      ->getAttribute('id');
    $js = <<<JS
var node = document.getElementById("{<span class="php-variable">$fieldid</span>}");
var keyEvent = document.createEvent('KeyboardEvent');
keyEvent.initKeyEvent('keypress',        // typeArg,
                       true,             // canBubbleArg,
                       true,             // cancelableArg,
                       window,             // viewArg,
                       {<span class="php-variable">$isCtrlKeyArg</span>},             // ctrlKeyArg,
                       {<span class="php-variable">$isAltKeyArg</span>},            // altKeyArg,
                       {<span class="php-variable">$isShiftKeyArg</span>},            // shiftKeyArg,
                       false,            // metaKeyArg,
                       {<span class="php-variable">$key</span>},       // keyCodeArg,
                       {<span class="php-variable">$key</span>}      // charCodeArg);
                     );
node.dispatchEvent(keyEvent);
JS;
    $this
      ->getSession()
      ->executeScript($js);
  }

  /**
   * Fill a text in the alert message.
   *
   * Varbase Context #varbase.
   *
   * Example #1: Given I drag and drop ".element-item" to ".target"
   * Example #2:  When I drag and drop "#panels-ipe-regionid-left .panels-ipe-portlet-wrapper" to "#panels-ipe-regionid-center .panels-ipe-sort-container"
   * Example #3:   And I drag and drop ".item-1" to ".target-2"
   *
   * @Given /^I drag and drop "([^"]*)" to "([^"]*)"$/
   */
  public function iDragAndDropTo($draggedElement, $targetElement) {
    $dragged = $this
      ->getSession()
      ->getPage()
      ->find('css', $draggedElement);
    if (empty($dragged)) {
      throw new \Exception('The selected dragged element [ ' . $draggedElement . ' ] is not in the page.');
    }
    $target = $this
      ->getSession()
      ->getPage()
      ->find('css', $targetElement);
    if (empty($target)) {
      throw new \Exception('The selected target element [ ' . $targetElement . ' ] is not in the page.');
    }
    $this
      ->getSession()
      ->getDriver()
      ->evaluateScript("jQuery('{$draggedElement}').detach().prependTo('{$targetElement}');");
  }

  /**
   * Select a radio button.
   *
   * Varbase Context #varbase.
   *
   * Example #1: When I select the "Male" radio button
   * Example #2:  And I select the "Male" radio button
   *
   * @When /^I select the "([^"]*)" radio button$/
   */
  public function iSelectTheRadioButton($labelText) {

    // Find the label by its text, then use that to get the radio item's ID.
    $radioId = NULL;

    /** @var $label NodeElement */
    foreach ($this
      ->getSession()
      ->getPage()
      ->findAll('css', 'label') as $label) {
      if ($labelText === $label
        ->getText()) {
        if ($label
          ->hasAttribute('for')) {
          $radioId = $label
            ->getAttribute('for');
          break;
        }
        else {
          throw new \Exception("Radio button's label needs the 'for' attribute to be set");
        }
      }
    }
    if (!$radioId) {
      throw new \InvalidArgumentException("Label '{$labelText}' not found.");
    }

    // Now use the ID to retrieve the button and click it.
    // @var NodeElement $radioButton.
    $radioButton = $this
      ->getSession()
      ->getPage()
      ->find('css', "#{$radioId}");
    if (!$radioButton) {
      throw new \Exception("{$labelText} radio button not found.");
    }
    $this
      ->getSession()
      ->getPage()
      ->fillField($radioId, $radioButton
      ->getAttribute('value'));
  }

  /**
   * Click on the label with the for attribute value.
   *
   * Linked to the an ID of a radio button with a value to select the radio
   * option. we need to use this when we do have a list of radio buttons
   * but we do have the label with extra HTML tags like images or the actual
   * radio button is hidden.
   * Varbase Context #varbase.
   *
   * Example #1: Given I click on the radio label for "right_sidebar_layout" value
   * Example #2:  When I click on the radio label for "layout-settings" value
   *
   * @Given /^I click on the radio label for "([^"]*)" value$/
   */
  public function iClickOnTheRadioLabelForValue($value) {
    $radio_label = $this
      ->getSession()
      ->getPage()
      ->find('xpath', "//label[contains(@for, '{$value}')]");
    if ($radio_label) {
      $radio_label
        ->click();
    }
    else {
      throw new \Exception("No label with the value of for='" . $value . "' radio button not found.");
    }
  }

  /**
   * Expand a field group by its id attribute.
   *
   * Varbase Context #varbase.
   *
   * Example #1: When I expand the field "Field Group ID"
   * Example #2:  And I expand the field "More options"
   *
   * @When I expand the field :arg1
   */
  public function iExpandThefield($fieldID) {
    $js = <<<JS
    var group = document.getElementById("{<span class="php-variable">$fieldID</span>}");
    group.setAttribute("open","");
JS;
    $this
      ->getSession()
      ->executeScript($js);
  }

  /**
   * Expand a select list by it's class attribute.
   *
   * Varbase Context #varbase.
   *
   * Example #1: When I expand the "1" select list "dropbutton-multiple"
   * Example #2:  And I expand the "2" select list "Editor Styling options"
   *
   * @When I expand the :nth select list :arg1
   */
  public function iExpandTheSelectList($index, $listClassName) {
    $js = <<<JS
    var group = document.getElementsByClassName("{<span class="php-variable">$listClassName</span>}")[{<span class="php-variable">$index</span>}];
    group.className += "open";
JS;
    $this
      ->getSession()
      ->executeScript($js);
  }

  /**
   * Scroll down in the current status of the page, about 350 down.
   *
   * Varbase Context #varbase.
   *
   * Example #1: When I scrolldown
   * Example #2:  And I scrolldown.
   *
   * @When I scrolldown
   */
  public function iScrolldown() {
    $this
      ->getSession()
      ->executeScript("javascript:window.scrollBy(200,350)");
  }

  /**
   * Scroll up in the current status of the page, about 350 up.
   *
   * Varbase Context #varbase.
   *
   * Example #1: When I scrollup.
   *
   * @When I scrollup
   */
  public function iScrollup() {
    $this
      ->getSession()
      ->executeScript("javascript:window.scrollBy(0,-350)");
  }

  /**
   * Check if the Image media browser opened.
   *
   * Varbase Context #varbase.
   *
   * Example #1: Then the image media browser should be open
   * Example #2:  And the image media browser should be open
   *
   * @Then /^the image media browser should be open$/
   */
  public function theImageMediaBrowserIsOpen() {
    if (!$this
      ->getSession()
      ->getPage()
      ->find('css', '.ui-dialog.ui-widget-content')) {
      throw new \Exception('The image media browser failed to open.');
    }
  }

  /**
   * Check if the media browser with the selected iframe id is open.
   *
   * Varbase Context #varbase.
   *
   * Example #1: Then the "editor_media_browser" media browser should be open
   * Example #2:  And the "multiple_image_browser" media browser should be open
   *
   * @Then /^the "([^"]*)" media browser should be open$/
   */
  public function theMediaBrowserIsOpen($entityBrowserIframeId) {
    if (!$this
      ->getSession()
      ->getPage()
      ->find('css', '.ui-dialog.ui-widget-content')) {
      throw new \Exception('The media browser failed to open.');
    }
    if (!$this
      ->getSession()
      ->getPage()
      ->find('css', "#{$entityBrowserIframeId}")) {
      throw new \Exception("{$entityBrowserIframeId} is not found.");
    }
  }

  /**
   * Find an element with a selected index having the first attribute.
   *
   * Check if it's have the second one.
   * Varbase Context #varbase.
   *
   * Example #1: Then I should see the "1" "wrapper" with "align2right" class
   * Example #2:  And I should see the "2" "wrapper" with "align2right" class
   *
   * @Then I should see the :nth :arg1 with :arg2 class
   */
  public function iShouldSeeTheElementWithTheIndexHavingTheAttribute($index, $wrapper, $position) {
    $items = $this
      ->getSession()
      ->getPage()
      ->findAll('css', '.' . $wrapper);
    $item = $items[$index]
      ->find('css', '.' . $wrapper . '.' . $position);
    if (!$item) {
      throw new \Exception("The image position is wrong");
    }
  }

  /**
   * Resize the current window browser to a selected width and height.
   *
   * Varbase Context #varbase.
   *
   * Example #1: And I resize the current window to width="1280" and height="600"
   * Example #2: And I resize the current window to width="1280" and height="600"
   *
   * @Given /^I resize the current window to width="([^"]*)" and height="([^"]*)"$/
   */
  public function resizeTheCurrentWindowToWidthAndHeight($width, $height) {
    $this
      ->getSession()
      ->resizeWindow((int) $width, (int) $height, 'current');
  }

  /**
   * Switch to an ifram by its id.
   *
   * Varbase Context #varbase.
   *
   * Example #1: When I switch to iframe "entity_browser_iframe_media_browser"
   * Example #2:  And I switch to iframe "remote-video-media"
   *
   * @When /^(?:|I )switch to iframe "([^"]*)"$/
   */
  public function iSwitchToIframe($iFrameLocator) {
    $this
      ->getSession()
      ->getDriver()
      ->switchToIFrame($iFrameLocator);
  }

  /**
   * Switch to the main frame or the parent ifram.
   *
   * Varbase Context #varbase.
   *
   * Example #1: When I switch to main fram
   * Example #2: When I switch to parent
   *
   * @When /^(?:|I )switch to main frame$/
   * @When /^(?:|I )switch to parent$/
   */
  public function iSwitchToParent() {
    $this
      ->getSession()
      ->getDriver()
      ->switchToIFrame(NULL);
  }

  /**
   * Helper function to let you get the value of an attribute name.
   *
   * For an HTML tag by other Attribute name and value.
   *
   * @param string $attributeName
   *   The attribute name.
   * @param string $otherAttributeName
   *   The other attribute name.
   * @param string $otherAttributeValue
   *   The other attribute value.
   * @param string $htmlTagName
   *   The HTML tag name you are filtring with.
   *
   * @return string
   *   Attribute value for the first matching element.
   */
  private function getAttributeByOtherAttributeValue($attributeName, $otherAttributeName, $otherAttributeValue, $htmlTagName = "*") {
    $element = $this
      ->getSession()
      ->getPage()
      ->find('xpath', "//{$htmlTagName}[contains(@{$otherAttributeName}, '{$otherAttributeValue}')]");
    return $element
      ->getAttribute($attributeName);
  }

  /**
   * Select a paragraph component.
   *
   * Varbase Context #varbase.
   *
   * Example 1: When I select the "Drupal block" paragraph component
   * Example 2:  And I select the "Modal" paragraph component
   *
   * @When /^I select (?:|the )"([^"]*)" paragraph component$/
   */
  public function iSelectTheParagraphComponent($value) {
    $this
      ->getSession()
      ->getPage()
      ->find('xpath', '//*[contains(@class, "paragraphs-add-dialog") and contains(@class, "ui-dialog-content")]//*[contains(@name, "' . $value . '")]')
      ->click();
  }

  /**
   * Matching element exists on the page after a wait.
   *
   * @param string $selector_type
   *   The element selector type (css, xpath).
   * @param string|array $selector
   *   The element selector.
   * @param int $timeout
   *   (optional) Timeout in milliseconds, defaults to 10000.
   */
  public function matchingElementAfterWait($selector_type, $selector, $timeout = 10000) {
    $start = microtime(TRUE);
    $end = $start + $timeout / 1000;
    $page = $this
      ->getSession()
      ->getPage();
    do {
      $node = $page
        ->find($selector_type, $selector);
      if (empty($node)) {
        return FALSE;
      }
      usleep(100000);
    } while (microtime(TRUE) < $end);
    return TRUE;
  }

  /**
   * Accept Alerts Before going to the next step.
   *
   * @BeforeStep @AcceptAlertsBeforStep
   */
  public function beforeStepAcceptAlert(BeforeStepScope $scope) {
    try {
      $this
        ->getSession()
        ->getDriver()
        ->getWebDriverSession()
        ->accept_alert();
    } catch (Exception $e) {

      // no-op, alert might not be present.
    }
  }

  /**
   * Accept Alerts After going to the next step.
   *
   * @AftereStep @AcceptAlertsAfterStep
   */
  public function afterStepAcceptAlert(AfterStepScope $scope) {
    try {
      $this
        ->getSession()
        ->getDriver()
        ->getWebDriverSession()
        ->accept_alert();
    } catch (Exception $e) {

      // no-op, alert might not be present.
    }
  }

  /**
   * Dismiss Alerts Before going to the next step.
   *
   * @BeforeStep @AcceptAlertsBeforStep
   */
  public function beforeStepDismissAlert(BeforeStepScope $scope) {
    try {
      $this
        ->getSession()
        ->getDriver()
        ->getWebDriverSession()
        ->dismiss_alert();
    } catch (Exception $e) {

      // no-op, alert might not be present.
    }
  }

  /**
   * Dismiss Alerts After going to the next step.
   *
   * @AftereStep @DismissAlertsAfterStep
   */
  public function afterStepDismissAlert(AfterStepScope $scope) {
    try {
      $this
        ->getSession()
        ->getDriver()
        ->getWebDriverSession()
        ->dismiss_alert();
    } catch (Exception $e) {

      // no-op, alert might not be present.
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
VarbaseContext::$parameters protected property Hold all passed parameters.
VarbaseContext::$users protected property Hold the user name and password from drupal_users parameters.
VarbaseContext::$varbaseUsers protected property Hold the user name and password from varbase_users parameters.
VarbaseContext::acceptAlert public function Accept alert if present.
VarbaseContext::afterStepAcceptAlert public function Accept Alerts After going to the next step.
VarbaseContext::afterStepDismissAlert public function Dismiss Alerts After going to the next step.
VarbaseContext::appendTheRichTextEditorField public function Append text at the end of a rich text editor field WYSIWYG with content.
VarbaseContext::beforeStepAcceptAlert public function Accept Alerts Before going to the next step.
VarbaseContext::beforeStepDismissAlert public function Dismiss Alerts Before going to the next step.
VarbaseContext::cleanUsers public function Clean users.
VarbaseContext::getAttributeByOtherAttributeValue private function Helper function to let you get the value of an attribute name.
VarbaseContext::iAmloggedInUserWithTheUser public function Authenticate a user with password from varbase configuration.
VarbaseContext::iAmLoggedInUserWithTheUsernameAndPassword public function Authenticate a user with a given username and password on the spot.
VarbaseContext::iClickButtonUnderTheEditorMediaBrowser public function Click on a link or button under the editor media browser.
VarbaseContext::iClickInThePanelRegion public function Click on the text in the selected panel region.
VarbaseContext::iClickOnCommandButtonInTheRichTextEditorField public function Click a command button in the rich text editor.
VarbaseContext::iClickOnTheImageWithTheAltText public function Click on an image with the provided alt.
VarbaseContext::iClickOnTheImageWithTheTitleText public function Click on an image with the provided title.
VarbaseContext::iClickOnTheRadioLabelForValue public function Click on the label with the for attribute value.
VarbaseContext::iClickOnTheTabUnderTheMediaBrowser public function Click on a tab under the editor media browser.
VarbaseContext::iClickTextInTheHtmlTagElement public function Click on the text in the selected element.
VarbaseContext::iClickTheEditorMediaBrowserCommandButton public function Click the editor media browser command button.
VarbaseContext::iDismissAlert public function Dismiss alert if present.
VarbaseContext::iDoubleClick public function Double click on an element.
VarbaseContext::iDoubleClickOnTheImageWithTheAltText public function Double click on an image with the provided alt Text.
VarbaseContext::iDoubleClickOnTheImageWithTheTitleText public function Double click on an image with the provided title.
VarbaseContext::iDragAndDropTo public function Fill a text in the alert message.
VarbaseContext::iExpandThefield public function Expand a field group by its id attribute.
VarbaseContext::iExpandTheSelectList public function Expand a select list by it's class attribute.
VarbaseContext::iFillInAlert public function Fill a text in the alert message.
VarbaseContext::iFillInFieldUnderTheEditorMediaBrowser public function Fill in a form field with id|name|title|alt|value.
VarbaseContext::iFillInTheRichTextEditorField public function Fill in a rich text editor field WYSIWYG with content.
VarbaseContext::iGoToWebsite public function Navigate directly to an external web site.
VarbaseContext::iLogout public function Logout from the current session.
VarbaseContext::iMouseOver public function Move the mouse over an element.
VarbaseContext::iPressModifierAndKeys public function Press a modifier and other key.
VarbaseContext::iPressTheButtonUnderTheEditorMediaBrowser public function Press a button in the filter form under the editor media browser.
VarbaseContext::iPrintAlertText public function Print the text of the current alert message.
VarbaseContext::iRightClick public function Right click on an element.
VarbaseContext::iScrolldown public function Scroll down in the current status of the page, about 350 down.
VarbaseContext::iScrollup public function Scroll up in the current status of the page, about 350 up.
VarbaseContext::iSelectTheFileUnderTheEditorMediaBrowser public function Select the file under the editor media browser.
VarbaseContext::iSelectTheParagraphComponent public function Select a paragraph component.
VarbaseContext::iSelectTheRadioButton public function Select a radio button.
VarbaseContext::iShouldNotSeeInThePanelRegion public function Check if we do not have the text in the selected panel region.
VarbaseContext::iShouldNotSeeTextInTheHtmlTagElement public function Check if we do not have the text in the selected element.
VarbaseContext::iShouldNotSeeTextUnderTheeEitorMediaBrowser public function Check if we can NOT see a text under the editor media browser.
VarbaseContext::iShouldSeeImageWithTheAltText public function Find an image with the alt text attribute.
VarbaseContext::iShouldSeeImageWithTheAltTextUnder public function Find an image with the alt text attribute under a custom iframe.
VarbaseContext::iShouldSeeImageWithTheTitleText public function Find an image with the title text attribute.
VarbaseContext::iShouldSeeImageWithTheTitleTextInTheRichTextEditorField public function Find an image with the title text attribute under a custom iframe.
VarbaseContext::iShouldSeeImageWithTheTitleTextUnderTheEditorMediaBrowser public function Find an image with the title text attribute.
VarbaseContext::iShouldSeeInThePanelRegion public function Check if we do have the text in the selected panel region.
VarbaseContext::ishouldSeeTextInTheHtmlTagElement public function Check if we do have the text in the selected element.
VarbaseContext::iShouldSeeTextUnderTheEditorMediaBrowser public function Check if we can see a text under the editor media browser.
VarbaseContext::iShouldSeeTheElementWithTheIndexHavingTheAttribute public function Find an element with a selected index having the first attribute.
VarbaseContext::iShouldSeeValueInTheInputElement public function Check if we do have a text in the input element.
VarbaseContext::iSwitchToIframe public function Switch to an ifram by its id.
VarbaseContext::iSwitchToParent public function Switch to the main frame or the parent ifram.
VarbaseContext::iWaitForMinutes public function Wait for minutes before going to the next step.
VarbaseContext::iWaitForSeconds public function Wait for seconds before going to the next step.
VarbaseContext::iWaitMaxOfSecondsForThePageToBeReadyAndLoaded public function Wait max of seconds for the page to be ready and loaded.
VarbaseContext::matchingElementAfterWait public function Matching element exists on the page after a wait.
VarbaseContext::moveFocusToTheRichTextEditorField public function Move the focus to selected rich text editor field.
VarbaseContext::prependTheRichTextEditorField public function Add append text at the end of rich text editor field WYSIWYG with content.
VarbaseContext::resizeTheCurrentWindowToWidthAndHeight public function Resize the current window browser to a selected width and height.
VarbaseContext::selectAllTextInTheRichTextEditorField public function Select all text in selected field input element.
VarbaseContext::theEitorMediaBrowserIsOpen public function Check if the editor media browser is open.
VarbaseContext::theImageMediaBrowserIsOpen public function Check if the Image media browser opened.
VarbaseContext::theMediaBrowserIsOpen public function Check if the media browser with the selected iframe id is open.
VarbaseContext::__construct public function Initializes context.