Skip to content

Conversation

@sreichel
Copy link
Contributor

@sreichel sreichel commented Nov 2, 2025

Copilot AI review requested due to automatic review settings November 2, 2025 06:29
@sreichel sreichel added the chore label Nov 2, 2025
@github-actions github-actions bot added Component: PayPal Relates to Mage_Paypal Component: Core Relates to Mage_Core Component: Catalog Relates to Mage_Catalog Component: lib/Varien Relates to lib/Varien Component: Sales Relates to Mage_Sales Component: Usa Relates to Mage_Usa Component: Tax Relates to Mage_Tax Component: lib/* Relates to lib/* php-cs-fixer labels Nov 2, 2025
@sreichel sreichel merged commit 0ee5b5c into OpenMage:main Nov 2, 2025
7 checks passed
@sreichel sreichel deleted the cleanup/phpdoc_var_without_name branch November 2, 2025 06:31
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR applies the phpdoc_var_without_name PHP-CS-Fixer rule to remove variable names from @var annotations in docblocks, aligning the codebase with PHPDoc best practices where property annotations should only contain the type and description, not the property name.

  • Adds the phpdoc_var_without_name rule to the PHP-CS-Fixer configuration
  • Removes redundant variable names from @var annotations across multiple files in the codebase
  • Updates docblocks to follow the standard @var type description format

Reviewed Changes

Copilot reviewed 17 out of 17 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
.php-cs-fixer.dist.php Adds the phpdoc_var_without_name rule to enforce proper @var annotation format
lib/Varien/Object.php Removes variable name from @var annotation for $_hasDataChanges property
lib/Varien/Io/Sftp.php Removes variable name from @var annotation for $_connection property
lib/Varien/Image/Adapter/Abstract.php Removes text from @var annotation for $imageBackgroundColor property
lib/Varien/Cache/Core.php Removes variable name from @var annotation for $_specificOptions property
app/code/core/Mage/Usa/Model/Shipping/Carrier/Dhl/International/Source/Method/*.php Removes variable name from @var annotations for $_contentType property across multiple DHL method classes
app/code/core/Mage/Tax/Model/Config.php Removes variable name from @var annotation for $_shippingPriceIncludeTax property
app/code/core/Mage/Sales/Model/Resource/Setup.php Removes variable names from @var annotations for $_flatEntityTables and $_flatEntitiesGrid properties
app/code/core/Mage/PaypalUk/Model/Express.php Removes variable name from @var annotation for $_proType property
app/code/core/Mage/Paypal/Model/Express.php Removes variable name from @var annotation for $_proType property
app/code/core/Mage/Paypal/Model/Direct.php Removes variable name from @var annotation for $_proType property
app/code/core/Mage/Core/Controller/Request/Http.php Removes variable name from @var annotation for $_isStraight property
app/code/core/Mage/Catalog/Block/Product/List/Toolbar.php Removes variable name from @var annotation for $_paramsMemorizeAllowed property

@sonarqubecloud
Copy link

sonarqubecloud bot commented Nov 2, 2025

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore Component: Catalog Relates to Mage_Catalog Component: Core Relates to Mage_Core Component: lib/Varien Relates to lib/Varien Component: lib/* Relates to lib/* Component: PayPal Relates to Mage_Paypal Component: Sales Relates to Mage_Sales Component: Tax Relates to Mage_Tax Component: Usa Relates to Mage_Usa php-cs-fixer

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant