[4.0] Cleanup of controller based on Intellij highlighting #28315
Conversation
wilsonge
changed the title
| * Override parent add method. | ||
| * | ||
| * @return mixed True if the record can be added, a \Exception object if not. | ||
| * @return \Exception|void True if the record can be added, a \Exception object if not. |
There was a problem hiding this comment.
Yup :D I didn’t dare follow the rabbit hole this late but one to come back to
| * @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. |
There was a problem hiding this comment.
Stuff like this makes me realize a lot of the Joomla code would choke up a static analyzer.
-
I'm pretty sure the base
display()method in the controllers only documents a$thisreturn, no type covariance -
I'm pretty sure all of the controller returns are unused anyway, either stuff is being echoed thanks to the output buffer being started or it's just all ignored
-
Seriously, this return type just makes me sad
There was a problem hiding this comment.
I’d like to move a lot of it to exceptions or in many of these cases as we are just setting redirects into the controller probably return $this would work. But for now I’m just documenting correctly can do a second round of cleanup specifically on that
3 participants
Summary of Changes
I was very tired this evening so I did what any sane person would normally do when they're tired. Get inspired by their editor to go cleanup doc blocks, return types etc in all the Joomla controllers in J4 (this wasn't automated before those moan based on the title - i just used the highlighting as a point to review)
Testing Instructions
Code Review
Documentation Changes Required
None. This improves the incode documentation to match reality