Skip to content

Conversation

@muhme
Copy link
Contributor

@muhme muhme commented Oct 22, 2025

User description

  • As named as one requirement in Pre-Update Check improvements PR 46324 and linked to this place extended one line for 6.x with parse_ini_string.
  • As checked it is already included in 4.4.14 administrator/components/com_joomlaupdate/src/Model/UpdateModel.php, also added for 5.x.
  • Some trailing spaces removed.

PR Type

Documentation


Description

  • Added parse_ini_string requirement to technical documentation

  • Replaced trailing spaces with HTML line breaks for consistency

  • Updated Joomla 6.x, 5.x, and 5.4 (Legacy) documentation

  • Added new "Required PHP Configuration" section


Diagram Walkthrough

flowchart LR
  A["Technical Requirements Docs"] -->|Add parse_ini_string| B["Required PHP Configuration"]
  A -->|Replace trailing spaces| C["HTML line breaks"]
  B -->|Apply to| D["Joomla 6.x, 5.x, 5.4"]
Loading

File Walkthrough

Relevant files
Documentation
technical-requirements.md
Add parse_ini_string requirement and fix formatting           

docs/get-started/technical-requirements.md

  • Added new "Required PHP Configuration" section documenting
    parse_ini_string requirement for Joomla 6.x and 5.x
  • Replaced trailing spaces with HTML line breaks (
    ) for proper
    formatting
  • Maintained consistency across all requirement sections
+7/-5     
technical-requirements.md
Add parse_ini_string requirement to 5.4 legacy docs           

versioned_docs/version-5.4/get-started/technical-requirements.md

  • Added new "Required PHP Configuration" section documenting
    parse_ini_string requirement for Joomla 5.4 (Legacy)
  • Replaced trailing spaces with HTML line breaks (
    ) for proper
    formatting
  • Fixed file ending with newline character
+4/-3     

* As named as one requirement in Pre-Update Check improvements PR
  [46324](joomla/joomla-cms#46324) and linked to this place
  extended one line for 6.x with `parse_ini_string`.
* As checked it is already included in 4.4.14
  `administrator/components/com_joomlaupdate/src/Model/UpdateModel.php`, also added for 5.x.
* Trailing spaces removed.
@qodo-merge-pro
Copy link
Contributor

qodo-merge-pro bot commented Oct 22, 2025

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
🟢
No security concerns identified No security vulnerabilities detected by AI analysis. Human verification advised for critical code.
Ticket Compliance
🎫 No ticket provided
- [ ] Create ticket/issue <!-- /create_ticket --create_ticket=true -->

</details></td></tr>
Codebase Duplication Compliance
Codebase context is not defined

Follow the guide to enable codebase context checks.

Custom Compliance
No custom compliance provided

Follow the guide to enable custom compliance check.

  • Update
Compliance status legend 🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

@muhme
Copy link
Contributor Author

muhme commented Oct 22, 2025

@richard67 could you please check and merge?

@qodo-merge-pro
Copy link
Contributor

qodo-merge-pro bot commented Oct 22, 2025

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
General
Improve clarity of PHP requirement

Improve the PHP configuration requirement by rephrasing it more formally and
adding specific guidance about the php.ini file and the disable_functions
directive.

docs/get-started/technical-requirements.md [27]

-**Required PHP Configuration:** Don't disable the `parse_ini_string` core function.
+**Required PHP Configuration:** The `parse_ini_string` function must not be disabled. This is typically configured in `php.ini` via the `disable_functions` directive.
  • Apply / Chat
Suggestion importance[1-10]: 6

__

Why: The suggestion improves the documentation's clarity and helpfulness by using more formal language and providing actionable guidance on where to check for the parse_ini_string function's status.

Low
  • Update

@muhme
Copy link
Contributor Author

muhme commented Oct 22, 2025

Improve clarity of PHP requirement

👎 The additional requirement should be as short as the other requirements.

@muhme muhme marked this pull request as draft October 22, 2025 16:02
@muhme
Copy link
Contributor Author

muhme commented Oct 22, 2025

Setting to DRAFT as formatting is lost, will improve

- and added `parse_ini_string` requirement also for 5.4 (Legacy)
@HLeithner
Copy link
Member

Sorry, that doesn't make sense to add single configuration options here, if you really like to add all needed php option here then you need to create a new page which handles "how to configure a webserver" or similar.

We have many options that need to be right so that joomla works.

@muhme
Copy link
Contributor Author

muhme commented Oct 22, 2025

ah, the trailing spaces are for line breaks, now replaced by HTML line break and added parse_ini_string requirement also for 5.4 (Legacy), ready for review

@muhme
Copy link
Contributor Author

muhme commented Oct 22, 2025

Sorry, that doesn't make sense to add single configuration options here, if you really like to add all needed php option here then you need to create a new page which handles "how to configure a webserver" or similar.

We have many options that need to be right so that joomla works.

Is this not a special case? There is one check in Pre-Update and if this check fails, there is a link to the Technical Requirements, as every failed requirement setting has an advice how to fix. But INI Parser support is not named in Technical Requirements. All other advices are working ...

fail

@muhme muhme marked this pull request as ready for review October 22, 2025 16:48
@qodo-merge-pro
Copy link
Contributor

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
🟢
No security concerns identified No security vulnerabilities detected by AI analysis. Human verification advised for critical code.
Ticket Compliance
🎫 No ticket provided
- [ ] Create ticket/issue <!-- /create_ticket --create_ticket=true -->

</details></td></tr>
Codebase Duplication Compliance
Codebase context is not defined

Follow the guide to enable codebase context checks.

Custom Compliance
No custom compliance provided

Follow the guide to enable custom compliance check.

Compliance status legend 🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

@qodo-merge-pro
Copy link
Contributor

PR Code Suggestions ✨

No code suggestions found for the PR.

@HLeithner
Copy link
Member

I have no idea why it's checked because if this function is disabled, it's only relevant if parse_ini_file is disabled.
I think the reason for this was for old php version since the getIniParserAvailability method is from Joomla 3.1 where I think that parse_ini_string was not always part of php.

So actually joomla doesn't need parse_ini_string only if parse_ini_file doesn't exists and in this case you would not came to this page, or at least have no text. only placeholders. Should or could be removed from the update checker in my opinion.

@richard67
Copy link
Member

So actually joomla doesn't need parse_ini_string only if parse_ini_file doesn't exists

@HLeithner That is not right. The code of the pre update checker also checks if the parse_ini_string method is in the disable_functions PHP ini parameter, and that still can be the case.

@richard67
Copy link
Member

P.S.: Anyway, as long as we have that check with the link to the requirements in the pre-update checker, this PR here makes sense to me, and if it should be removed from the pre-update check, the documentation can be adjusted with a corresponding PR linked to the CMS PR which removes it.

@richard67
Copy link
Member

@muhme When checking the preview in the CI checks, I can see your change on the 5.4 and the 6.1 page, but not on the 6.0 page. I think you have to add it also to here: versioned_docs/version-6.0/get-started/technical-requirements.md. It seems the unversioned pages are shown for 6.1, and 6.0 is (like 5.4) in the versioned pages..

@HLeithner
Copy link
Member

P.S.: Anyway, as long as we have that check with the link to the requirements in the pre-update checker, this PR here makes sense to me, and if it should be removed from the pre-update check, the documentation can be adjusted with a corresponding PR linked to the CMS PR which removes it.

please check the cms code, it makes no sense to check for it, disable
this is the only place where parse_ini_string is called and only if parse_ini_file doesn't exists or is disabled.
image

parse_ini_file disabled:
image

parse_ini_string disabled:
image

if both disabled:
image

so as you can see, this check is completely use less and adding this requirement is also useless because else you need 100 other php options which need to be set to joomla works for example request_order.

@muhme
Copy link
Contributor Author

muhme commented Oct 22, 2025

@muhme When checking the preview in the CI checks, I can see your change on the 5.4 and the 6.1 page, but not on the 6.0 page

@richard67 Thank you for checking, I have added for 6.0 (Current) too

@richard67
Copy link
Member

Hmm, maybe the pre-update check should be adjusted so it does not check the parse_ini_string but checks the parse_ini_file for not being disabled?

@HLeithner
Copy link
Member

it doesn't need to check it at all, if it is not there it will break as you see in the red screenshot. if it falls back to parse_ini_string it doesn't matter, so why scare people.

@muhme
Copy link
Contributor Author

muhme commented Oct 23, 2025

Thank you @HLeithner and @richard67 for your investigations. Created joomla/joomla-cms#46359

@muhme muhme closed this Oct 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants