[Summary view]

Differences Between: [Versions 310 and 403] [Versions 311 and 403] [Versions 39 and 403] [Versions 400 and 403] [Versions 401 and 403]

   1  <?php
   2  
   3  namespace IMSGlobal\LTI\Profile;
   4  
   5  /**
   6  
   7   * Class to represent a resource handler message object
   8   *
   9   * @author  Stephen P Vickers <svickers@imsglobal.org>
  10   * @copyright  IMS Global Learning Consortium Inc
  11   * @date  2016
  12   * @version 3.0.0
  13   * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
  14   */
  15  
  16  #[\AllowDynamicProperties]
  17  class Message
  18  {
  19  
  20  /**
  21   * LTI message type.
  22   *
  23   * @var string $type
  24   */
  25      public $type = null;
  26  /**
  27   * Path to send message request to (used in conjunction with a base URL for the Tool Provider).
  28   *
  29   * @var string $path
  30   */
  31      public $path = null;
  32  /**
  33   * Capabilities required by message.
  34   *
  35   * @var array $capabilities
  36   */
  37      public $capabilities = null;
  38  /**
  39   * Variable parameters to accompany message request.
  40   *
  41   * @var array $variables
  42   */
  43      public $variables = null;
  44  /**
  45   * Fixed parameters to accompany message request.
  46   *
  47   * @var array $constants
  48   */
  49      public $constants = null;
  50  
  51  
  52  /**
  53   * Class constructor.
  54   *
  55   * @param string $type          LTI message type
  56   * @param string $path          Path to send message request to
  57   * @param array  $capabilities  Array of capabilities required by message
  58   * @param array  $variables     Array of variable parameters to accompany message request
  59   * @param array  $constants     Array of fixed parameters to accompany message request
  60   */
  61      function __construct($type, $path, $capabilities = array(), $variables = array(), $constants = array())
  62      {
  63  
  64          $this->type = $type;
  65          $this->path = $path;
  66          $this->capabilities = $capabilities;
  67          $this->variables = $variables;
  68          $this->constants = $constants;
  69  
  70      }
  71  
  72  }