Potential backward compatibility issues in Joomla 1.7 and Joomla Platform 11.2
From Joomla! Documentation
Revision as of 12:13, 29 August 2012 by Tom Hutchison
- 1 Platform
- 2 CMS
- 3 References
This documents track potential backward compatibility issues for Joomla 1.7 and Joomla Platform 11.1 which will be included in Joomla 1.7. Listed are issues which potentially breaks extensions and newly deprecated APIs.
Please help making this document complete.
The base of this comparison is Joomla 1.6.
- JPATH_PLATFORM is now used instead of JPATH_LIBRARIES (JPATH_LIBRARIES will continue to be supported for version 1.7)
JDatabaseQuery is now abstract due of the work done to support new database engines (Windows Azure and Microsoft SQL Server). This means you must use
$db->getQuery(true); to instantiate a query as is the correct practice in Joomla 1.6.
The getConnectors method formerly supported a file called driver.php that it searched for in a folder with the same name as the database, such as /mydatabasename/driver.php. This seems never to have actually been used in the core. If you have a driver with that structure simply rename the file with the name of the database (mydatabasename.php) and place it in the libraries/database/database folder. The files and class names for database support that are currently in that folder can be used as models for this.
- getHeadData(), setHeadData() and mergeHeadData() are from now on only present in JDocumentHTML. They have been removed from JDocument and JDocumentXML.
- JDocumentHTML::$_links has changed to a multidimensional array. Also the rendering of the link elements has been moved from JDocumentHTML to JDocumentRenderHead.
- A div element with the ID "system-message-container" is always rendered, whether there are messages or not. This ID should not be used in any extension or template.
JError & JException
JError and JException have been deprecated with Joomla Platform 11.1. Please see Exceptions and Logging in Joomla 1.7 and Joomla Platform 11.1 for more information.
- JLoader can't load files multiple times anymore.
- JLog has shifted to joomla.log.log from joomla.error.log and features support for multiple loggers.
- JModuleHelper::getModule can now match a module either with the name (usually mod_something) or module (usually something without the mod_ prefix) which means that parameters will be used if there is an instance of the module. If a faux name was being used to generate a module without parameters that will no longer work.
- The unused parameter $akey has been removed from JURI::buildQuery().
- JUpdater:: arrayUnique() has been deprecated Use JArrayHelper::arrayUnique() instead. Note that the later is static.
- MooTools Core has been updated to version 1.3.2, MooTools More to 188.8.131.52. Due to a change in JSON handling a slight change in behavior can occur. More details can be found on the MooTools Wiki.
- checkAll() has been deprecated, use Joomla.checkAll() instead. Note that Joomla.checkAll() doesn't include some legacy functionality.
General Coding Principles
Within the new Joomla release cycle, developers need to be conscious of more frequent changes to version numbers. If you are doing hard checks against, for example, a version number exactly equal to "1.6" then as we move to 1.7, those checks may fail with unexpected results. You should ensure that version checks appropriately allow for future increments like 1.7, 1.8, 2.0, 3.0, and so on.
- TinyMCE has been updated to the 3.4 series requiring new language files and potentially breaking TinyMCE plug-ins. As of 1.7 RC1, version 184.108.40.206 is distributed.
- MooTools Core and MooTools More will not always be loaded in the backend as it was in the past. Extensions have to specifically include it using
JHtml::_('behavior.framework');for Core and adding the 'true' option for More.
- The link to "View Site" is no longer included in mod_status. Administrator templates have to add it themselves.
- mod_online and mod_status have been removed
- mod_menu uses a class instead of an id attribute for the itemid.
The file /libraries/version.php has been moved from the platform to the CMS, specifically to /includes/version.php. If direct access to this file is needed jimport will need to be adjusted but it also can be access by loading framework.php
or by using JLoader.
- Remove getHeadData(), setHeadData() and mergeHeadData() from JDocument since it only applies to JDocumentHTML. (GitHub)
- Move the rendering of HTML link elements to JDocumentRendererHead. (GitHub)
- Deprecate JException (GitHub)
- Deprecate JError (GitHub)
- Use include_once instead of include in JLoader (GitHub)
- Remove an unused paramet in JURI::buildQuery(). (GitHub)
- Move JUpdater:arrayUnique() to JArrayHelper::arrayUnique(). Keep JUpdater:arrayUnique() as an alias an deprecate it. (GitHub)
- Update Mootools to version 1.3.2 (Issue) (Revision) (GitHub)
- Namespace the checkAll() function. (GitHub)
- Update TinyMCE to version 3.4.2 (Issue) (Revision)
- Update TinyMCE to version 220.127.116.11 (Issue) (Revision)
- Don't always load Mootools (More) in the backend (Issue) (Revision)
- Unused admin modules (Issue) (Revision)
- mod_menu can create invalid id attribute HTML (Issue) (Revision)