[4.2] Deprecate getting the router by the app and introduce a service

components/com_finder/src/View/Search/HtmlView.php

@@ -21,6 +21,7 @@
 use Joomla\CMS\Plugin\PluginHelper;
 use Joomla\CMS\Profiler\Profiler;
 use Joomla\CMS\Router\Route;
+use Joomla\CMS\Router\SiteRouter;
 use Joomla\CMS\Uri\Uri;
 use Joomla\Component\Finder\Administrator\Indexer\Query;
 use Joomla\Component\Finder\Site\Helper\FinderHelper;
@@ -160,7 +161,7 @@ public function display($tpl = null)
 		if (strpos($this->query->input, '"'))
 		{
 			// Get the application router.
-			$router = $app->getRouter();
+			$router = Factory::getContainer()->get(SiteRouter::class);;
 
 			// Fix the q variable in the URL.
 			if ($router->getVar('q') !== $this->query->input)

libraries/src/Application/AdministratorApplication.php

@@ -197,7 +197,8 @@ protected function doExecute()
 	 *
 	 * @return  Router
 	 *
-	 * @since	3.2
+	 * @since      3.2
+	 * @deprecated 5.0 Inject the router or load it from the dependency injection container
 	 */
 	public static function getRouter($name = 'administrator', array $options = array())
 	{

libraries/src/Application/ApiApplication.php

@@ -226,7 +226,7 @@ public function getTemplate($params = false)
 	 */
 	protected function route()
 	{
-		$router = $this->getApiRouter();
+		$router = $this->getContainer()->get(ApiRouter::class);
 
 		// Trigger the onBeforeApiRoute event.
 		PluginHelper::importPlugin('webservices');
@@ -387,11 +387,12 @@ function ($carry, $route) {
 	 *
 	 * @return  ApiRouter
 	 *
-	 * @since   4.0.0
+	 * @since      4.0.0
+	 * @deprecated 5.0 Inject the router or load it from the dependency injection container
 	 */
 	public function getApiRouter()
 	{
-		return $this->getContainer()->get('ApiRouter');
+		return $this->getContainer()->get(ApiRouter::class);
 	}
 
 	/**

libraries/src/Application/CMSApplication.php

@@ -30,6 +30,7 @@
 use Joomla\CMS\Profiler\Profiler;
 use Joomla\CMS\Router\Route;
 use Joomla\CMS\Router\Router;
+use Joomla\CMS\Router\SiteRouter;
 use Joomla\CMS\Session\MetadataManager;
 use Joomla\CMS\Session\Session;
 use Joomla\CMS\Uri\Uri;
@@ -595,7 +596,8 @@ public function getPathway()
 	 *
 	 * @return  Router
 	 *
-	 * @since   3.2
+	 * @since      3.2
+	 * @deprecated 5.0 Inject the router or load it from the dependency injection container
 	 */
 	public static function getRouter($name = null, array $options = array())
 	{
@@ -1062,7 +1064,7 @@ protected function route()
 		// Get the full request URI.
 		$uri = clone Uri::getInstance();
 
-		$router = static::getRouter();
+		$router = $this->getContainer()->get(SiteRouter::class);
 		$result = $router->parse($uri, true);
 
 		$active = $this->getMenu()->getActive();

libraries/src/Application/CMSWebApplicationInterface.php

@@ -51,7 +51,8 @@ public function getMenu($name = null, $options = array());
 	 *
 	 * @return  Router
 	 *
-	 * @since   4.0.0
+	 * @since      4.0.0
+	 * @deprecated 5.0 Inject the router or load it from the dependency injection container
 	 */
 	public static function getRouter($name = null, array $options = array());
 

libraries/src/Application/ConsoleApplication.php

@@ -446,8 +446,9 @@ public function setName(string $name): void
 	 *
 	 * @return  Router
 	 *
-	 * @since   4.0.6
-	 * @throws  \InvalidArgumentException
+	 * @since      4.0.6
+	 * @throws     \InvalidArgumentException
+	 * @deprecated 5.0 Inject the router or load it from the dependency injection container
 	 */
 	public static function getRouter($name = null, array $options = array())
 	{

libraries/src/Application/SiteApplication.php

@@ -145,7 +145,6 @@ public function dispatch($component = null)
 
 		// Set up the params
 		$document = $this->getDocument();
-		$router   = static::getRouter();
 		$params   = $this->getParams();
 
 		// Register the document object with Factory
@@ -378,7 +377,8 @@ public function getPathway($name = 'site', $options = array())
 	 *
 	 * @return	\Joomla\CMS\Router\Router
 	 *
-	 * @since	3.2
+	 * @since      3.2
+	 * @deprecated 5.0 Inject the router or load it from the dependency injection container
 	 */
 	public static function getRouter($name = 'site', array $options = array())
 	{

libraries/src/Factory.php

@@ -589,7 +589,7 @@ protected static function createContainer(): Container
 			->registerServiceProvider(new \Joomla\CMS\Service\Provider\Session)
 			->registerServiceProvider(new \Joomla\CMS\Service\Provider\Toolbar)
 			->registerServiceProvider(new \Joomla\CMS\Service\Provider\WebAssetRegistry)
-			->registerServiceProvider(new \Joomla\CMS\Service\Provider\ApiRouter)
+			->registerServiceProvider(new \Joomla\CMS\Service\Provider\Router)
 			->registerServiceProvider(new \Joomla\CMS\Service\Provider\User);
 
 		return $container;

libraries/src/Router/Route.php

@@ -130,9 +130,7 @@ public static function link($client, $url, $xhtml = true, $tls = self::TLS_IGNOR
 		// Get the router instance, only attempt when a client name is given.
 		if ($client && !isset(self::$_router[$client]))
 		{
-			$app = Factory::getApplication();
-
-			self::$_router[$client] = $app->getRouter($client);
+			self::$_router[$client] = Factory::getContainer()->get(ucfirst($client) . 'Router');
 		}
 
 		// Make sure that we have our router

libraries/src/Router/Router.php

@@ -94,8 +94,9 @@ class Router
 	 *
 	 * @return  Router  A Router object.
 	 *
-	 * @since   1.5
-	 * @throws  \RuntimeException
+	 * @since      1.5
+	 * @throws     \RuntimeException
+	 * @deprecated 5.0 Inject the router or load it from the dependency injection container
 	 */
 	public static function getInstance($client, $options = array())
 	{

libraries/src/Service/Provider/ApiRouter.php → libraries/src/Service/Provider/Router.php

@@ -11,6 +11,10 @@
 \defined('JPATH_PLATFORM') or die;
 
 use Joomla\CMS\Application\ApiApplication;
+use Joomla\CMS\Application\SiteApplication;
+use Joomla\CMS\Router\AdministratorRouter;
+use Joomla\CMS\Router\ApiRouter;
+use Joomla\CMS\Router\SiteRouter;
 use Joomla\DI\Container;
 use Joomla\DI\ServiceProviderInterface;
 
@@ -19,7 +23,7 @@
  *
  * @since  4.0.0
  */
-class ApiRouter implements ServiceProviderInterface
+class Router implements ServiceProviderInterface
 {
 	/**
 	 * Registers the service provider with a DI container.
@@ -32,12 +36,32 @@ class ApiRouter implements ServiceProviderInterface
 	 */
 	public function register(Container $container)
 	{
-		$container->alias('ApiRouter', 'Joomla\CMS\Router\ApiRouter')
+		$container->alias('SiteRouter', SiteRouter::class)
 			->share(
-				'Joomla\CMS\Router\ApiRouter',
+				SiteRouter::class,
 				function (Container $container)
 				{
-					return new \Joomla\CMS\Router\ApiRouter($container->get(ApiApplication::class));
+					return new SiteRouter($container->get(SiteApplication::class));
+				},
+				true
+			);
+
+		$container->alias('AdministratorRouter', AdministratorRouter::class)
+			->share(
+				AdministratorRouter::class,
+				function (Container $container)
+				{
+					return new AdministratorRouter();
+				},
+				true
+			);
+
+		$container->alias('ApiRouter', ApiRouter::class)
+			->share(
+				ApiRouter::class,
+				function (Container $container)
+				{
+					return new ApiRouter($container->get(ApiApplication::class));
 				},
 				true
 			);

plugins/system/cache/cache.php

@@ -249,7 +249,7 @@ protected function isExcluded()
 			$exclusions = explode("\n", $exclusions);
 
 			// Gets internal URI.
-			$internal_uri	= '/index.php?' . Uri::getInstance()->buildQuery($this->app->getRouter()->getVars());
+			$internal_uri	= '/index.php?' . Uri::getInstance()->buildQuery(Factory::getContainer()->get(SiteRouter::class)->getVars());
 
 			// Loop through each pattern.
 			if ($exclusions)

plugins/system/languagefilter/languagefilter.php

@@ -24,6 +24,7 @@
 use Joomla\CMS\Plugin\CMSPlugin;
 use Joomla\CMS\Router\Route;
 use Joomla\CMS\Router\Router;
+use Joomla\CMS\Router\SiteRouter;
 use Joomla\CMS\Uri\Uri;
 use Joomla\Component\Menus\Administrator\Helper\MenusHelper;
 use Joomla\Registry\Registry;
@@ -764,7 +765,7 @@ public function onAfterDispatch()
 			$remove_default_prefix = $this->params->get('remove_default_prefix', 0);
 			$server                = Uri::getInstance()->toString(array('scheme', 'host', 'port'));
 			$is_home               = false;
-			$currentInternalUrl    = 'index.php?' . http_build_query($this->app->getRouter()->getVars());
+			$currentInternalUrl    = 'index.php?' . http_build_query(Factory::getContainer()->get(SiteRouter::class)->getVars());
 
 			if ($active)
 			{