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 * Prevent modification of the request to the provider
  10 These changes can be reverted once the following pull requests have been integrated upstream:
  11 * https://github.com/IMSGlobal/LTI-Tool-Provider-Library-PHP/pull/10
  12 * https://github.com/IMSGlobal/LTI-Tool-Provider-Library-PHP/pull/11
  13 * https://github.com/IMSGlobal/LTI-Tool-Provider-Library-PHP/pull/47
  14 * https://github.com/IMSGlobal/LTI-Tool-Provider-Library-PHP/pull/48
  15
  16 This local changes can be reverted once it's checked that they are present upstream (note the
  17 LTI-Tool-Provider-Library-PHP repo has been archived so it doesn't accept pull requests anymore):
  18 * MDL-67034 php74 compliance fixes
  19
  20 It is recommended by upstream to install depdencies via composer - but the composer installation is bundled
  21 with an autoloader so it's better to do it manually.
  22
  23 Information
  24 -----------
  25
  26 URL: https://github.com/IMSGlobal/LTI-Tool-Provider-Library-PHP/wiki
  27 License: Apache License, Version 2.0
  28
  29 Installation
  30 ------------
  31
  32 1) Download the latest version of the provider library
  33 wget https://github.com/IMSGlobal/LTI-Tool-Provider-Library-PHP/archive/3.0.3.zip
  34
  35 2) Unzip the archive
  36 unzip 3.0.3.zip
  37
  38 3) Move the source code directory into place
  39 mv LTI-Tool-Provider-Library-PHP-3.0.3/* lib/ltiprovider/
  40
  41 4) Updates
  42 Check that the following pull request is included in the release.
  43 Then remove this step from this file.
  44 https://github.com/IMSGlobal/LTI-Tool-Provider-Library-PHP/pull/13
  45 If not, apply manually.
  46
  47 5) Run unit tests on enrol_lti_testsuite
  48
  49 Upgrading Notes
  50 ---------------
  51
  52 Check if there are any new changes to the database schema. To do this, view the logs
  53 since the last release for the data connector base class and the mysql data connector.
  54
  55 https://github.com/IMSGlobal/LTI-Tool-Provider-Library-PHP/compare/3.0.2...3.0.3
  56
  57 src/ToolProvider/DataConnector/DataConnector.php
  58 src/ToolProvider/DataConnector/DataConnector_mysql.php
  59
  60 In case of any changes we may need to update
  61
  62 enrol/lti/classes/data_connector.php
  63 enrol/lti/db/install.xml
  64 enrol/lti/db/upgrade.php