From cc01a7923d17d4a5cee0b695a257bd17b42a9282 Mon Sep 17 00:00:00 2001 From: Brian Dunne Date: Sat, 22 Feb 2025 22:58:20 -0600 Subject: [PATCH 1/3] Add XML doc for Squiz\Classes\ClassFileName sniff --- .../Docs/Classes/ClassFileNameStandard.xml | 47 +++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 src/Standards/Squiz/Docs/Classes/ClassFileNameStandard.xml diff --git a/src/Standards/Squiz/Docs/Classes/ClassFileNameStandard.xml b/src/Standards/Squiz/Docs/Classes/ClassFileNameStandard.xml new file mode 100644 index 0000000000..046ce20451 --- /dev/null +++ b/src/Standards/Squiz/Docs/Classes/ClassFileNameStandard.xml @@ -0,0 +1,47 @@ + + + + + + + /* ./src/Foo.php contents: */ + +class Foo +{ +} + ]]> + + + /* ./src/Foo.php contents: */ + +class MyFoo +{ +} + ]]> + + + + + /* ./src/MyFoo.php contents: */ + +class MyFoo +{ +} + ]]> + + + /* ./src/myFoo.php contents: */ + +class MyFoo +{ +} + ]]> + + + From 1e8f5db58c9b4f304fd4050c80d82eed1fa602a8 Mon Sep 17 00:00:00 2001 From: Brian Dunne Date: Mon, 24 Feb 2025 20:19:07 -0600 Subject: [PATCH 2/3] [Doc] Emphasize sniff focus for ClassFileName Adjusts the `` tags in the Squiz.Classes.ClassFileName sniff XML docs to better highlight the parts of the code samples that illustrate the purpose of the sniff. --- .../Squiz/Docs/Classes/ClassFileNameStandard.xml | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/src/Standards/Squiz/Docs/Classes/ClassFileNameStandard.xml b/src/Standards/Squiz/Docs/Classes/ClassFileNameStandard.xml index 046ce20451..945513e809 100644 --- a/src/Standards/Squiz/Docs/Classes/ClassFileNameStandard.xml +++ b/src/Standards/Squiz/Docs/Classes/ClassFileNameStandard.xml @@ -7,18 +7,18 @@ /* ./src/Foo.php contents: */ + /* ./src/Foo.php contents: */ -class Foo +class Foo { } ]]> /* ./src/Foo.php contents: */ + /* ./src/Foo.php contents: */ -class MyFoo +class MyFoo { } ]]> @@ -27,18 +27,18 @@ class MyFoo /* ./src/MyFoo.php contents: */ + /* ./src/MyFoo.php contents: */ -class MyFoo +class MyFoo { } ]]> /* ./src/myFoo.php contents: */ + /* ./src/myFoo.php contents: */ -class MyFoo +class MyFoo { } ]]> From f75039a425331ea1e63f19020167e48c6aff8610 Mon Sep 17 00:00:00 2001 From: Brian Dunne Date: Fri, 7 Mar 2025 10:57:00 -0600 Subject: [PATCH 3/3] Correct file/class name relation in sniff doc Per PR #845, the filename must be modified to match the class name, since class names are much more restrictive than filenames and the inverse is not always possible. This clarifies in the example titles that the fix for the invalid code is to modify the filename rather than the class name. --- src/Standards/Squiz/Docs/Classes/ClassFileNameStandard.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Standards/Squiz/Docs/Classes/ClassFileNameStandard.xml b/src/Standards/Squiz/Docs/Classes/ClassFileNameStandard.xml index 945513e809..b252969238 100644 --- a/src/Standards/Squiz/Docs/Classes/ClassFileNameStandard.xml +++ b/src/Standards/Squiz/Docs/Classes/ClassFileNameStandard.xml @@ -14,7 +14,7 @@ class Foo } ]]> - + Foo.php contents: */ @@ -34,7 +34,7 @@ class MyFoo } ]]> - + myFoo.php contents: */