Joomla! Issue Tracker | Joomla! CMS #15301 - [4.0] Controller classes improvements

? ?

Closed
29 Sep 2017
Medium
Build: 4.0-dev
# 15301
Diff
joomdonation:controller-improvements

Success

Success continuous-integration/drone/pr the build was successful Details
Success continuous-integration/travis-ci/pr The Travis CI build passed Details
Success continuous-integration/appveyor/pr AppVeyor build succeeded Details

User tests: Successful: Unsuccessful:

joomdonation
14 Apr 2017

Pull Request for Issue # .

Summary of Changes

This PR makes several improvements to controller classes as explained below:

Add $option property to Controller class. We will now get $option from $config or input, not guessing it from class name like in none-namespace class anymore
Correct behavior or getName() method:

For base component controller, it will return name controller (for example, contact, banners, modules)
For sub-controller class, it will return the name of that sub-controller. For example, BannersControllerBanner will return banner.

Implement getModel method for admin controller. With this method, we can delete most of blank getModel method in admin controllers (I deleted some in this PR for demo purpose)
Some code clean up, docblock, codestyle for easy navigating between method/class in modern IDE like PHPStorm
Pass $option and $name property to Model and View creation code so that the Model and View class won't have to guess these important properties from class name anymore

Testing Instructions

Install Joomla 4 from 4.0-dev branch or nightly build
Apply patch
Try to navigate to random pages in frontend and backend, make sure it still works as expected
Try to publish/unpublish banners for example, make sure it is working as expected

Documentation Changes Required

getName() method of Controller return name of actual controller (not always return name of component like before)
Note the getModel method of Admin controller implemented.

423ff3f 14 Apr 2017

Improve controller classes

b0b26aa 14 Apr 2017

Remove getModel method code in some admin models

joomdonation - open - 14 Apr 2017

joomdonation - change - 14 Apr 2017

Status

New

⇒

Pending

joomla-cms-bot - change - 14 Apr 2017

Category

Administration com_banners com_categories com_content Libraries

⇒

Administration com_banners com_categories com_content Libraries Unit Tests

7a9fdec 14 Apr 2017

name is required for this kind of 'sub-controller'

joomdonation - change - 14 Apr 2017

Labels

Added: ?

d7d2277 14 Apr 2017

Again, need name available for sub-controller

721dcc9 14 Apr 2017

Fix more test

joomdonation - comment - 14 Apr 2017

Travis still false here, but it comes from JPaginationTest and not related to this PR. I did, however, had to change some tests in JControllerFormTest. Those tests are written for none namespace classes and might not be correct anymore now:

As mentioned in PR description, we are now getting option directly from config or input, not guessing from class name anymore. So for those tests, I added option to config array of controller constructor
For controller class name MincesControllerMince, in a Joomla component, I assume it is a sub-controller and comes from the request has task=mince.task_name. With the code I implemented in getInstance() method https://github.com/joomdonation/joomla-cms/blob/721dcc9d14265b8a2a1591f4753503912637223d/libraries/src/CMS/Controller/Controller.php#L296 , we will have name=mince passed to $config array. That's why I pass name=mince to the controller constructor of the test

joomdonation - change - 14 Apr 2017

The description was changed

joomdonation - edited - 14 Apr 2017

1871161 15 Apr 2017

CMS, not Cms

rjcf18 - test_item - 15 Apr 2017 - Tested successfully

rjcf18 - comment - 15 Apr 2017

I have tested this item ✅ successfully on 1871161

I have navigated through several list and edit views on the backend in com_users (users, notes, fields), com_menus (menus, menu items), com_banners(banners, categories, clients, tracks), com_content (articles, categories, fields, field groups, featured articles), published and unpublished several banners and several articles and have found no problems whatsoever. Also went through several pages and modules on the frontend and everything seems to be fine.