Merge branch 'MDL-32657-master-1' of git://git.luns.net.uk/moodle
[moodle.git] / lib / pear / README.txt
blob75abd055ad00f7d9ac8a006da0800d88e5d291fb
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 Spreadsheet_Excel_Writer classes:
18     - Current version: 0.9.1
19     - by Xavier Noguer and Mika Tuupola
20     - License: LGPL
21     - http://pear.php.net/package/Spreadsheet_Excel_Writer
22 - PEAR OLE classes:
23     - Current version: 0.5
24     - by Xavier Noguer
25     - License: PHP (Permission given to Moodle to redistribute under GPL)
26     - http://pear.php.net/package/OLE
27 - PEAR HTML_Quickform:
28     - Current version: 3.2.6
29     - by Bertrand Mansion, Adam Daniel, Alexey Borzov
30     - License: PHP (Permission given to Moodle to redistribute under GPL)
31     - http://pear.php.net/package/HTML_Quickform
32 - PEAR HTML_Quickform_Renderer_Tableless:
33     - Current version: 0.3.4
34     - by Mark Wiesemann
35     - License: PHP (Permission given to Moodle to redistribute under GPL)
36     - http://pear.php.net/package/HTML_QuickForm_Renderer_Tableless
37 - PEAR HTML_QuickForm_DHTMLRulesTableless:
38     - Current version: 0.1.2
39     - by Alexey Borzov, Adam Daniel, Bertrand Mansion, Justin Patrin, Mark Wiesemann
40     - License: PHP (Permission given to Moodle to redistribute under GPL)
41     - http://pear.php.net/package/HTML_QuickForm_DHTMLRulesTableless
42 - PEAR HTML_Common:
43     - Current version: 1.2.2
44     - by Adam Daniel, Bertrand Mansion, Klaus Guenther, Alexey Borzov,
45     - License: PHP  (Permission given to Moodle to redistribute under GPL)
46     - http://pear.php.net/package/HTML
47 - PEAR main class:
48     - Current version: 1.4.5
49     - by Stig Bakken, Thomas V.V.Cox, Pierre-Alain Joye,
50       Greg Beaver and Martin Jansen
51     - License: PHP
52     - http://pear.php.net/package/PEAR
53 - PEAR HTTP_WebDAV_Server
54     - Current version: HEAD @ 28-01-2008
55     - by Hartmut Holzgraefe and Christian Stocker
56     - License: BSD
57     - http://pear.php.net/package/HTTP_WebDAV_Server
58 - PEAR HTML_AJAX:
59     - Current version: 0.5.6
60     - by Elizabeth Smith, Arpad Ray, Joshua Eichorn, David Coallier and Laurent Yaish
61     - License: LGPL
62     - http://pear.php.net/package/HTML_AJAX/
63 - PEAR Auth_RADIUS:
64     - Current version: 1.0.6 (2008-04-13)
65     - by Michael Bretterklieber
66     - License: BSD
67     - http://pear.php.net/package/Auth_RADIUS
68 - PEAR Crypt_CHAP:
69     - Current Version: 1.0.1 (2007-03-14)
70     - by Michael Bretterklieber
71     - License: BSD
72     - http://pear.php.net/package/Crypt_CHAP
73 - PEAR XML_Parser:
74     - Current Version: 1.3.2 (2009-01-21)
75     - by Stephan Schmidt, Stig Bakken, Tomas V.V.Cox
76     - License: BSD
77     - http://pear.php.net/package/XML_Parser
81 ----------------------------------------------------------------
82 A NOTE TO DEVELOPERS
83 ================================================================
85 We must not use these classes directly ever. Instead we must build
86 and use wrapper classes to isolate Moodle code from internal PEAR
87 implementations, allowing us to migrate if needed to other
88 libraries in the future. For an example of wrapped classes,
89 see the excel.class.lib file, that includes code to build
90 Excel files using the cool library inside PEAR, but using
91 the old calls used before Moodle 1.6 to maintain compatibility.
93 Please, don't forget it! Always use wrapper classes/functions!
95 Ciao,
96 Eloy Lafuente, 2005-12-17 :-)
100 ----------------------------------------------------------------
101 A NOTE ON THE PHP LICENSE AND MOODLE
102 ================================================================
104 Everything in Moodle in pure GPL.  This pear directory is the only
105 part of the distribution that is not.
107 There is some question about how PHP-licensed software can be
108 included within a GPL-licensed distribution like Moodle, specifically
109 the clause that annoyingly says no derivative of the software can
110 include the name PHP.
112 We don't intend to rename Moodle to anything of the sort, obviously,
113 but to help people downstream who could possibly want to do so,
114 we have sought special permission from the authors of these classes
115 to allow us an exemption on this point so that we don't need to
116 change our nice clean GPL license.
118 Several authors have given Moodle explicit permission to distribute
119 their PHP-licensed PEAR classes in the Moodle distribution, allowing
120 anybody using these classes ONLY as part of the Moodle distribution
121 exemption from clauses of the PHP license that could cause
122 conflict with the main GNU Public License that Moodle uses.
124 We are still waiting to hear back from the others but we assume
125 for now that it will likewise be OK.
127 If you are at all worried about this situation you can simply delete
128 this directory from Moodle and it will use your installed PEAR
129 libraries instead.
131 Cheers,
132 Martin Dougiamas, 2 April 2006