Updates coding standard to something PSR-12-ish #7886

Sesquipedalian · 2023-11-15T21:07:20Z

PSR-12 with tab indentation and closing PHP tags (for now, anyway), plus a selection of other nice cleanup options.

PSR-12 with tab indentation and closing PHP tags (for now, anyway), plus a selection of other nice cleanup options. Signed-off-by: Jon Stovell <jonstovell@gmail.com>

Signed-off-by: Jon Stovell <jonstovell@gmail.com>

live627 · 2023-11-16T01:31:26Z

Sources/Actions/Activate.php

-		$request = Db::$db->query('', '
+		$request = Db::$db->query(
+			'',
+			'


This one's funny. Even though it looks strange, it's consistent with other params on their own lines.

Well its a bc breakage. But we could introduce a identifierQuery() and drop the first param off this one. Considering like 95% of our queries don't need this.

Well its a bc breakage. But we could introduce a identifierQuery() and drop the first param off this one. Considering like 95% of our queries don't need this.

That's a good idea. We'd just need to switch which method the backward compatibility entry in Utils::$smcFunc pointed to, and we'd be good to go.

Hm. Here's another option that would introduce fewer complications for backward compatibility.

$request = Db::$db->query( '', 'SELECT id_member, validation_code, member_name, real_name, email_address, is_activated, passwd, lngfile FROM {db_prefix}members' . (empty($_REQUEST['u']) ? ' WHERE member_name = {string:email_address} OR email_address = {string:email_address}' : ' WHERE id_member = {int:id_member}') . ' LIMIT 1', [ 'id_member' => isset($_REQUEST['u']) ? (int) $_REQUEST['u'] : 0, 'email_address' => $_POST['user'] ?? '', ], );

Taking out the extra line break at the start of the query string makes it look a lot less weird in my opinion.

Does help but still looks odd. If this is easier then go this way. Maybe we introduce that in 3.1 or another future release.

Well its a bc breakage

Not is not. Bots never do bc breaks unless specifically told to.

I believe @jdarwood007 meant that his idea to make an identifierQuery() method would break backward compatibility.

Signed-off-by: Jon Stovell <jonstovell@gmail.com> # Conflicts: # Sources/Security.php

Signed-off-by: Jon Stovell <jonstovell@gmail.com>

jdarwood007

I give it my approval as this is just code standards and we just want to align on something that is easier enough for all of us to ensure our code meets prior to sending up PRs

jdarwood007 · 2023-11-16T03:58:05Z

FYI, there are only 42 (nice) uses of the identifier

jeremy@Zeus:~/repos/sm/SMF3.0(release-3.0○) » grep -Rn "Db::\$db->query(\s*'\w"
./other/upgrade_2-1_postgresql.sql:64:	Db::$db->query('truncate_table', '
./other/upgrade_2-1_mysql.sql:99:	Db::$db->query('truncate_table', '
./other/upgrade.php:1956:		Db::$db->query('substring', '
./Sources/tasks/FetchSMFiles.php:80:			Db::$db->query('substring', '
./Sources/ServerSideIncludes.php:488:		$request = Db::$db->query('substring', '
./Sources/ServerSideIncludes.php:632:		$request = Db::$db->query('substring', '
./Sources/ServerSideIncludes.php:665:		$request = Db::$db->query('substring', '
./Sources/PersonalMessage/PM.php:1255:			$request = Db::$db->query('pm_find_username', '
./Sources/User.php:1399:				Db::$db->query('delete_log_online_interval', '
./Sources/Actions/Recent.php:192:		$request = Db::$db->query('substring', '
./Sources/Actions/Admin/Maintenance.php:275:		$result = Db::$db->query('order_by_board_order', '
./Sources/Actions/Admin/Maintenance.php:913:		Db::$db->query('truncate_table', '
./Sources/Actions/Admin/Maintenance.php:921:		Db::$db->query('truncate_table', '
./Sources/Actions/Admin/Maintenance.php:924:		Db::$db->query('truncate_table', '
./Sources/Actions/Admin/Maintenance.php:927:		Db::$db->query('truncate_table', '
./Sources/Actions/Admin/Subscriptions.php:739:				Db::$db->query('substring', '
./Sources/Actions/Admin/Bans.php:1977:			Db::$db->query('truncate_table', '
./Sources/Actions/Admin/Themes.php:350:			$request = Db::$db->query('themes_count', '
./Sources/Actions/Admin/Themes.php:464:					Db::$db->query('substring', '
./Sources/Actions/Admin/Themes.php:476:					Db::$db->query('substring', '
./Sources/Actions/Admin/Themes.php:527:					Db::$db->query('substring', '
./Sources/Actions/Admin/Themes.php:539:					Db::$db->query('substring', '
./Sources/Actions/Admin/Reports.php:292:		$request = Db::$db->query('order_by_board_order', '
./Sources/Actions/Admin/ErrorLog.php:580:			Db::$db->query('truncate_table', '
./Sources/Actions/Admin/Tasks.php:412:			Db::$db->query('truncate_table', '
./Sources/Actions/Admin/Boards.php:988:		$request = Db::$db->query('order_by_board_order', '
./Sources/Actions/Admin/Calendar.php:418:			$request = Db::$db->query('order_by_board_order', '
./Sources/Actions/Unread.php:840:		$this->topic_request = Db::$db->query('substring', '
./Sources/Actions/Unread.php:906:		$this->topic_request = Db::$db->query('substring', '
./Sources/Actions/Search.php:174:		$request = Db::$db->query('order_by_board_order', '
./Sources/Actions/UnreadReplies.php:267:		$this->topic_request = Db::$db->query('substring', '
./Sources/Actions/UnreadReplies.php:296:		$request = Db::$db->query('unread_fetch_topic_count', '
./Sources/Actions/UnreadReplies.php:364:		$this->topic_request = Db::$db->query('substring', '
./Sources/Actions/Profile/IgnoreBoards.php:74:		$request = Db::$db->query('order_by_board_order', '
./Sources/Actions/Profile/StatPanel.php:103:		$result = Db::$db->query('distinct_poll_votes', '
./Sources/Actions/Profile/StatPanel.php:155:		$result = Db::$db->query('profile_board_stats', '
./Sources/Actions/Profile/StatPanel.php:188:		$result = Db::$db->query('user_activity_by_time', '
./Sources/Actions/Profile/ShowPermissions.php:88:		$request = Db::$db->query('order_by_board_order', '
./Sources/Actions/Credits.php:371:			$request = Db::$db->query('substring', '
./Sources/Actions/MessageIndex.php:241:		$request = Db::$db->query('order_by_board_order', '
./Sources/Actions/MessageIndex.php:668:		$result = Db::$db->query('substring', '
./Sources/Actions/Memberlist.php:324:			$request = Db::$db->query('substring', '

BrickOzp · 2023-11-16T07:05:26Z

.php-cs-fixer.dist.php

To me, blank line before "break" looks weird. But if that is in PSR-12 let's go with it.

It's not required by PSR-12. I've tweaked the rules now to change that bit.

Signed-off-by: Jon Stovell <jonstovell@gmail.com>

Sesquipedalian added the Standards & Protocols label Nov 15, 2023

Sesquipedalian added this to the 3.0 Alpha 1 milestone Nov 15, 2023

Sesquipedalian marked this pull request as draft November 15, 2023 21:08

Sesquipedalian added 2 commits November 15, 2023 14:09

Adds PHP-CS-Fixer ruleset

d02e6d2

PSR-12 with tab indentation and closing PHP tags (for now, anyway), plus a selection of other nice cleanup options. Signed-off-by: Jon Stovell <jonstovell@gmail.com>

Updates coding style

a86ccb8

Signed-off-by: Jon Stovell <jonstovell@gmail.com>

Sesquipedalian force-pushed the psr-12-ish branch from f1de869 to a86ccb8 Compare November 15, 2023 21:10

live627 reviewed Nov 16, 2023

View reviewed changes

Sesquipedalian added 2 commits November 15, 2023 20:05

Merge remote-tracking branch 'upstream/release-3.0' into psr-12-ish

56093d5

Signed-off-by: Jon Stovell <jonstovell@gmail.com> # Conflicts: # Sources/Security.php

Tweaks formatting of db query strings

a5c8003

Signed-off-by: Jon Stovell <jonstovell@gmail.com>

jdarwood007 approved these changes Nov 16, 2023

View reviewed changes

Sesquipedalian marked this pull request as ready for review November 16, 2023 03:53

BrickOzp reviewed Nov 16, 2023

View reviewed changes

BrickOzp approved these changes Nov 16, 2023

View reviewed changes

Sesquipedalian added 3 commits November 21, 2023 13:14

Removes PHP-CS-Fixer rule to insert blank line before break statements

e8489b7

Signed-off-by: Jon Stovell <jonstovell@gmail.com>

Makes Unicode data files compliant with our coding standard

8f94ae6

Signed-off-by: Jon Stovell <jonstovell@gmail.com>

Makes root directory files compliant with our coding standard

a01f66c

Signed-off-by: Jon Stovell <jonstovell@gmail.com>

Sesquipedalian force-pushed the psr-12-ish branch from 9a22931 to a01f66c Compare November 21, 2023 22:58

Sesquipedalian merged commit b32ffd6 into SimpleMachines:release-3.0 Nov 21, 2023
3 checks passed

Sesquipedalian deleted the psr-12-ish branch November 21, 2023 23:05

Sesquipedalian mentioned this pull request Nov 25, 2023

Post-PSR 12 cleanup #7901

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updates coding standard to something PSR-12-ish #7886

Updates coding standard to something PSR-12-ish #7886

Sesquipedalian commented Nov 15, 2023

live627 Nov 16, 2023

jdarwood007 Nov 16, 2023 •

edited

Loading

Sesquipedalian Nov 16, 2023

Sesquipedalian Nov 16, 2023

jdarwood007 Nov 16, 2023

live627 Nov 17, 2023

Sesquipedalian Nov 21, 2023

jdarwood007 left a comment

jdarwood007 commented Nov 16, 2023

BrickOzp Nov 16, 2023

Sesquipedalian Nov 21, 2023

Updates coding standard to something PSR-12-ish #7886

Updates coding standard to something PSR-12-ish #7886

Conversation

Sesquipedalian commented Nov 15, 2023

Choose a reason for hiding this comment

jdarwood007 Nov 16, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jdarwood007 left a comment

Choose a reason for hiding this comment

jdarwood007 commented Nov 16, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jdarwood007 Nov 16, 2023 •

edited

Loading