[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   * Statement base object for xAPI structure checking and usage.
  19   *
  20   * @package    core_xapi
  21   * @copyright  2020 Ferran Recio
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core_xapi\local\statement;
  26  use stdClass;
  27  use JsonSerializable;
  28  use core_xapi\iri;
  29  
  30  defined('MOODLE_INTERNAL') || die();
  31  
  32  /**
  33   * Item class used for xAPI statement elements without validation.
  34   *
  35   * @copyright  2020 Ferran Recio
  36   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  37   */
  38  class item implements JsonSerializable {
  39  
  40      /** @var stdClass the item structure. */
  41      protected $data;
  42  
  43      /**
  44       * Item constructor.
  45       *
  46       * @param stdClass $data from the specific xAPI element
  47       */
  48      protected function __construct(stdClass $data) {
  49          $this->data = $data;
  50      }
  51  
  52      /**
  53       * Function to create an item from part of the xAPI statement.
  54       *
  55       * @param stdClass $data the original xAPI element
  56       * @return item the xAPI item generated
  57       */
  58      public static function create_from_data(stdClass $data): item {
  59          return new self($data);
  60      }
  61  
  62      /**
  63       * Return the data to serialize in case JSON statement is needed.
  64       *
  65       * @return stdClass the original data structure
  66       */
  67      public function jsonSerialize(): stdClass {
  68          return $this->get_data();
  69      }
  70  
  71      /**
  72       * Return the original data from this item.
  73       *
  74       * @return stdClass the original data structure
  75       */
  76      public function get_data(): stdClass {
  77          return $this->data;
  78      }
  79  }