[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   * Extract record vault preprocessor.
  19   *
  20   * @package    mod_forum
  21   * @copyright  2019 Ryan Wyllie <ryan@moodle.com>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace mod_forum\local\vaults\preprocessors;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  use moodle_database;
  30  use core\dml\table as dml_table;
  31  
  32  /**
  33   * Extract record vault preprocessor.
  34   *
  35   * Extract record vault preprocessor. Typically used to separate out records
  36   * when two tables have been joined together in a query.
  37   *
  38   * @copyright  2019 Ryan Wyllie <ryan@moodle.com>
  39   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  40   */
  41  class extract_record {
  42      /** @var \core\dml\table $table The table object relating to the table that the records were loaded from */
  43      private $table;
  44  
  45      /**
  46       * Constructor.
  47       *
  48       * @param string $table The table name where the records were loaded from
  49       * @param string $alias The table alias used as the record property prefix
  50       */
  51      public function __construct(string $table, string $alias) {
  52          $this->table = new dml_table($table, $alias, $alias);
  53      }
  54  
  55      /**
  56       * Extract a record embedded in the properties of another record out into a
  57       * separate record.
  58       *
  59       * @param stdClass[] $records The list of records to process
  60       * @return stdClass[] The extracted records
  61       */
  62      public function execute(array $records) : array {
  63          return array_map(function($record) {
  64              return $this->table->extract_from_result($record);
  65          }, $records);
  66      }
  67  }