Cleanup of controller based on Intellij highlighting (#28315)

Author: wilsonge

administrator/components/com_associations/src/Controller/AssociationController.php

@@ -30,7 +30,7 @@ class AssociationController extends FormController
 	 * @param   string  $urlVar  The name of the URL variable if different from the primary key
 	 *                           (sometimes required to avoid router collisions).
 	 *
-	 * @return  boolean  True if access level check and checkout passes, false otherwise.
+	 * @return  FormController|boolean  True if access level check and checkout passes, false otherwise.
 	 *
 	 * @since  3.7.0
 	 */

administrator/components/com_banners/src/Controller/BannersController.php

@@ -15,6 +15,7 @@
 use Joomla\CMS\Language\Text;
 use Joomla\CMS\MVC\Controller\AdminController;
 use Joomla\CMS\MVC\Factory\MVCFactoryInterface;
+use Joomla\Input\Input;
 use Joomla\Utilities\ArrayHelper;
 
 /**
@@ -38,7 +39,7 @@ class BannersController extends AdminController
 	 * @param   array                $config   An optional associative array of configuration settings.
 	 * @param   MVCFactoryInterface  $factory  The factory.
 	 * @param   CmsApplication       $app      The JApplication for the dispatcher
-	 * @param   \JInput              $input    Input
+	 * @param   Input                $input    Input
 	 *
 	 * @since   3.0
 	 */

administrator/components/com_cache/src/Controller/DisplayController.php

@@ -54,7 +54,7 @@ public function getQuickiconContent()
 
 		// Number bytes are returned in format xxx.xx MB
 		$bytes = HTMLHelper::_('number.bytes', $size, 'MB', 1);
-		
+
 		if (!empty($bytes))
 		{
 			$result['amount'] = $bytes;
@@ -114,7 +114,7 @@ public function deleteAll()
 		// Check for request forgeries
 		$this->checkToken();
 
-		$app        = $this->app;
+		/** @var \Joomla\Component\Cache\Administrator\Model\CacheModel $model */
 		$model      = $this->getModel('cache');
 		$allCleared = true;
 
@@ -124,7 +124,7 @@ public function deleteAll()
 		{
 			if ($mCache->clean($cache->group) === false)
 			{
-				$app->enqueueMessage(
+				$this->app->enqueueMessage(
 					Text::sprintf(
 						'COM_CACHE_EXPIRED_ITEMS_DELETE_ERROR', Text::_('JADMINISTRATOR') . ' > ' . $cache->group
 					), 'error'
@@ -135,14 +135,14 @@ public function deleteAll()
 
 		if ($allCleared)
 		{
-			$app->enqueueMessage(Text::_('COM_CACHE_MSG_ALL_CACHE_GROUPS_CLEARED'), 'message');
+			$this->app->enqueueMessage(Text::_('COM_CACHE_MSG_ALL_CACHE_GROUPS_CLEARED'), 'message');
 		}
 		else
 		{
-			$app->enqueueMessage(Text::_('COM_CACHE_MSG_SOME_CACHE_GROUPS_CLEARED'), 'warning');
+			$this->app->enqueueMessage(Text::_('COM_CACHE_MSG_SOME_CACHE_GROUPS_CLEARED'), 'warning');
 		}
 
-		$app->triggerEvent('onAfterPurge', array());
+		$this->app->triggerEvent('onAfterPurge', array());
 		$this->setRedirect('index.php?option=com_cache&view=cache');
 	}
 

administrator/components/com_categories/src/Controller/CategoriesController.php

@@ -40,9 +40,9 @@ public function getModel($name = 'Category', $prefix = 'Administrator', $config
 	}
 
 	/**
-	 * Method to get the number of content categories
+	 * Outputs the JSON-encoded amount of published content categories
 	 *
-	 * @return  string  The JSON-encoded amount of published content categories
+	 * @return  void
 	 *
 	 * @since   4.0
 	 */

administrator/components/com_categories/src/Controller/CategoryController.php

@@ -127,7 +127,6 @@ public function batch($model = null)
 	{
 		$this->checkToken();
 
-		// Set the model
 		/** @var \Joomla\Component\Categories\Administrator\Model\CategoryModel $model */
 		$model = $this->getModel('Category');
 

administrator/components/com_categories/src/Controller/DisplayController.php

@@ -68,7 +68,7 @@ public function __construct($config = array(), MVCFactoryInterface $factory = nu
 	 * @param   boolean  $cachable   If true, the view output will be cached
 	 * @param   array    $urlparams  An array of safe URL parameters and their variable types, for valid values see {@link \JFilterInput::clean()}.
 	 *
-	 * @return  static  This object to support chaining.
+	 * @return  static|boolean  This object to support chaining.
 	 *
 	 * @since   1.5
 	 */

administrator/components/com_checkin/src/Controller/DisplayController.php

@@ -78,6 +78,7 @@ public function checkin()
 	 * @return  void
 	 *
 	 * @since   4.0.0
+	 * @throws  \Exception
 	 */
 	public function getMenuBadgeData()
 	{
@@ -99,6 +100,7 @@ public function getMenuBadgeData()
 	 * @return  void
 	 *
 	 * @since   4.0
+	 * @throws  \Exception
 	 */
 	public function getQuickiconContent()
 	{

administrator/components/com_config/src/Controller/ApplicationController.php

@@ -63,7 +63,7 @@ public function cancel()
 	/**
 	 * Saves the form
 	 *
-	 * @return  mixed
+	 * @return  void|boolean  Void on success. Boolean false on fail.
 	 *
 	 * @since  4.0.0
 	 */
@@ -205,7 +205,7 @@ public function save()
 	/**
 	 * Method to remove root in global configuration.
 	 *
-	 * @return  boolean  True on success.
+	 * @return  boolean
 	 *
 	 * @since   3.2
 	 */
@@ -247,12 +247,14 @@ public function removeroot()
 
 		// Set the redirect based on the task.
 		$this->setRedirect(Route::_('index.php'), Text::_('COM_CONFIG_SAVE_SUCCESS'));
+
+		return true;
 	}
 
 	/**
 	 * Method to send the test mail.
 	 *
-	 * @return  string
+	 * @return  void
 	 *
 	 * @since   3.5
 	 */
@@ -290,7 +292,7 @@ public function sendtestmail()
 	/**
 	 * Method to GET permission value and give it to the model for storing in the database.
 	 *
-	 * @return  boolean  true on success, false when failed
+	 * @return  void
 	 *
 	 * @since   3.5
 	 */

administrator/components/com_config/src/Controller/ComponentController.php

@@ -11,13 +11,15 @@
 
 defined('_JEXEC') or die;
 
+use Joomla\CMS\Application\CMSApplication;
 use Joomla\CMS\Client\ClientHelper;
 use Joomla\CMS\Language\Text;
 use Joomla\CMS\MVC\Controller\BaseController;
 use Joomla\CMS\MVC\Factory\MVCFactoryInterface;
 use Joomla\CMS\Router\Route;
 use Joomla\CMS\Session\Session;
 use Joomla\CMS\Uri\Uri;
+use Joomla\Input\Input;
 
 /**
  * Note: this view is intended only to be opened in a popup
@@ -34,7 +36,7 @@ class ComponentController extends BaseController
 	 * 'view_path' (this list is not meant to be comprehensive).
 	 * @param   MVCFactoryInterface  $factory  The factory.
 	 * @param   CMSApplication       $app      The JApplication for the dispatcher
-	 * @param   \JInput              $input    Input
+	 * @param   Input                $input    Input
 	 *
 	 * @since   3.0
 	 */

administrator/components/com_config/src/Controller/RequestController.php

@@ -24,7 +24,7 @@ class RequestController extends BaseController
 	/**
 	 * Execute the controller.
 	 *
-	 * @return  mixed  A rendered view or true
+	 * @return  mixed  A rendered view or false
 	 *
 	 * @since   3.2
 	 */
@@ -62,7 +62,7 @@ public function getJson()
 		{
 			$this->app->enqueueMessage(Text::_('JERROR_ALERTNOAUTHOR'), 'error');
 
-			return;
+			return false;
 		}
 
 		try