[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 attachment 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  
  27  use core_xapi\xapi_exception;
  28  use core_xapi\iri;
  29  use stdClass;
  30  
  31  /**
  32   * Abstract xAPI attachment class.
  33   *
  34   * @copyright  2020 Ferran Recio
  35   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36   */
  37  class item_attachment extends item {
  38  
  39      /**
  40       * Function to create an item from part of the xAPI statement.
  41       *
  42       * @param stdClass $data the original xAPI element
  43       * @return item item_attachment xAPI generated
  44       */
  45      public static function create_from_data(stdClass $data): item {
  46  
  47          if (empty($data->usageType)) {
  48              throw new xapi_exception("missing attachment usageType");
  49          }
  50          if (!iri::check($data->usageType)) {
  51              throw new xapi_exception("attachment usageType $data->usageType is not a valid IRI");
  52          }
  53          if (empty($data->display)) {
  54              throw new xapi_exception("missing attachment display");
  55          }
  56          if (empty($data->contentType)) {
  57              throw new xapi_exception("missing attachment contentType");
  58          }
  59          if (empty($data->length)) {
  60              throw new xapi_exception("missing attachment length");
  61          }
  62          if (!is_numeric($data->length)) {
  63              throw new xapi_exception("invalid attachment length format");
  64          }
  65          if (empty($data->sha2)) {
  66              throw new xapi_exception("missing attachment sha2");
  67          }
  68  
  69          // More required property checks will appear here in the future.
  70  
  71          return new self($data);
  72      }
  73  }