[#36516] - [4.1] Misc improvements for Task\TaskOption
- Fixed in Code Base
- 12 Mar 2022
- Medium
- Build: 4.1-dev
- # 36516
- Diff
- ditsuke:improve-taskoption-misc
User tests: Successful: Unsuccessful:
Summary of Changes
- Add
@property-readsdocs for better IDE/static analysis support. - Refactor
TaskOption::typetoTaskOption::id
Testing Instructions
- Create a new Scheduled Task with a short interval-based schedule (1 minute).
- Let it run organically at planned time (should be a minute after created).
- Run it manually from the button in the Scheduled Tasks manager.
Actual result BEFORE applying this Pull Request
-
Everything works as expected; but:
-
TaskOption::type doesn't make sense.
-
Poor IDE support for $taskOption->{property} since they're accessed only through TaskOption::__get().
Expected result AFTER applying this Pull Request
-
Everything works as expected; but:
-
TaskOption::id makes more sense.
-
IDE doesn't complain about valid $taskOption->{property{ reads.
Documentation Changes Required
-
| Status | New | ⇒ | Pending |
joomla-cms-bot
- | Category | ⇒ | Administration |
| Labels |
Added:
?
|
||
Create a new task.
Cannot use object of type Joomla\CMS\Object\CMSObject as array
JROOT\administrator\components\com_scheduler\src\Traits\TaskPluginTrait.php:214
Manually running the task.
I have tested this item
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/36516.
I have tested this item
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/36516.
| Status | Pending | ⇒ | Ready to Commit |
RTC
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/36516.
I guess this will break all 3rd party extension, using ->type already, so you need to add the fallback into the magic get method (if "type" use "id") and deprecate it the same moment to make it work.
| Labels |
Added:
?
?
|
||
I guess this will break all 3rd party extension, using
->typealready, so you need to add the fallback into the magic get method (if "type" use "id") and deprecate it the same moment to make it work.
@bembelimen added back with deprecated status. Please review.
| Labels |
Removed:
?
|
||
@bembelimen Does it need 2 tests again? Or is it ok to keep RTC and you review?
We should use the log class instead throwing a PHP depreciation:
https://github.com/joomla/joomla-cms/blob/4.1-dev/libraries/src/Application/CMSApplication.php#L418
Then review is enough
We should use the log class instead throwing a PHP depreciation:
https://github.com/joomla/joomla-cms/blob/4.1-dev/libraries/src/Application/CMSApplication.php#L418
Then review is enough
@ditsuke Could you implement that suggestion? Thanks in advance.
| Labels |
Added:
?
|
||
@richard67 thanks for tagging. Implemented with ef13678.
| Status | Ready to Commit | ⇒ | Fixed in Code Base |
| Closed_Date | 0000-00-00 00:00:00 | ⇒ | 2022-03-12 09:34:54 |
| Closed_By | ⇒ | bembelimen |
Thx
thanks
Tests, please!