[Documentation] PSR12 - Constant Visiblity

[dingo-d]

The PR contains the documentation for the PSR12/Properties/ConstantVisiblity sniff.

Description

This PR will add the documentation for the above-mentioned sniff, according to the official standard definitions.

Suggested changelog entry

Add documentation for the PSR12 ConstantVisiblity sniff

Related issues/external references

Part of #148

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
  • This change is only breaking for integrators, not for external standards or end-users.
• Documentation improvement

PR checklist

• I have checked there is no other PR open for the same change.
• I have read the Contribution Guidelines.
• I grant the project the right to include and distribute the code under the BSD-3-Clause license (and I have the right to grant these rights).
• I have added tests to cover my changes.
• I have verified that the code complies with the projects coding standards.
• [Required for new sniffs] I have added XML documentation for the sniff.

[jrfnl]

Thanks for this PR @dingo-d !

Looking good. Just two small questions.

[jrfnl]

Is it "class constants" ? Or all OO constants ? Constants can also be declared on interfaces, traits (PHP 8.2+) and enums, after all.

Also not sure if the "class" needs to be repeated.

Suggested change

	Visibility must be declared on all class constants if your project PHP minimum version supports class constant visibilities (PHP 7.1 or later).
	Visibility must be declared on all class constants if your project PHP minimum version supports constant visibilities (PHP 7.1 or later).

[dingo-d]

Well, the documentation states

The term "class" refers to all classes, interfaces, and traits.

That's why I opted to use that term.

I added the 'class' to distinguish them from defined constants.

[jrfnl]

Well, the documentation states

The term "class" refers to all classes, interfaces, and traits.

That's why I opted to use that term.

I added the 'class' to distinguish them from defined constants.

I fully understand (and support) why it was added, I just wonder if the right term was added. After all, the PSR12 definition is not available from within the PHPCS docs.

[dingo-d]

I've added this to the documentation description, I think it should help to avoid misunderstandings.

[jrfnl]

Thanks @dingo-d ! LGTM.

Only thing I'm wondering about is whether the "The term "class" refers to all classes, interfaces, and traits." phrase should also mention enums ?

Enums didn't exist when PSR12 was written, but the sniff does apply the rule to enums too.

[dingo-d]

Thanks @dingo-d ! LGTM.

Only thing I'm wondering about is whether the "The term "class" refers to all classes, interfaces, and traits." phrase should also mention enums ?

Enums didn't exist when PSR12 was written, but the sniff does apply the rule to enums too.

Good catch! Will update this to add enums as well.