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.
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * Steps definitions that will be deprecated in the next releases.
 *
 * @package    core
 * @category   test
 * @copyright  2013 David MonllaĆ³
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

// NOTE: no MOODLE_INTERNAL test here, this file may be required by behat before including /config.php.

require_once(__DIR__ . '/../../../lib/behat/behat_base.php');

use Behat\Mink\Exception\ElementNotFoundException as ElementNotFoundException,
    Behat\Gherkin\Node\TableNode as TableNode,
    Behat\Gherkin\Node\PyStringNode as PyStringNode;

/**
 * Deprecated behat step definitions.
 *
 * @package    core
 * @category   test
 * @copyright  2013 David MonllaĆ³
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class behat_deprecated extends behat_base {

    /**
< * Docks a block. Editing mode should be previously enabled. < * @throws ExpectationException < * @param string $blockname < * @return void < * @deprecated since Moodle 3.7 MDL-64506 - please do not use this definition step any more. < * @todo MDL-65215 This will be deleted in Moodle 3.11. < */ < public function i_dock_block($blockname) { < < $message = "Block docking is no longer used as of MDL-64506. Please update your tests."; < $this->deprecated_message($message); < < // Looking for both title and alt. < $xpath = "//input[@type='image'][@title='" . get_string('dockblock', 'block', $blockname) . "' or @alt='" . get_string('addtodock', 'block') . "']"; < $this->execute('behat_general::i_click_on_in_the', < array($xpath, "xpath_element", $this->escape($blockname), "block") < ); < } < < /**
* Throws an exception if $CFG->behat_usedeprecated is not allowed. * * @throws Exception * @param string|array $alternatives Alternative/s to the requested step * @param bool $throwexception If set to true we always throw exception, irrespective of behat_usedeprecated setting. * @return void */ protected function deprecated_message($alternatives, $throwexception = false) { global $CFG; // We do nothing if it is enabled. if (!empty($CFG->behat_usedeprecated) && !$throwexception) { return; } if (is_scalar($alternatives)) { $alternatives = array($alternatives); } // Show an appropriate message based on the throwexception flag. if ($throwexception) { $message = 'This step has been removed. Rather than using this step you can:'; } else { $message = 'Deprecated step, rather than using this step you can:'; } // Add all alternatives to the message. foreach ($alternatives as $alternative) { $message .= PHP_EOL . '- ' . $alternative; } if (!$throwexception) { $message .= PHP_EOL . '- Set $CFG->behat_usedeprecated in config.php to allow the use of deprecated steps if you don\'t have any other option'; } throw new Exception($message); } }