Fix some incorrect PHPDoc return types for \Magento\Framework\View\Page\Config methods

[spalewski]

Description (*)

This pull request fixes some incorrect PHPDoc return types for methods in the \Magento\Framework\View\Page\Config. Previously, some return types were inaccurately documented (@return string was marked instead of @return mixed). This update aligns the PHPDocs with the actual return values to improve code clarity and IDE support.

Contribution checklist (*)

• Pull request has a meaningful description of its purpose
• All commits are accompanied by meaningful commit messages
• All new or changed code is covered with unit/integration tests (if applicable)
• README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
• All automated tests passed successfully (all builds are green)

[m2-assistant]

Hi @spalewski. Thank you for your contribution!
Here are some useful tips on how you can test your changes using Magento test environment.
❗ Automated tests can be triggered manually with an appropriate comment:

• @magento run all tests - run or re-run all required tests against the PR changes
• @magento run <test-build(s)> - run or re-run specific test build(s)
  For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names.

Allowed build names are:

1. Database Compare
2. Functional Tests CE
3. Functional Tests EE
4. Functional Tests B2B
5. Integration Tests
6. Magento Health Index
7. Sample Data Tests CE
8. Sample Data Tests EE
9. Sample Data Tests B2B
10. Static Tests
11. Unit Tests
12. WebAPI Tests
13. Semantic Version Checker

You can find more information about the builds here
ℹ️ Run only required test builds during development. Run all test builds before sending your pull request for review.

---

For more details, review the Code Contributions documentation.
Join Magento Community Engineering Slack and ask your questions in #github channel.

[spalewski]

@magento run all tests

[ihor-sviziev]

@spalewski, could you please explain, when the return type doesn't match?

[spalewski]

@spalewski, could you please explain, when the return type doesn't match?

because it returns value of \Magento\Framework\App\Config\ScopeConfigInterface::getValue and that is: @return mixed. For example could be null in some scenarios (like new store added).

[ihor-sviziev]

@spalewski, could you please provide use cases together with steps to reproduce when these methods don't return a string? It may be better to define a return type string explicitly.

[spalewski]

@spalewski, could you please provide use cases together with steps to reproduce when these methods don't return a string? It may be better to define a return type string explicitly.

Just as I wrote above. Just add new website/store/storeview and use those methods in that scope, for ex. on the homepage (or any CMS page that was in db already). It returns null in that case. Also, values are assigned to $this->metadata array where initial values are: array<string, null>.