| 1 |
<?php |
| 2 |
namespace UiCoreElements\Utils; |
| 3 |
|
| 4 |
use UiCoreElements\Helper; |
| 5 |
use UiCoreElements\Controls\Query; |
| 6 |
|
| 7 |
use UiCoreElements\Utils\Meta_Trait; |
| 8 |
use UiCoreElements\Utils\Post_Trait; |
| 9 |
|
| 10 |
defined('ABSPATH') || exit(); |
| 11 |
|
| 12 |
/** |
| 13 |
* Product Component |
| 14 |
* |
| 15 |
* @since 1.0.11 |
| 16 |
*/ |
| 17 |
|
| 18 |
trait Product_Trait { |
| 19 |
|
| 20 |
use Post_Trait, |
| 21 |
Meta_Trait; |
| 22 |
|
| 23 |
/** |
| 24 |
* Returns the proper query args for the product loop. |
| 25 |
* |
| 26 |
* @param array $settings Elementor controls settings. |
| 27 |
* @param array|WP_Query $default_query The default query variables. |
| 28 |
* |
| 29 |
* @return array|stdClass Return the products data, prepared for loop. |
| 30 |
*/ |
| 31 |
function TRAIT_query_products($settings, $default_query) |
| 32 |
{ |
| 33 |
$post_type = $settings['product-filter_post_type']; |
| 34 |
|
| 35 |
switch ($post_type){ |
| 36 |
case 'current' : |
| 37 |
// Makes sure widget will render some products at editor screen |
| 38 |
if( $this->is_edit_mode() ){ |
| 39 |
$query_args['post_type'] = 'product'; |
| 40 |
|
| 41 |
} else { |
| 42 |
$query_args = $default_query; |
| 43 |
|
| 44 |
// Set pagination |
| 45 |
$query_args['paged'] = Query::get_queried_page($settings); |
| 46 |
|
| 47 |
// Set tax filters for filter component, if enabled |
| 48 |
$queried_filters = Query::get_queried_filters($settings, 'product', 'product-filter'); |
| 49 |
$query_args['tax_query'] = empty($queried_filters['tax_query']) ? [] : $queried_filters['tax_query']; |
| 50 |
} |
| 51 |
break; |
| 52 |
|
| 53 |
case 'related' : |
| 54 |
return Helper::get_product_related($settings['item_limit']['size']); |
| 55 |
break; |
| 56 |
|
| 57 |
default : |
| 58 |
$query_args = Query::get_query_args('product-filter', $settings, true); |
| 59 |
break; |
| 60 |
} |
| 61 |
|
| 62 |
// Set total pages |
| 63 |
$query_args['total_pages'] = Query::get_total_pages($query_args); |
| 64 |
|
| 65 |
// Hide out of stock products |
| 66 |
if( $settings['hide_out_of_stock'] === 'yes' ){ |
| 67 |
$query_args['meta_query'] = [ |
| 68 |
[ |
| 69 |
'key' => '_stock_status', |
| 70 |
'value' => 'instock', |
| 71 |
'compare' => '=', |
| 72 |
] |
| 73 |
]; |
| 74 |
} |
| 75 |
|
| 76 |
$this->_query = $query_args; |
| 77 |
|
| 78 |
return wc_get_products($query_args); |
| 79 |
} |
| 80 |
|
| 81 |
|
| 82 |
// Render functions |
| 83 |
function get_product_image(object $product) |
| 84 |
{ |
| 85 |
if ($this->get_settings_for_display('image') !== 'yes') { |
| 86 |
return; |
| 87 |
} |
| 88 |
|
| 89 |
// Get product image ID |
| 90 |
$pic_id = $product->get_image_id(); |
| 91 |
if (!$pic_id) { |
| 92 |
return; |
| 93 |
} |
| 94 |
|
| 95 |
// Get image size |
| 96 |
$size = $this->get_settings_for_display('image_size_select') ?? 'uicore-medium'; |
| 97 |
?> |
| 98 |
<a class="ui-e-post-img-wrapp" |
| 99 |
href="<?php echo esc_url($product->get_permalink()); ?>" |
| 100 |
title="<?php echo esc_attr__('View Product:', 'uicore-elements') . ' ' . esc_attr($product->get_name()); ?>"> |
| 101 |
|
| 102 |
<?php if ($this->get_settings_for_display('masonry') === 'ui-e-maso') { ?> |
| 103 |
<?php |
| 104 |
// Get secondary image if available |
| 105 |
$sec_img = $this->get_product_secondary_image( $product ); |
| 106 |
$classes = $sec_img ? 'ui-e-post-img ui-e-hover-hide' : 'ui-e-post-img'; |
| 107 |
|
| 108 |
// Print secondary image markup if exists |
| 109 |
echo $sec_img ? wp_kses_post($sec_img) : ''; |
| 110 |
|
| 111 |
// Print main product image |
| 112 |
echo wp_get_attachment_image($pic_id, $size, false, ['class' => $classes]); |
| 113 |
?> |
| 114 |
<?php } else { ?> |
| 115 |
<?php |
| 116 |
// Get secondary image with size |
| 117 |
$sec_img = $this->get_product_secondary_image( $product, $size, true ); |
| 118 |
echo $sec_img ? wp_kses_post($sec_img) : ''; |
| 119 |
?> |
| 120 |
<div class="ui-e-post-img <?php echo $sec_img ? 'ui-e-hover-hide' : ''; ?>" |
| 121 |
style="background-image:url(<?php echo wp_get_attachment_image_url($pic_id, $size); ?>)"> |
| 122 |
</div> |
| 123 |
<?php } ?> |
| 124 |
</a> |
| 125 |
<?php |
| 126 |
} |
| 127 |
function get_product_secondary_image($product, $size = 'woocommerce_thumbnail', $bg_output = false) |
| 128 |
{ |
| 129 |
// Requested only for products with change-image animation |
| 130 |
if( 'ui-e-img-anim-change' !== $this->get_settings_for_display('anim_image') ) { |
| 131 |
return false; |
| 132 |
} |
| 133 |
|
| 134 |
// Get product gallery image IDs |
| 135 |
$gallery_image_ids = $product->get_gallery_image_ids(); |
| 136 |
|
| 137 |
// Check if there is at least one gallery image |
| 138 |
if (empty($gallery_image_ids)) { |
| 139 |
return false; |
| 140 |
} |
| 141 |
|
| 142 |
// Get the first image from the gallery |
| 143 |
$secondary_image_id = $gallery_image_ids[0]; |
| 144 |
$secondary_image_url = wp_get_attachment_image_url($secondary_image_id, $size); |
| 145 |
|
| 146 |
// Output secondary image as <img> or background <div> |
| 147 |
if ($bg_output) { |
| 148 |
return sprintf( |
| 149 |
'<div class="ui-e-post-img ui-e-post-img-secondary" style="background-image: url(%s);"></div>', |
| 150 |
esc_url($secondary_image_url) |
| 151 |
); |
| 152 |
} else { |
| 153 |
return wp_get_attachment_image($secondary_image_id, $size, false, [ |
| 154 |
'class' => 'ui-e-post-img ui-e-post-img-secondary' |
| 155 |
]); |
| 156 |
} |
| 157 |
} |
| 158 |
function get_product_title($product) |
| 159 |
{ |
| 160 |
if ($this->get_settings_for_display('title') !== 'yes') { |
| 161 |
return; |
| 162 |
} |
| 163 |
|
| 164 |
?> |
| 165 |
<a href="<?php echo esc_url($product->get_permalink()); ?>" |
| 166 |
title="<?php echo esc_attr__('View Product:', 'uicore-elements') . ' ' . esc_html($product->get_name()); ?>"> |
| 167 |
<h4 class="ui-e-post-title"><span><?php echo esc_html($product->get_name()); ?></span></h4> |
| 168 |
</a> |
| 169 |
<?php |
| 170 |
} |
| 171 |
|
| 172 |
/** |
| 173 |
* Renders a product item with various settings and options. |
| 174 |
* Important: any changes here should also be considered to `TRAIT_render_item()` from Post Component. |
| 175 |
* |
| 176 |
* @param WC_Product $product The product object. |
| 177 |
* @param bool $carousel Indicates if the item needs carousel classnames. |
| 178 |
* @param bool $legacy Indicates if the item is using legacy classnames. |
| 179 |
* @param bool $is_ajax Indicates if the item is being rendered through REST API. |
| 180 |
* |
| 181 |
* @return void |
| 182 |
*/ |
| 183 |
function TRAIT_render_product($product, $carousel = false, $legacy = false, $is_ajax = false) |
| 184 |
{ |
| 185 |
$settings = $this->get_settings_for_display(); |
| 186 |
$excerpt_length = $settings['excerpt_trim']; |
| 187 |
|
| 188 |
// Classnames but checking if we the widget is APG (legacy version) |
| 189 |
$item_classes = $legacy ? ['ui-e-post-item', 'ui-e-item'] : ['ui-e-item'] ; // Single item lower wrap class receptor |
| 190 |
$hover_item_class = $legacy ? 'anim_item' : 'item_hover_animation'; // item hover animation class |
| 191 |
|
| 192 |
// If widget is not carousel type, we set animations classes directly on item selector |
| 193 |
if(!$carousel) { |
| 194 |
$item_classes[] = 'ui-e-animations-wrp'; |
| 195 |
$item_classes[] = $settings['animate_items'] === 'ui-e-grid-animate' ? 'elementor-invisible' : ''; |
| 196 |
$item_classes[] = $settings[$hover_item_class] !== '' ? $settings[$hover_item_class] : ''; |
| 197 |
|
| 198 |
} else { |
| 199 |
// Get entrance and item hover animation classes |
| 200 |
$entrance = (isset($settings['animate_items']) && $settings['animate_items'] == 'ui-e-grid-animate') ? 'elementor-invisible' : ''; |
| 201 |
$hover = isset($settings[$hover_item_class]) ? $settings[$hover_item_class] : ''; //$settings[$hover_item_class] : null; |
| 202 |
$animations = sprintf('%s %s', $entrance, $hover); |
| 203 |
|
| 204 |
// Check if entrance or hover animation are set |
| 205 |
$has_animation = !empty($entrance) || !empty($hover) |
| 206 |
|
| 207 |
// Prints extra wrappers required by the carousel script |
| 208 |
?> |
| 209 |
<div class="ui-e-wrp swiper-slide"> |
| 210 |
<?php if($has_animation) : ?> |
| 211 |
<div class="ui-e-animations-wrp <?php echo esc_attr($animations);?>"> |
| 212 |
<?php endif; ?> |
| 213 |
|
| 214 |
<?php } ?> |
| 215 |
|
| 216 |
<div class="<?php echo esc_attr( implode(' ', $item_classes));?>"> |
| 217 |
<article <?php post_class('product'); ?>> |
| 218 |
<div class="ui-e-post-top"> |
| 219 |
<?php $this->get_product_image($product); ?> |
| 220 |
<?php $this->get_post_meta('top'); ?> |
| 221 |
<?php |
| 222 |
if($settings['button_position'] === 'ui-e-button-placement-image') { |
| 223 |
$this->TRAIT_get_button(true); |
| 224 |
} |
| 225 |
?> |
| 226 |
</div> |
| 227 |
<div class="ui-e-post-content"> |
| 228 |
<?php $this->get_post_meta('before_title'); ?> |
| 229 |
<?php |
| 230 |
if ($this->get_settings_for_display('title') === 'yes') |
| 231 |
$this->get_product_title($product); |
| 232 |
?> |
| 233 |
<?php $this->get_post_meta('after_title'); ?> |
| 234 |
<?php |
| 235 |
if ($this->get_settings_for_display('excerpt')) |
| 236 |
echo wp_kses_post('<div class="ui-e-post-text">' . wp_trim_words(get_the_excerpt(), $excerpt_length) . '</div>'); |
| 237 |
?> |
| 238 |
<?php $this->get_post_meta('bottom'); // button |
| 239 |
?> |
| 240 |
<?php |
| 241 |
if( defined('UICORE_VERSION') && version_compare(UICORE_VERSION, '6.0.1', '>=') && $this->get_settings_for_display('show_swatches') === 'yes' ){ |
| 242 |
// ajax requests works under minimal conditions, wich means Swatches class is not present |
| 243 |
if ( $is_ajax ) { |
| 244 |
require_once UICORE_INCLUDES . '/woocommerce/components/class-swatches.php'; |
| 245 |
} |
| 246 |
|
| 247 |
\UiCore\WooCommerce\Swatches::print_swatches($product); // from Uicore Framework |
| 248 |
} |
| 249 |
if ( $this->get_settings_for_display('show_button') === 'yes' ) { |
| 250 |
// Add match height spacing element if carousel. May look intrusive, but is the simplest method compared |
| 251 |
// to absolute positioning or catching last content element to apply margin. |
| 252 |
if($carousel && $settings['match_height'] === 'yes'){ |
| 253 |
?> |
| 254 |
<span class="ui-e-match-height"></span> |
| 255 |
<?php |
| 256 |
} |
| 257 |
|
| 258 |
if( !isset($settings['button_position']) || empty($settings['button_position']) ) { |
| 259 |
$this->TRAIT_get_button(true); |
| 260 |
} |
| 261 |
} |
| 262 |
?> |
| 263 |
</div> |
| 264 |
</article> |
| 265 |
</div> |
| 266 |
|
| 267 |
<?php if($carousel) { ?> |
| 268 |
</div> |
| 269 |
<?php if($has_animation) : ?> |
| 270 |
</div> |
| 271 |
<?php endif; ?> |
| 272 |
|
| 273 |
<?php } |
| 274 |
} |
| 275 |
|
| 276 |
// TODO: discover why using Post_Trait here forces us to have |
| 277 |
// this public content_template() to avoid fatal error |
| 278 |
public function content_template() {} |
| 279 |
} |
| 280 |
|
