insideout10 / wordlift-plugin

src/includes/batch-analysis/class-wordlift-batch-analysis-sql-helper.php

Indentation +203 added lines, -203 removed lines

@@ -11,24 +11,24 @@ 
 
 class Wordlift_Batch_Analysis_Sql_Helper {
 
-	/**
-	 * Get the base SQL statement to submit a post for Batch Analysis.
-	 *
-	 * Functions may use this base SQL and add their own filters. This function
-	 * should be `private` and only used by the {@link Wordlift_Batch_Analysis_Service}
-	 * `submit` function. But since we want to maintain compatibility with PHP 5.3
-	 * and we couldn't use traits to hide the function from the Wordlift_Batch_Analysis_Service
-	 * we used a Helper function.
-	 *
-	 * @since 3.14.2
-	 *
-	 * @param array $args An array of parameters, see {@link submit}.
-	 *
-	 * @return string The base SQL.
-	 */
-	public static function get_sql( $args ) {
-
-		/*
+    /**
+     * Get the base SQL statement to submit a post for Batch Analysis.
+     *
+     * Functions may use this base SQL and add their own filters. This function
+     * should be `private` and only used by the {@link Wordlift_Batch_Analysis_Service}
+     * `submit` function. But since we want to maintain compatibility with PHP 5.3
+     * and we couldn't use traits to hide the function from the Wordlift_Batch_Analysis_Service
+     * we used a Helper function.
+     *
+     * @since 3.14.2
+     *
+     * @param array $args An array of parameters, see {@link submit}.
+     *
+     * @return string The base SQL.
+     */
+    public static function get_sql( $args ) {
+
+        /*
 		Prepare the statement:
 			1. Insert into `postmeta` the meta keys and values:
 				a) state meta, with value of SUBMIT (0),
@@ -44,20 +44,20 @@ 
 			9. Filter by `post_id` where `exclude` is the posts id to exclude.
 		*/
 
-		// @codingStandardsIgnoreStart, Ignore phpcs sanitation errors.
-		return self::get_base_query( $args )
-			   . " WHERE p.post_type IN ('" . join( "', '", array_map( 'esc_sql', (array) $args['post_type'] ) ) . "')"
-			   . "  AND p.post_status = 'publish'"
-			   . Wordlift_Batch_Analysis_Sql_Helper::and_include_annotated( $args['include_annotated'] )
-			   . Wordlift_Batch_Analysis_Sql_Helper::and_post_date_from( $args['from'] )
-			   . Wordlift_Batch_Analysis_Sql_Helper::and_post_date_to( $args['to'] )
-			   . Wordlift_Batch_Analysis_Sql_Helper::and_exclude_posts( $args['exclude'] );
-		// @codingStandardsIgnoreEnd
-	}
+        // @codingStandardsIgnoreStart, Ignore phpcs sanitation errors.
+        return self::get_base_query( $args )
+                . " WHERE p.post_type IN ('" . join( "', '", array_map( 'esc_sql', (array) $args['post_type'] ) ) . "')"
+                . "  AND p.post_status = 'publish'"
+                . Wordlift_Batch_Analysis_Sql_Helper::and_include_annotated( $args['include_annotated'] )
+                . Wordlift_Batch_Analysis_Sql_Helper::and_post_date_from( $args['from'] )
+                . Wordlift_Batch_Analysis_Sql_Helper::and_post_date_to( $args['to'] )
+                . Wordlift_Batch_Analysis_Sql_Helper::and_exclude_posts( $args['exclude'] );
+        // @codingStandardsIgnoreEnd
+    }
 
-	public static function get_sql_for_ids( $args ) {
+    public static function get_sql_for_ids( $args ) {
 
-		/*
+        /*
 		Prepare the statement:
 			1. Insert into `postmeta` the meta keys and values:
 				a) state meta, with value of SUBMIT (0),
@@ -73,178 +73,178 @@ 
 			9. Filter by `post_id` where `exclude` is the posts id to exclude.
 		*/
 
-		// @codingStandardsIgnoreStart, Ignore phpcs sanitation errors.
-
-		return self::get_base_query( $args )
-			   . ' WHERE p.id IN (' . implode( ', ', wp_parse_id_list( $args['ids'] ) ) . ')';
-		// @codingStandardsIgnoreEnd
-	}
-
-	private static function get_base_query( $args ) {
-		global $wpdb;
-
-		// Get the link options.
-		$link_options = serialize( array(
-			'links'           => $args['links'],
-			'min_occurrences' => $args['min_occurrences'],
-		) );
-
-		return $wpdb->prepare(
-			"INSERT INTO $wpdb->postmeta ( post_id, meta_key, meta_value )"
-			// Populate 3 metas for the batch analysis request using a SQL
-			// statement: each meta contains a state for the batch analysis
-			// request.
-			. ' SELECT p.ID, metas.* FROM ('
-			. '  SELECT %s, 0 FROM dual'                // STATE_META_KEY.
-			. '   UNION'
-			. '	 SELECT %s, UTC_TIMESTAMP() FROM dual'  // SUBMIT_TIMESTAMP_META_KEY.
-			. '	  UNION'
-			. '	 SELECT %s, %s FROM dual'               // LINK_META_KEY.
-			. '	) metas'
-			. ", $wpdb->posts p",
-			Wordlift_Batch_Analysis_Service::STATE_META_KEY,
-			Wordlift_Batch_Analysis_Service::SUBMIT_TIMESTAMP_META_KEY,
-			Wordlift_Batch_Analysis_Service::BATCH_ANALYSIS_OPTIONS_META_KEY,
-			$link_options
-		);
-	}
-
-	/**
-	 * Add a clause to analyze all auto selected posts, i.e. non annotated posts.
-	 *
-	 * @param bool $include Whether to include annotated posts in selection.
-	 *
-	 * @since  3.17.0
-	 *
-	 * @return string The `post_content` clause.
-	 */
-	private static function and_include_annotated( $include ) {
-
-		// Bail out with an empty string if we include all the posts.
-		if ( true === $include ) {
-			return '';
-		}
-
-		// Filter out already annotated posts.
-		return " AND p.post_content NOT REGEXP '<[a-z]+ id=\"urn:[^\"]+\" class=\"[^\"]+\" itemid=\"[^\"]+\">'";
-	}
-
-	/**
-	 * Add the start date clause.
-	 *
-	 * @param  DateTime|null $value The date where the analysis should start.
-	 *
-	 * @since  3.17.0
-	 *
-	 * @return string The start `post_date_gmt` clause
-	 */
-	private static function and_post_date_from( $value ) {
-
-		// Bail out if the `from` isn't specified.
-		if ( null === $value ) {
-			return '';
-		}
-
-		// Try to convert the value to a date, GMT timezone.
-		$date = self::get_mysql_date_string( $value );
-
-		// Return the clause.
-		return " AND p.post_date_gmt >= '$date'";
-	}
-
-	/**
-	 * Add the `to` date clause.
-	 *
-	 * @param  DateTime|null $value The `to` date clause.
-	 *
-	 * @since  3.17.0
-	 *
-	 * @return string The end `post_date_gmt` clause
-	 */
-	private static function and_post_date_to( $value ) {
-
-		// Bail out if the `from` isn't specified.
-		if ( null === $value ) {
-			return '';
-		}
-
-		// Try to convert the value to a date, GMT timezone.
-		$date = self::get_mysql_date_string( $value );
-
-		// Return the clause.
-		return " AND p.post_date_gmt <= '$date'";
-	}
-
-	/**
-	 * Include specific posts by their id in the analysis.
-	 *
-	 * @param array $include Array of post ids to include.
-	 *
-	 * @since  3.17.0
-	 *
-	 * @return string The posts IN clause.
-	 */
-	private static function and_include_posts( $include ) {
-
-		// Bail if the param is not set.
-		if ( empty( $include ) ) {
-			return '';
-		}
-
-		return ' AND p.ID IN ( ' . implode( ',', wp_parse_id_list( $include ) ) . ' )';
-	}
-
-	/**
-	 * Exclude specific posts by ids.
-	 *
-	 * @param array $exclude Array of post ids to exclude.
-	 *
-	 * @since  3.17.0
-	 *
-	 * @return string The posts NOT IN clause.
-	 */
-	private static function and_exclude_posts( $exclude ) {
-
-		// Bail if the param is not set.
-		if ( empty( $exclude ) ) {
-			return '';
-		}
-
-		return ' AND p.ID NOT IN ( ' . implode( ',', wp_parse_id_list( $exclude ) ) . ' )';
-	}
-
-
-	/**
-	 * Convert a `Y-m-d'T'H:i:sT` string representation of a date to a MySQL
-	 * date string, taking into consideration the time zone.
-	 *
-	 * If the date string cannot be converted, the processing is stopped.
-	 *
-	 * @since 3.17.0
-	 *
-	 * @param string $value A date represented as `Y-m-d'T'H:i:sT`.
-	 *
-	 * @return string A MySQL string representation of the date.
-	 */
-	private static function get_mysql_date_string( $value ) {
-
-		// Try to convert the value to a date, GMT timezone.
-		$date = date_create_from_format( 'Y-m-d\TH:i:sT', $value );
-
-		if ( false === $date ) {
-			wp_die( "Invalid date format, use `Y-m-d'T'H:i:sT`." );
-		}
-
-		// Convert the DateTime timezone to `GMT`.
-		$date->setTimezone( timezone_open( 'GMT' ) );
-
-		// Stop if the conversion failed.
-		if ( false === $date ) {
-			wp_die( "Invalid date format, date must be in Y-m-d'T'H:i:sT format." );
-		}
-
-		// Return the clause.
-		return $date->format( 'Y-m-d H:i:s' );
-	}
+        // @codingStandardsIgnoreStart, Ignore phpcs sanitation errors.
+
+        return self::get_base_query( $args )
+                . ' WHERE p.id IN (' . implode( ', ', wp_parse_id_list( $args['ids'] ) ) . ')';
+        // @codingStandardsIgnoreEnd
+    }
+
+    private static function get_base_query( $args ) {
+        global $wpdb;
+
+        // Get the link options.
+        $link_options = serialize( array(
+            'links'           => $args['links'],
+            'min_occurrences' => $args['min_occurrences'],
+        ) );
+
+        return $wpdb->prepare(
+            "INSERT INTO $wpdb->postmeta ( post_id, meta_key, meta_value )"
+            // Populate 3 metas for the batch analysis request using a SQL
+            // statement: each meta contains a state for the batch analysis
+            // request.
+            . ' SELECT p.ID, metas.* FROM ('
+            . '  SELECT %s, 0 FROM dual'                // STATE_META_KEY.
+            . '   UNION'
+            . '	 SELECT %s, UTC_TIMESTAMP() FROM dual'  // SUBMIT_TIMESTAMP_META_KEY.
+            . '	  UNION'
+            . '	 SELECT %s, %s FROM dual'               // LINK_META_KEY.
+            . '	) metas'
+            . ", $wpdb->posts p",
+            Wordlift_Batch_Analysis_Service::STATE_META_KEY,
+            Wordlift_Batch_Analysis_Service::SUBMIT_TIMESTAMP_META_KEY,
+            Wordlift_Batch_Analysis_Service::BATCH_ANALYSIS_OPTIONS_META_KEY,
+            $link_options
+        );
+    }
+
+    /**
+     * Add a clause to analyze all auto selected posts, i.e. non annotated posts.
+     *
+     * @param bool $include Whether to include annotated posts in selection.
+     *
+     * @since  3.17.0
+     *
+     * @return string The `post_content` clause.
+     */
+    private static function and_include_annotated( $include ) {
+
+        // Bail out with an empty string if we include all the posts.
+        if ( true === $include ) {
+            return '';
+        }
+
+        // Filter out already annotated posts.
+        return " AND p.post_content NOT REGEXP '<[a-z]+ id=\"urn:[^\"]+\" class=\"[^\"]+\" itemid=\"[^\"]+\">'";
+    }
+
+    /**
+     * Add the start date clause.
+     *
+     * @param  DateTime|null $value The date where the analysis should start.
+     *
+     * @since  3.17.0
+     *
+     * @return string The start `post_date_gmt` clause
+     */
+    private static function and_post_date_from( $value ) {
+
+        // Bail out if the `from` isn't specified.
+        if ( null === $value ) {
+            return '';
+        }
+
+        // Try to convert the value to a date, GMT timezone.
+        $date = self::get_mysql_date_string( $value );
+
+        // Return the clause.
+        return " AND p.post_date_gmt >= '$date'";
+    }
+
+    /**
+     * Add the `to` date clause.
+     *
+     * @param  DateTime|null $value The `to` date clause.
+     *
+     * @since  3.17.0
+     *
+     * @return string The end `post_date_gmt` clause
+     */
+    private static function and_post_date_to( $value ) {
+
+        // Bail out if the `from` isn't specified.
+        if ( null === $value ) {
+            return '';
+        }
+
+        // Try to convert the value to a date, GMT timezone.
+        $date = self::get_mysql_date_string( $value );
+
+        // Return the clause.
+        return " AND p.post_date_gmt <= '$date'";
+    }
+
+    /**
+     * Include specific posts by their id in the analysis.
+     *
+     * @param array $include Array of post ids to include.
+     *
+     * @since  3.17.0
+     *
+     * @return string The posts IN clause.
+     */
+    private static function and_include_posts( $include ) {
+
+        // Bail if the param is not set.
+        if ( empty( $include ) ) {
+            return '';
+        }
+
+        return ' AND p.ID IN ( ' . implode( ',', wp_parse_id_list( $include ) ) . ' )';
+    }
+
+    /**
+     * Exclude specific posts by ids.
+     *
+     * @param array $exclude Array of post ids to exclude.
+     *
+     * @since  3.17.0
+     *
+     * @return string The posts NOT IN clause.
+     */
+    private static function and_exclude_posts( $exclude ) {
+
+        // Bail if the param is not set.
+        if ( empty( $exclude ) ) {
+            return '';
+        }
+
+        return ' AND p.ID NOT IN ( ' . implode( ',', wp_parse_id_list( $exclude ) ) . ' )';
+    }
+
+
+    /**
+     * Convert a `Y-m-d'T'H:i:sT` string representation of a date to a MySQL
+     * date string, taking into consideration the time zone.
+     *
+     * If the date string cannot be converted, the processing is stopped.
+     *
+     * @since 3.17.0
+     *
+     * @param string $value A date represented as `Y-m-d'T'H:i:sT`.
+     *
+     * @return string A MySQL string representation of the date.
+     */
+    private static function get_mysql_date_string( $value ) {
+
+        // Try to convert the value to a date, GMT timezone.
+        $date = date_create_from_format( 'Y-m-d\TH:i:sT', $value );
+
+        if ( false === $date ) {
+            wp_die( "Invalid date format, use `Y-m-d'T'H:i:sT`." );
+        }
+
+        // Convert the DateTime timezone to `GMT`.
+        $date->setTimezone( timezone_open( 'GMT' ) );
+
+        // Stop if the conversion failed.
+        if ( false === $date ) {
+            wp_die( "Invalid date format, date must be in Y-m-d'T'H:i:sT format." );
+        }
+
+        // Return the clause.
+        return $date->format( 'Y-m-d H:i:s' );
+    }
 
 }

Spacing +35 added lines, -35 removed lines

@@ -26,7 +26,7 @@ 
 	 *
 	 * @return string The base SQL.
 	 */
-	public static function get_sql( $args ) {
+	public static function get_sql($args) {
 
 		/*
 		Prepare the statement:
@@ -45,17 +45,17 @@ 
 		*/
 
 		// @codingStandardsIgnoreStart, Ignore phpcs sanitation errors.
-		return self::get_base_query( $args )
-			   . " WHERE p.post_type IN ('" . join( "', '", array_map( 'esc_sql', (array) $args['post_type'] ) ) . "')"
+		return self::get_base_query($args)
+			   . " WHERE p.post_type IN ('".join("', '", array_map('esc_sql', (array) $args['post_type']))."')"
 			   . "  AND p.post_status = 'publish'"
-			   . Wordlift_Batch_Analysis_Sql_Helper::and_include_annotated( $args['include_annotated'] )
-			   . Wordlift_Batch_Analysis_Sql_Helper::and_post_date_from( $args['from'] )
-			   . Wordlift_Batch_Analysis_Sql_Helper::and_post_date_to( $args['to'] )
-			   . Wordlift_Batch_Analysis_Sql_Helper::and_exclude_posts( $args['exclude'] );
+			   . Wordlift_Batch_Analysis_Sql_Helper::and_include_annotated($args['include_annotated'])
+			   . Wordlift_Batch_Analysis_Sql_Helper::and_post_date_from($args['from'])
+			   . Wordlift_Batch_Analysis_Sql_Helper::and_post_date_to($args['to'])
+			   . Wordlift_Batch_Analysis_Sql_Helper::and_exclude_posts($args['exclude']);
 		// @codingStandardsIgnoreEnd
 	}
 
-	public static function get_sql_for_ids( $args ) {
+	public static function get_sql_for_ids($args) {
 
 		/*
 		Prepare the statement:
@@ -75,19 +75,19 @@ 
 
 		// @codingStandardsIgnoreStart, Ignore phpcs sanitation errors.
 
-		return self::get_base_query( $args )
-			   . ' WHERE p.id IN (' . implode( ', ', wp_parse_id_list( $args['ids'] ) ) . ')';
+		return self::get_base_query($args)
+			   . ' WHERE p.id IN ('.implode(', ', wp_parse_id_list($args['ids'])).')';
 		// @codingStandardsIgnoreEnd
 	}
 
-	private static function get_base_query( $args ) {
+	private static function get_base_query($args) {
 		global $wpdb;
 
 		// Get the link options.
-		$link_options = serialize( array(
+		$link_options = serialize(array(
 			'links'           => $args['links'],
 			'min_occurrences' => $args['min_occurrences'],
-		) );
+		));
 
 		return $wpdb->prepare(
 			"INSERT INTO $wpdb->postmeta ( post_id, meta_key, meta_value )"
@@ -118,10 +118,10 @@ 
 	 *
 	 * @return string The `post_content` clause.
 	 */
-	private static function and_include_annotated( $include ) {
+	private static function and_include_annotated($include) {
 
 		// Bail out with an empty string if we include all the posts.
-		if ( true === $include ) {
+		if (true === $include) {
 			return '';
 		}
 
@@ -138,15 +138,15 @@ 
 	 *
 	 * @return string The start `post_date_gmt` clause
 	 */
-	private static function and_post_date_from( $value ) {
+	private static function and_post_date_from($value) {
 
 		// Bail out if the `from` isn't specified.
-		if ( null === $value ) {
+		if (null === $value) {
 			return '';
 		}
 
 		// Try to convert the value to a date, GMT timezone.
-		$date = self::get_mysql_date_string( $value );
+		$date = self::get_mysql_date_string($value);
 
 		// Return the clause.
 		return " AND p.post_date_gmt >= '$date'";
@@ -161,15 +161,15 @@ 
 	 *
 	 * @return string The end `post_date_gmt` clause
 	 */
-	private static function and_post_date_to( $value ) {
+	private static function and_post_date_to($value) {
 
 		// Bail out if the `from` isn't specified.
-		if ( null === $value ) {
+		if (null === $value) {
 			return '';
 		}
 
 		// Try to convert the value to a date, GMT timezone.
-		$date = self::get_mysql_date_string( $value );
+		$date = self::get_mysql_date_string($value);
 
 		// Return the clause.
 		return " AND p.post_date_gmt <= '$date'";
@@ -184,14 +184,14 @@ 
 	 *
 	 * @return string The posts IN clause.
 	 */
-	private static function and_include_posts( $include ) {
+	private static function and_include_posts($include) {
 
 		// Bail if the param is not set.
-		if ( empty( $include ) ) {
+		if (empty($include)) {
 			return '';
 		}
 
-		return ' AND p.ID IN ( ' . implode( ',', wp_parse_id_list( $include ) ) . ' )';
+		return ' AND p.ID IN ( '.implode(',', wp_parse_id_list($include)).' )';
 	}
 
 	/**
@@ -203,14 +203,14 @@ 
 	 *
 	 * @return string The posts NOT IN clause.
 	 */
-	private static function and_exclude_posts( $exclude ) {
+	private static function and_exclude_posts($exclude) {
 
 		// Bail if the param is not set.
-		if ( empty( $exclude ) ) {
+		if (empty($exclude)) {
 			return '';
 		}
 
-		return ' AND p.ID NOT IN ( ' . implode( ',', wp_parse_id_list( $exclude ) ) . ' )';
+		return ' AND p.ID NOT IN ( '.implode(',', wp_parse_id_list($exclude)).' )';
 	}
 
 
@@ -226,25 +226,25 @@ 
 	 *
 	 * @return string A MySQL string representation of the date.
 	 */
-	private static function get_mysql_date_string( $value ) {
+	private static function get_mysql_date_string($value) {
 
 		// Try to convert the value to a date, GMT timezone.
-		$date = date_create_from_format( 'Y-m-d\TH:i:sT', $value );
+		$date = date_create_from_format('Y-m-d\TH:i:sT', $value);
 
-		if ( false === $date ) {
-			wp_die( "Invalid date format, use `Y-m-d'T'H:i:sT`." );
+		if (false === $date) {
+			wp_die("Invalid date format, use `Y-m-d'T'H:i:sT`.");
 		}
 
 		// Convert the DateTime timezone to `GMT`.
-		$date->setTimezone( timezone_open( 'GMT' ) );
+		$date->setTimezone(timezone_open('GMT'));
 
 		// Stop if the conversion failed.
-		if ( false === $date ) {
-			wp_die( "Invalid date format, date must be in Y-m-d'T'H:i:sT format." );
+		if (false === $date) {
+			wp_die("Invalid date format, date must be in Y-m-d'T'H:i:sT format.");
 		}
 
 		// Return the clause.
-		return $date->format( 'Y-m-d H:i:s' );
+		return $date->format('Y-m-d H:i:s');
 	}
 
 }