| 1 |
<?php |
| 2 |
/** |
| 3 |
* Shared product search SQL filters. |
| 4 |
* |
| 5 |
* @package WCPOS\WooCommercePOS\API |
| 6 |
*/ |
| 7 |
|
| 8 |
namespace WCPOS\WooCommercePOS\API; |
| 9 |
|
| 10 |
use WCPOS\WooCommercePOS\Services\Barcode_Field; |
| 11 |
use WP_Query; |
| 12 |
|
| 13 |
/** |
| 14 |
* Keeps v1 and v2 product search fields identical. |
| 15 |
*/ |
| 16 |
final class Product_Search { |
| 17 |
private const MAX_SEARCH_TERMS = 10; |
| 18 |
|
| 19 |
/** |
| 20 |
* Search product titles, SKUs, and the configured barcode field. |
| 21 |
* |
| 22 |
* @param string $search Search SQL. |
| 23 |
* @param WP_Query $wp_query Query instance. |
| 24 |
* @return string |
| 25 |
*/ |
| 26 |
public static function posts_search( string $search, WP_Query $wp_query ): string { |
| 27 |
global $wpdb; |
| 28 |
$q = $wp_query->query_vars; |
| 29 |
$phrase = $q['wcpos_search_phrase'] ?? null; |
| 30 |
if ( empty( $search ) && null === $phrase ) { |
| 31 |
return $search; |
| 32 |
} |
| 33 |
$terms = null !== $phrase |
| 34 |
? preg_split( '/[\s\p{Z}\p{C}]+/u', $phrase, -1, PREG_SPLIT_NO_EMPTY ) |
| 35 |
: (array) $q['search_terms']; |
| 36 |
if ( null !== $phrase && ( false === $terms || array() === $terms ) ) { |
| 37 |
return ' AND 1=0 '; |
| 38 |
} |
| 39 |
// Like WP_Query::parse_search() and WooCommerce's search_products(), collapse over-long lists to the phrase. |
| 40 |
if ( null !== $phrase && self::MAX_SEARCH_TERMS < \count( $terms ) ) { |
| 41 |
$terms = array( $phrase ); |
| 42 |
} |
| 43 |
$n = ! empty( $q['exact'] ) ? '' : '%'; |
| 44 |
$meta_fields = Barcode_Field::search_keys(); |
| 45 |
$meta_placeholders = implode( ', ', array_fill( 0, \count( $meta_fields ), '%s' ) ); |
| 46 |
$search_conditions = array(); |
| 47 |
foreach ( $terms as $term ) { |
| 48 |
$term = $n . $wpdb->esc_like( $term ) . $n; |
| 49 |
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Table names come from $wpdb; $meta_placeholders is a generated list of %s placeholders, and the keys themselves are passed to prepare() as arguments. |
| 50 |
$search_conditions[] = $wpdb->prepare( |
| 51 |
"( {$wpdb->posts}.post_title LIKE %s OR EXISTS ( |
| 52 |
SELECT 1 FROM {$wpdb->postmeta} AS wcpos_search_meta WHERE wcpos_search_meta.post_id = {$wpdb->posts}.ID AND wcpos_search_meta.meta_key IN ($meta_placeholders) AND wcpos_search_meta.meta_value LIKE %s |
| 53 |
) )", |
| 54 |
array_merge( array( $term ), $meta_fields, array( $term ) ) |
| 55 |
); |
| 56 |
// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared |
| 57 |
} |
| 58 |
|
| 59 |
if ( ! empty( $search_conditions ) ) { |
| 60 |
$search = ' AND (' . implode( ' AND ', $search_conditions ) . ') '; |
| 61 |
if ( ! is_user_logged_in() ) { |
| 62 |
$search .= " AND ($wpdb->posts.post_password = '') "; |
| 63 |
} |
| 64 |
} |
| 65 |
return $search; |
| 66 |
} |
| 67 |
|
| 68 |
/** |
| 69 |
* Join product meta while searching. |
| 70 |
* |
| 71 |
* @param string $join JOIN SQL. |
| 72 |
* @param WP_Query $query Query instance. |
| 73 |
* @return string |
| 74 |
*/ |
| 75 |
public static function posts_join( string $join, WP_Query $query ): string { |
| 76 |
global $wpdb; |
| 77 |
if ( self::is_searching( $query ) && false === strpos( $join, 'pm1' ) ) { |
| 78 |
$join .= " LEFT JOIN {$wpdb->postmeta} pm1 ON {$wpdb->posts}.ID = pm1.post_id "; |
| 79 |
} |
| 80 |
return $join; |
| 81 |
} |
| 82 |
|
| 83 |
/** |
| 84 |
* Group product search results after joining meta. |
| 85 |
* |
| 86 |
* @param string $groupby GROUP BY SQL. |
| 87 |
* @param WP_Query $query Query instance. |
| 88 |
* @return string |
| 89 |
*/ |
| 90 |
public static function posts_groupby( string $groupby, WP_Query $query ): string { |
| 91 |
global $wpdb; |
| 92 |
if ( self::is_searching( $query ) ) { |
| 93 |
$groupby = "{$wpdb->posts}.ID"; |
| 94 |
} |
| 95 |
return $groupby; |
| 96 |
} |
| 97 |
|
| 98 |
/** |
| 99 |
* Rank exact SKU or barcode matches ahead of substring matches. |
| 100 |
* |
| 101 |
* @param string $orderby ORDER BY SQL. |
| 102 |
* @param WP_Query $query Query instance. |
| 103 |
*/ |
| 104 |
public static function posts_orderby( string $orderby, WP_Query $query ): string { |
| 105 |
global $wpdb; |
| 106 |
if ( ! self::is_searching( $query ) ) { |
| 107 |
return $orderby; |
| 108 |
} |
| 109 |
$keys = Barcode_Field::search_keys(); |
| 110 |
return $wpdb->prepare( |
| 111 |
'MIN(CASE WHEN pm1.meta_key IN (' . implode( ', ', array_fill( 0, count( $keys ), '%s' ) ) . ') AND pm1.meta_value = %s THEN 0 ELSE 1 END) ASC', |
| 112 |
array_merge( $keys, array( trim( (string) ( $query->query_vars['wcpos_search_phrase'] ?? $query->query_vars['s'] ) ) ) ) |
| 113 |
) . ', ' . ( '' === trim( $orderby ) ? "{$wpdb->posts}.ID DESC" : $orderby ); |
| 114 |
} |
| 115 |
|
| 116 |
/** |
| 117 |
* Whether the query carries a search term. Not empty(): the literal term "0" is a search. |
| 118 |
* |
| 119 |
* @param WP_Query $query Query instance. |
| 120 |
* @return bool |
| 121 |
*/ |
| 122 |
private static function is_searching( WP_Query $query ): bool { |
| 123 |
return '' !== (string) ( $query->query_vars['wcpos_search_phrase'] ?? $query->query_vars['s'] ?? '' ); |
| 124 |
} |
| 125 |
} |
| 126 |
|
