Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ajello-meta wants to merge 1 commit into from
Closed

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 47 additions & 36 deletions facebook-commerce-events-tracker.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
<?php
// phpcs:ignoreFile
/**
* Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved
*
Expand All @@ -23,6 +22,11 @@
include_once 'facebook-commerce-pixel-event.php';
}

/**
* Class WC_Facebookcommerce_EventsTracker
*
* This class is responsible for tracking events and sending them to Facebook.
*/
class WC_Facebookcommerce_EventsTracker {

/** @var \WC_Facebookcommerce_Pixel instance */
Expand Down Expand Up @@ -50,8 +54,8 @@ class WC_Facebookcommerce_EventsTracker {
/**
* Events tracker constructor.
*
* @param $user_info
* @param $aam_settings
* @param array $user_info
* @param AAMSettings $aam_settings
*/
public function __construct( $user_info, $aam_settings ) {

Expand Down Expand Up @@ -127,7 +131,7 @@ private function add_hooks() {

// InitiateCheckout events for checkout block.
add_action( 'woocommerce_blocks_checkout_enqueue_data', array( $this, 'inject_initiate_checkout_event' ) );

// Purchase and Subscribe events
add_action( 'woocommerce_new_order', array( $this, 'inject_purchase_event' ) );
add_action( 'woocommerce_payment_complete', array( $this, 'inject_purchase_event' ), 10 );
Expand All @@ -146,12 +150,12 @@ private function add_hooks() {


/**
* Prints the base JavaScript pixel code.
* Prints the base JavaScript pixel code
*
* phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped
*/
public function inject_base_pixel() {

if ( $this->is_pixel_enabled() ) {
// phpcs:ignore WordPress.XSS.EscapeOutput.OutputNotEscaped
echo $this->pixel->pixel_base_code();
}
}
Expand All @@ -161,11 +165,11 @@ public function inject_base_pixel() {
* Prints the base <noscript> pixel code.
*
* This is necessary to avoid W3 validation errors.
*
* phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped
*/
public function inject_base_pixel_noscript() {

if ( $this->is_pixel_enabled() ) {
// phpcs:ignore WordPress.XSS.EscapeOutput.OutputNotEscaped
echo $this->pixel->pixel_base_code_noscript();
}
}
Expand All @@ -183,7 +187,7 @@ public function inject_view_category_event() {

$products = array_values(
array_map(
function( $post ) {
function ( $post ) {
return wc_get_product( $post );
},
$wp_query->posts
Expand Down Expand Up @@ -290,6 +294,8 @@ private function is_single_search_result() {
*
* @since 2.1.2
*
* @param Event $event
*
* @return void
*/
private function add_product_search_event_to_session( Event $event ) {
Expand Down Expand Up @@ -509,10 +515,10 @@ public function inject_view_content_event() {
}

if ( WC_Facebookcommerce_Utils::is_variable_type( $product->get_type() ) ) {
$product_price = $product->get_variation_price( 'min' );
} else {
$product_price = $product->get_price();
}
$product_price = $product->get_variation_price( 'min' );
} else {
$product_price = $product->get_price();
}

$categories = \WC_Facebookcommerce_Utils::get_product_categories( $product->get_id() );

Expand Down Expand Up @@ -573,7 +579,7 @@ public function inject_add_to_cart_event( $cart_item_key, $product_id, $quantity
if ( ! isset( $cart->cart_contents[ $cart_item_key ] ) ) {
return;
}

// phpcs:ignore Universal.Operators.DisallowShortTernary.Found
$product = wc_get_product( $variation_id ?: $product_id );

// bail if invalid product or error
Expand All @@ -590,8 +596,8 @@ public function inject_add_to_cart_event( $cart_item_key, $product_id, $quantity
'contents' => wp_json_encode(
array(
array(
"id" => \WC_Facebookcommerce_Utils::get_fb_retailer_id( $product ),
"quantity" => $quantity,
'id' => \WC_Facebookcommerce_Utils::get_fb_retailer_id( $product ),
'quantity' => $quantity,
),
)
),
Expand Down Expand Up @@ -641,18 +647,19 @@ public function add_filter_for_add_to_cart_fragments() {
*
* @param array $fragments add to cart fragments
* @return array
*
* phpcs:disable WordPress.Security.NonceVerification.Missing
*/
public function add_add_to_cart_event_fragment( $fragments ) {

$product_id = isset( $_POST['product_id'] ) ? (int) $_POST['product_id'] : '';
$quantity = isset( $_POST['quantity']) ? (int) $_POST['quantity'] : '';
$product = wc_get_product($product_id);
$quantity = isset( $_POST['quantity'] ) ? (int) $_POST['quantity'] : '';
$product = wc_get_product( $product_id );

if ( ! $product instanceof \WC_Product || empty( $quantity ) ) {
return $fragments;
}


if ( $this->is_pixel_enabled() ) {

$params = array(
Expand All @@ -672,7 +679,8 @@ public function add_add_to_cart_event_fragment( $fragments ) {
);

// send the event ID to prevent duplication
if ( ! empty( $event_id = WC()->session->get( 'facebook_for_woocommerce_add_to_cart_event_id' ) ) ) {
$event_id = WC()->session->get( 'facebook_for_woocommerce_add_to_cart_event_id' );
if ( ! empty( $event_id ) ) {
$params['event_id'] = $event_id;
}

Expand Down Expand Up @@ -717,7 +725,6 @@ public function add_filter_for_conditional_add_to_cart_fragment() {
public function add_conditional_add_to_cart_event_fragment( $fragments ) {

if ( $this->is_pixel_enabled() ) {

$params = array(
'content_ids' => $this->get_cart_content_ids(),
'content_name' => $this->get_cart_content_names(),
Expand All @@ -728,8 +735,8 @@ public function add_conditional_add_to_cart_event_fragment( $fragments ) {
);

// send the event ID to prevent duplication
if ( ! empty( $event_id = WC()->session->get( 'facebook_for_woocommerce_add_to_cart_event_id' ) ) ) {

$event_id = WC()->session->get( 'facebook_for_woocommerce_add_to_cart_event_id' );
if ( ! empty( $event_id ) ) {
$params['event_id'] = $event_id;
}

Expand Down Expand Up @@ -768,7 +775,8 @@ public function inject_initiate_checkout_event() {
);

// if there is only one item in the cart, send its first category
if ( ( $cart = WC()->cart ) && count( $cart->get_cart() ) === 1 ) {
$cart = WC()->cart;
if ( ( $cart ) && count( $cart->get_cart() ) === 1 ) {

$item = current( $cart->get_cart() );

Expand Down Expand Up @@ -823,7 +831,7 @@ public function inject_purchase_event( $order_id ) {
if ( ! $order ) {
return;
}

// Get the status of the order to ensure we track the actual purchases and not the ones that have a failed payment.
$order_state = $order->get_status();

Expand Down Expand Up @@ -874,7 +882,7 @@ public function inject_purchase_event( $order_id ) {
$event_data = array(
'event_name' => $event_name,
'custom_data' => array(
'content_ids' => wp_json_encode( array_merge( ... $product_ids ) ),
'content_ids' => wp_json_encode( array_merge( ...$product_ids ) ),
'content_name' => wp_json_encode( $product_names ),
'contents' => wp_json_encode( $contents ),
'content_type' => $content_type,
Expand All @@ -893,7 +901,6 @@ public function inject_purchase_event( $order_id ) {
$this->pixel->inject_event( $event_name, $event_data );

$this->inject_subscribe_event( $order_id );

}


Expand Down Expand Up @@ -962,7 +969,7 @@ public function inject_lead_event() {
* @since 2.0.0
*
* @param Event $event event object
* @param bool $send_now optional, defaults to true
* @param bool $send_now optional, defaults to true
*/
protected function send_api_event( Event $event, bool $send_now = true ) {
$this->tracked_events[] = $event;
Expand Down Expand Up @@ -1003,7 +1010,8 @@ private function get_cart_content_ids() {

$product_ids = array( array() );

if ( $cart = WC()->cart ) {
$cart = WC()->cart;
if ( $cart ) {

foreach ( $cart->get_cart() as $item ) {

Expand All @@ -1014,7 +1022,7 @@ private function get_cart_content_ids() {
}
}

return wp_json_encode( array_unique( array_merge( ... $product_ids ) ) );
return wp_json_encode( array_unique( array_merge( ...$product_ids ) ) );
}


Expand All @@ -1029,7 +1037,8 @@ private function get_cart_content_names() {

$product_names = array();

if ( $cart = WC()->cart ) {
$cart = WC()->cart;
if ( $cart ) {

foreach ( $cart->get_cart() as $item ) {

Expand All @@ -1055,7 +1064,8 @@ private function get_cart_contents() {

$cart_contents = array();

if ( $cart = WC()->cart ) {
$cart = WC()->cart;
if ( $cart ) {

foreach ( $cart->get_cart() as $item ) {

Expand Down Expand Up @@ -1091,10 +1101,12 @@ private function get_cart_total() {
*
* @since 2.0.3
*
* @param \WC_Order $order
*
* @return array
*/
private function get_user_data_from_billing_address( $order ) {
if ( $this->aam_settings == null || ! $this->aam_settings->get_enable_automatic_matching() ) {
if ( null === $this->aam_settings || ! $this->aam_settings->get_enable_automatic_matching() ) {
return array();
}
$user_data = array();
Expand All @@ -1111,7 +1123,7 @@ private function get_user_data_from_billing_address( $order ) {
$user_data['ph'] = $order->get_billing_phone();
// The fields contain country, so we do not need to add a condition
foreach ( $user_data as $field => $value ) {
if ( $value === null || $value === '' ||
if ( null === $value || '' === $value ||
! in_array( $field, $this->aam_settings->get_enabled_automatic_matching_fields() )
) {
unset( $user_data[ $field ] );
Expand Down Expand Up @@ -1154,7 +1166,6 @@ public function send_pending_events() {
$this->send_api_event( $event );
}
}

}

endif;