[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  declare(strict_types=1);
  18  
  19  /**
  20   * Behat data generator for comments
  21   *
  22   * @package     core_comment
  23   * @copyright   2022 Paul Holden <paulh@moodle.com>
  24   * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  25   */
  26  class behat_core_comment_generator extends behat_generator_base {
  27  
  28      /**
  29       * Get a list of the entities that can be created for this component
  30       *
  31       * @return array[]
  32       */
  33      protected function get_creatable_entities(): array {
  34          return [
  35              'Comments' => [
  36                  'singular' => 'Comment',
  37                  'datagenerator' => 'comment',
  38                  'required' => [
  39                      'contextlevel',
  40                      'reference',
  41                      'component',
  42                      'area',
  43                      'content',
  44                  ],
  45              ],
  46          ];
  47      }
  48  
  49      /**
  50       * Pre-process comment, populate context property
  51       *
  52       * @param array $comment
  53       * @return array
  54       */
  55      protected function preprocess_comment(array $comment): array {
  56          $comment['context'] = $this->get_context($comment['contextlevel'], $comment['reference']);
  57          unset($comment['contextlevel'], $comment['reference']);
  58  
  59          return $comment;
  60      }
  61  }