[PHPDOC] Fix bad phpdoc Magento\Framework\App\Config\ScopeConfigInterface #39199

dimitriBouteille · 2024-09-23T08:31:36Z

Description (*)

This PR fix bad phpdoc in Magento\Framework\App\Config\ScopeConfigInterface :

getValue : The $scopeCode argument can accept StoreInterface
isSetFlag : The $scopeCode argument can accept StoreInterface

Here is an example where the type StoreInterface is used :

magento2/lib/internal/Magento/Framework/App/Config.php

Lines 66 to 75 in 7377de5

    
           if ($scope !== 'default') { 
        
               if (is_numeric($scopeCode) || $scopeCode === null) { 
        
                   $scopeCode = $this->scopeCodeResolver->resolve($scope, $scopeCode); 
        
               } elseif ($scopeCode instanceof \Magento\Framework\App\ScopeInterface) { 
        
                   $scopeCode = $scopeCode->getCode(); 
        
               } 
        
               if ($scopeCode) { 
        
                   $configPath .= '/' . $scopeCode; 
        
               } 
        
           }

For example, with PHPSTAN is very complicated to setup the project with level 5 or higher :(

Related Pull Requests

None

Fixed Issues (if relevant)

None

Manual testing scenarios (*)

Setup PHPSTAN with level 5 or higher and run check.

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)

Resolved issues:

resolves [Issue] [PHPDOC] Fix bad phpdoc Magento\Framework\App\Config\ScopeConfigInterface #39492: [PHPDOC] Fix bad phpdoc Magento\Framework\App\Config\ScopeConfigInterface

m2-assistant · 2024-09-23T08:31:39Z

Hi @dimitriBouteille. 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:

Database Compare
Functional Tests CE
Functional Tests EE
Functional Tests B2B
Integration Tests
Magento Health Index
Sample Data Tests CE
Sample Data Tests EE
Sample Data Tests B2B
Static Tests
Unit Tests
WebAPI Tests
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.

dimitriBouteille · 2024-09-23T08:31:54Z

@magento run all tests

engcom-Hotel · 2024-12-13T06:18:03Z

@magento run all tests

engcom-Hotel

Hello @dimitriBouteille,

Thank you for your contribution!

The changes look good to us. However, please check the failed tests, particularly the static test, and address the issues accordingly.

dimitriBouteille · 2024-12-16T08:35:38Z

@magento run all tests

dimitriBouteille · 2024-12-16T08:39:07Z

@magento run Static Tests

engcom-Dash · 2024-12-16T09:25:26Z

Hello @dimitriBouteille,

Thank you for your contribution!

The changes look good to us. However, please check the failed tests, particularly the static test, and address the issues accordingly.

@engcom-Hotel- I have fixed the static failures. Moving back to pending review.

cc: @dimitriBouteille

engcom-Dash · 2024-12-16T09:25:34Z

@magento run all tests

dimitriBouteille · 2024-12-16T09:26:07Z

@engcom-Dash Thanks you ❤️

dimitriBouteille · 2024-12-16T13:04:27Z

@engcom-Bravo @engcom-Hotel Why some tests fails ? Same problem here #39153

I think the problem don't come from this PR

engcom-Hotel

Hello @dimitriBouteille,

Please refer to my below review comment

Thanks @engcom-Dash for highlighting the same.

Thanks

lib/internal/Magento/Framework/App/Config/ScopeConfigInterface.php

engcom-Hotel · 2024-12-17T07:14:53Z

@magento run all tests

engcom-Dash · 2024-12-18T07:01:34Z

@magento run all tests

engcom-Dash · 2024-12-18T10:45:59Z

Manual testing is not required here, as this PR is only updating the doc block. Since the builds are failing, moving it to Extended Testing.

engcom-Dash · 2024-12-18T10:46:44Z

@magento run Unit Tests, Functional Tests CE

engcom-Dash · 2024-12-18T11:00:05Z

@magento create issue

engcom-Dash · 2024-12-18T13:00:46Z

The Functional CE test failures are inconsistent in the last two builds and seem to be flaky. They neither part of PR nor failing because of the PR changes, hence moving it to Merge in Progress.

Run 1: https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/39199/a125ed7085d0b92289c951805b6e9521/Functional/allure-report-ce/index.html#categories/bdbf199525818fae7a8651db9eafe741

Run 2: https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/39199/f392145369943d85ff0af0463c0324f9/Functional/allure-report-ce/index.html#categories/ee9a7904470df46f41d453cf2e3cad02/b03e5f18341f5c1f/

Fix bad phpdoc Magento\Framework\App\Config\ScopeConfigInterface

689812b

m2-community-project bot added the Progress: pending review label Sep 23, 2024

Rollback addBreadcrumb

632f588

engcom-Hotel added the Priority: P2 A defect with this priority could have functionality issues which are not to expectations. label Sep 24, 2024

Merge branch '2.4-develop' into phpdoc/scopeConfig

8e329a8

Priyakshic added the Project: Community Picked PRs upvoted by the community label Dec 11, 2024

engcom-Bravo added the Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it label Dec 11, 2024

Merge branch '2.4-develop' into phpdoc/scopeConfig

a9d0893

engcom-Hotel self-requested a review December 13, 2024 06:18

engcom-Hotel requested changes Dec 13, 2024

View reviewed changes

m2-community-project bot assigned engcom-Hotel Dec 13, 2024

m2-community-project bot added Progress: needs update and removed Progress: pending review labels Dec 13, 2024

engcom-Dash self-assigned this Dec 16, 2024

Merge branch '2.4-develop' into phpdoc/scopeConfig

33ba280

39199: fix static failures

7954b26

engcom-Hotel approved these changes Dec 16, 2024

View reviewed changes

m2-community-project bot added the Progress: ready for testing label Dec 16, 2024

engcom-Hotel requested changes Dec 16, 2024

View reviewed changes

lib/internal/Magento/Framework/App/Config/ScopeConfigInterface.php Outdated Show resolved Hide resolved

lib/internal/Magento/Framework/App/Config/ScopeConfigInterface.php Outdated Show resolved Hide resolved

m2-community-project bot added Progress: needs update and removed Progress: ready for testing labels Dec 16, 2024

Fix review

cf6e875

m2-community-project bot added Progress: review and removed Progress: needs update labels Dec 16, 2024

Merge branch '2.4-develop' into phpdoc/scopeConfig

8c8dd99

engcom-Hotel added Progress: pending review and removed Progress: review labels Dec 17, 2024

engcom-Hotel approved these changes Dec 17, 2024

View reviewed changes

m2-community-project bot added Progress: ready for testing and removed Progress: pending review labels Dec 17, 2024

Merge branch '2.4-develop' into phpdoc/scopeConfig

aa0fabc

m2-assistant bot mentioned this pull request Dec 18, 2024

[Issue] [PHPDOC] Fix bad phpdoc Magento\Framework\App\Config\ScopeConfigInterface #39492

Open

5 tasks

engcom-Dash added the Progress: accept label Dec 18, 2024

m2-community-project bot removed the Progress: ready for testing label Dec 18, 2024

Merge branch '2.4-develop' into phpdoc/scopeConfig

d435d88

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[PHPDOC] Fix bad phpdoc Magento\Framework\App\Config\ScopeConfigInterface #39199

[PHPDOC] Fix bad phpdoc Magento\Framework\App\Config\ScopeConfigInterface #39199

dimitriBouteille commented Sep 23, 2024 •

edited by m2-assistant bot

Loading

m2-assistant bot commented Sep 23, 2024

dimitriBouteille commented Sep 23, 2024

engcom-Hotel commented Dec 13, 2024

engcom-Hotel left a comment

dimitriBouteille commented Dec 16, 2024

dimitriBouteille commented Dec 16, 2024

engcom-Dash commented Dec 16, 2024

engcom-Dash commented Dec 16, 2024

dimitriBouteille commented Dec 16, 2024

dimitriBouteille commented Dec 16, 2024 •

edited

Loading

engcom-Hotel left a comment

engcom-Hotel commented Dec 17, 2024

engcom-Dash commented Dec 18, 2024

engcom-Dash commented Dec 18, 2024

engcom-Dash commented Dec 18, 2024

engcom-Dash commented Dec 18, 2024

engcom-Dash commented Dec 18, 2024

	if ($scope !== 'default') {
	if (is_numeric($scopeCode) \|\| $scopeCode === null) {
	$scopeCode = $this->scopeCodeResolver->resolve($scope, $scopeCode);
	} elseif ($scopeCode instanceof \Magento\Framework\App\ScopeInterface) {
	$scopeCode = $scopeCode->getCode();
	}
	if ($scopeCode) {
	$configPath .= '/' . $scopeCode;
	}
	}

[PHPDOC] Fix bad phpdoc Magento\Framework\App\Config\ScopeConfigInterface #39199

Are you sure you want to change the base?

[PHPDOC] Fix bad phpdoc Magento\Framework\App\Config\ScopeConfigInterface #39199

Conversation

dimitriBouteille commented Sep 23, 2024 • edited by m2-assistant bot Loading

Description (*)

Related Pull Requests

Fixed Issues (if relevant)

Manual testing scenarios (*)

Contribution checklist (*)

Resolved issues:

m2-assistant bot commented Sep 23, 2024

dimitriBouteille commented Sep 23, 2024

engcom-Hotel commented Dec 13, 2024

engcom-Hotel left a comment

Choose a reason for hiding this comment

dimitriBouteille commented Dec 16, 2024

dimitriBouteille commented Dec 16, 2024

engcom-Dash commented Dec 16, 2024

engcom-Dash commented Dec 16, 2024

dimitriBouteille commented Dec 16, 2024

dimitriBouteille commented Dec 16, 2024 • edited Loading

engcom-Hotel left a comment

Choose a reason for hiding this comment

engcom-Hotel commented Dec 17, 2024

engcom-Dash commented Dec 18, 2024

engcom-Dash commented Dec 18, 2024

engcom-Dash commented Dec 18, 2024

engcom-Dash commented Dec 18, 2024

engcom-Dash commented Dec 18, 2024

dimitriBouteille commented Sep 23, 2024 •

edited by m2-assistant bot

Loading

dimitriBouteille commented Dec 16, 2024 •

edited

Loading