Merge branch 'MDL-71860-master' of git://github.com/lameze/moodle
[moodle.git] / lib / pear / README.txt
blob2138d2b01e16e3af2cac6021c179172b5f5e4340
1 PEAR Libraries
2 ====================================================================
5 This directory (lib/pear) contains unmodified copies of some
6 libraries from the standard PEAR distribution (http://pear.php.net).
8 We include these in Moodle solely for the convenience of sites that
9 may not have PEAR installed.
11 If this directory is DELETED from Moodle then Moodle will search
12 the standard PHP directories and use the PEAR libraries there instead.
15 In detail, the libraries added here are:
17 - PEAR HTML_Quickform:
18     - Current version: 3.2.6
19     - by Bertrand Mansion, Adam Daniel, Alexey Borzov
20     - License: PHP (Permission given to Moodle to redistribute under GPL)
21     - http://pear.php.net/package/HTML_Quickform
22 - PEAR HTML_Quickform_Renderer_Tableless:
23     - Current version: 0.3.4
24     - by Mark Wiesemann
25     - License: PHP (Permission given to Moodle to redistribute under GPL)
26     - http://pear.php.net/package/HTML_QuickForm_Renderer_Tableless
27 - PEAR HTML_QuickForm_DHTMLRulesTableless:
28     - Current version: 0.1.2
29     - by Alexey Borzov, Adam Daniel, Bertrand Mansion, Justin Patrin, Mark Wiesemann
30     - License: PHP (Permission given to Moodle to redistribute under GPL)
31     - http://pear.php.net/package/HTML_QuickForm_DHTMLRulesTableless
32 - PEAR HTML_Common:
33     - Current version: 1.2.2
34     - by Adam Daniel, Bertrand Mansion, Klaus Guenther, Alexey Borzov,
35     - License: PHP  (Permission given to Moodle to redistribute under GPL)
36     - http://pear.php.net/package/HTML
37 - PEAR main class:
38     - Current version: 1.4.5
39     - by Stig Bakken, Thomas V.V.Cox, Pierre-Alain Joye,
40       Greg Beaver and Martin Jansen
41     - License: PHP
42     - http://pear.php.net/package/PEAR
43 - PEAR HTML_AJAX:
44     - Current version: 0.5.6
45     - by Elizabeth Smith, Arpad Ray, Joshua Eichorn, David Coallier and Laurent Yaish
46     - License: LGPL
47     - http://pear.php.net/package/HTML_AJAX/
49 ----------------------------------------------------------------
50 A NOTE TO DEVELOPERS
51 ================================================================
53 We must not use these classes directly ever. Instead we must build
54 and use wrapper classes to isolate Moodle code from internal PEAR
55 implementations, allowing us to migrate if needed to other
56 libraries in the future. For an example of wrapped classes,
57 see the excel.class.lib file, that includes code to build
58 Excel files using the cool library inside PEAR, but using
59 the old calls used before Moodle 1.6 to maintain compatibility.
61 Please, don't forget it! Always use wrapper classes/functions!
63 Ciao,
64 Eloy Lafuente, 2005-12-17 :-)
68 ----------------------------------------------------------------
69 A NOTE ON THE PHP LICENSE AND MOODLE
70 ================================================================
72 Everything in Moodle in pure GPL.  This pear directory is the only
73 part of the distribution that is not.
75 There is some question about how PHP-licensed software can be
76 included within a GPL-licensed distribution like Moodle, specifically
77 the clause that annoyingly says no derivative of the software can
78 include the name PHP.
80 We don't intend to rename Moodle to anything of the sort, obviously,
81 but to help people downstream who could possibly want to do so,
82 we have sought special permission from the authors of these classes
83 to allow us an exemption on this point so that we don't need to
84 change our nice clean GPL license.
86 Several authors have given Moodle explicit permission to distribute
87 their PHP-licensed PEAR classes in the Moodle distribution, allowing
88 anybody using these classes ONLY as part of the Moodle distribution
89 exemption from clauses of the PHP license that could cause
90 conflict with the main GNU Public License that Moodle uses.
92 We are still waiting to hear back from the others but we assume
93 for now that it will likewise be OK.
95 If you are at all worried about this situation you can simply delete
96 this directory from Moodle and it will use your installed PEAR
97 libraries instead.
99 Cheers,
100 Martin Dougiamas, 2 April 2006