[#47701] - fix: replace print_r with json_encode in BaseController debug logging
- Ready to Commit
- Medium
- Build: 6.2-dev
- # 47701
- Diff
- Mahesh-Gite-28:fix/print_r-json
User tests: Successful: Unsuccessful:
- I read the [Generative AI policy](https://developer.joomla.org/generative-ai-policy.html) and my contribution is either not created with the help of AI or is compatible with the policy and GNU/GPL 2 or later.
Summary of Changes
Replace str_replace("\n", ' ', print_r($values, 1)) with
json_encode($values, JSON_UNESCAPED_SLASHES) in three JDEBUG-only
debug log statements inside BaseController.
Affected methods
- checkEditId()
- holdEditId()
- releaseEditId()
Testing Instructions
-
Enable JDEBUG in Joomla configuration.
-
Trigger actions that call:
- checkEditId()
- holdEditId()
- releaseEditId()
-
Verify log output.
Ensure that:
- Logs are generated correctly
- Output is in JSON format
- No functional behavior is affected
Actual result BEFORE applying this Pull Request
Debug logs used print_r() combined with str_replace(),
producing verbose and less readable output with unnecessary processing overhead.
Expected result AFTER applying this Pull Request
Debug logs use json_encode(), producing cleaner, compact, and
more efficient single-line output without extra processing.
Link to documentations
- No documentation changes for guide.joomla.org needed
- No documentation changes for manual.joomla.org needed
| Status | New | ⇒ | Pending |
joomla-cms-bot
- | Category | ⇒ | Libraries |
| Labels |
Added:
PR-6.2-dev
|
||
I think the change is OK. In case we need to check the log, we would want to see ID of items currently being edited. I think [132, 133] for example is cleaner and easier to check than Array ( [0] => 123 [1] => 124 )
@Mahesh-Gite-28 Since $values is just an array of integer, any reasons you use json_encode($values, JSON_UNESCAPED_SLASHES) in your case? Personal, I think it just need to be json_encode($values) or even simpler just simple '[' . implode(', ', $values) . ']' (Not a big thing anyway)
Thanks for the suggestion.
You’re right, since $values only contains integer arrays, JSON_UNESCAPED_SLASHES is unnecessary here.
I’ve updated it to use json_encode($values).
Hi
I’ve addressed the review feedback and updated the implementation accordingly.
All checks are passing now.
Could someone please take another look when convenient?
Thanks!
Hi @joomdonation 👋
I’ve addressed the review feedback and updated the implementation accordingly.
All checks are now passing.
Could you please take another look when convenient?
Thanks!
I have tested this item ✅ successfully on 960cde7
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/47701.
I have tested this item ✅ successfully on 960cde7
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/47701.
@Mahesh-Gite-28 Looks good to me. We still need 2nd test and then hopefully the PR will be accepted.
I have tested this item ✅ successfully on 960cde7
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/47701.
I have tested this item ✅ successfully on 960cde7
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/47701.
| Status | Pending | ⇒ | Ready to Commit |
RTC
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/47701.
RTC
This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/47701.
| Labels |
Added:
RTC
|
||
I have tested this but I dont know if its better or worse or expected
This is the log from opening and saving a module
Before
After