Skip to content

Fix linter errors for ./facebook-commerce-events-tracker.php#3254

Closed
ajello-meta wants to merge 1 commit intomainfrom
phpcs-facebook-commerce-events-tracker
Closed

Fix linter errors for ./facebook-commerce-events-tracker.php#3254
ajello-meta wants to merge 1 commit intomainfrom
phpcs-facebook-commerce-events-tracker

Conversation

@ajello-meta
Copy link
Copy Markdown
Contributor

@ajello-meta ajello-meta commented May 27, 2025

Description

This PR fixes phpcs issues in ./facebook-commerce-events-tracker.php. Comments were also added for several functions. The fixes were made manually (in conjunction with ./vendor/bin/phpcbf) to ensure that the logic remains the same. Running ./vendor/bin/phpcs:

[FILE: /Users/angeloou/Local Sites/test-site-i/app/public/wp-content/plugins/facebook-for-woocommerce/facebook-commerce-events-tracker.php](https://woo2.staging.magento-commerce-extension-testing.com/wp-admin/)
[-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------](https://woo2.staging.magento-commerce-extension-testing.com/wp-admin/)
[FOUND 44 ERRORS AND 12 WARNINGS AFFECTING 38 LINES](https://woo2.staging.magento-commerce-extension-testing.com/wp-admin/)
[-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------](https://woo2.staging.magento-commerce-extension-testing.com/wp-admin/)
   25 | ERROR   | [ ] Missing doc comment for class WC_Facebookcommerce_EventsTracker (Squiz.Commenting.ClassComment.Missing)
   49 | ERROR   | [ ] Doc comment for parameter "$user_info" missing (Squiz.Commenting.FunctionComment.MissingParamTag)
   49 | ERROR   | [ ] Doc comment for parameter "$aam_settings" missing (Squiz.Commenting.FunctionComment.MissingParamTag)
   52 | ERROR   | [ ] Missing parameter type (Squiz.Commenting.FunctionComment.MissingParamType)
   53 | ERROR   | [ ] Missing parameter type (Squiz.Commenting.FunctionComment.MissingParamType)
  154 | ERROR   | [ ] All output should be run through an escaping function (see the Security sections in the WordPress Developer Handbooks), found '$this'.
      |         |     (WordPress.Security.EscapeOutput.OutputNotEscaped)
  168 | ERROR   | [ ] All output should be run through an escaping function (see the Security sections in the WordPress Developer Handbooks), found '$this'.
      |         |     (WordPress.Security.EscapeOutput.OutputNotEscaped)
  185 | ERROR   | [x] Expected 1 space after FUNCTION keyword; 0 found (Squiz.Functions.MultiLineFunctionDeclaration.SpaceAfterFunction)
 [ 226 | WARNING | [ ] json_encode() is discouraged. Use wp_json_encode() instead. (WordPress.WP.AlternativeFunctions.json_encode_json_encode)](https://woo2.staging.magento-commerce-extension-testing.com/wp-admin/)
  285 | ERROR   | [ ] Doc comment for parameter "$event" missing (Squiz.Commenting.FunctionComment.MissingParamTag)
 [ 449 | WARNING | [ ] json_encode() is discouraged. Use wp_json_encode() instead. (WordPress.WP.AlternativeFunctions.json_encode_json_encode)](https://woo2.staging.magento-commerce-extension-testing.com/wp-admin/)
  511 | ERROR   | [x] Tabs must be used to indent lines; spaces are not allowed (Generic.WhiteSpace.DisallowSpaceIndent.SpacesUsed)
  512 | ERROR   | [x] Tabs must be used to indent lines; spaces are not allowed (Generic.WhiteSpace.DisallowSpaceIndent.SpacesUsed)
  512 | ERROR   | [x] Line indented incorrectly; expected 3 tabs, found 6 (Generic.WhiteSpace.ScopeIndent.IncorrectExact)
  513 | ERROR   | [x] Tabs must be used to indent lines; spaces are not allowed (Generic.WhiteSpace.DisallowSpaceIndent.SpacesUsed)
  514 | ERROR   | [x] Tabs must be used to indent lines; spaces are not allowed (Generic.WhiteSpace.DisallowSpaceIndent.SpacesUsed)
  514 | ERROR   | [x] Line indented incorrectly; expected 3 tabs, found 6 (Generic.WhiteSpace.ScopeIndent.IncorrectExact)
  576 | ERROR   | [ ] Using short ternaries is not allowed as they are rarely used correctly (Universal.Operators.DisallowShortTernary.Found)
  592 | ERROR   | [x] String "id" does not require double quotes; use single quotes instead (Squiz.Strings.DoubleQuoteUsage.NotRequired)
  592 | ERROR   | [x] Spaces must be used for mid-line alignment; tabs are not allowed (Universal.WhiteSpace.DisallowInlineTabs.NonIndentTabsUsed)
  593 | ERROR   | [x] String "quantity" does not require double quotes; use single quotes instead (Squiz.Strings.DoubleQuoteUsage.NotRequired)
  593 | ERROR   | [x] Expected 1 space after "=>"; 2 found (WordPress.WhiteSpace.OperatorSpacing.SpacingAfter)
  646 | ERROR   | [ ] Processing form data without nonce verification. (WordPress.Security.NonceVerification.Missing)
  646 | ERROR   | [ ] Processing form data without nonce verification. (WordPress.Security.NonceVerification.Missing)
  647 | ERROR   | [ ] Processing form data without nonce verification. (WordPress.Security.NonceVerification.Missing)
  647 | ERROR   | [x] Expected 1 spaces before closing parenthesis; 0 found (PEAR.Functions.FunctionCallSignature.SpaceBeforeCloseBracket)
  647 | ERROR   | [ ] Processing form data without nonce verification. (WordPress.Security.NonceVerification.Missing)
  648 | ERROR   | [x] Spaces must be used for mid-line alignment; tabs are not allowed (Universal.WhiteSpace.DisallowInlineTabs.NonIndentTabsUsed)
  648 | ERROR   | [x] Expected 1 spaces after opening parenthesis; 0 found (PEAR.Functions.FunctionCallSignature.SpaceAfterOpenBracket)
  648 | ERROR   | [x] Expected 1 spaces before closing parenthesis; 0 found (PEAR.Functions.FunctionCallSignature.SpaceBeforeCloseBracket)
  653 | ERROR   | [x] Functions must not contain multiple empty lines in a row; found 2 empty lines (Squiz.WhiteSpace.SuperfluousWhitespace.EmptyLines)
 [ 674 | WARNING | [ ] Variable assignment found within a condition. Did you mean to do a comparison ? (Generic.CodeAnalysis.AssignmentInCondition.Found)](https://woo2.staging.magento-commerce-extension-testing.com/wp-admin/)
  674 | ERROR   | [ ] Assignments must be the first block of code on a line (Squiz.PHP.DisallowMultipleAssignments.FoundInControlStructure)
 [ 730 | WARNING | [ ] Variable assignment found within a condition. Did you mean to do a comparison ? (Generic.CodeAnalysis.AssignmentInCondition.Found)](https://woo2.staging.magento-commerce-extension-testing.com/wp-admin/)
  730 | ERROR   | [ ] Assignments must be the first block of code on a line (Squiz.PHP.DisallowMultipleAssignments.FoundInControlStructure)
 [ 770 | WARNING | [ ] Variable assignment found within a condition. Did you mean to do a comparison ? (Generic.CodeAnalysis.AssignmentInCondition.Found)](https://woo2.staging.magento-commerce-extension-testing.com/wp-admin/)
  770 | ERROR   | [ ] Assignments must be the first block of code on a line (Squiz.PHP.DisallowMultipleAssignments.FoundInControlStructure)
 [ 833 | WARNING | [ ] Not using strict comparison for in_array; supply true for $strict argument. (WordPress.PHP.StrictInArray.MissingTrueStrict)](https://woo2.staging.magento-commerce-extension-testing.com/wp-admin/)
  876 | ERROR   | [x] Expected 0 spaces after the spread operator; 1 found (Generic.WhiteSpace.SpreadOperatorSpacingAfter.TooMuchSpace)
  896 | ERROR   | [x] Function closing brace must go on the next line following the body; found 1 blank lines before brace (PSR2.Methods.FunctionClosingBrace.SpacingBeforeClose)
 [ 919 | WARNING | [ ] This comment is 41% valid code; is this commented out code? (Squiz.PHP.CommentedOutCode.Found)](https://woo2.staging.magento-commerce-extension-testing.com/wp-admin/)
  964 | ERROR   | [x] Expected 2 spaces after parameter type; 1 found (Squiz.Commenting.FunctionComment.SpacingAfterParamType)
[ 1005 | WARNING | [ ] Variable assignment found within a condition. Did you mean to do a comparison ? (Generic.CodeAnalysis.AssignmentInCondition.Found)](https://woo2.staging.magento-commerce-extension-testing.com/wp-admin/)
 1005 | ERROR   | [ ] Assignments must be the first block of code on a line (Squiz.PHP.DisallowMultipleAssignments.FoundInControlStructure)
 1016 | ERROR   | [x] Expected 0 spaces after the spread operator; 1 found (Generic.WhiteSpace.SpreadOperatorSpacingAfter.TooMuchSpace)
[ 1031 | WARNING | [ ] Variable assignment found within a condition. Did you mean to do a comparison ? (Generic.CodeAnalysis.AssignmentInCondition.Found)](https://woo2.staging.magento-commerce-extension-testing.com/wp-admin/)
 1031 | ERROR   | [ ] Assignments must be the first block of code on a line (Squiz.PHP.DisallowMultipleAssignments.FoundInControlStructure)
[ 1057 | WARNING | [ ] Variable assignment found within a condition. Did you mean to do a comparison ? (Generic.CodeAnalysis.AssignmentInCondition.Found)](https://woo2.staging.magento-commerce-extension-testing.com/wp-admin/)
 1057 | ERROR   | [ ] Assignments must be the first block of code on a line (Squiz.PHP.DisallowMultipleAssignments.FoundInControlStructure)
 1088 | ERROR   | [ ] Doc comment for parameter "$order" missing (Squiz.Commenting.FunctionComment.MissingParamTag)
[ 1096 | WARNING | [x] Loose comparisons are not allowed. Expected: "==="; Found: "==" (Universal.Operators.StrictComparisons.LooseEqual)](https://woo2.staging.magento-commerce-extension-testing.com/wp-admin/)
 1096 | ERROR   | [ ] Use Yoda Condition checks, you must. (WordPress.PHP.YodaConditions.NotYoda)
 1113 | ERROR   | [ ] Use Yoda Condition checks, you must. (WordPress.PHP.YodaConditions.NotYoda)
 1113 | ERROR   | [ ] Use Yoda Condition checks, you must. (WordPress.PHP.YodaConditions.NotYoda)
[ 1114 | WARNING | [ ] Not using strict comparison for in_array; supply true for $strict argument. (WordPress.PHP.StrictInArray.MissingTrueStrict)](https://woo2.staging.magento-commerce-extension-testing.com/wp-admin/)
 1157 | ERROR   | [x] The closing brace for the class must go on the next line after the body (PSR2.Classes.ClassDeclaration.CloseBraceAfterBody)
[-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------](https://woo2.staging.magento-commerce-extension-testing.com/wp-admin/)
[PHPCBF CAN FIX THE 22 MARKED SNIFF VIOLATIONS AUTOMATICALLY](https://woo2.staging.magento-commerce-extension-testing.com/wp-admin/)
[-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------](https://woo2.staging.magento-commerce-extension-testing.com/wp-admin/)

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Syntax change (non-breaking change which fixes code modularity, linting or phpcs issues)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected

Test Plan

  1. Run ./vendor/bin/phpcs, you should get:
FILE: /Users/angeloou/Local Sites/test-site-i/app/public/wp-content/plugins/facebook-for-woocommerce/facebook-commerce-events-tracker.php
----------------------------------------------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 5 WARNINGS AFFECTING 5 LINES
----------------------------------------------------------------------------------------------------------------------------------------------
  231 | WARNING | json_encode() is discouraged. Use wp_json_encode() instead. (WordPress.WP.AlternativeFunctions.json_encode_json_encode)
  456 | WARNING | json_encode() is discouraged. Use wp_json_encode() instead. (WordPress.WP.AlternativeFunctions.json_encode_json_encode)
  842 | WARNING | Not using strict comparison for in_array; supply true for $strict argument. (WordPress.PHP.StrictInArray.MissingTrueStrict)
  927 | WARNING | This comment is 41% valid code; is this commented out code? (Squiz.PHP.CommentedOutCode.Found)
 1127 | WARNING | Not using strict comparison for in_array; supply true for $strict argument. (WordPress.PHP.StrictInArray.MissingTrueStrict)
----------------------------------------------------------------------------------------------------------------------------------------------
  1. Run extension and test the basic functionality to ensure everything still works as intended.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented May 27, 2025

📦 Latest Plugin Build

Built at: 2025-05-27T21:41:30.358Z
Commit: 79248c7
Size: 1.1M

Download: Click here to download the plugin

To download: Click the link above → Scroll to bottom → Download "facebook-for-woocommerce" artifact

@facebook-github-bot
Copy link
Copy Markdown
Contributor

facebook-github-bot commented May 27, 2025

@ajello-meta has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

@facebook-github-bot
Copy link
Copy Markdown
Contributor

facebook-github-bot commented May 28, 2025

@ajello-meta merged this pull request in b71d8ed.

@carterbuce carterbuce mentioned this pull request May 29, 2025
Closed
@tzahgr tzahgr mentioned this pull request Jun 4, 2025
Closed
facebook-github-bot pushed a commit that referenced this pull request Jun 4, 2025
@carterbuce @facebook-github-bot
Release/3.5.0 (#3264)
eb41b58 
Summary:
= 3.5.0 - 2025-05-28 =
*  Add - Create basic checkout permalink w/ products and coupon support by ajello-meta in #2887
*  Add - Common Feed Upload Framework by Jmencab in #2875
*  Fix - Fix bug where templates were not loading correctly by ajello-meta in #2915
*  Tweak - Change MICE to use base site url instead of shop url by carterbuce in #2934
*  Tweak - Improve custom checkout UI by ajello-meta in #2930
*  Tweak - Make custom checkout UI mobile compatible by ajello-meta in #2942
*  Fix - Update parsing for Checkout URL Product IDs by carterbuce in #2935
*  Add - Implement dummy logging util by nealweiMeta in #2920
*  Add - Setup cron job for batch logging with global message queue by nealweiMeta in #2924
*  Add - Error log request api activate by nealweiMeta in #2933
*  Add - Log locally with debug mode enabled by nealweiMeta in #2939
*  Add - Ratings and reviews feed upload by nrostrow-meta in #2937
*  Tweak - Feed upload skip logic and logging calls by nrostrow-meta in #2964
*  Add - Add function to fetch feed upload instance by nrostrow-meta in #2970
*  Tweak - Have feed uploads always use feed generator by nrostrow-meta in #2971
*  Tweak - Trigger metadata feed uploads on CPI ID change (post onboarding) by nrostrow-meta in #2995
*  Add - Shipping profile feed upload button by nrostrow-meta in #3140
*  Add - Navigation menu feed upload logic by nrostrow-meta in #3159
*  Fix - Fixing some fclose and logging gaps in the feed upload logic by nrostrow-meta in #3192
*  Add - Enabling navigation menu feed upload and adding manual sync button by nrostrow-meta in #3223
*  Add - Promotions feed upload by carterbuce in #2941
*  Add - Plugin AJAX API Framework by sol-loup in #2928
*  Tweak - Test Infrastructure Enhancement by sol-loup in #2944
*  Add - Implement telemetry logs api by nealweiMeta in #2940
*  Fix -  Make error logging event configurable by nealweiMeta in #2954
*  Add - Implement logging toggle by nealweiMeta in #2959
*  Fix - auto products sync by nealweiMeta in #2978
*  Tweak - Sync products with restriction by nealweiMeta in #2983
*  Fix - Fix use_enhanced_onboarding for legacy connections by carterbuce in #2986
*  Add - Create enhanced settings UI by ajello-meta in #2968
*  Add - Create new troubleshooting drawer from legacy debug settings by ajello-meta in #2977
*  Add - Add manual product and coupon sync buttons by ajello-meta in #2984
*  Tweak - Make page title in enhanced settings static by ajello-meta in #2985
*  Tweak - Align finalized content for logging toggle by nealweiMeta in #2992
*  Tweak - Improve local log by nealweiMeta in #3009
*  Fix - Fix free shipping coupon sync by carterbuce in #2993
*  Tweak - Add logging for feed generation scheduling failure by carterbuce in #2994
*  Tweak - Add logging in checkout for coupon code by ajello-meta in #2991
*  Tweak - Clean up CSS in enhanced settings UI by ajello-meta in #2996
*  Tweak - Remove the "Advertise" tab by ajello-meta in #3024
*  Tweak - Sync "Usage Count" in Promos Feed by carterbuce in #3036
*  Tweak - Disable mini_shops product capability for unsupported items by carterbuce in #3084
*  Add - Add usage logging for enhanced settings tabs by ajello-meta in #3202
*  Tweak - Remove UI of a checkbox that controls enablement of the new style feed generation by mshymon in #3056
*  Fix - Fix linter errors for ./includes/fbutils.php files by ajello-meta in #3075
*  Fix - Hotfix for Rollout Switches by vinkmeta in #3236
*  Add - Opt out sync experience. by SayanPandey in #3220
*  Fix - Added a transient flag to avoid flooding of product set api requests by vinkmeta in #3245
*  Fix - Additional check for the opt-out banner by SayanPandey in #3259
*  Fix - Bump up GraphAPI version to 21 by vahidkay-meta in #3219
*  Fix - fix linter errors for ./class-wc-facebookcommerce.php by ajello-meta in #3255
*  Fix - fix linter errors for ./facebook-commerce-events-tracker.php by ajello-meta in #3254
*  Fix - fix linter errors for ./includes/Admin/Settings_Screens/Advertise.php by ajello-meta in #3237
*  Fix - fix linter errors for ./includes/Admin/Settings_Screens/Product_Sync.php by ajello-meta in #3239
*  Fix - fix function return typing for get_settings() by ajello-meta in #3257
*  Tweak - Addition check for opt out by SayanPandey in #3259
*  Tweak - Update the GraphAPI version to 21 by vahidkay-meta in #3219
*  Fix - Enabled rollout switch only for plugin admins by vinkmeta in #3242
*  Add - reset connection functionality by jczhuoMeta in #3262
*  Fix - fixing the non static method called as static issue by SayanPandey in #3263
*  Fix - Fix linter errors for ./facebook-commerce.php by ajello-meta in #3251

Pull Request resolved: #3264

Test Plan:
Imported from GitHub, without a `Test Plan:` line.

**!---- (auto-generated) DO NOT EDIT OR PUT ANYTHING AFTER THIS LINE ----!**
MFTRunTestsScript Run / Test Suite: sa_checkout / Test Collection: bloks / Diff Version V7
https://internalfb.com/intern/testinfra/testrun/10414574226197703
MFTRunTestsScript Run / Test Suite: sa_checkout / Test Collection: www / Diff Version V7
https://internalfb.com/intern/testinfra/testrun/844425351364266

Reviewed By: vinkmeta, nrostrow-meta

Differential Revision: D75569981

Pulled By: carterbuce

fbshipit-source-id: 11bb39a9d66dfcbc80af413466feef0792d27ce4
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

CLA Signed Merged

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ajello-meta @facebook-github-bot