lib/ltiprovider/readme_moodle.txt

   1 LTI Tool Provider Library PHP
   2 =============================
   3
   4 Some changes from the upstream version have been made:
   5 * Define consumer profile member variable for ToolConsumer class
   6 * Added context type property for Context class
   7 * Set context type if 'context_type' parameter was submitted through POST
   8 * Do not require tool_consumer_instance_guid
   9 These changes can be reverted once the following pull requests/issues have been integrated upstream:
  10 * https://github.com/IMSGlobal/LTI-Tool-Provider-Library-PHP/pull/10/commits/a9a1641f1a593eba4638133245c21d9ad47d8680
  11 * https://github.com/IMSGlobal/LTI-Tool-Provider-Library-PHP/pull/11/commits/0bae60389bd020a02be5554516b86336e651e237
  12 * https://github.com/IMSGlobal/LTI-Tool-Provider-Library-PHP/issues/19
  13
  14 It is recommended by upstream to install depdencies via composer - but the composer installation is bundled
  15 with an autoloader so it's better to do it manually.
  16
  17 Information
  18 -----------
  19
  20 URL: https://github.com/IMSGlobal/LTI-Tool-Provider-Library-PHP/wiki
  21 License: Apache License, Version 2.0
  22
  23 Installation
  24 ------------
  25
  26 1) Download the latest version of the provider library
  27 wget https://github.com/IMSGlobal/LTI-Tool-Provider-Library-PHP/archive/3.0.3.zip
  28
  29 2) Unzip the archive
  30 unzip 3.0.3.zip
  31
  32 3) Move the source code directory into place
  33 mv LTI-Tool-Provider-Library-PHP-3.0.3/* lib/ltiprovider/
  34
  35 4) Updates
  36 Check that the following pull request is included in the release.
  37 Then remove this step from this file.
  38 https://github.com/IMSGlobal/LTI-Tool-Provider-Library-PHP/pull/13
  39 If not, apply manually.
  40
  41 5) Run unit tests on enrol_lti_testsuite
  42
  43 Upgrading Notes
  44 ---------------
  45
  46 Check if there are any new changes to the database schema. To do this, view the logs
  47 since the last release for the data connector base class and the mysql data connector.
  48
  49 https://github.com/IMSGlobal/LTI-Tool-Provider-Library-PHP/compare/3.0.2...3.0.3
  50
  51 src/ToolProvider/DataConnector/DataConnector.php
  52 src/ToolProvider/DataConnector/DataConnector_mysql.php
  53
  54 In case of any changes we may need to update
  55
  56 enrol/lti/classes/data_connector.php
  57 enrol/lti/db/install.xml
  58 enrol/lti/db/upgrade.php