Viewing file:  kkart-cart-functions.php (17.27 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/**
* Kkart Cart Functions
*
* Functions for cart specific things.
*
* @package Kkart\Functions
* @version 2.5.0
*/
use Automattic\Jetpack\Constants;
defined( 'ABSPATH' ) || exit;
/**
* Prevent password protected products being added to the cart.
*
* @param bool $passed Validation.
* @param int $product_id Product ID.
* @return bool
*/
function kkart_protected_product_add_to_cart( $passed, $product_id ) {
if ( post_password_required( $product_id ) ) {
$passed = false;
kkart_add_notice( __( 'This product is protected and cannot be purchased.', 'kkart' ), 'error' );
}
return $passed;
}
add_filter( 'kkart_add_to_cart_validation', 'kkart_protected_product_add_to_cart', 10, 2 );
/**
* Clears the cart session when called.
*/
function kkart_empty_cart() {
if ( ! isset( KKART()->cart ) || '' === KKART()->cart ) {
KKART()->cart = new KKART_Cart();
}
KKART()->cart->empty_cart( false );
}
/**
* Load the persistent cart.
*
* @param string $user_login User login.
* @param WP_User $user User data.
* @deprecated 2.3
*/
function kkart_load_persistent_cart( $user_login, $user ) {
if ( ! $user || ! apply_filters( 'kkart_persistent_cart_enabled', true ) ) {
return;
}
$saved_cart = get_user_meta( $user->ID, '_kkart_persistent_cart_' . get_current_blog_id(), true );
if ( ! $saved_cart ) {
return;
}
$cart = KKART()->session->cart;
if ( empty( $cart ) || ! is_array( $cart ) || 0 === count( $cart ) ) {
KKART()->session->cart = $saved_cart['cart'];
}
}
/**
* Retrieves unvalidated referer from '_wp_http_referer' or HTTP referer.
*
* Do not use for redirects, use {@see wp_get_referer()} instead.
*
* @since 2.6.1
* @return string|false Referer URL on success, false on failure.
*/
function kkart_get_raw_referer() {
if ( function_exists( 'wp_get_raw_referer' ) ) {
return wp_get_raw_referer();
}
if ( ! empty( $_REQUEST['_wp_http_referer'] ) ) { // WPCS: input var ok, CSRF ok.
return wp_unslash( $_REQUEST['_wp_http_referer'] ); // WPCS: input var ok, CSRF ok, sanitization ok.
} elseif ( ! empty( $_SERVER['HTTP_REFERER'] ) ) { // WPCS: input var ok, CSRF ok.
return wp_unslash( $_SERVER['HTTP_REFERER'] ); // WPCS: input var ok, CSRF ok, sanitization ok.
}
return false;
}
/**
* Add to cart messages.
*
* @param int|array $products Product ID list or single product ID.
* @param bool $show_qty Should qty's be shown? Added in 2.6.0.
* @param bool $return Return message rather than add it.
*
* @return mixed
*/
function kkart_add_to_cart_message( $products, $show_qty = false, $return = false ) {
$titles = array();
$count = 0;
if ( ! is_array( $products ) ) {
$products = array( $products => 1 );
$show_qty = false;
}
if ( ! $show_qty ) {
$products = array_fill_keys( array_keys( $products ), 1 );
}
foreach ( $products as $product_id => $qty ) {
/* translators: %s: product name */
$titles[] = apply_filters( 'kkart_add_to_cart_qty_html', ( $qty > 1 ? absint( $qty ) . ' × ' : '' ), $product_id ) . apply_filters( 'kkart_add_to_cart_item_name_in_quotes', sprintf( _x( '“%s”', 'Item name in quotes', 'kkart' ), strip_tags( get_the_title( $product_id ) ) ), $product_id );
$count += $qty;
}
$titles = array_filter( $titles );
/* translators: %s: product name */
$added_text = sprintf( _n( '%s has been added to your cart.', '%s have been added to your cart.', $count, 'kkart' ), kkart_format_list_of_items( $titles ) );
// Output success messages.
if ( 'yes' === get_option( 'kkart_cart_redirect_after_add' ) ) {
$return_to = apply_filters( 'kkart_continue_shopping_redirect', kkart_get_raw_referer() ? wp_validate_redirect( kkart_get_raw_referer(), false ) : kkart_get_page_permalink( 'shop' ) );
$message = sprintf( '<a href="%s" tabindex="1" class="button kkart-forward">%s</a> %s', esc_url( $return_to ), esc_html__( 'Continue shopping', 'kkart' ), esc_html( $added_text ) );
} else {
$message = sprintf( '<a href="%s" tabindex="1" class="button kkart-forward">%s</a> %s', esc_url( kkart_get_cart_url() ), esc_html__( 'View cart', 'kkart' ), esc_html( $added_text ) );
}
if ( has_filter( 'kkart_add_to_cart_message' ) ) {
kkart_deprecated_function( 'The kkart_add_to_cart_message filter', '3.0', 'kkart_add_to_cart_message_html' );
$message = apply_filters( 'kkart_add_to_cart_message', $message, $product_id );
}
$message = apply_filters( 'kkart_add_to_cart_message_html', $message, $products, $show_qty );
if ( $return ) {
return $message;
} else {
kkart_add_notice( $message, apply_filters( 'kkart_add_to_cart_notice_type', 'success' ) );
}
}
/**
* Comma separate a list of item names, and replace final comma with 'and'.
*
* @param array $items Cart items.
* @return string
*/
function kkart_format_list_of_items( $items ) {
$item_string = '';
foreach ( $items as $key => $item ) {
$item_string .= $item;
if ( count( $items ) === $key + 2 ) {
$item_string .= ' ' . __( 'and', 'kkart' ) . ' ';
} elseif ( count( $items ) !== $key + 1 ) {
$item_string .= ', ';
}
}
return $item_string;
}
/**
* Clear cart after payment.
*/
function kkart_clear_cart_after_payment() {
global $wp;
if ( ! empty( $wp->query_vars['order-received'] ) ) {
$order_id = absint( $wp->query_vars['order-received'] );
$order_key = isset( $_GET['key'] ) ? kkart_clean( wp_unslash( $_GET['key'] ) ) : ''; // WPCS: input var ok, CSRF ok.
if ( $order_id > 0 ) {
$order = kkart_get_order( $order_id );
if ( $order && hash_equals( $order->get_order_key(), $order_key ) ) {
KKART()->cart->empty_cart();
}
}
}
if ( KKART()->session->order_awaiting_payment > 0 ) {
$order = kkart_get_order( KKART()->session->order_awaiting_payment );
if ( $order && $order->get_id() > 0 ) {
// If the order has not failed, or is not pending, the order must have gone through.
if ( ! $order->has_status( array( 'failed', 'pending', 'cancelled' ) ) ) {
KKART()->cart->empty_cart();
}
}
}
}
add_action( 'get_header', 'kkart_clear_cart_after_payment' );
/**
* Get the subtotal.
*/
function kkart_cart_totals_subtotal_html() {
echo KKART()->cart->get_cart_subtotal(); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}
/**
* Get shipping methods.
*/
function kkart_cart_totals_shipping_html($return = false) {
KKART()->cart->calculate_shipping();
$packages = KKART()->shipping()->get_packages();
$first = true;
ob_start();
foreach ( $packages as $i => $package ) {
$chosen_method = isset( KKART()->session->chosen_shipping_methods[ $i ] ) ? KKART()->session->chosen_shipping_methods[ $i ] : '';
$product_names = array();
if ( count( $packages ) > 1 ) {
foreach ( $package['contents'] as $item_id => $values ) {
$product_names[ $item_id ] = $values['data']->get_name() . ' ×' . $values['quantity'];
}
$product_names = apply_filters( 'kkart_shipping_package_details_array', $product_names, $package );
}
$params = array(
'package' => $package,
'available_methods' => $package['rates'],
'show_package_details' => count( $packages ) > 1,
//'show_shipping_calculator' => is_cart() && apply_filters( 'kkart_shipping_show_shipping_calculator', $first, $i, $package ),
'package_details' => implode( ', ', $product_names ),
/* translators: %d: shipping package number */
'package_name' => apply_filters( 'kkart_shipping_package_name', ( ( $i + 1 ) > 1 ) ? sprintf( _x( 'Shipping %d', 'shipping packages', 'kkart' ), ( $i + 1 ) ) : _x( 'Shipping', 'shipping packages', 'kkart' ), $i, $package ),
'index' => $i,
'chosen_method' => $chosen_method,
'formatted_destination' => KKART()->countries->get_formatted_address( $package['destination'], ', ' ),
'has_calculated_shipping' => KKART()->customer->has_calculated_shipping(),
);
kkart_cart_shipping_tmpl( $params );
$first = false;
}
if($return){
return ob_get_clean();
}
echo ob_get_clean();
}
/**
* Get taxes total.
*/
function kkart_cart_totals_taxes_total_html($echo = true) {
$html = apply_filters( 'kkart_cart_totals_taxes_total_html', kkart_price( KKART()->cart->get_taxes_total() ) ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
if(!$echo){
return $html;
}
echo $html;
}
/**
* Get a coupon label.
*
* @param string|KKART_Coupon $coupon Coupon data or code.
* @param bool $echo Echo or return.
*
* @return string
*/
function kkart_cart_totals_coupon_label( $coupon, $echo = true ) {
if ( is_string( $coupon ) ) {
$coupon = new KKART_Coupon( $coupon );
}
/* translators: %s: coupon code */
$label = apply_filters( 'kkart_cart_totals_coupon_label', sprintf( esc_html__( 'Coupon: %s', 'kkart' ), $coupon->get_code() ), $coupon );
if ( $echo ) {
echo $label; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
} else {
return $label;
}
}
/**
* Get coupon display HTML.
*
* @param string|KKART_Coupon $coupon Coupon data or code.
*/
function kkart_cart_totals_coupon_html( $coupon ) {
if ( is_string( $coupon ) ) {
$coupon = new KKART_Coupon( $coupon );
}
$discount_amount_html = '';
$amount = KKART()->cart->get_coupon_discount_amount( $coupon->get_code(), KKART()->cart->display_cart_ex_tax );
$discount_amount_html = '-' . kkart_price( $amount );
if ( $coupon->get_free_shipping() && empty( $amount ) ) {
$discount_amount_html = __( 'Free shipping coupon', 'kkart' );
}
$discount_amount_html = apply_filters( 'kkart_coupon_discount_amount_html', $discount_amount_html, $coupon );
$coupon_html = $discount_amount_html . ' <a href="#" class="kkart-remove-coupon" data-coupon="' . esc_attr( $coupon->get_code() ) . '">' . __( '[Remove]', 'kkart' ) . '</a>';
echo wp_kses( apply_filters( 'kkart_cart_totals_coupon_html', $coupon_html, $coupon, $discount_amount_html ), array_replace_recursive( wp_kses_allowed_html( 'post' ), array( 'a' => array( 'data-coupon' => true ) ) ) ); // phpcs:ignore PHPCompatibility.PHP.NewFunctions.array_replace_recursiveFound
}
/**
* Get order total html including inc tax if needed.
*/
function kkart_cart_totals_order_total_html() {
$value = '<strong class="checkout-total">' . KKART()->cart->get_total() . '</strong> ';
// If prices are tax inclusive, show taxes here.
if ( kkart_tax_enabled() && KKART()->cart->display_prices_including_tax() ) {
$tax_string_array = array();
$cart_tax_totals = KKART()->cart->get_tax_totals();
if ( get_option( 'kkart_tax_total_display' ) === 'itemized' ) {
foreach ( $cart_tax_totals as $code => $tax ) {
$tax_string_array[] = sprintf( '%s %s', $tax->formatted_amount, $tax->label );
}
} elseif ( ! empty( $cart_tax_totals ) ) {
$tax_string_array[] = sprintf( '%s %s', kkart_price( KKART()->cart->get_taxes_total( true, true ) ), KKART()->countries->tax_or_vat() );
}
if ( ! empty( $tax_string_array ) ) {
$taxable_address = KKART()->customer->get_taxable_address();
if ( KKART()->customer->is_customer_outside_base() && ! KKART()->customer->has_calculated_shipping() ) {
$country = KKART()->countries->estimated_for_prefix( $taxable_address[0] ) . KKART()->countries->countries[ $taxable_address[0] ];
/* translators: 1: tax amount 2: country name */
$tax_text = wp_kses_post( sprintf( __( '(includes %1$s estimated for %2$s)', 'kkart' ), implode( ', ', $tax_string_array ), $country ) );
} else {
/* translators: %s: tax amount */
$tax_text = wp_kses_post( sprintf( __( '(includes %s)', 'kkart' ), implode( ', ', $tax_string_array ) ) );
}
$value .= '<small class="includes_tax">' . $tax_text . '</small>';
}
}
echo apply_filters( 'kkart_cart_totals_order_total_html', $value ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}
/**
* Get the fee value.
*
* @param object $fee Fee data.
*/
function kkart_cart_totals_fee_html( $fee ) {
$cart_totals_fee_html = KKART()->cart->display_prices_including_tax() ? kkart_price( $fee->total + $fee->tax ) : kkart_price( $fee->total );
echo apply_filters( 'kkart_cart_totals_fee_html', $cart_totals_fee_html, $fee ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}
/**
* Get a shipping methods full label including price.
*
* @param KKART_Shipping_Rate $method Shipping method rate data.
* @return string
*/
function kkart_cart_totals_shipping_method_label( $method ) {
$label = $method->get_label();
$has_cost = 0 < $method->cost;
$hide_cost = ! $has_cost && in_array( $method->get_method_id(), array( 'free_shipping', 'local_pickup' ), true );
if ( $has_cost && ! $hide_cost ) {
if ( KKART()->cart->display_prices_including_tax() ) {
$label .= ': ' . kkart_price( $method->cost + $method->get_shipping_tax() );
if ( $method->get_shipping_tax() > 0 && ! kkart_prices_include_tax() ) {
$label .= ' <small class="tax_label">' . KKART()->countries->inc_tax_or_vat() . '</small>';
}
} else {
$label .= ': ' . kkart_price( $method->cost );
if ( $method->get_shipping_tax() > 0 && kkart_prices_include_tax() ) {
$label .= ' <small class="tax_label">' . KKART()->countries->ex_tax_or_vat() . '</small>';
}
}
}
return apply_filters( 'kkart_cart_shipping_method_full_label', $label, $method );
}
/**
* Round discount.
*
* @param double $value Amount to round.
* @param int $precision DP to round.
* @return float
*/
function kkart_cart_round_discount( $value, $precision ) {
return kkart_round_discount( $value, $precision );
}
/**
* Gets chosen shipping method IDs from chosen_shipping_methods session, without instance IDs.
*
* @since 2.6.2
* @return string[]
*/
function kkart_get_chosen_shipping_method_ids() {
$method_ids = array();
$chosen_methods = KKART()->session->get( 'chosen_shipping_methods', array() );
foreach ( $chosen_methods as $chosen_method ) {
$chosen_method = explode( ':', $chosen_method );
$method_ids[] = current( $chosen_method );
}
return $method_ids;
}
/**
* Get chosen method for package from session.
*
* @since 3.2.0
* @param int $key Key of package.
* @param array $package Package data array.
* @return string|bool
*/
function kkart_get_chosen_shipping_method_for_package( $key, $package ) {
$chosen_methods = KKART()->session->get( 'chosen_shipping_methods' );
$chosen_method = isset( $chosen_methods[ $key ] ) ? $chosen_methods[ $key ] : false;
$changed = kkart_shipping_methods_have_changed( $key, $package );
// This is deprecated but here for BW compat. TODO: Remove in 4.0.0.
$method_counts = KKART()->session->get( 'shipping_method_counts' );
if ( ! empty( $method_counts[ $key ] ) ) {
$method_count = absint( $method_counts[ $key ] );
} else {
$method_count = 0;
}
// If not set, not available, or available methods have changed, set to the DEFAULT option.
if ( ! $chosen_method || $changed || ! isset( $package['rates'][ $chosen_method ] ) || count( $package['rates'] ) !== $method_count ) {
$chosen_method = kkart_get_default_shipping_method_for_package( $key, $package, $chosen_method );
$chosen_methods[ $key ] = $chosen_method;
$method_counts[ $key ] = count( $package['rates'] );
KKART()->session->set( 'chosen_shipping_methods', $chosen_methods );
KKART()->session->set( 'shipping_method_counts', $method_counts );
do_action( 'kkart_shipping_method_chosen', $chosen_method );
}
return $chosen_method;
}
/**
* Choose the default method for a package.
*
* @since 3.2.0
* @param int $key Key of package.
* @param array $package Package data array.
* @param string $chosen_method Chosen method id.
* @return string
*/
function kkart_get_default_shipping_method_for_package( $key, $package, $chosen_method ) {
$rate_keys = array_keys( $package['rates'] );
$default = current( $rate_keys );
$coupons = KKART()->cart->get_coupons();
foreach ( $coupons as $coupon ) {
if ( $coupon->get_free_shipping() ) {
foreach ( $rate_keys as $rate_key ) {
if ( 0 === stripos( $rate_key, 'free_shipping' ) ) {
$default = $rate_key;
break;
}
}
break;
}
}
return apply_filters( 'kkart_shipping_chosen_method', $default, $package['rates'], $chosen_method );
}
/**
* See if the methods have changed since the last request.
*
* @since 3.2.0
* @param int $key Key of package.
* @param array $package Package data array.
* @return bool
*/
function kkart_shipping_methods_have_changed( $key, $package ) {
// Lookup previous methods from session.
$previous_shipping_methods = KKART()->session->get( 'previous_shipping_methods' );
// Get new and old rates.
$new_rates = array_keys( $package['rates'] );
$prev_rates = isset( $previous_shipping_methods[ $key ] ) ? $previous_shipping_methods[ $key ] : false;
// Update session.
$previous_shipping_methods[ $key ] = $new_rates;
KKART()->session->set( 'previous_shipping_methods', $previous_shipping_methods );
return $new_rates !== $prev_rates;
}
/**
* Gets a hash of important product data that when changed should cause cart items to be invalidated.
*
* The kkart_cart_item_data_to_validate filter can be used to add custom properties.
*
* @param KKART_Product $product Product object.
* @return string
*/
function kkart_get_cart_item_data_hash( $product ) {
return md5(
wp_json_encode(
apply_filters(
'kkart_cart_item_data_to_validate',
array(
'type' => $product->get_type(),
'attributes' => 'variation' === $product->get_type() ? $product->get_variation_attributes() : '',
),
$product
)
)
);
}
|