Skip to content

PHPStan/DOCBlock fixes ... #2336

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
Parent: Fixed "if newsletter module disabled, customer backend would blank without notice"
merged 8 commits into from
Aug 9, 2022
Merged

PHPStan/DOCBlock fixes ... #2336

merged 8 commits into from
Aug 9, 2022

Conversation

@sreichel
Copy link
Contributor

@sreichel sreichel commented Jul 24, 2022 •
edited
Loading

Description (*)

  • fixed "a few" phpstan errors
  • added some DOCs
  • removed useless @return void

Related Pull Requests

#2146

Manual testing scenarios (*)

  1. run vendor/bin/phpstan analyze -c .github/phpstan.neon

Contribution checklist (*)

  • Pull request has a meaningful description of its purpose
  • All commits are accompanied by meaningful commit messages
  • All automated tests passed successfully (all builds are green)
  • Add yourself to contributors list

@sreichel
PHPStan/DOCBlock fixes ...
01dc0a0 
- fixed "a few" phpstan errors
- added some DOCs
- removed useless @return void
@github-actions github-actions bot added Component: Adminhtml Relates to Mage_Adminhtml Component: Admin Relates to Mage_Admin Component: Api PageRelates to Mage_Api Component: Api2 Relates to Mage_Api2 Component: Authorizenet Relates to Mage_Authorizenet Component: Backup Relates to Mage_Backup Component: Bundle Relates to Mage_Bundle Component: Captcha Relates to Mage_Captcha Component: Catalog Relates to Mage_Catalog Component: CatalogRule Relates to Mage_CatalogRule Component: CatalogSearch Relates to Mage_CatalogSearch Component: Checkout Relates to Mage_Checkout Component: Cms Relates to Mage_Cms Component: ConfigurableSwatches Relates to Mage_ConfigurableSwatches Component: Core Relates to Mage_Core Component: CurrencySymbol Relates to Mage_CurrencySymbol Component: Customer Relates to Mage_Customer Component: Dataflow Relates to Mage_Dataflow Component: Directory Relates to Mage_Directory Component: Downloadable Relates to Mage_Downloadable Component: Eav Relates to Mage_Eav Component: GoogleAnalytics Relates to Mage_GoogleAnalytics Component: ImportExport Relates to Mage_ImportExport Component: Index Relates to Mage_Index Component: Oauth Relates to Mage_Oauth Component: Page Relates to Mage_Page Component: PageCache Relates to Mage_PageCache Component: Paygate Relates to Mage_Paygate Component: Payment Relates to Mage_Payment labels Jul 24, 2022
@github-actions

This comment has been minimized.

Sign in to view
@github-actions

This comment has been minimized.

Sign in to view
1 similar comment
@github-actions

This comment has been minimized.

Sign in to view
@github-actions

This comment has been minimized.

Sign in to view
1 similar comment
@github-actions

This comment has been minimized.

Sign in to view
@github-actions

This comment has been minimized.

Sign in to view
1 similar comment
@github-actions

This comment has been minimized.

Sign in to view
@sreichel
Copy link
Contributor Author

sreichel commented Aug 9, 2022 •
edited
Loading

Last commit ... for some reason commented lines did not work anymore (locally)... moved them to excludePaths.

@sreichel sreichel requested review from fballiano and kiatng August 9, 2022 00:27
@github-actions

This comment has been minimized.

Sign in to view
1 similar comment
@github-actions

This comment has been minimized.

Sign in to view
@github-actions

This comment has been minimized.

Sign in to view
1 similar comment
@github-actions

This comment has been minimized.

Sign in to view
@sreichel sreichel requested a review from elidrissidev August 9, 2022 05:02
luigifab
luigifab approved these changes Aug 9, 2022
View reviewed changes
Copy link
Contributor

@luigifab luigifab left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose PHPStan says always the truth. Not tested.
Doc block changes, some return added, one undefined variable defined, 2x ->useProductItem() changed to ->useProductItem(true).

@fballiano fballiano merged commit d782c4d into 1.9.4.x Aug 9, 2022
@fballiano fballiano deleted the phpstan-fixes branch August 9, 2022 09:41
@github-actions
Copy link
Contributor

github-actions bot commented Aug 9, 2022

Unit Test Results

1 files  ±0  1 suites  ±0   0s ⏱️ ±0s
0 tests ±0  0 ✔️ ±0  0 💤 ±0  0 ❌ ±0 
7 runs  ±0  5 ✔️ ±0  2 💤 ±0  0 ❌ ±0 

Results for commit d782c4d. ± Comparison against base commit 8d2a11b.

@sreichel
Copy link
Contributor Author

sreichel commented Aug 10, 2022 •
edited
Loading

I suppose PHPStan says always the truth. Not tested. Doc block changes, some return added, one undefined variable defined, 2x ->useProductItem() changed to ->useProductItem(true).

All changes are manually reviewed.

  • added returns to nothing else than return $this ... (will be unified in later PR)
  • useProductItem() ... either this methot accecpts no paramenters or default value is true.

sreichel added a commit that referenced this pull request Aug 12, 2022
@fballiano @sreichel
@Schrank @colinmollenhour @Sdfendor @kiatng @discountscott @addison74 @justinbeaty @luigifab @Flyingmana @leissbua
Merge v19 into v20 (#2370)
71998f5 
* Merge PR #2342

* Revert "Add basic text for Ukraine (#2074)" (#2325)

This reverts commit 33dfa26.

* Mage_Catalog_Model_Product_Attribute_Backend_Groupprice_Abstract: avoid loading all websites when using only the current one (#2351)

* Added support for HTTP2 to Mage_HTTP_Client_Curl (#1137)

* Blocked access to all dot files (#2349)

* Capitalization Adjustment Regarding CamelCase in Method Names (#2365)

* refactor: Adjusted capitalization of two public methods.

* refactor: Adjusted capitalization of one protected method.

* refactor: Adjusted capitalization of where call.

* chore: Removed fixed error from phpstan baseline.

* Some microoptimization (#2335)

* Avoid duplicate method calls

* Replaced array_push()

* Changed substr() third parameter

* Use array_key_exists()

* php7 opcode - internal functions

* Enclosed error with <pre> tag for prettier error print (if developer mode is enabled). (#2368)

* Updated phpstan to 1.8.2 (#2367)

* Escape product titles in MSRP JavaScript (#2366)

* Product names were not escaped. If contained a double quote, would break the JavaScript for MSRP/MAP

* update contribution list

* Update boxes.css (#2330)

* Force describeTable() to use read DB adapter (#2371)

* Do not install n98/n98_layouthelper (#2373)

* Add apt update to XML validation workflow (#2376)

* Merged PR #2375

* Replace remaining "sizeof" calls with "count" (#2369)

* Remove DISCLAIMER and change Magento -> OpenMage in header (#2297)

* Added label for phpstan cosmetic changes (#2384)

* Added weight to salesOrderShipmentAddTrack API (#1377)

* PHPStan/DOCBlock fixes (#2336)

* Updated docs for email addTo() (#2382)

* Updated phpstan experimental (#2386)

* Cosmetic changes to Mage_Payment_Model_Method_Abstract::validate() (#2388)

* Replaced join() calls with implode() (#2389)

* Hidden empty sub menu from backend (#2391)

* Remove Thumbs.db file (#2394)

* Support PHP 8.1 in composer.json (#2378)

* php condition in composer.json

This solves the issue related to php versions > 8.1

* Reduced condition for PHP requirement

* Changed PHP requirement

* Updated version in Ubuntu 22.04 based on PHP 8.1.2

* Composer.lock updated in Ubuntu 20.04 (PHP 8.1.2)

* Update composer.lock

* Update composer.lock

* Blocked various file types in .htaccess (#2359)

* Color swatches work with disparate product IDs (#2390)

* Move Credit Memo at the end of the buttons list (#2392)

* Version bump (#2387)

* Minor fixes on 'filter_condition_callback' method _filterStoreCondition() (#2362)

* add ReturnTypeWillChange to various Files catched by code style checker #2302

* Phpstan fixes (#2396)

* Fixed addCrumb()

* Fixed initForm() and _needToAddDummy()

* Fixed addLink()

* Fixed addLinkRel()

* Fixed canUseCanonicalTag()

* Fixed getAddUrl...()

* Fixed rollBack() camelCase error reported by phpstan (#2403)

* Changes default root dir in composer.json (#2401)

* Fixed targetNamespace for WS-I Compliant SOAP APIs (#2405)

* Updated phpstan baseline

Co-authored-by: sv3n <[email protected]>
Co-authored-by: Fabian Blechschmidt <[email protected]>
Co-authored-by: Colin Mollenhour <[email protected]>
Co-authored-by: Kevin Jakob <[email protected]>
Co-authored-by: Ng Kiat Siong <[email protected]>
Co-authored-by: Scott Moore <[email protected]>
Co-authored-by: ADDISON <[email protected]>
Co-authored-by: Justin Beaty <[email protected]>
Co-authored-by: luigifab <[email protected]>
Co-authored-by: Daniel Fahlke <[email protected]>
Co-authored-by: leissbua <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kiatng kiatng kiatng approved these changes

@addison74 addison74 addison74 approved these changes

@fballiano fballiano Awaiting requested review from fballiano

@elidrissidev elidrissidev Awaiting requested review from elidrissidev

+1 more reviewer

@luigifab luigifab luigifab approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Component: Admin Relates to Mage_Admin Component: Adminhtml Relates to Mage_Adminhtml Component: Api PageRelates to Mage_Api Component: Api2 Relates to Mage_Api2 Component: Authorizenet Relates to Mage_Authorizenet Component: Backup Relates to Mage_Backup Component: Bundle Relates to Mage_Bundle Component: Captcha Relates to Mage_Captcha Component: Catalog Relates to Mage_Catalog Component: CatalogRule Relates to Mage_CatalogRule Component: CatalogSearch Relates to Mage_CatalogSearch Component: Checkout Relates to Mage_Checkout Component: Cms Relates to Mage_Cms Component: ConfigurableSwatches Relates to Mage_ConfigurableSwatches Component: Core Relates to Mage_Core Component: CurrencySymbol Relates to Mage_CurrencySymbol Component: Customer Relates to Mage_Customer Component: Dataflow Relates to Mage_Dataflow Component: Directory Relates to Mage_Directory Component: Downloadable Relates to Mage_Downloadable Component: Eav Relates to Mage_Eav Component: GoogleAnalytics Relates to Mage_GoogleAnalytics Component: ImportExport Relates to Mage_ImportExport Component: Index Relates to Mage_Index Component: Oauth Relates to Mage_Oauth Component: Page Relates to Mage_Page Component: PageCache Relates to Mage_PageCache Component: Paygate Relates to Mage_Paygate Component: Payment Relates to Mage_Payment Component: PayPal Relates to Mage_Paypal Component: Poll Relates to Mage_Poll Component: Rating Relates to Mage_Rating Component: Reports Relates to Mage_Reports Component: Rss Relates to Mage_Rss Component: Sales Relates to Mage_Sales Component: SalesRule Relates to Mage_SalesRule Component: Shipping Relates to Mage_Shipping Component: Tag Relates to Mage_Tag Component: Tax Relates to Mage_Tax Component: Usa Relates to Mage_Usa Component: Weee Relates to Mage_Weee Component: Wishlist Relates to Mage_Wishlist environment phpstan

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@sreichel @fballiano @kiatng @addison74 @luigifab