Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.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');
> require_once(__DIR__ . '/../../../lib/behat/behat_deprecated_base.php');
< use Behat\Mink\Exception\ElementNotFoundException as ElementNotFoundException, < Behat\Gherkin\Node\TableNode as TableNode, < Behat\Gherkin\Node\PyStringNode as PyStringNode;
> use Behat\Mink\Exception\ElementNotFoundException as ElementNotFoundException;
/**
< * Deprecated behat step definitions.
> * Steps definitions that are now deprecated and will be removed in the next releases. > * > * This file only contains the steps that previously were in the behat_*.php files in the SAME DIRECTORY. > * When deprecating steps from other components or plugins, create a behat_COMPONENT_deprecated.php > * file in the same directory where the steps were defined.
* * @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 {
> class behat_deprecated extends behat_deprecated_base {
/**
< * Throws an exception if $CFG->behat_usedeprecated is not allowed.
> * Clicks link with specified id|title|alt|text in the flat navigation drawer.
*
< * @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
> * @When /^I select "(?P<link_string>(?:[^"]|\\")*)" from flat navigation drawer$/ > * @param string $link > * @deprecated Since Moodle 4.0
*/
< 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:'; < }
> public function i_select_from_flat_navigation_drawer(string $link) { > $this->deprecated_message(['i_select_from_primary_navigation', 'i_select_from_secondary_navigation']);
< // Add all alternatives to the message. < foreach ($alternatives as $alternative) { < $message .= PHP_EOL . '- ' . $alternative;
> $this->execute('behat_navigation::i_open_flat_navigation_drawer'); > $this->execute('behat_general::i_click_on_in_the', [$link, 'link', '#nav-drawer', 'css_element']);
}
< < 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); < } <
}