Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.
   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  /**
  18   * Behat steps definitions for drag and drop onto image.
  19   *
  20   * @package   qtype_ddimageortext
  21   * @category  test
  22   * @copyright 2015 The Open University
  23   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  
  26  // NOTE: no MOODLE_INTERNAL test here, this file may be required by behat before including /config.php.
  27  
  28  require_once (__DIR__ . '/../../../../../lib/behat/behat_base.php');
  29  
  30  /**
  31   * Steps definitions related with the drag and drop onto image question type.
  32   *
  33   * @copyright 2015 The Open University
  34   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   */
  36  class behat_qtype_ddimageortext extends behat_base {
  37  
  38      /**
  39       * Get the xpath for a given drag item.
  40       * @param string $dragitem the text of the item to drag.
  41       * @return string the xpath expression.
  42       */
  43      protected function drag_xpath($dragitem) {
  44          return '//div[contains(concat(" ", @class, " "), " draghome ") and ' .
  45                  'contains(normalize-space(.), "' . $this->escape($dragitem) . '") and not(contains(@class, "dragplaceholder"))]';
  46      }
  47  
  48      /**
  49       * Get the xpath for a given drop box.
  50       * @param string $placenumber the number of the drop box.
  51       * @return string the xpath expression.
  52       */
  53      protected function drop_xpath($placenumber) {
  54          return '//div[contains(concat(" ", @class, " "), " dropzone ") and ' .
  55                  'contains(concat(" ", @class, " "), " place' . $placenumber . ' ")]';
  56      }
  57  
  58      /**
  59       * Drag the drag item with the given text to the given space.
  60       *
  61       * @param string $dragitem the text of the item to drag.
  62       * @param int $placenumber the number of the place to drop into.
  63       *
  64       * @Given /^I drag "(?P<drag_item>[^"]*)" to place "(?P<place_number>\d+)" in the drag and drop onto image question$/
  65       */
  66      public function i_drag_to_place_in_the_drag_and_drop_onto_image_question($dragitem, $placenumber) {
  67          $generalcontext = behat_context_helper::get('behat_general');
  68          $generalcontext->i_drag_and_i_drop_it_in($this->drag_xpath($dragitem),
  69                  'xpath_element', $this->drop_xpath($placenumber), 'xpath_element');
  70      }
  71  
  72      /**
  73       * Type some characters while focussed on a given drop box.
  74       *
  75       * @param string $keys the characters to type.
  76       * @param int $placenumber the number of the place to drop into.
  77       *
  78       * @Given /^I type "(?P<keys>[^"]*)" on place "(?P<place_number>\d+)" in the drag and drop onto image question$/
  79       */
  80      public function i_type_on_place_in_the_drag_and_drop_onto_image_question($keys, $placenumber) {
  81          $node = $this->get_selected_node('xpath_element', $this->drop_xpath($placenumber));
  82          $this->ensure_node_is_visible($node);
  83  
  84          $node->focus();
  85          foreach (str_split($keys) as $key) {
  86              behat_base::type_keys($this->getSession(), [$key]);
  87              $this->wait_for_pending_js();
  88          }
  89      }
  90  }