joomla · wilsonge · Feb 8, 2020 · Jan 28, 2020
diff --git a/api/components/com_categories/Controller/CategoriesController.php b/api/components/com_categories/Controller/CategoriesController.php
@@ -47,7 +47,7 @@ class CategoriesController extends ApiController
 	 */
 	public function displayItem($id = null)
 	{
-		$this->input->set('model_state', ['filter.extension' => $this->getExtensionFromInput()]);
+		$this->modelState->set('filter.extension', $this->getExtensionFromInput());
 
 		return parent::displayItem($id);
 	}
@@ -60,7 +60,7 @@ public function displayItem($id = null)
 	 */
 	public function displayList()
 	{
-		$this->input->set('model_state', ['filter.extension' => $this->getExtensionFromInput()]);
+		$this->modelState->set('filter.extension', $this->getExtensionFromInput());
 
 		return parent::displayList();
 	}

diff --git a/api/components/com_contenthistory/Controller/HistoryController.php b/api/components/com_contenthistory/Controller/HistoryController.php
@@ -48,14 +48,11 @@ class HistoryController extends ApiController
 	 */
 	public function displayList()
 	{
-		$this->input->set('model_state', [
-				'type_alias'     => $this->getTypeAliasFromInput(),
-				'type_id'        => $this->getTypeIdFromInput(),
-				'item_id'        => $this->getItemIdFromInput(),
-				'list.ordering'  => 'h.save_date',
-				'list.direction' => 'DESC',
-			]
-		);
+		$this->modelState->set('type_alias', $this->getTypeAliasFromInput());
+		$this->modelState->set('type_id', $this->getTypeIdFromInput());
+		$this->modelState->set('item_id', $this->getItemIdFromInput());
+		$this->modelState->set('list.ordering', 'h.save_date');
+		$this->modelState->set('list.direction', 'DESC');
 
 		return parent::displayList();
 	}

diff --git a/api/components/com_fields/Controller/FieldsController.php b/api/components/com_fields/Controller/FieldsController.php
@@ -47,7 +47,7 @@ class FieldsController extends ApiController
 	 */
 	public function displayItem($id = null)
 	{
-		$this->input->set('model_state', ['filter.context' => $this->getContextFromInput()]);
+		$this->modelState->set('filter.context', $this->getContextFromInput());
 
 		return parent::displayItem($id);
 	}
@@ -61,7 +61,7 @@ public function displayItem($id = null)
 	 */
 	public function displayList()
 	{
-		$this->input->set('model_state', ['filter.context' => $this->getContextFromInput()]);
+		$this->modelState->set('filter.context', $this->getContextFromInput());
 
 		return parent::displayList();
 	}

diff --git a/api/components/com_fields/Controller/GroupsController.php b/api/components/com_fields/Controller/GroupsController.php
@@ -47,7 +47,7 @@ class GroupsController extends ApiController
 	 */
 	public function displayItem($id = null)
 	{
-		$this->input->set('model_state', ['filter.context' => $this->getContextFromInput()]);
+		$this->modelState->set('filter.context', $this->getContextFromInput());
 
 		return parent::displayItem($id);
 	}
@@ -61,7 +61,7 @@ public function displayItem($id = null)
 	 */
 	public function displayList()
 	{
-		$this->input->set('model_state', ['filter.context' => $this->getContextFromInput()]);
+		$this->modelState->set('filter.context', $this->getContextFromInput());
 
 		return parent::displayList();
 	}

diff --git a/api/components/com_languages/Controller/OverridesController.php b/api/components/com_languages/Controller/OverridesController.php
@@ -52,11 +52,8 @@ class OverridesController extends ApiController
 	 */
 	public function displayItem($id = null)
 	{
-		$this->input->set('model_state', [
-				'filter.language' => $this->getLanguageFromInput(),
-				'filter.client'   => $this->getClientFromInput(),
-			]
-		);
+		$this->modelState->set('filter.language', $this->getLanguageFromInput());
+		$this->modelState->set('filter.client', $this->getClientFromInput());
 
 		return parent::displayItem($id);
 	}
@@ -70,11 +67,8 @@ public function displayItem($id = null)
 	 */
 	public function displayList()
 	{
-		$this->input->set('model_state', [
-				'filter.language' => $this->getLanguageFromInput(),
-				'filter.client'   => $this->getClientFromInput(),
-			]
-		);
+		$this->modelState->set('filter.language', $this->getLanguageFromInput());
+		$this->modelState->set('filter.client', $this->getClientFromInput());
 
 		return parent::displayList();
 	}
@@ -168,11 +162,8 @@ public function delete($id = null)
 
 		$this->input->set('model', $this->contentType);
 
-		$this->input->set('model_state', [
-				'filter.language' => $this->getLanguageFromInput(),
-				'filter.client'   => $this->getClientFromInput(),
-			]
-		);
+		$this->modelState->set('filter.language', $this->getLanguageFromInput());
+		$this->modelState->set('filter.client', $this->getClientFromInput());
 
 		parent::delete($id);
 	}

diff --git a/api/components/com_menus/Controller/ItemsController.php b/api/components/com_menus/Controller/ItemsController.php
@@ -51,7 +51,7 @@ class ItemsController extends ApiController
 	 */
 	public function displayItem($id = null)
 	{
-		$this->input->set('model_state', ['filter.client_id' => $this->getClientIdFromInput()]);
+		$this->modelState->set('filter.client_id', $this->getClientIdFromInput());
 
 		return parent::displayItem($id);
 	}
@@ -65,7 +65,7 @@ public function displayItem($id = null)
 	 */
 	public function displayList()
 	{
-		$this->input->set('model_state', ['filter.client_id' => $this->getClientIdFromInput()]);
+		$this->modelState->set('filter.client_id', $this->getClientIdFromInput());
 
 		return parent::displayList();
 	}

diff --git a/api/components/com_menus/Controller/MenusController.php b/api/components/com_menus/Controller/MenusController.php
@@ -47,7 +47,7 @@ class MenusController extends ApiController
 	 */
 	public function displayItem($id = null)
 	{
-		$this->input->set('model_state', ['client_id' => $this->getClientIdFromInput()]);
+		$this->modelState->set('filter.client_id', $this->getClientIdFromInput());
 
 		return parent::displayItem($id);
 	}
@@ -61,7 +61,7 @@ public function displayItem($id = null)
 	 */
 	public function displayList()
 	{
-		$this->input->set('model_state', ['client_id' => $this->getClientIdFromInput()]);
+		$this->modelState->set('filter.client_id', $this->getClientIdFromInput());
 
 		return parent::displayList();
 	}

diff --git a/api/components/com_modules/Controller/ModulesController.php b/api/components/com_modules/Controller/ModulesController.php
@@ -50,7 +50,7 @@ class ModulesController extends ApiController
 	 */
 	public function displayItem($id = null)
 	{
-		$this->input->set('model_state', ['client_id' => $this->getClientIdFromInput()]);
+		$this->modelState->set('filter.client_id', $this->getClientIdFromInput());
 
 		return parent::displayItem($id);
 	}
@@ -64,7 +64,7 @@ public function displayItem($id = null)
 	 */
 	public function displayList()
 	{
-		$this->input->set('model_state', ['client_id' => $this->getClientIdFromInput()]);
+		$this->modelState->set('filter.client_id', $this->getClientIdFromInput());
 
 		return parent::displayList();
 	}

diff --git a/api/components/com_templates/Controller/StylesController.php b/api/components/com_templates/Controller/StylesController.php
@@ -47,7 +47,7 @@ class StylesController extends ApiController
 	 */
 	public function displayItem($id = null)
 	{
-		$this->input->set('model_state', ['client_id' => $this->getClientIdFromInput()]);
+		$this->modelState->set('client_id', $this->getClientIdFromInput());
 
 		return parent::displayItem($id);
 	}
@@ -61,7 +61,7 @@ public function displayItem($id = null)
 	 */
 	public function displayList()
 	{
-		$this->input->set('model_state', ['client_id' => $this->getClientIdFromInput()]);
+		$this->modelState->set('client_id', $this->getClientIdFromInput());
 
 		return parent::displayList();
 	}

diff --git a/libraries/src/MVC/Controller/ApiController.php b/libraries/src/MVC/Controller/ApiController.php
@@ -18,6 +18,7 @@
 use Joomla\CMS\MVC\Factory\MvcFactoryInterface;
 use Joomla\CMS\MVC\Model\ListModel;
 use Joomla\CMS\MVC\View\JsonApiView;
+use Joomla\CMS\Object\CMSObject;
 use Joomla\Input\Input;
 use Joomla\String\Inflector;
 use Tobscure\JsonApi\Exception\InvalidParameterException;
@@ -71,6 +72,13 @@ class ApiController extends BaseController
 	 */
 	protected $itemsPerPage = 20;
 
+	/**
+	 * The model state to inject
+	 *
+	 * @var  CMSObject
+	 */
+	protected $modelState;
+
 	/**
 	 * Constructor.
 	 *
@@ -86,6 +94,8 @@ class ApiController extends BaseController
 	 */
 	public function __construct($config = array(), MvcFactoryInterface $factory = null, $app = null, $input = null)
 	{
+		$this->modelState = new CMSObject;
+
 		parent::__construct($config, $factory, $app, $input);
 
 		// Guess the option as com_NameOfController
@@ -151,23 +161,14 @@ public function displayItem($id = null)
 
 		$modelName = $this->input->get('model', Inflector::singularize($this->contentType));
 
-		// Create the model, ignoring request data so we can safely set the state in the request, without it being
-		// reinitialised on the first getState call
-		$model = $this->getModel($modelName, '', ['ignore_request' => true]);
+		// Create the model, ignoring request data so we can safely set the state in the request from the controller
+		$model = $this->getModel($modelName, '', ['ignore_request' => true, 'state' => $this->modelState]);
 
 		if (!$model)
 		{
 			throw new \RuntimeException(Text::_('JLIB_APPLICATION_ERROR_MODEL_CREATE'));
 		}
 
-		if ($modelState = $this->input->get('model_state', false, 'array'))
-		{
-			foreach ($modelState as $property => $value)
-			{
-				$model->setState($property, $value);
-			}
-		}
-
 		try
 		{
 			$modelName = $model->getName();
@@ -199,20 +200,17 @@ public function displayList()
 	{
 		// Assemble pagination information (using recommended JsonApi pagination notation for offset strategy)
 		$paginationInfo = $this->input->get('page', [], 'array');
-		$internalPaginationMapping = [];
 
 		if (\array_key_exists('offset', $paginationInfo))
 		{
-			$this->input->set('limitstart', $paginationInfo['offset']);
+			$this->modelState->set($this->context . '.limitstart', $paginationInfo['offset']);
 		}
 
 		if (\array_key_exists('limit', $paginationInfo))
 		{
-			$internalPaginationMapping['limit'] = $paginationInfo['limit'];
+			$this->modelState->set($this->context . '.list.limit', $paginationInfo['limit']);
 		}
 
-		$this->input->set('list', $internalPaginationMapping);
-
 		$viewType   = $this->app->getDocument()->getType();
 		$viewName   = $this->input->get('view', $this->default_view);
 		$viewLayout = $this->input->get('layout', 'default', 'string');
@@ -235,21 +233,13 @@ public function displayList()
 		$modelName = $this->input->get('model', $this->contentType);
 
 		/** @var ListModel $model */
-		$model = $this->getModel($modelName, '', ['ignore_request' => true]);
+		$model = $this->getModel($modelName, '', ['ignore_request' => true, 'state' => $this->modelState]);
 
 		if (!$model)
 		{
 			throw new \RuntimeException(Text::_('JLIB_APPLICATION_ERROR_MODEL_CREATE'));
 		}
 
-		if ($modelState = $this->input->get('model_state', false, 'array'))
-		{
-			foreach ($modelState as $property => $value)
-			{
-				$model->setState($property, $value);
-			}
-		}
-
 		// Push the model into the view (as default)
 		$view->setModel($model, true);
 
@@ -305,14 +295,6 @@ public function delete($id = null)
 			throw new \RuntimeException(Text::_('JLIB_APPLICATION_ERROR_MODEL_CREATE'));
 		}
 
-		if ($modelState = $this->input->get('model_state', false, 'array'))
-		{
-			foreach ($modelState as $property => $value)
-			{
-				$model->setState($property, $value);
-			}
-		}
-
 		// Remove the item.
 		if (!$model->delete($id))
 		{