AbstractProductListBlock.php
2 months ago
ProductListBlock.php
2 months ago
ProductPageBlock.php
2 months ago
ProductReviewBlock.php
4 months ago
ProductReviewListBlock.php
4 months ago
RelatedProductsBlock.php
2 months ago
ProductListBlock.php
279 lines
| 1 | <?php |
| 2 | |
| 3 | namespace SureCart\Models\Blocks; |
| 4 | |
| 5 | /** |
| 6 | * The product list block. |
| 7 | */ |
| 8 | class ProductListBlock extends AbstractProductListBlock { |
| 9 | /** |
| 10 | * Get the query context. |
| 11 | * |
| 12 | * @return array |
| 13 | */ |
| 14 | public function getQueryContext() { |
| 15 | return $this->block->context['query'] ?? []; |
| 16 | } |
| 17 | |
| 18 | /** |
| 19 | * Build the query |
| 20 | * |
| 21 | * @return $this |
| 22 | */ |
| 23 | public function parse_query() { |
| 24 | $query = $this->getQueryContext(); |
| 25 | |
| 26 | $offset = absint( $query['offset'] ?? 0 ); |
| 27 | $per_page = $this->block->parsed_block['attrs']['query']['perPage'] ?? $this->block->parsed_block['attrs']['limit'] ?? $query['perPage'] ?? 15; |
| 28 | $order = ! empty( $this->url->getArg( 'order' ) ) |
| 29 | ? sanitize_text_field( $this->url->getArg( 'order' ) ) |
| 30 | : ( ! empty( $query['order'] ) ? $query['order'] : 'desc' ); |
| 31 | $orderby = ! empty( $this->url->getArg( 'orderby' ) ) |
| 32 | ? sanitize_text_field( $this->url->getArg( 'orderby' ) ) |
| 33 | : ( ! empty( $query['orderBy'] ) ? $query['orderBy'] : 'date' ); |
| 34 | $page = $this->url->getCurrentPage(); |
| 35 | |
| 36 | // build up the query. |
| 37 | $query_vars = array_filter( |
| 38 | array( |
| 39 | 'post_type' => 'sc_product', |
| 40 | 'post_status' => 'publish', |
| 41 | 'ignore_sticky_posts' => 1, |
| 42 | 'posts_per_page' => $per_page, |
| 43 | 'offset' => ( $per_page * ( $page - 1 ) ) + $offset, |
| 44 | 'paged' => (int) $this->url->getCurrentPage(), |
| 45 | 'order' => $order, |
| 46 | 'orderby' => $orderby, |
| 47 | 's' => sanitize_text_field( $this->url->getArg( 'search' ) ), |
| 48 | ) |
| 49 | ); |
| 50 | |
| 51 | // handle search. |
| 52 | if ( ! empty( $query['search'] ) && empty( $query_vars['s'] ) ) { |
| 53 | $query_vars['s'] = sanitize_text_field( $query['search'] ); |
| 54 | } |
| 55 | |
| 56 | // put together price query. |
| 57 | if ( 'price' === $this->url->getArg( 'orderby' ) ) { |
| 58 | $query_vars['meta_key'] = 'min_price_amount'; |
| 59 | $query_vars['orderby'] = 'meta_value_num'; |
| 60 | } |
| 61 | |
| 62 | $tax_query = array( |
| 63 | 'relation' => 'OR', |
| 64 | ); |
| 65 | |
| 66 | // handle tax query. |
| 67 | if ( ! empty( $query['taxQuery'] ) ) { |
| 68 | foreach ( $query['taxQuery'] as $taxonomy => $terms ) { |
| 69 | if ( is_taxonomy_viewable( $taxonomy ) && ! empty( $terms ) ) { |
| 70 | $tax_query[] = array( |
| 71 | 'taxonomy' => sanitize_key( $taxonomy ), |
| 72 | 'terms' => array_filter( array_map( 'absint', $terms ) ), |
| 73 | 'include_children' => false, |
| 74 | ); |
| 75 | } |
| 76 | } |
| 77 | } |
| 78 | |
| 79 | // put together price query. |
| 80 | if ( 'price' === $orderby ) { |
| 81 | $query_vars['meta_key'] = 'min_price_amount'; |
| 82 | $query_vars['orderby'] = 'meta_value_num'; |
| 83 | } |
| 84 | |
| 85 | $collection_id = sanitize_text_field( $this->block->context['surecart/product-list/collection_id'] ?? $this->block->parsed_block['attrs']['collection_id'] ?? '' ); |
| 86 | |
| 87 | // handle collection id send from "sc_product_collection" shortcode. |
| 88 | if ( ! empty( $collection_id ) ) { |
| 89 | $collection_ids = array_unique( array_map( 'sanitize_text_field', explode( ',', $collection_id ) ) ); |
| 90 | |
| 91 | $legacy_collection_ids = get_terms( |
| 92 | array( |
| 93 | 'taxonomy' => 'sc_collection', |
| 94 | 'field' => 'term_id', |
| 95 | 'meta_query' => array( |
| 96 | array( |
| 97 | 'key' => 'sc_id', |
| 98 | 'value' => $collection_ids, |
| 99 | 'compare' => 'IN', |
| 100 | ), |
| 101 | ), |
| 102 | ) |
| 103 | ); // platform collection ids converted to WP taxonomy ids. |
| 104 | |
| 105 | // only get the term_id. |
| 106 | $legacy_collection_ids = array_map( |
| 107 | function ( $term ) { |
| 108 | return $term->term_id; |
| 109 | }, |
| 110 | $legacy_collection_ids |
| 111 | ); |
| 112 | |
| 113 | $tax_query[] = |
| 114 | array( |
| 115 | 'taxonomy' => 'sc_collection', |
| 116 | 'field' => 'term_id', |
| 117 | 'terms' => array_unique( array_map( 'absint', $legacy_collection_ids ?? array() ) ), |
| 118 | ); |
| 119 | } elseif ( is_tax() ) { |
| 120 | $term = get_queried_object(); |
| 121 | $tax_query[] = |
| 122 | array( |
| 123 | 'taxonomy' => 'sc_collection', |
| 124 | 'field' => 'term_id', |
| 125 | 'terms' => array_unique( array_map( 'absint', [ (int) $term->term_id ] ) ), |
| 126 | ); |
| 127 | } |
| 128 | |
| 129 | $all_taxonomies = $this->url->getAllTaxonomyArgs(); |
| 130 | |
| 131 | // handle taxonomies query. |
| 132 | foreach ( $all_taxonomies as $taxonomy => $terms ) { |
| 133 | $tax_query[] = |
| 134 | array( |
| 135 | 'taxonomy' => $taxonomy, |
| 136 | 'field' => 'slug', |
| 137 | 'terms' => array_unique( array_map( 'strval', $terms ?? array() ) ), |
| 138 | 'operator' => 'IN', |
| 139 | ); |
| 140 | } |
| 141 | |
| 142 | $query_vars['tax_query'][] = $tax_query; |
| 143 | |
| 144 | // handle featured. |
| 145 | if ( 'featured' === ( $this->block->context['surecart/product-list/type'] ?? 'all' ) ) { |
| 146 | $query_vars['meta_query'] = [ |
| 147 | [ |
| 148 | 'key' => 'featured', |
| 149 | 'value' => '1', |
| 150 | 'compare' => '=', |
| 151 | ], |
| 152 | ]; |
| 153 | } |
| 154 | |
| 155 | if ( 'custom' === ( $this->block->context['surecart/product-list/type'] ?? $this->block->parsed_block['attrs']['type'] ?? 'all' ) ) { |
| 156 | $query = $this->getQueryContext(); |
| 157 | // backward compatibility. |
| 158 | |
| 159 | $ids = ! empty( $query['include'] ) ? $query['include'] : ( ! empty( $this->block->context['surecart/product-list/ids'] ) ? $this->block->context['surecart/product-list/ids'] : ( ! empty( $this->block->parsed_block['attrs']['ids'] ) ? $this->block->parsed_block['attrs']['ids'] : [] ) ); |
| 160 | $ids = is_array( $ids ) ? $ids : explode( ',', $ids ); |
| 161 | |
| 162 | // fallback for older strings - get the ids of legacy products. |
| 163 | $legacy_ids = []; |
| 164 | $ids_that_are_strings = array_map( 'sanitize_text_field', array_filter( $ids, 'is_string' ) ); |
| 165 | if ( ! empty( $ids_that_are_strings ) ) { |
| 166 | $legacy_ids = get_posts( |
| 167 | [ |
| 168 | 'post_type' => 'sc_product', |
| 169 | 'status' => 'publish', |
| 170 | 'fields' => 'ids', |
| 171 | 'posts_per_page' => -1, |
| 172 | 'meta_query' => [ |
| 173 | [ |
| 174 | 'key' => 'sc_id', |
| 175 | 'value' => $ids_that_are_strings, |
| 176 | 'compare' => 'IN', |
| 177 | ], |
| 178 | ], |
| 179 | ] |
| 180 | ); |
| 181 | } |
| 182 | |
| 183 | // get only ids that are integers. |
| 184 | $ids_that_are_integers = array_filter( $ids, 'is_int' ); |
| 185 | |
| 186 | // post in. |
| 187 | $query_vars['post__in'] = array_merge( $legacy_ids, $ids_that_are_integers ); |
| 188 | |
| 189 | // order by posts if there is not an order by. |
| 190 | if ( empty( $query_vars['orderby'] ) ) { |
| 191 | $query_vars['orderby'] = 'post__in'; |
| 192 | } |
| 193 | } |
| 194 | |
| 195 | return $query_vars; |
| 196 | } |
| 197 | |
| 198 | /** |
| 199 | * Get the terms. |
| 200 | * |
| 201 | * @return array |
| 202 | */ |
| 203 | public function getTermOptions( $taxonomy_slug = 'sc_collection' ) { |
| 204 | $taxonomy_slug = ! empty( $taxonomy_slug ) ? $taxonomy_slug : 'sc_collection'; |
| 205 | |
| 206 | // get non-empty terms. |
| 207 | $terms = get_terms( |
| 208 | array( |
| 209 | 'taxonomy' => $taxonomy_slug, |
| 210 | 'hide_empty' => true, |
| 211 | ) |
| 212 | ); |
| 213 | |
| 214 | if ( is_wp_error( $terms ) ) { |
| 215 | return false; |
| 216 | } |
| 217 | |
| 218 | // we are on a collection page. |
| 219 | $current_term = get_queried_object(); |
| 220 | if ( is_a( $current_term, \WP_Term::class ) ) { |
| 221 | return false; |
| 222 | } |
| 223 | |
| 224 | $url = \SureCart::block()->urlParams( 'products' ); |
| 225 | |
| 226 | $options = array_map( |
| 227 | function ( $term ) use ( $url, $taxonomy_slug ) { |
| 228 | return [ |
| 229 | 'value' => $term->slug, |
| 230 | 'label' => $term->name, |
| 231 | 'href' => $url->hasFilterArg( $taxonomy_slug, $term->slug ) ? $url->removeFilterArg( $taxonomy_slug, $term->slug ) : $url->addFilterArg( $taxonomy_slug, $term->slug ), |
| 232 | 'checked' => $url->hasFilterArg( $taxonomy_slug, $term->slug ), |
| 233 | ]; |
| 234 | }, |
| 235 | $terms ?? [] |
| 236 | ); |
| 237 | |
| 238 | // no filter options. |
| 239 | if ( empty( $options ) ) { |
| 240 | return false; |
| 241 | } |
| 242 | |
| 243 | return $options; |
| 244 | } |
| 245 | |
| 246 | /** |
| 247 | * Offset the found posts. |
| 248 | * See: https://codex.wordpress.org/Making_Custom_Queries_using_Offset_and_Pagination |
| 249 | * |
| 250 | * @param int $found_posts The found posts. |
| 251 | * |
| 252 | * @return int The found posts with offset. |
| 253 | */ |
| 254 | public function offsetFoundPosts( $found_posts ) { |
| 255 | $query = $this->getQueryContext(); |
| 256 | $offset = absint( $query['offset'] ?? 0 ); |
| 257 | |
| 258 | return $found_posts - $offset; |
| 259 | } |
| 260 | |
| 261 | /** |
| 262 | * Run the query |
| 263 | * |
| 264 | * @return $this|\WP_Error |
| 265 | */ |
| 266 | public function query() { |
| 267 | $query_vars = $this->parse_query(); |
| 268 | wp_reset_postdata(); |
| 269 | |
| 270 | add_filter( 'found_posts', [ $this, 'offsetFoundPosts' ], 1 ); |
| 271 | $this->query = new \WP_Query( $query_vars ); |
| 272 | remove_filter( 'found_posts', [ $this, 'offsetFoundPosts' ], 1 ); |
| 273 | |
| 274 | $this->primeAttachmentCaches(); |
| 275 | |
| 276 | return $this; |
| 277 | } |
| 278 | } |
| 279 |