Skip to content

Commit 17a8e76

Browse files
jrfnljrfnl
committed
PHP 8.2 | Ruleset: prevent notices about dynamic properties being set
### ⚠️ This PR contains two - albeit small - BC-breaks! ⚠️ The BC-breaks can be broken down as follows: ### For end-users If a property is set via a ruleset for an **_individual_** sniff and that sniff does not have the property explicitly declared, nor does the sniff declare the PHP magic `__set()` method or `extend stdClass`, the ruleset will now be regarded as invalid. In practice, this means the PHPCS run will halt and will show an informative notice to the end-user about the invalid property setting and the PHPCS run will exit with exit code `3`. For properties being set for a complete category of sniffs or a complete standard, the PHPCS run will not halt, nor show an error when the property isn't supported for all sniffs in the category/standard. In that case, the property will only be set on those sniffs which support it (i.e. either have the property explicitly declared on the sniff, or have the magic `__set()` method declared on the sniff, or `extend stdClass`) and will be silently ignored for all other sniffs. 👉 Aside from possibly surfacing some incidental typos in property settings in rulesets, I expect this change to go mostly unnoticed by end-users. ### For developers of PHPCS standards/integrations 1. The format of the `$ruleset['sniff code']['properties']['property name']` sub-array has changed from a `array|string` type property value to a sub-array containing two entries: 1. `'value'` - containing the `array|string` type property value. 2. `'scope'` - containing a string, either `sniff` or `standard`, to indicate whether the ruleset property directive was for an individual sniff or for a whole standard/category of sniffs. 2. The third parameter for the `Ruleset::setSniffProperty()` method has been changed to expect the above mentioned array of `$settings` instead of just a property value. This change is necessary to allow for throwing the error notice when an invalid property is being set on an invalid sniff versus silently ignoring the invalid property if the ruleset specified it on a standard/category. 👉 The impact of this BC-break is expected to be small, as it would require for an external standard or integration of PHPCS to: * `extend` the `Ruleset` class **and** overload the `setSniffProperty()` method to have any impact; * or to call the `setSniffProperty()` method on the `Ruleset` object directly (which _may_ happen in custom test frameworks for external standards). Note: * The change to the `processRule()` method cannot be overloaded as it is a `private` method. * The change in the `populateTokenListeners()` method is only cosmetic and has no functional impact. --- ### Technical choices made: For consistent handling of properties set in a (custom) ruleset across PHP versions, I have chosen to only support setting properties when: * A property is explicitly declared on a sniff class. * A sniff class explicitly declares (or inherits) the magic `__set()` method. * A sniff class `extends` `stdClass`. Note: no additional check has been added to verify that a declared property is `public`. If that is not the case a PHP native error would be thrown previously and still will be now. This behaviour has not changed. I have chosen **not** to respect the `#[\AllowDynamicProperties]` attribute as it is not possible (without tokenizing the sniff files which would create a lot of overhead) to determine whether that attribute exists on a class when PHPCS runs on PHP < 8.0 as the Reflection method needed to detect the attribute is only available on PHP 8.0+. In other words, adding support for the attribute would introduce an inconsistency in how properties set in a ruleset are handled based on the PHP version on which PHPCS is being run. It would also mean that the error notice for invalid properties set on individual sniffs would only be available on PHP 8.2+, which would greatly reduce the usefulness of the error notice. In my opinion, consistency here is more important than supporting the attribute, especially as there are three fully supported ways to allow for supporting properties to be set from a ruleset. The three above mentioned ways to allow for setting properties from a ruleset for a sniff are all fully supported on all PHP versions currently supported by PHPCS, so there is no compelling reason to also allow for the attribute. ### Suggested changelog entry > PHP 8.2: prevent deprecation notices for properties set in a (custom) ruleset for complete standards/complete sniff categories > - Invalid properties set for individual sniffs will now result in an error and halt the execution of PHPCS. > - Properties set for complete standards/complete sniff categories will now only be set on sniffs which explicitly support the property. > The property will be silently ignored for those sniffs which do not support the property. > - For sniff developers: it is strongly recommended for sniffs to explicitly declare any user-adjustable `public` properties. > If dynamic properties need to be supported for a sniff, either declare the magic `__set()`/`__get()`/`__isset()`/`__unset()` methods on the sniff or let the sniff extend `stdClass`. > Note: The `#[\AllowDynamicProperties]` attribute will have **no effect** for properties which are being set in rulesets. > - Sniff developers/integrators of PHPCS may need to make some small adjustments to allow for changes to the PHPCS internals. See the description of PR 3629 for full details. ### Other notes The changes are accompanied by a full set of tests covering the change. There is a little overlap between the `RuleInclusionTest` class and the new `SetSniffPropertyTest` class, but for the most part, the tests compliment each other. Includes: * Correct handling of properties being set via `phpcs:set` annotations. * The `RuleInclusionTest` XML fixture and test expectations have been adjusted to allow for these changes. 1. As we now need "settable" properties to exist on sniffs to use for the `testSettingProperties()` test, the `PSR1` ruleset is not sufficient as the sniffs in that ruleset don't have public properties. For that reason, the "set property for complete standard" test has been changed to use `PSR2` instead and set the `indent` property. The test expectations has been adjusted to match. 2. Along the same lines, the `Zend.NamingConventions` sniffs don't have public properties, so the "setting property for complete category" test has been switched to `PSR12.Operators` and set the `ignoreSpacingBeforeAssignments` property. The test expectations has been adjusted to match. 3. In both these cases, the XML `<rule>` now contains both a property which is valid for at least some sniffs in the standard/category and a property which is invalid in for all sniffs. For the _invalid_ properties, a separate `testSettingInvalidPropertiesOnStandardsAndCategoriesSilentlyFails()` test with data provider has been added to verify these will not be set. 4. As the ruleset has changed, the expectations for the `testHasSniffCodes()` test and the `testRegisteredSniffCodes()` test have been updated to match. 5. The test descriptions for the test cases in the `dataSettingProperties()` have also been updated to make it more explicit what each test case is testing. * The PHPCS ruleset has been updated to exclude sniffs which function as test fixtures from the PHPCS check for this repo. * A minor tweak has been made to the `ValidatePEARPackageXML` script to prevent a warning about sniffs which function as test fixtures. These test fixtures should receive the `role="test"` attribute, not a `role="php"` attribute. Fixes 3489
1 parent ed8e00d commit 17a8e76

20 files changed

+783
-47
lines changed

‎package.xml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,13 +122,32 @@ http://pear.php.net/dtd/package-2.0.xsd">
122122
</dir>
123123
</dir>
124124
<dir name="Ruleset">
125+
<dir name="Fixtures">
126+
<dir name="Sniffs">
127+
<dir name="Category">
128+
<file baseinstalldir="" name="SetPropertyAllowedAsDeclaredSniff.php" role="test" />
129+
<file baseinstalldir="" name="SetPropertyAllowedViaMagicMethodSniff.php" role="test" />
130+
<file baseinstalldir="" name="SetPropertyAllowedViaStdClassSniff.php" role="test" />
131+
<file baseinstalldir="" name="SetPropertyNotAllowedViaAttributeSniff.php" role="test" />
132+
</dir>
133+
</dir>
134+
</dir>
125135
<file baseinstalldir="" name="RuleInclusionTest.php" role="test" />
126136
<file baseinstalldir="" name="RuleInclusionTest.xml" role="test" />
127137
<file baseinstalldir="" name="RuleInclusionTest-include.xml" role="test" />
128138
<file baseinstalldir="" name="RuleInclusionAbsoluteLinuxTest.php" role="test" />
129139
<file baseinstalldir="" name="RuleInclusionAbsoluteLinuxTest.xml" role="test" />
130140
<file baseinstalldir="" name="RuleInclusionAbsoluteWindowsTest.php" role="test" />
131141
<file baseinstalldir="" name="RuleInclusionAbsoluteWindowsTest.xml" role="test" />
142+
<file baseinstalldir="" name="SetSniffPropertyTest.php" role="test" />
143+
<file baseinstalldir="" name="SetPropertyAllowedAsDeclaredTest.xml" role="test" />
144+
<file baseinstalldir="" name="SetPropertyAllowedViaMagicMethodTest.xml" role="test" />
145+
<file baseinstalldir="" name="SetPropertyAllowedViaStdClassTest.xml" role="test" />
146+
<file baseinstalldir="" name="SetPropertyAppliesPropertyToMultipleSniffsInCategoryTest.xml" role="test" />
147+
<file baseinstalldir="" name="SetPropertyThrowsErrorOnInvalidPropertyTest.xml" role="test" />
148+
<file baseinstalldir="" name="SetPropertyNotAllowedViaAttributeTest.xml" role="test" />
149+
<file baseinstalldir="" name="SetPropertyDoesNotThrowErrorOnInvalidPropertyWhenSetForStandardTest.xml" role="test" />
150+
<file baseinstalldir="" name="SetPropertyDoesNotThrowErrorOnInvalidPropertyWhenSetForCategoryTest.xml" role="test" />
132151
</dir>
133152
<dir name="Sniffs">
134153
<file baseinstalldir="" name="AbstractArraySniffTest.inc" role="test" />
@@ -2112,6 +2131,19 @@ http://pear.php.net/dtd/package-2.0.xsd">
21122131
<install as="CodeSniffer/Core/Ruleset/RuleInclusionAbsoluteLinuxTest.xml" name="tests/Core/Ruleset/RuleInclusionAbsoluteLinuxTest.xml" />
21132132
<install as="CodeSniffer/Core/Ruleset/RuleInclusionAbsoluteWindowsTest.php" name="tests/Core/Ruleset/RuleInclusionAbsoluteWindowsTest.php" />
21142133
<install as="CodeSniffer/Core/Ruleset/RuleInclusionAbsoluteWindowsTest.xml" name="tests/Core/Ruleset/RuleInclusionAbsoluteWindowsTest.xml" />
2134+
<install as="CodeSniffer/Core/Ruleset/SetSniffPropertyTest.php" name="tests/Core/Ruleset/SetSniffPropertyTest.php" />
2135+
<install as="CodeSniffer/Core/Ruleset/SetPropertyAllowedAsDeclaredTest.xml" name="tests/Core/Ruleset/SetPropertyAllowedAsDeclaredTest.xml" />
2136+
<install as="CodeSniffer/Core/Ruleset/SetPropertyAllowedViaMagicMethodTest.xml" name="tests/Core/Ruleset/SetPropertyAllowedViaMagicMethodTest.xml" />
2137+
<install as="CodeSniffer/Core/Ruleset/SetPropertyAllowedViaStdClassTest.xml" name="tests/Core/Ruleset/SetPropertyAllowedViaStdClassTest.xml" />
2138+
<install as="CodeSniffer/Core/Ruleset/SetPropertyAppliesPropertyToMultipleSniffsInCategoryTest.xml" name="tests/Core/Ruleset/SetPropertyAppliesPropertyToMultipleSniffsInCategoryTest.xml" />
2139+
<install as="CodeSniffer/Core/Ruleset/SetPropertyNotAllowedViaAttributeTest.xml" name="tests/Core/Ruleset/SetPropertyNotAllowedViaAttributeTest.xml" />
2140+
<install as="CodeSniffer/Core/Ruleset/SetPropertyDoesNotThrowErrorOnInvalidPropertyWhenSetForCategoryTest.xml" name="tests/Core/Ruleset/SetPropertyDoesNotThrowErrorOnInvalidPropertyWhenSetForCategoryTest.xml" />
2141+
<install as="CodeSniffer/Core/Ruleset/SetPropertyDoesNotThrowErrorOnInvalidPropertyWhenSetForStandardTest.xml" name="tests/Core/Ruleset/SetPropertyDoesNotThrowErrorOnInvalidPropertyWhenSetForStandardTest.xml" />
2142+
<install as="CodeSniffer/Core/Ruleset/SetPropertyThrowsErrorOnInvalidPropertyTest.xml" name="tests/Core/Ruleset/SetPropertyThrowsErrorOnInvalidPropertyTest.xml" />
2143+
<install as="CodeSniffer/Core/Ruleset/Fixtures/Sniffs/Category/SetPropertyAllowedAsDeclaredSniff.php" name="tests/Core/Ruleset/Fixtures/Sniffs/Category/SetPropertyAllowedAsDeclaredSniff.php" />
2144+
<install as="CodeSniffer/Core/Ruleset/Fixtures/Sniffs/Category/SetPropertyAllowedViaMagicMethodSniff.php" name="tests/Core/Ruleset/Fixtures/Sniffs/Category/SetPropertyAllowedViaMagicMethodSniff.php" />
2145+
<install as="CodeSniffer/Core/Ruleset/Fixtures/Sniffs/Category/SetPropertyAllowedViaStdClassSniff.php" name="tests/Core/Ruleset/Fixtures/Sniffs/Category/SetPropertyAllowedViaStdClassSniff.php" />
2146+
<install as="CodeSniffer/Core/Ruleset/Fixtures/Sniffs/Category/SetPropertyNotAllowedViaAttributeSniff.php" name="tests/Core/Ruleset/Fixtures/Sniffs/Category/SetPropertyNotAllowedViaAttributeSniff.php" />
21152147
<install as="CodeSniffer/Core/Sniffs/AbstractArraySniffTest.inc" name="tests/Core/Sniffs/AbstractArraySniffTest.inc" />
21162148
<install as="CodeSniffer/Core/Sniffs/AbstractArraySniffTest.php" name="tests/Core/Sniffs/AbstractArraySniffTest.php" />
21172149
<install as="CodeSniffer/Core/Sniffs/AbstractArraySniffTestable.php" name="tests/Core/Sniffs/AbstractArraySniffTestable.php" />
@@ -2220,6 +2252,19 @@ http://pear.php.net/dtd/package-2.0.xsd">
22202252
<install as="CodeSniffer/Core/Ruleset/RuleInclusionAbsoluteLinuxTest.xml" name="tests/Core/Ruleset/RuleInclusionAbsoluteLinuxTest.xml" />
22212253
<install as="CodeSniffer/Core/Ruleset/RuleInclusionAbsoluteWindowsTest.php" name="tests/Core/Ruleset/RuleInclusionAbsoluteWindowsTest.php" />
22222254
<install as="CodeSniffer/Core/Ruleset/RuleInclusionAbsoluteWindowsTest.xml" name="tests/Core/Ruleset/RuleInclusionAbsoluteWindowsTest.xml" />
2255+
<install as="CodeSniffer/Core/Ruleset/SetSniffPropertyTest.php" name="tests/Core/Ruleset/SetSniffPropertyTest.php" />
2256+
<install as="CodeSniffer/Core/Ruleset/SetPropertyAllowedAsDeclaredTest.xml" name="tests/Core/Ruleset/SetPropertyAllowedAsDeclaredTest.xml" />
2257+
<install as="CodeSniffer/Core/Ruleset/SetPropertyAllowedViaMagicMethodTest.xml" name="tests/Core/Ruleset/SetPropertyAllowedViaMagicMethodTest.xml" />
2258+
<install as="CodeSniffer/Core/Ruleset/SetPropertyAllowedViaStdClassTest.xml" name="tests/Core/Ruleset/SetPropertyAllowedViaStdClassTest.xml" />
2259+
<install as="CodeSniffer/Core/Ruleset/SetPropertyNotAllowedViaAttributeTest.xml" name="tests/Core/Ruleset/SetPropertyNotAllowedViaAttributeTest.xml" />
2260+
<install as="CodeSniffer/Core/Ruleset/SetPropertyAppliesPropertyToMultipleSniffsInCategoryTest.xml" name="tests/Core/Ruleset/SetPropertyAppliesPropertyToMultipleSniffsInCategoryTest.xml" />
2261+
<install as="CodeSniffer/Core/Ruleset/SetPropertyDoesNotThrowErrorOnInvalidPropertyWhenSetForCategoryTest.xml" name="tests/Core/Ruleset/SetPropertyDoesNotThrowErrorOnInvalidPropertyWhenSetForCategoryTest.xml" />
2262+
<install as="CodeSniffer/Core/Ruleset/SetPropertyDoesNotThrowErrorOnInvalidPropertyWhenSetForStandardTest.xml" name="tests/Core/Ruleset/SetPropertyDoesNotThrowErrorOnInvalidPropertyWhenSetForStandardTest.xml" />
2263+
<install as="CodeSniffer/Core/Ruleset/SetPropertyThrowsErrorOnInvalidPropertyTest.xml" name="tests/Core/Ruleset/SetPropertyThrowsErrorOnInvalidPropertyTest.xml" />
2264+
<install as="CodeSniffer/Core/Ruleset/Fixtures/Sniffs/Category/SetPropertyAllowedAsDeclaredSniff.php" name="tests/Core/Ruleset/Fixtures/Sniffs/Category/SetPropertyAllowedAsDeclaredSniff.php" />
2265+
<install as="CodeSniffer/Core/Ruleset/Fixtures/Sniffs/Category/SetPropertyAllowedViaMagicMethodSniff.php" name="tests/Core/Ruleset/Fixtures/Sniffs/Category/SetPropertyAllowedViaMagicMethodSniff.php" />
2266+
<install as="CodeSniffer/Core/Ruleset/Fixtures/Sniffs/Category/SetPropertyAllowedViaStdClassSniff.php" name="tests/Core/Ruleset/Fixtures/Sniffs/Category/SetPropertyAllowedViaStdClassSniff.php" />
2267+
<install as="CodeSniffer/Core/Ruleset/Fixtures/Sniffs/Category/SetPropertyNotAllowedViaAttributeSniff.php" name="tests/Core/Ruleset/Fixtures/Sniffs/Category/SetPropertyNotAllowedViaAttributeSniff.php" />
22232268
<install as="CodeSniffer/Core/Sniffs/AbstractArraySniffTest.inc" name="tests/Core/Sniffs/AbstractArraySniffTest.inc" />
22242269
<install as="CodeSniffer/Core/Sniffs/AbstractArraySniffTest.php" name="tests/Core/Sniffs/AbstractArraySniffTest.php" />
22252270
<install as="CodeSniffer/Core/Sniffs/AbstractArraySniffTestable.php" name="tests/Core/Sniffs/AbstractArraySniffTestable.php" />

‎phpcs.xml.dist

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010

1111
<exclude-pattern>*/src/Standards/*/Tests/*\.(inc|css|js)$</exclude-pattern>
1212
<exclude-pattern>*/tests/Core/*/*\.(inc|css|js)$</exclude-pattern>
13+
<exclude-pattern>*/tests/Core/*/Fixtures/*\.php$</exclude-pattern>
1314

1415
<arg name="basepath" value="."/>
1516
<arg name="colors"/>

‎scripts/ValidatePEAR/ValidatePEARPackageXML.php

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -232,10 +232,11 @@ protected function checkFileTag($tag, $currentDirectory='')
232232
$valid = false;
233233
} else {
234234
// Limited validation of the "role" tags.
235-
if (strpos($name, 'Test.') !== false && $role !== 'test') {
235+
if ((strpos($name, 'tests/') === 0 || strpos($name, 'Test.') !== false) && $role !== 'test') {
236236
echo "- Test files should have the role 'test'. Found: '$role' for file '{$name}'.".PHP_EOL;
237237
$valid = false;
238-
} else if ((strpos($name, 'Standard.xml') !== false || strpos($name, 'Sniff.php') !== false)
238+
} else if (strpos($name, 'tests/') !== 0
239+
&& (strpos($name, 'Standard.xml') !== false || strpos($name, 'Sniff.php') !== false)
239240
&& $role !== 'php'
240241
) {
241242
echo "- Sniff files, including sniff documentation files should have the role 'php'. Found: '$role' for file '{$name}'.".PHP_EOL;

‎src/Files/File.php

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -379,9 +379,12 @@ public function process()
379379
if (isset($this->ruleset->sniffCodes[$parts[0]]) === true) {
380380
$listenerCode = array_shift($parts);
381381
$propertyCode = array_shift($parts);
382-
$propertyValue = rtrim(implode(' ', $parts), " */\r\n");
382+
$settings = [
383+
'value' => rtrim(implode(' ', $parts), " */\r\n"),
384+
'scope' => 'sniff',
385+
];
383386
$listenerClass = $this->ruleset->sniffCodes[$listenerCode];
384-
$this->ruleset->setSniffProperty($listenerClass, $propertyCode, $propertyValue);
387+
$this->ruleset->setSniffProperty($listenerClass, $propertyCode, $settings);
385388
}
386389
}
387390
}
@@ -403,9 +406,12 @@ public function process()
403406
$listenerCode = $token['sniffCode'];
404407
if (isset($this->ruleset->sniffCodes[$listenerCode]) === true) {
405408
$propertyCode = $token['sniffProperty'];
406-
$propertyValue = $token['sniffPropertyValue'];
409+
$settings = [
410+
'value' => $token['sniffPropertyValue'],
411+
'scope' => 'sniff',
412+
];
407413
$listenerClass = $this->ruleset->sniffCodes[$listenerCode];
408-
$this->ruleset->setSniffProperty($listenerClass, $propertyCode, $propertyValue);
414+
$this->ruleset->setSniffProperty($listenerClass, $propertyCode, $settings);
409415
}
410416
}
411417
}//end if

‎src/Ruleset.php

Lines changed: 53 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313

1414
use PHP_CodeSniffer\Exceptions\RuntimeException;
1515
use PHP_CodeSniffer\Util;
16+
use stdClass;
1617

1718
class Ruleset
1819
{
@@ -960,6 +961,11 @@ private function processRule($rule, $newSniffs, $depth=0)
960961
if (isset($rule->properties) === true
961962
&& $this->shouldProcessElement($rule->properties) === true
962963
) {
964+
$propertyScope = 'standard';
965+
if ($code === $ref || substr($ref, -9) === 'Sniff.php') {
966+
$propertyScope = 'sniff';
967+
}
968+
963969
foreach ($rule->properties->property as $prop) {
964970
if ($this->shouldProcessElement($prop) === false) {
965971
continue;
@@ -980,9 +986,9 @@ private function processRule($rule, $newSniffs, $depth=0)
980986
$values = [];
981987
if (isset($prop['extend']) === true
982988
&& (string) $prop['extend'] === 'true'
983-
&& isset($this->ruleset[$code]['properties'][$name]) === true
989+
&& isset($this->ruleset[$code]['properties'][$name]['value']) === true
984990
) {
985-
$values = $this->ruleset[$code]['properties'][$name];
991+
$values = $this->ruleset[$code]['properties'][$name]['value'];
986992
}
987993

988994
if (isset($prop->element) === true) {
@@ -1017,7 +1023,10 @@ private function processRule($rule, $newSniffs, $depth=0)
10171023
}
10181024
}//end if
10191025

1020-
$this->ruleset[$code]['properties'][$name] = $values;
1026+
$this->ruleset[$code]['properties'][$name] = [
1027+
'value' => $values,
1028+
'scope' => $propertyScope,
1029+
];
10211030
if (PHP_CODESNIFFER_VERBOSITY > 1) {
10221031
echo str_repeat("\t", $depth);
10231032
echo "\t\t=> array property \"$name\" set to \"$printValue\"";
@@ -1028,7 +1037,10 @@ private function processRule($rule, $newSniffs, $depth=0)
10281037
echo PHP_EOL;
10291038
}
10301039
} else {
1031-
$this->ruleset[$code]['properties'][$name] = (string) $prop['value'];
1040+
$this->ruleset[$code]['properties'][$name] = [
1041+
'value' => (string) $prop['value'],
1042+
'scope' => $propertyScope,
1043+
];
10321044
if (PHP_CODESNIFFER_VERBOSITY > 1) {
10331045
echo str_repeat("\t", $depth);
10341046
echo "\t\t=> property \"$name\" set to \"".(string) $prop['value'].'"';
@@ -1218,8 +1230,8 @@ public function populateTokenListeners()
12181230

12191231
// Set custom properties.
12201232
if (isset($this->ruleset[$sniffCode]['properties']) === true) {
1221-
foreach ($this->ruleset[$sniffCode]['properties'] as $name => $value) {
1222-
$this->setSniffProperty($sniffClass, $name, $value);
1233+
foreach ($this->ruleset[$sniffCode]['properties'] as $name => $settings) {
1234+
$this->setSniffProperty($sniffClass, $name, $settings);
12231235
}
12241236
}
12251237

@@ -1286,18 +1298,48 @@ public function populateTokenListeners()
12861298
*
12871299
* @param string $sniffClass The class name of the sniff.
12881300
* @param string $name The name of the property to change.
1289-
* @param string $value The new value of the property.
1301+
* @param array $settings Array with the new value of the property and the scope of the property being set.
12901302
*
12911303
* @return void
1304+
*
1305+
* @throws \PHP_CodeSniffer\Exceptions\RuntimeException When attempting to set a non-existent property on a sniff
1306+
* which doesn't declare the property or explicitly supports
1307+
* dynamic properties.
12921308
*/
1293-
public function setSniffProperty($sniffClass, $name, $value)
1309+
public function setSniffProperty($sniffClass, $name, $settings)
12941310
{
12951311
// Setting a property for a sniff we are not using.
12961312
if (isset($this->sniffs[$sniffClass]) === false) {
12971313
return;
12981314
}
12991315

1300-
$name = trim($name);
1316+
$name = trim($name);
1317+
$propertyName = $name;
1318+
if (substr($propertyName, -2) === '[]') {
1319+
$propertyName = substr($propertyName, 0, -2);
1320+
}
1321+
1322+
$isSettable = false;
1323+
$sniffObject = $this->sniffs[$sniffClass];
1324+
if (property_exists($sniffObject, $propertyName) === true
1325+
|| ($sniffObject instanceof stdClass) === true
1326+
|| method_exists($sniffObject, '__set') === true
1327+
) {
1328+
$isSettable = true;
1329+
}
1330+
1331+
if ($isSettable === false) {
1332+
if ($settings['scope'] === 'sniff') {
1333+
$notice = "Ruleset invalid. Property \"$propertyName\" does not exist on sniff ";
1334+
$notice .= array_search($sniffClass, $this->sniffCodes, true);
1335+
throw new RuntimeException($notice);
1336+
}
1337+
1338+
return;
1339+
}
1340+
1341+
$value = $settings['value'];
1342+
13011343
if (is_string($value) === true) {
13021344
$value = trim($value);
13031345
}
@@ -1312,7 +1354,7 @@ public function setSniffProperty($sniffClass, $name, $value)
13121354
} else if ($value === 'false') {
13131355
$value = false;
13141356
} else if (substr($name, -2) === '[]') {
1315-
$name = substr($name, 0, -2);
1357+
$name = $propertyName;
13161358
$values = [];
13171359
if ($value !== null) {
13181360
foreach (explode(',', $value) as $val) {
@@ -1328,7 +1370,7 @@ public function setSniffProperty($sniffClass, $name, $value)
13281370
$value = $values;
13291371
}
13301372

1331-
$this->sniffs[$sniffClass]->$name = $value;
1373+
$sniffObject->$name = $value;
13321374

13331375
}//end setSniffProperty()
13341376

‎tests/Core/Ruleset/Fixtures/Sniffs/Category/SetPropertyAllowedAsDeclaredSniff.php

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<?php
2+
/**
3+
* Test fixture.
4+
*
5+
* @see \PHP_CodeSniffer\Tests\Core\Ruleset\SetSniffPropertyTest
6+
*/
7+
8+
namespace Fixtures\Sniffs\Category;
9+
10+
use PHP_CodeSniffer\Files\File;
11+
use PHP_CodeSniffer\Sniffs\Sniff;
12+
13+
class SetPropertyAllowedAsDeclaredSniff implements Sniff
14+
{
15+
16+
public $arbitrarystring;
17+
public $arbitraryarray;
18+
19+
public function register()
20+
{
21+
return [T_WHITESPACE];
22+
}
23+
24+
public function process(File $phpcsFile, $stackPtr)
25+
{
26+
// Do something.
27+
}
28+
}

‎tests/Core/Ruleset/Fixtures/Sniffs/Category/SetPropertyAllowedViaMagicMethodSniff.php

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
<?php
2+
/**
3+
* Test fixture.
4+
*
5+
* @see \PHP_CodeSniffer\Tests\Core\Ruleset\SetSniffPropertyTest
6+
*/
7+
8+
namespace Fixtures\Sniffs\Category;
9+
10+
use PHP_CodeSniffer\Files\File;
11+
use PHP_CodeSniffer\Sniffs\Sniff;
12+
13+
class SetPropertyAllowedViaMagicMethodSniff implements Sniff
14+
{
15+
private $magic = [];
16+
17+
public function __set($name, $value)
18+
{
19+
$this->magic[$name] = $value;
20+
}
21+
22+
public function __get($name)
23+
{
24+
if (isset($this->magic[$name])) {
25+
return $this->magic[$name];
26+
}
27+
28+
return null;
29+
}
30+
31+
public function register()
32+
{
33+
return [T_WHITESPACE];
34+
}
35+
36+
public function process(File $phpcsFile, $stackPtr)
37+
{
38+
// Do something.
39+
}
40+
}

‎tests/Core/Ruleset/Fixtures/Sniffs/Category/SetPropertyAllowedViaStdClassSniff.php

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<?php
2+
/**
3+
* Test fixture.
4+
*
5+
* @see \PHP_CodeSniffer\Tests\Core\Ruleset\SetSniffPropertyTest
6+
*/
7+
8+
namespace Fixtures\Sniffs\Category;
9+
10+
use PHP_CodeSniffer\Files\File;
11+
use PHP_CodeSniffer\Sniffs\Sniff;
12+
use stdClass;
13+
14+
class SetPropertyAllowedViaStdClassSniff extends stdClass implements Sniff
15+
{
16+
17+
public function register()
18+
{
19+
return [T_WHITESPACE];
20+
}
21+
22+
public function process(File $phpcsFile, $stackPtr)
23+
{
24+
// Do something.
25+
}
26+
}

0 commit comments

Comments
 (0)