Merge pull request joomla#947 from LouisLandry/legacy

Legacy class path for gracefully deprecating libraries.
robschley · Mar 2, 2012 · 12f00b8 · 12f00b8
2 parents dd7d104 + 6448c95
commit 12f00b8
Show file tree

Hide file tree

Showing 60 changed files with 124 additions and 117 deletions.
diff --git a/libraries/import.legacy.php b/libraries/import.legacy.php
@@ -0,0 +1,66 @@
+<?php
+/**
+ * @package    Joomla.Platform
+ *
+ * @copyright  Copyright (C) 2005 - 2012 Open Source Matters, Inc. All rights reserved.
+ * @license    GNU General Public License version 2 or later; see LICENSE
+ */
+
+// Set the platform root path as a constant if necessary.
+if (!defined('JPATH_PLATFORM'))
+{
+	define('JPATH_PLATFORM', __DIR__);
+}
+
+// Detect the native operating system type.
+$os = strtoupper(substr(PHP_OS, 0, 3));
+if (!defined('IS_WIN'))
+{
+	define('IS_WIN', ($os === 'WIN') ? true : false);
+}
+if (!defined('IS_MAC'))
+{
+	define('IS_MAC', ($os === 'MAC') ? true : false);
+}
+if (!defined('IS_UNIX'))
+{
+	define('IS_UNIX', (($os !== 'MAC') && ($os !== 'WIN')) ? true : false);
+}
+
+// Import the platform version library if necessary.
+if (!class_exists('JPlatform'))
+{
+	require_once JPATH_PLATFORM . '/platform.php';
+}
+
+// Import the library loader if necessary.
+if (!class_exists('JLoader'))
+{
+	require_once JPATH_PLATFORM . '/loader.php';
+}
+
+class_exists('JLoader') or die;
+
+// Register the legacy library base path for deprecated or legacy libraries.
+JLoader::registerPrefix('J', JPATH_PLATFORM . '/legacy');
+
+// Setup the autoloaders.
+JLoader::setup();
+
+// Import the base Joomla Platform libraries.
+JLoader::import('joomla.factory');
+JLoader::import('joomla.base.object');
+
+// Register JRequest for legacy reasons
+JLoader::register('JRequest', JPATH_PLATFORM . '/joomla/environment/request.php');
+
+// Register classes that don't follow one file per class naming conventions.
+JLoader::register('JText', JPATH_PLATFORM . '/joomla/language/text.php');
+JLoader::register('JRoute', JPATH_PLATFORM . '/joomla/application/route.php');
+
+// Register classes where the names have been changed to fit the autoloader rules
+// @deprecated  12.3
+JLoader::register('JDatabaseQueryMySQL', JPATH_PLATFORM . '/database/query/mysql.php');
+JLoader::register('JDatabaseQueryMySQLi', JPATH_PLATFORM . '/database/query/mysqli.php');
+JLoader::register('JDatabaseQuerySQLAzure', JPATH_PLATFORM . '/database/query/sqlazure.php');
+JLoader::register('JDatabaseQuerySQLSrv', JPATH_PLATFORM . '/database/query/sqlsrv.php');
diff --git a/libraries/import.php b/libraries/import.php
@@ -46,18 +46,7 @@ class_exists('JLoader') or die;
 
 // Import the base Joomla Platform libraries.
 JLoader::import('joomla.factory');
-JLoader::import('joomla.error.exception');
-
-// Register JRequest for legacy reasons
-JLoader::register('JRequest', JPATH_PLATFORM . '/joomla/environment/request.php');
 
 // Register classes that don't follow one file per class naming conventions.
 JLoader::register('JText', JPATH_PLATFORM . '/joomla/language/text.php');
 JLoader::register('JRoute', JPATH_PLATFORM . '/joomla/application/route.php');
-
-// Register classes where the names have been changed to fit the autoloader rules
-// @deprecated  12.3
-JLoader::register('JDatabaseQueryMySQL', JPATH_PLATFORM . '/database/query/mysql.php');
-JLoader::register('JDatabaseQueryMySQLi', JPATH_PLATFORM . '/database/query/mysqli.php');
-JLoader::register('JDatabaseQuerySQLAzure', JPATH_PLATFORM . '/database/query/sqlazure.php');
-JLoader::register('JDatabaseQuerySQLSrv', JPATH_PLATFORM . '/database/query/sqlsrv.php');
diff --git a/libraries/joomla/error/profiler.php → libraries/joomla/profiler/profiler.php b/libraries/joomla/error/profiler.php → libraries/joomla/profiler/profiler.php
@@ -1,7 +1,7 @@
 <?php
 /**
  * @package     Joomla.Platform
- * @subpackage  Error
+ * @subpackage  Profiler
  *
  * @copyright   Copyright (C) 2005 - 2012 Open Source Matters, Inc. All rights reserved.
  * @license     GNU General Public License version 2 or later; see LICENSE
@@ -14,7 +14,7 @@
  * of sections of code to understand where time is being spent.
  *
  * @package     Joomla.Platform
- * @subpackage  Error
+ * @subpackage  Profiler
  * @since       11.1
  */
 class JProfiler

diff --git a/libraries/joomla/application/application.php → libraries/legacy/application/application.php b/libraries/joomla/application/application.php → libraries/legacy/application/application.php
diff --git a/libraries/joomla/application/helper.php → libraries/legacy/application/helper.php b/libraries/joomla/application/helper.php → libraries/legacy/application/helper.php
diff --git a/libraries/joomla/application/categories.php → libraries/legacy/categories/categories.php b/libraries/joomla/application/categories.php → libraries/legacy/categories/categories.php
diff --git a/libraries/joomla/error/error.php → libraries/legacy/error/error.php b/libraries/joomla/error/error.php → libraries/legacy/error/error.php
diff --git a/libraries/joomla/error/exception.php → libraries/legacy/exception/exception.php b/libraries/joomla/error/exception.php → libraries/legacy/exception/exception.php
@@ -1,7 +1,7 @@
 <?php
 /**
  * @package     Joomla.Platform
- * @subpackage  Error
+ * @subpackage  Exception
  *
  * @copyright   Copyright (C) 2005 - 2012 Open Source Matters, Inc. All rights reserved.
  * @license     GNU General Public License version 2 or later; see LICENSE
@@ -13,7 +13,7 @@
  * Joomla! Exception object.
  *
  * @package     Joomla.Platform
- * @subpackage  Error
+ * @subpackage  Exception
  * @since       11.1
  * @deprecated  12.1
  */

diff --git a/libraries/cms/form/field/helpsite.php → libraries/legacy/form/field/helpsite.php b/libraries/cms/form/field/helpsite.php → libraries/legacy/form/field/helpsite.php
diff --git a/libraries/cms/form/field/media.php → libraries/legacy/form/field/media.php b/libraries/cms/form/field/media.php → libraries/legacy/form/field/media.php
diff --git a/libraries/cms/form/field/menuitem.php → libraries/legacy/form/field/menuitem.php b/libraries/cms/form/field/menuitem.php → libraries/legacy/form/field/menuitem.php
diff --git a/libraries/cms/form/field/templatestyle.php → ...aries/legacy/form/field/templatestyle.php b/libraries/cms/form/field/templatestyle.php → ...aries/legacy/form/field/templatestyle.php
diff --git a/libraries/cms/form/field/user.php → libraries/legacy/form/field/user.php b/libraries/cms/form/field/user.php → libraries/legacy/form/field/user.php
diff --git a/libraries/cms/help/help.php → libraries/legacy/help/help.php b/libraries/cms/help/help.php → libraries/legacy/help/help.php
diff --git a/libraries/joomla/application/menu.php → libraries/legacy/menu/menu.php b/libraries/joomla/application/menu.php → libraries/legacy/menu/menu.php
diff --git a/libraries/joomla/application/pathway.php → libraries/legacy/pathway/pathway.php b/libraries/joomla/application/pathway.php → libraries/legacy/pathway/pathway.php
diff --git a/libraries/joomla/environment/request.php → libraries/legacy/request/request.php b/libraries/joomla/environment/request.php → libraries/legacy/request/request.php
diff --git a/libraries/cms/table/content.php → libraries/legacy/table/content.php b/libraries/cms/table/content.php → libraries/legacy/table/content.php
diff --git a/libraries/cms/toolbar/button.php → libraries/legacy/toolbar/button.php b/libraries/cms/toolbar/button.php → libraries/legacy/toolbar/button.php
diff --git a/libraries/cms/toolbar/button/confirm.php → libraries/legacy/toolbar/button/confirm.php b/libraries/cms/toolbar/button/confirm.php → libraries/legacy/toolbar/button/confirm.php
diff --git a/libraries/cms/toolbar/button/custom.php → libraries/legacy/toolbar/button/custom.php b/libraries/cms/toolbar/button/custom.php → libraries/legacy/toolbar/button/custom.php
diff --git a/libraries/cms/toolbar/button/help.php → libraries/legacy/toolbar/button/help.php b/libraries/cms/toolbar/button/help.php → libraries/legacy/toolbar/button/help.php
diff --git a/libraries/cms/toolbar/button/link.php → libraries/legacy/toolbar/button/link.php b/libraries/cms/toolbar/button/link.php → libraries/legacy/toolbar/button/link.php
diff --git a/libraries/cms/toolbar/button/popup.php → libraries/legacy/toolbar/button/popup.php b/libraries/cms/toolbar/button/popup.php → libraries/legacy/toolbar/button/popup.php
diff --git a/libraries/cms/toolbar/button/separator.php → ...aries/legacy/toolbar/button/separator.php b/libraries/cms/toolbar/button/separator.php → ...aries/legacy/toolbar/button/separator.php
diff --git a/libraries/cms/toolbar/button/standard.php → libraries/legacy/toolbar/button/standard.php b/libraries/cms/toolbar/button/standard.php → libraries/legacy/toolbar/button/standard.php
diff --git a/libraries/cms/toolbar/toolbar.php → libraries/legacy/toolbar/toolbar.php b/libraries/cms/toolbar/toolbar.php → libraries/legacy/toolbar/toolbar.php
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -18,6 +18,7 @@
 	<filter>
 	  <whitelist addUncoveredFilesFromWhitelist="false">
 	    <directory suffix=".php">libraries/joomla</directory>
+	    <directory suffix=".php">libraries/legacy</directory>
 	    <file>libraries/import.php</file>
 	    <file>libraries/loader.php</file>
 	    <file>libraries/platform.php</file>

diff --git a/tests/bootstrap.php b/tests/bootstrap.php
@@ -74,7 +74,7 @@
 }
 
 // Import the platform.
-require_once JPATH_PLATFORM . '/import.php';
+require_once JPATH_PLATFORM . '/import.legacy.php';
 
 // Include the base test cases.
 require_once JPATH_TESTS . '/includes/JoomlaTestCase.php';

diff --git a/tests/includes/JoomlaTestCase.php b/tests/includes/JoomlaTestCase.php
@@ -331,7 +331,7 @@ protected function restoreFactoryState()
 	public function getMockApplication()
 	{
 		// Load the real class first otherwise the mock will be used if jimport is called again.
-		require_once JPATH_PLATFORM . '/joomla/application/application.php';
+		require_once JPATH_PLATFORM . '/legacy/application/application.php';
 
 		// Load the mock class builder.
 		require_once JPATH_TESTS . '/includes/mocks/JApplicationMock.php';

diff --git a/tests/suite/joomla/application/component/JControllerTest.php b/tests/suite/joomla/application/component/JControllerTest.php
@@ -6,7 +6,6 @@
  */
 
 require_once JPATH_PLATFORM . '/joomla/application/component/controller.php';
-require_once JPATH_PLATFORM . '/joomla/environment/request.php';
 
 /**
  * Test class for JController.
@@ -64,12 +63,12 @@ public function testAddModelPath()
     public function testCreateFileName()
     {
     	$parts = array('name' => 'test');
-    	
+
     	$this->assertThat(
     		JControllerInspector::createFileName('controller', $parts),
     		$this->equalTo('test.php')
     	);
-    	
+
     	$parts['format'] = 'html';
 
     	$this->assertThat(
@@ -83,36 +82,36 @@ public function testCreateFileName()
     		JControllerInspector::createFileName('controller', $parts),
     		$this->equalTo('test.json.php')
     	);
-    	
+
     	$parts = array('name' => 'TEST', 'format' => 'JSON');
-    	
+
     	$this->assertThat(
     		JControllerInspector::createFileName('controller', $parts),
     		$this->equalTo('test.json.php')
     	);
-    	
+
     	$parts = array('name' => 'test');
-    	
+
 		$this->assertThat(
     		JControllerInspector::createFileName('view', $parts),
     		$this->equalTo('test/view.php')
     	);
-    	
+
     	$parts['type'] = 'json';
-    	
+
 		$this->assertThat(
     		JControllerInspector::createFileName('view', $parts),
     		$this->equalTo('test/view.json.php')
     	);
-    	
+
     	$parts = array('type' => 'JSON', 'name' => 'TEST');
 
 		$this->assertThat(
     		JControllerInspector::createFileName('view', $parts),
     		$this->equalTo('test/view.json.php')
     	);
     }
-	
+
     /**
      * @todo Implement testGetInstance().
      */
@@ -178,7 +177,7 @@ public function testAddPath()
 			'Line:' . __LINE__ . ' The path type should be present, clean and with a trailing slash.'
 		);
 	}
-	
+
 	/**
 	 * Test JController::addViewPath
 	 */

diff --git a/tests/suite/joomla/error/JProfilerTest.php → ...s/suite/joomla/profiler/JProfilerTest.php b/tests/suite/joomla/error/JProfilerTest.php → ...s/suite/joomla/profiler/JProfilerTest.php
@@ -6,8 +6,6 @@
  * @license     GNU General Public License version 2 or later; see LICENSE
  */
 
-include_once JPATH_PLATFORM . '/joomla/error/profiler.php';
-
 /**
  * Test class for JProfiler.
  * Generated by PHPUnit on 2011-10-26 at 19:34:10.

diff --git a/...la/application/JApplicationHelperTest.php → ...cy/application/JApplicationHelperTest.php b/...la/application/JApplicationHelperTest.php → ...cy/application/JApplicationHelperTest.php
@@ -7,8 +7,6 @@
  * @license     GNU General Public License version 2 or later; see LICENSE
  */
 
-require_once JPATH_PLATFORM.'/joomla/application/helper.php';
-
 class JApplicationHelperInspector extends JApplicationHelper
 {
 	/**

diff --git a/...e/joomla/application/JApplicationTest.php → ...e/legacy/application/JApplicationTest.php b/...e/joomla/application/JApplicationTest.php → ...e/legacy/application/JApplicationTest.php
@@ -7,10 +7,6 @@
  * @license     GNU General Public License version 2 or later; see LICENSE
  */
 
-require_once JPATH_PLATFORM . '/joomla/input/input.php';
-require_once JPATH_PLATFORM . '/joomla/environment/request.php';
-require_once JPATH_PLATFORM . '/joomla/application/application.php';
-
 /**
  * Test class for JApplication.
  * Generated by PHPUnit on 2009-10-08 at 11:53:44.

diff --git a/...te/joomla/application/JCategoriesTest.php → ...ite/legacy/categories/JCategoriesTest.php b/...te/joomla/application/JCategoriesTest.php → ...ite/legacy/categories/JCategoriesTest.php
@@ -7,8 +7,6 @@
  * @license     GNU General Public License version 2 or later; see LICENSE
  */
 
-require_once JPATH_PLATFORM.'/joomla/application/categories.php';
-
 /**
  * Test class for JCategories.
  * Generated by PHPUnit on 2009-10-08 at 11:55:02.

diff --git a/.../joomla/application/JCategoryNodeTest.php → ...e/legacy/categories/JCategoryNodeTest.php b/.../joomla/application/JCategoryNodeTest.php → ...e/legacy/categories/JCategoryNodeTest.php
@@ -7,8 +7,6 @@
  * @license     GNU General Public License version 2 or later; see LICENSE
  */
 
-require_once JPATH_PLATFORM.'/joomla/application/categories.php';
-
 /**
  * Test class for JCategoryNode.
  * Generated by PHPUnit on 2009-10-08 at 11:55:26.

diff --git a/tests/suite/joomla/error/JErrorTest.php → tests/suite/legacy/error/JErrorTest.php b/tests/suite/joomla/error/JErrorTest.php → tests/suite/legacy/error/JErrorTest.php
@@ -6,8 +6,6 @@
  * @license     GNU General Public License version 2 or later; see LICENSE
  */
 
-include_once JPATH_PLATFORM . '/joomla/error/error.php';
-
 /**
  * Test class for JError.
  * Generated by PHPUnit on 2011-10-26 at 19:34:13.

diff --git a/tests/suite/joomla/error/JExceptionTest.php → ...suite/legacy/exception/JExceptionTest.php b/tests/suite/joomla/error/JExceptionTest.php → ...suite/legacy/exception/JExceptionTest.php
@@ -6,8 +6,6 @@
  * @license     GNU General Public License version 2 or later; see LICENSE
  */
 
-include_once JPATH_PLATFORM . '/joomla/error/exception.php';
-
 /**
  * Test class for JException.
  * Generated by PHPUnit on 2011-10-26 at 19:34:12.

diff --git a/...cms/form/field/JFormFieldHelpsiteTest.php → ...acy/form/field/JFormFieldHelpsiteTest.php b/...cms/form/field/JFormFieldHelpsiteTest.php → ...acy/form/field/JFormFieldHelpsiteTest.php
@@ -20,8 +20,8 @@ class JFormFieldHelpsiteTest extends JoomlaTestCase
 	 */
 	protected function setUp()
 	{
-		require_once JPATH_PLATFORM . '/cms/help/help.php';
-		require_once JPATH_PLATFORM . '/cms/form/field/helpsite.php';
+		require_once JPATH_PLATFORM . '/legacy/help/help.php';
+		require_once JPATH_PLATFORM . '/legacy/form/field/helpsite.php';
 		include_once dirname(dirname(dirname(__DIR__))) . '/joomla/form/inspectors.php';
 	}
 

diff --git a/...te/cms/form/field/JFormFieldMediaTest.php → ...legacy/form/field/JFormFieldMediaTest.php b/...te/cms/form/field/JFormFieldMediaTest.php → ...legacy/form/field/JFormFieldMediaTest.php
@@ -20,7 +20,7 @@ class JFormFieldMediaTest extends JoomlaTestCase
 	 */
 	protected function setUp()
 	{
-		require_once JPATH_PLATFORM . '/cms/form/field/media.php';
+		require_once JPATH_PLATFORM . '/legacy/form/field/media.php';
 		include_once dirname(dirname(dirname(__DIR__))) . '/joomla/form/inspectors.php';
 	}
 

diff --git a/...orm/field/JFormFieldTemplateStyleTest.php → ...orm/field/JFormFieldTemplateStyleTest.php b/...orm/field/JFormFieldTemplateStyleTest.php → ...orm/field/JFormFieldTemplateStyleTest.php
@@ -20,7 +20,7 @@ class JFormFieldTemplateStyleTest extends JoomlaTestCase
 	 */
 	protected function setUp()
 	{
-		require_once JPATH_PLATFORM.'/cms/form/field/templatestyle.php';
+		require_once JPATH_PLATFORM.'/legacy/form/field/templatestyle.php';
 		include_once JPATH_TESTS .  '/suite/joomla/form/inspectors.php';
 	}
 

diff --git a/...ite/cms/form/field/JFormFieldUserTest.php → .../legacy/form/field/JFormFieldUserTest.php b/...ite/cms/form/field/JFormFieldUserTest.php → .../legacy/form/field/JFormFieldUserTest.php
@@ -20,7 +20,7 @@ class JFormFieldUserTest extends JoomlaTestCase
 	 */
 	protected function setUp()
 	{
-		require_once JPATH_PLATFORM . '/cms/form/field/user.php';
+		require_once JPATH_PLATFORM . '/legacy/form/field/user.php';
 		include_once dirname(dirname(dirname(__DIR__))) . '/joomla/form/inspectors.php';
 	}
 

diff --git a/tests/suite/joomla/application/JMenuTest.php → tests/suite/legacy/menu/JMenuTest.php b/tests/suite/joomla/application/JMenuTest.php → tests/suite/legacy/menu/JMenuTest.php
@@ -7,8 +7,6 @@
  * @license     GNU General Public License version 2 or later; see LICENSE
  */
 
-require_once JPATH_PLATFORM.'/joomla/application/menu.php';
-
 /**
  * Test class for JMenu.
  * Generated by PHPUnit on 2009-10-08 at 12:49:26.