|
12 | 12 | - 9. [KNOWN COMPATIBILITY PROBLEMS](#SECTION9)
|
13 | 13 | - 10. [FREQUENTLY ASKED QUESTIONS (FAQ)](#SECTION10)
|
14 | 14 | - 11. [LEGAL INFORMATION](#SECTION11)
|
| 15 | +- 12. [MIGRATION GUIDE](#SECTION12) |
15 | 16 |
|
16 | 17 | *Note regarding translations: In the event of errors (e.g., discrepancies between translations, typos, etc), the English version of the README is considered the original and authoritative version. If you find any errors, your assistance in correcting them would be welcomed.*
|
17 | 18 |
|
@@ -238,17 +239,11 @@ https://github.com/phpMussel/phpMussel>v2
|
238 | 239 | │ Changelog-v2.txt
|
239 | 240 | │ codeception.yml
|
240 | 241 | │ composer.json
|
241 |
| -│ CONTRIBUTING.md |
242 | 242 | │ LICENSE.txt
|
243 | 243 | │ loader.php
|
244 |
| -│ PEOPLE.md |
245 | 244 | │ README.md
|
246 |
| -│ SECURITY.md |
247 | 245 | │ web.config
|
248 | 246 | │
|
249 |
| -├───.github |
250 |
| -│ ISSUE_TEMPLATE.md |
251 |
| -│ |
252 | 247 | ├───tests
|
253 | 248 | │ │ .gitignore
|
254 | 249 | │ │ acceptance.suite.yml
|
@@ -322,6 +317,7 @@ https://github.com/phpMussel/phpMussel>v2
|
322 | 317 | │ │ Demojibakefier.php
|
323 | 318 | │ │ Events.php
|
324 | 319 | │ │ L10N.php
|
| 320 | +│ │ Matrix.php |
325 | 321 | │ │ NumberFormatter.php
|
326 | 322 | │ │ YAML.php
|
327 | 323 | │ │
|
@@ -869,7 +865,7 @@ Compatibility directives for phpMussel.
|
869 | 865 | - This directive should generally be disabled unless it's required for correct functionality of phpMussel on your specific system. Normally, when disabled, when phpMussel detects the presence of elements in the `$_FILES` array(), it'll attempt to initiate a scan of the files that those elements represent, and, if those elements are blank or empty, phpMussel will return an error message. This is proper behaviour for phpMussel. However, for some CMS, empty elements in `$_FILES` can occur as a result of the natural behaviour of those CMS, or errors may be reported when there aren't any, in which case, the normal behaviour for phpMussel will be interfering with the normal behaviour of those CMS. If such a situation occurs for you, enabling this option will instruct phpMussel to not attempt to initiate scans for such empty elements, ignore them when found and to not return any related error messages, thus allowing continuation of the page request. False = OFF; True = ON.
|
870 | 866 |
|
871 | 867 | ##### "only_allow_images"
|
872 |
| -- If you only expect or only intend to allow images to be uploaded to your system or CMS, and if you absolutely don't require any files other than images to be uploaded to your system or CMS, this directive should be enabled, but should otherwise be disabled. If this directive is enabled, it'll instruct phpMussel to indiscriminately block any uploads identified as non-image files, without scanning them. This may reduce processing time and memory usage for attempted uploads of non-image files. False = OFF; True = ON. |
| 868 | +- When set to true, any files encountered by the scanner which aren't images will be flagged immediately, without being scanned. This may help reduce the time needed to complete a scan in some cases. Set to false by default. |
873 | 869 |
|
874 | 870 | #### "heuristic" (Category)
|
875 | 871 | Heuristic directives.
|
@@ -1759,4 +1755,61 @@ Alternatively, there's a brief (non-authoritative) overview of GDPR/DSGVO availa
|
1759 | 1755 | ---
|
1760 | 1756 |
|
1761 | 1757 |
|
| 1758 | +### 12. <a name="SECTION12"></a>MIGRATION GUIDE |
| 1759 | + |
| 1760 | +#### 12.0 MIGRATING FROM v0 TO v1 |
| 1761 | + |
| 1762 | +##### 12.0.0 SUMMARY |
| 1763 | + |
| 1764 | +There are significant backwards-incompatible changes between v0 and v1, to the extent they could almost be regarded as entirely different packages. Also, at the time of writing this migrating guide, v0 has already reached EoL since a long time ago, so starting again afresh with a completely new installation is the most recommended way forward (preferably just skipping ahead directly to v2 or newer, if possible). |
| 1765 | + |
| 1766 | +##### 12.0.1 REQUIREMENTS |
| 1767 | + |
| 1768 | +phpMussel v1 requires at least PHP 5.4 or newer with PCRE support. Ensure you meet the requirements before attempting to install, update, or migrate. BZ2 support, cURL support, LZF support, RAR support, and ZIP support is also strongly recommended (though the package should still mostly function without it). |
| 1769 | + |
| 1770 | +##### 12.0.2 BACKWARDS-INCOMPATIBLE CHANGES, DEPRECATIONS, ETC |
| 1771 | + |
| 1772 | +Too many to list. |
| 1773 | + |
| 1774 | +##### 12.0.3 NEW FEATURES, BENEFITS, OTHER CHANGES, ETC |
| 1775 | + |
| 1776 | +Too many to list. |
| 1777 | + |
| 1778 | +#### 12.1 MIGRATING FROM v1 TO v2 |
| 1779 | + |
| 1780 | +##### 12.1.0 SUMMARY |
| 1781 | + |
| 1782 | +Some backwards-incompatible changes exist between v1 and v2, and migrating directly from the front-end isn't possible. If you haven't changed anything at your existing installation at all (e.g., configuration hasn't changed from any of the default values, no new plugins or signature files have been installed, no custom signatures, etc), or if you don't care about retaining your existing configuration, customistaions, any old logs or other old data, just starting again afresh with a completely new installation would be the easiest, simplest, and most recommended way forward. Otherwise, if you want to preserve anything from your existing installation, follow the steps below to migrate manually from v1 to v2. |
| 1783 | + |
| 1784 | +##### 12.1.1 REQUIREMENTS |
| 1785 | + |
| 1786 | +phpMussel v2 requires at least PHP 7.2 or newer with PCRE support. Ensure you meet the requirements before attempting to install, update, or migrate. BZ2 support, cURL support, LZF support, RAR support, and ZIP support is also strongly recommended (though the package should still mostly function without it). |
| 1787 | + |
| 1788 | +##### 12.1.2 BACKWARDS-INCOMPATIBLE CHANGES, DEPRECATIONS, ETC |
| 1789 | + |
| 1790 | +- Minimum requirements raised. |
| 1791 | +- Some small changes to the loader. |
| 1792 | +- The code for processing plugins shifted from the loader to the functions file and reworked. |
| 1793 | +- Numerous configuration directives renamed in order to implement snake_case. |
| 1794 | + |
| 1795 | +##### 12.1.3 NEW FEATURES, BENEFITS, OTHER CHANGES, ETC |
| 1796 | + |
| 1797 | +- Support for 4 additional languages added (20 total supported by v1; 24 total supported by v2). |
| 1798 | +- Very slight overall performance improvements may be noticeable in some circumstances. |
| 1799 | +- Slightly stronger typecasting and future-proofing. |
| 1800 | +- Codebase refactored to take advantage of syntax and features available to PHP since the raised minimum requirements (e.g., scalar parameter type hints, return type declarations, generators, etc). |
| 1801 | + |
| 1802 | +##### 12.1.4 STEPS TO MIGRATE |
| 1803 | + |
| 1804 | +*To-do.* |
| 1805 | + |
| 1806 | +#### 12.2 MIGRATING FROM v2 TO v3 |
| 1807 | + |
| 1808 | +##### 12.2.0 SUMMARY |
| 1809 | + |
| 1810 | +v3 doesn't exist yet. More information will be provided at a later time, when it becomes relevant. |
| 1811 | + |
| 1812 | +--- |
| 1813 | + |
| 1814 | + |
1762 | 1815 | Last Updated: 1 March 2020 (2020.03.01).
|
0 commit comments