[Summary view]

   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 data generator for core_payment.
  19   *
  20   * @package    core_payment
  21   * @category   test
  22   * @copyright  2020 Marina Glancy
  23   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  
  26  
  27  /**
  28   * Behat data generator for core_payment.
  29   *
  30   * @package    core_payment
  31   * @category   test
  32   * @copyright  2020 Marina Glancy
  33   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  34   */
  35  class behat_core_payment_generator extends behat_generator_base {
  36  
  37      /**
  38       * Get a list of the entities that can be created.
  39       *
  40       * @return array entity name => information about how to generate.
  41       */
  42      protected function get_creatable_entities(): array {
  43          return [
  44              'payment accounts' => [
  45                  'singular' => 'payment account',
  46                  'datagenerator' => 'payment_account',
  47                  'required' => ['name'],
  48              ],
  49              'payments' => [
  50                  'singular' => 'payment',
  51                  'datagenerator' => 'payment',
  52                  'required' => ['account', 'amount', 'user'],
  53                  'switchids' => ['account' => 'accountid', 'user' => 'userid'],
  54              ],
  55          ];
  56      }
  57  
  58      /**
  59       * Look up the id of a account from its name.
  60       *
  61       * @param string $accountname
  62       * @return int corresponding id.
  63       */
  64      protected function get_account_id(string $accountname): int {
  65          global $DB;
  66  
  67          if (!$id = $DB->get_field('payment_accounts', 'id', ['name' => $accountname])) {
  68              throw new Exception('There is no account with name "' . $accountname . '".');
  69          }
  70          return $id;
  71      }
  72  }