Fix the issues reported by phpcs [#3347789]

Problem/Motivation

Fix the phpcs issues reported.

FILE: password_policy_history/tests/src/Unit/PasswordHistoryTest.php
------------------------------------------------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
------------------------------------------------------------------------------------------------------------------
 131 | ERROR | [x] Missing function doc comment
 134 | ERROR | [x] TRUE, FALSE and NULL must be uppercase; expected "TRUE" but found "true"
------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
------------------------------------------------------------------------------------------------------------------


FILE: password_policy_history/password_policy_history.module
------------------------------------------------------------------------------------------------------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 1 LINE
------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 32 | ERROR | The $_POST super global must not be accessed directly; inject the request.stack service and use $stack->getCurrentRequest()->request->get('pass') instead
 32 | ERROR | The $_POST super global must not be accessed directly; inject the request.stack service and use $stack->getCurrentRequest()->request->get('pass') instead
------------------------------------------------------------------------------------------------------------------------------------------------------------------------


FILE: src/Plugin/migrate/process/PolicyConfiguration.php
------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
------------------------------------------------------------------------------------------------------
 127 | ERROR | Type hint "array" missing for $value
------------------------------------------------------------------------------------------------------

Time: 2.28 secs; Memory: 14MB

Steps to reproduce

Run phpcs --standard="Drupal,DrupalPractice" --extensions=php,module,inc,install,test,profile,theme,css,info,yml .

Proposed resolution

Fix the issues reported and re-run the above command to check all issues are fixed.

Issue fork password_policy-3347789

Show commands

Start within a Git clone of the project using the version control instructions.

Add & fetch this issue fork’s repository

Or, if you do not have SSH keys set up on git.drupalcode.org:

Add & fetch this issue fork’s repository

3347789-comment-13 changes, plain diff MR !50
Check out this branch for the first time

Check out existing branch, if you already have it locally

3 hidden branches

3347789-phpcs

changes, plain diff MR !49

Check out this branch for the first time

Check out existing branch, if you already have it locally

phpcs-3347789

changes, plain diff MR !47

Check out this branch for the first time

Check out existing branch, if you already have it locally

3347789-fix-phpcs-issues

changes, plain diff MR !46

Check out this branch for the first time

Check out existing branch, if you already have it locally

About issue forks

Comments

Comment #1

14 March 2023 at 07:41

hardikpandya created an issue. See original summary.

Comment #2

14 March 2023 at 07:53

hardikpandya opened merge request !46

Comment #3

hardikpandya commented 14 March 2023 at 07:54

Assigned:	hardikpandya	» Unassigned
Status:	Active	» Needs review

Comment #4

avpaderno

he/him

Italian

Brescia, 🇮🇹 🇪🇺

commented 14 March 2023 at 08:03

Title:	Fix Drupal Coding Standards \| phpcs	» Fix the issues reported by phpcs
Category:	Bug report	» Task
Priority:	Normal	» Minor
Status:	Needs review	» Needs work
Issue tags:		+Coding standards

+  /**
+   * Set ReflectionClass object.
+   */

That does not describe what the method does. Then, parameters are not documented, nor is the return value.

Comment #5

15 March 2023 at 09:09

kkalashnikov made their first commit to this issue’s fork.

Comment #6

15 March 2023 at 09:09

kkalashnikov opened merge request !47

Comment #7

kunalgautam commented 21 March 2023 at 07:13

Status:

Needs work

» Needs review

Comment #8

17 April 2023 at 15:58

hmendes made their first commit to this issue’s fork.

Comment #9

avpaderno

he/him

Italian

Brescia, 🇮🇹 🇪🇺

commented 18 April 2023 at 13:41

Status:

Needs review

» Needs work

-  public function setProtectedProperty($object, $property, $value) {
-    $reflection = new \ReflectionClass($object);
-    $reflection_property = $reflection->getProperty($property);
-    $reflection_property->setAccessible(true);
-    $reflection_property->setValue($object, $value);
-  }

What reported by PHP_CodeSniffer and shown in the issue summary does not say that method must be removed.

Comment #10

20 April 2023 at 11:46

sakthi_dev made their first commit to this issue’s fork.

Comment #11

20 April 2023 at 11:56

sakthi_dev opened merge request !49

Comment #12

sakthi_dev commented 20 April 2023 at 11:56

Status:

Needs work

» Needs review

Please review.

Comment #13

avpaderno

he/him

Italian

Brescia, 🇮🇹 🇪🇺

commented 20 April 2023 at 20:39

Status:

Needs review

» Needs work

+   * @param $object
+   *   The object variable.
+   * @param $property
+   *   The property variable.
+   * @param $value.
+   *   The variable of value.

Parameters are not described that way. It is not a helpful description, since it repeats the parameter names, adding variable. (Yes, a parameter is a local variable accessible from the function/method. That is how PHP works.)

+   * @return NULL
+   *   Returns Null.
+   */

If a method/function does not return anything, @return does not need to be added.

Comment #14

22 April 2023 at 18:14

Diego_Mow made their first commit to this issue’s fork.

Comment #15

22 April 2023 at 18:17

Diego_Mow opened merge request !50

Comment #16

diego_mow commented 22 April 2023 at 18:18

Status:

Needs work

» Needs review

MR 50 fixes same code from MR 49 + Comments on #13.

Comment #17

alina.basarabeanu commented 9 August 2023 at 15:30

I applied the changes from MR 50 to Drupal Version 9.5.10 and Password Policy 4.0.0 but I still get a lot of phpcs errors.
I will list just a few.

FILE: /docroot/modules/contrib/password_policy/password_policy_delay/src/Plugin/PasswordConstraint/PasswordDelay.php
---------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
---------------------------------------------------------------------------------------------------------------------------
12 | ERROR | [x] Use statements should be sorted alphabetically. The first wrong one is Drupal\Core\Password\PasswordInterface.
---------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-------------------------------------------------------------------

FILE: /docroot/modules/contrib/password_policy/PATCHES.txt
-----------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AND 1 WARNING AFFECTING 2 LINES
-----------------------------------------------------------------------------------------------------------------------
1 | WARNING | [ ] Line exceeds 80 characters; contains 104 characters
5 | ERROR | [x] Expected 1 newline at end of file; 3 found
-----------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-----------------------------------------------------------------------------------------------------------------------

FILE: /docroot/modules/contrib/password_policy/password_policy.module
FOUND 1 ERROR AFFECTING 1 LINE
---------------------------------------------------------------------------------------------------------------------------
10 | ERROR | [x] Use statements should be sorted alphabetically. The first wrong one is Drupal\Core\Entity\EntityInterface.
---------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY

FILE: /docroot/modules/contrib/password_policy/password_policy_history/tests/src/Unit/PasswordHistoryTest.php
---------------------------------------------------------------------------------------------------------------------------
FOUND 5 ERRORS AFFECTING 5 LINES
---------------------------------------------------------------------------------------------------------------------------
7 | ERROR | [x] Use statements should be sorted alphabetically. The first wrong one is Drupal\Core\Password\PasswordInterface.
22 | ERROR | [x] Data types in @var tags need to be fully namespaced
129 | ERROR | [x] Expected 1 blank line after function; 0 found
130 | ERROR | [ ] Parameter $value is not described in comment
137 | ERROR | [x] Doc comment parameter name "$value." must not end with a dot
---------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 4 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------------------------------------------------------