weekday in some places
protected static $weekdays = array(
1 => 'Monday',
2 => 'Tuesday',
3 => 'Wednesday',
4 => 'Thursday',
5 => 'Friday',
6 => 'Saturday',
7 => 'Sunday',
);
/**
* Bootstraps the class and hooks required actions & filters.
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.5
*/
public static function init() {
self::$setting_id = WC_Subscriptions_Admin::$option_prefix . '_sync_payments';
self::$setting_id_proration = WC_Subscriptions_Admin::$option_prefix . '_prorate_synced_payments';
self::$setting_id_days_no_fee = WC_Subscriptions_Admin::$option_prefix . '_days_no_fee';
self::$sync_field_label = __( 'Synchronise renewals', 'woocommerce-subscriptions' );
self::$sync_description = __( 'Align the payment date for all customers who purchase this subscription to a specific day of the week or month.', 'woocommerce-subscriptions' );
// translators: placeholder is a year (e.g. "2016")
self::$sync_description_year = sprintf( _x( 'Align the payment date for this subscription to a specific day of the year. If the date has already taken place this year, the first payment will be processed in %s. Set the day to 0 to disable payment syncing for this product.', 'used in subscription product edit screen', 'woocommerce-subscriptions' ), gmdate( 'Y', wcs_date_to_time( '+1 year' ) ) );
// Add the settings to control whether syncing is enabled and how it will behave
add_filter( 'woocommerce_subscription_settings', __CLASS__ . '::add_settings' );
// When enabled, add the sync selection fields to the Edit Product screen
add_action( 'woocommerce_subscriptions_product_options_pricing', __CLASS__ . '::subscription_product_fields' );
add_action( 'woocommerce_variable_subscription_pricing', __CLASS__ . '::variable_subscription_product_fields', 10, 3 );
// Add the translated fields to the Subscriptions admin script
add_filter( 'woocommerce_subscriptions_admin_script_parameters', __CLASS__ . '::admin_script_parameters', 10 );
// Save sync options when a subscription product is saved
add_action( 'woocommerce_process_product_meta_subscription', __CLASS__ . '::save_subscription_meta', 10 );
// Save sync options when a variable subscription product is saved
add_action( 'woocommerce_process_product_meta_variable-subscription', __CLASS__ . '::process_product_meta_variable_subscription' );
add_action( 'woocommerce_save_product_variation', __CLASS__ . '::save_product_variation', 20, 2 );
// Make sure the expiration dates are calculated from the synced start date
add_filter( 'woocommerce_subscriptions_product_trial_expiration_date', __CLASS__ . '::recalculate_product_trial_expiration_date', 10, 2 );
add_filter( 'woocommerce_subscriptions_product_expiration_date', __CLASS__ . '::recalculate_product_expiration_date', 10, 3 );
// Display a product's first payment date on the product's page to make sure it's obvious to the customer when payments will start
add_action( 'woocommerce_single_product_summary', __CLASS__ . '::products_first_payment_date', 31 );
// Display a product's first payment date on the product's page to make sure it's obvious to the customer when payments will start
add_action( 'woocommerce_subscriptions_product_first_renewal_payment_time', __CLASS__ . '::products_first_renewal_payment_time', 10, 4 );
// Maybe mock a free trial on the product for calculating totals and displaying correct shipping costs
add_action( 'woocommerce_before_calculate_totals', __CLASS__ . '::maybe_set_free_trial', 0, 1 );
add_action( 'woocommerce_subscription_cart_before_grouping', __CLASS__ . '::maybe_unset_free_trial' );
add_action( 'woocommerce_subscription_cart_after_grouping', __CLASS__ . '::maybe_set_free_trial' );
add_filter( 'wcs_recurring_cart_start_date', __CLASS__ . '::maybe_unset_free_trial', 0, 1 );
add_filter( 'wcs_recurring_cart_end_date', __CLASS__ . '::maybe_set_free_trial', 100, 1 );
add_filter( 'woocommerce_subscriptions_calculated_total', __CLASS__ . '::maybe_unset_free_trial', 10000, 1 );
add_action( 'woocommerce_cart_totals_before_shipping', __CLASS__ . '::maybe_set_free_trial' );
add_action( 'woocommerce_cart_totals_after_shipping', __CLASS__ . '::maybe_unset_free_trial' );
add_action( 'woocommerce_review_order_before_shipping', __CLASS__ . '::maybe_set_free_trial' );
add_action( 'woocommerce_review_order_after_shipping', __CLASS__ . '::maybe_unset_free_trial' );
// Set prorated initial amount when calculating initial total
add_filter( 'woocommerce_subscriptions_cart_get_price', __CLASS__ . '::set_prorated_price_for_calculation', 10, 2 );
// When creating a subscription check if it contains a synced product and make sure the correct meta is set on the subscription
add_action( 'woocommerce_new_subscription', __CLASS__ . '::maybe_add_subscription_meta', 10, 1 );
// When adding an item to a subscription, check if it is for a synced product to make sure the sync meta is set on the subscription. We can't attach to just the 'woocommerce_new_order_item' here because the '_product_id' and '_variation_id' meta are not set before it fires
add_action( 'woocommerce_ajax_add_order_item_meta', __CLASS__ . '::ajax_maybe_add_meta_for_item', 10, 2 );
if ( wcs_is_woocommerce_pre( '3.0' ) ) {
add_action( 'woocommerce_order_add_product', __CLASS__ . '::maybe_add_meta_for_new_product', 10, 3 );
add_action( 'woocommerce_add_order_item_meta', array( __CLASS__, 'maybe_add_order_item_meta' ), 10, 2 );
} else {
add_action( 'woocommerce_new_order_item', __CLASS__ . '::maybe_add_meta_for_new_line_item', 10, 3 );
add_action( 'woocommerce_checkout_create_order_line_item', array( __CLASS__, 'maybe_add_line_item_meta' ), 10, 3 );
}
// Make sure the sign-up fee for a synchronised subscription is correct
add_filter( 'woocommerce_subscriptions_sign_up_fee', __CLASS__ . '::get_synced_sign_up_fee', 1, 3 );
// If it's an initial sync order and the total is zero, and nothing needs to be shipped, do not reduce stock
add_filter( 'woocommerce_order_item_quantity', __CLASS__ . '::maybe_do_not_reduce_stock', 10, 3 );
add_filter( 'woocommerce_subscriptions_recurring_cart_key', __CLASS__ . '::add_to_recurring_product_grouping_key', 10, 2 );
add_filter( 'woocommerce_subscriptions_item_grouping_key', __CLASS__ . '::add_to_recurring_product_grouping_key', 10, 2 );
// Add defaults for our options.
add_filter( 'default_option_' . self::$setting_id_days_no_fee, array( __CLASS__, 'option_default' ), 10, 3 );
// Sanitize options when saving.
add_filter( 'woocommerce_admin_settings_sanitize_option_' . self::$setting_id_days_no_fee, array( __CLASS__, 'sanitize_option' ), 10, 2 );
// Ensure options are the proper type.
add_filter( 'option_' . self::$setting_id_days_no_fee, 'intval' );
// Don't display migrated order item meta on the Edit Order screen
add_filter( 'woocommerce_hidden_order_itemmeta', array( __CLASS__, 'hide_order_itemmeta' ) );
}
/**
* Set default value of 'no' for our options.
*
* This only sets the default
*
* @author Jeremy Pry
*
* @param mixed $default The default value for the option.
* @param string $option The option name.
* @param bool $passed_default Whether get_option() was passed a default value.
*
* @return mixed The default option value.
*/
public static function option_default( $default, $option, $passed_default = null ) {
switch ( $option ) {
case self::$setting_id_days_no_fee:
$default = $passed_default ? $default : 0;
break;
}
return $default;
}
/**
* Sanitize our options when they are saved in the admin area.
*
* @author Jeremy Pry
*
* @param mixed $value The value being saved.
* @param array $option The option data array.
*
* @return mixed The sanitized option value.
*/
public static function sanitize_option( $value, $option ) {
switch ( $option['id'] ) {
case self::$setting_id_days_no_fee:
$value = absint( $value );
break;
}
return $value;
}
/**
* Check if payment syncing is enabled on the store.
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.5
*/
public static function is_syncing_enabled() {
return 'yes' === get_option( self::$setting_id, 'no' );
}
/**
* Check if payments can be prorated on the store.
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.5
*/
public static function is_sync_proration_enabled() {
return 'no' !== get_option( self::$setting_id_proration, 'no' );
}
/**
* Add sync settings to the Subscription's settings page.
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.5
*/
public static function add_settings( $settings ) {
$synchronisation_settings = array(
array(
'name' => __( 'Synchronisation', 'woocommerce-subscriptions' ),
'type' => 'title',
// translators: placeholders are opening and closing link tags
'desc' => sprintf( _x( 'Align subscription renewal to a specific day of the week, month or year. For example, the first day of the month. %1$sLearn more%2$s.', 'used in the general subscription options page', 'woocommerce-subscriptions' ), '', '' ),
'id' => self::$setting_id . '_title',
),
array(
'name' => self::$sync_field_label,
'desc' => __( 'Align Subscription Renewal Day', 'woocommerce-subscriptions' ),
'id' => self::$setting_id,
'default' => 'no',
'type' => 'checkbox',
),
array(
'name' => __( 'Prorate First Renewal', 'woocommerce-subscriptions' ),
'desc' => __( 'If a subscription is synchronised to a specific day of the week, month or year, charge a prorated amount for the subscription at the time of sign up.', 'woocommerce-subscriptions' ),
'id' => self::$setting_id_proration,
'css' => 'min-width:150px;',
'default' => 'no',
'type' => 'select',
'class' => 'wc-enhanced-select',
'options' => array(
'no' => _x( 'Never (do not charge any recurring amount)', 'when to prorate first payment / subscription length', 'woocommerce-subscriptions' ),
'recurring' => _x( 'Never (charge the full recurring amount at sign-up)', 'when to prorate first payment / subscription length', 'woocommerce-subscriptions' ),
'virtual' => _x( 'For Virtual Subscription Products Only', 'when to prorate first payment / subscription length', 'woocommerce-subscriptions' ),
'yes' => _x( 'For All Subscription Products', 'when to prorate first payment / subscription length', 'woocommerce-subscriptions' ),
),
'desc_tip' => true,
),
array(
'name' => __( 'Sign-up grace period', 'woocommerce-subscriptions' ),
'desc' => _x( 'days prior to Renewal Day', "there's a number immediately in front of this text", 'woocommerce-subscriptions' ),
'id' => self::$setting_id_days_no_fee,
'default' => 0,
'type' => 'number',
'desc_tip' => __( 'Subscriptions created within this many days prior to the Renewal Day will not be charged at sign-up. Set to zero for all new Subscriptions to be charged the full recurring amount. Must be a positive number.', 'woocommerce-subscriptions' ),
),
array(
'type' => 'sectionend',
'id' => self::$setting_id . '_title',
),
);
// Insert the switch settings in after the Roles section otherwise add the settings to the end.
if ( ! WC_Subscriptions_Admin::insert_setting_after( $settings, WC_Subscriptions_Admin::$option_prefix . '_role_options', $synchronisation_settings, 'multiple-settings', 'sectionend' ) ) {
$settings = array_merge( $settings, $synchronisation_settings );
}
return $settings;
}
/**
* Add the sync setting fields to the Edit Product screen
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.5
*/
public static function subscription_product_fields() {
global $post, $wp_locale;
if ( self::is_syncing_enabled() ) {
// Set month as the default billing period
$subscription_period = get_post_meta( $post->ID, '_subscription_period', true );
if ( ! $subscription_period ) {
$subscription_period = 'month';
}
// Determine whether to display the week/month sync fields or the annual sync fields
$display_week_month_select = ( ! in_array( $subscription_period, array( 'month', 'week' ) ) ) ? 'display: none;' : '';
$display_annual_select = ( 'year' != $subscription_period ) ? 'display: none;' : '';
$payment_day = self::get_products_payment_day( $post->ID );
// An annual sync date is already set in the form: array( 'day' => 'nn', 'month' => 'nn' ), create a MySQL string from those values (year and time are irrelvent as they are ignored)
if ( is_array( $payment_day ) ) {
$payment_month = ( 0 === (int) $payment_day['day'] ) ? 0 : $payment_day['month'];
$payment_day = $payment_day['day'];
} else {
$payment_month = 0;
}
echo '
';
echo '
';
woocommerce_wp_select(
array(
'id' => self::$post_meta_key,
'class' => 'wc_input_subscription_payment_sync select short wc-enhanced-select',
'label' => self::$sync_field_label,
'options' => self::get_billing_period_ranges( $subscription_period ),
'description' => self::$sync_description,
'desc_tip' => true,
'value' => $payment_day, // Explicitly set value in to ensure backward compatibility
)
);
echo '
';
echo '
';
?>
';
echo '
';
}
}
/**
* Add the sync setting fields to the variation section of the Edit Product screen
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.5
*/
public static function variable_subscription_product_fields( $loop, $variation_data, $variation ) {
if ( self::is_syncing_enabled() ) {
// Set month as the default billing period
$subscription_period = WC_Subscriptions_Product::get_period( $variation );
if ( empty( $subscription_period ) ) {
$subscription_period = 'month';
}
$display_week_month_select = ( ! in_array( $subscription_period, array( 'month', 'week' ) ) ) ? 'display: none;' : '';
$display_annual_select = ( 'year' != $subscription_period ) ? 'display: none;' : '';
$payment_day = self::get_products_payment_day( $variation );
// An annual sync date is already set in the form: array( 'day' => 'nn', 'month' => 'nn' ), create a MySQL string from those values (year and time are irrelvent as they are ignored)
if ( is_array( $payment_day ) ) {
$payment_month = ( 0 === (int) $payment_day['day'] ) ? 0 : $payment_day['month'];
$payment_day = $payment_day['day'];
} else {
$payment_month = 0;
}
include( WC_Subscriptions_Plugin::instance()->get_plugin_directory( 'templates/admin/html-variation-synchronisation.php' ) );
}
}
/**
* Save sync options when a subscription product is saved
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.5
*/
public static function save_subscription_meta( $post_id ) {
if ( empty( $_POST['_wcsnonce'] ) || ! wp_verify_nonce( wc_clean( wp_unslash( $_POST['_wcsnonce'] ) ), 'wcs_subscription_meta' ) ) {
return;
}
// Set month as the default billing period
if ( ! isset( $_POST['_subscription_period'] ) ) {
$_POST['_subscription_period'] = 'month';
}
if ( 'year' == $_POST['_subscription_period'] ) { // save the day & month for the date rather than just the day
$_POST[ self::$post_meta_key ] = array(
'day' => isset( $_POST[ self::$post_meta_key_day ] ) ? wc_clean( wp_unslash( $_POST[ self::$post_meta_key_day ] ) ) : 0,
'month' => isset( $_POST[ self::$post_meta_key_month ] ) ? wc_clean( wp_unslash( $_POST[ self::$post_meta_key_month ] ) ) : '01',
);
} else {
if ( ! isset( $_POST[ self::$post_meta_key ] ) ) {
$_POST[ self::$post_meta_key ] = 0;
}
}
update_post_meta( $post_id, self::$post_meta_key, wc_clean( wp_unslash( $_POST[ self::$post_meta_key ] ) ) );
}
/**
* Save sync options when a variable subscription product is saved
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.5
*/
public static function process_product_meta_variable_subscription( $post_id ) {
if ( empty( $_POST['_wcsnonce_save_variations'] ) || ! wp_verify_nonce( wc_clean( wp_unslash( $_POST['_wcsnonce_save_variations'] ) ), 'wcs_subscription_variations' ) || ! isset( $_POST['variable_post_id'] ) || ! is_array( $_POST['variable_post_id'] ) ) {
return;
}
// Make sure the parent product doesn't have a sync value (in case it was once a simple subscription)
update_post_meta( $post_id, self::$post_meta_key, 0 );
}
/**
* Save sync options when a variable subscription product is saved
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.5
*/
public static function save_product_variation( $variation_id, $index ) {
if ( empty( $_POST['_wcsnonce_save_variations'] ) || ! wp_verify_nonce( wc_clean( wp_unslash( $_POST['_wcsnonce_save_variations'] ) ), 'wcs_subscription_variations' ) || ! isset( $_POST['variable_post_id'] ) || ! is_array( $_POST['variable_post_id'] ) ) {
return;
}
$day_field = 'variable' . self::$post_meta_key_day;
$month_field = 'variable' . self::$post_meta_key_month;
if ( 'year' == $_POST['variable_subscription_period'][ $index ] ) { // save the day & month for the date rather than just the day
$_POST[ 'variable' . self::$post_meta_key ][ $index ] = array(
'day' => isset( $_POST[ $day_field ][ $index ] ) ? wc_clean( wp_unslash( $_POST[ $day_field ][ $index ] ) ) : 0,
'month' => isset( $_POST[ $month_field ][ $index ] ) ? wc_clean( wp_unslash( $_POST[ $month_field ][ $index ] ) ) : 0,
);
} elseif ( ! isset( $_POST[ 'variable' . self::$post_meta_key ][ $index ] ) ) {
$_POST[ 'variable' . self::$post_meta_key ][ $index ] = 0;
}
update_post_meta( $variation_id, self::$post_meta_key, wc_clean( wp_unslash( $_POST[ 'variable' . self::$post_meta_key ][ $index ] ) ) );
}
/**
* Add translated syncing options for our client side script
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.5
*/
public static function admin_script_parameters( $script_parameters ) {
// Get admin screen id
$screen = get_current_screen();
if ( 'product' == $screen->id ) {
$billing_period_strings = self::get_billing_period_ranges();
$script_parameters['syncOptions'] = array(
'week' => $billing_period_strings['week'],
'month' => $billing_period_strings['month'],
'year' => self::get_year_sync_options(),
);
}
return $script_parameters;
}
/**
* Determine whether a product, specified with $product, needs to have its first payment processed on a
* specific day (instead of at the time of sign-up).
*
* @return (bool) True is the product's first payment will be synced to a certain day.
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.5
*/
public static function is_product_synced( $product ) {
if ( ! is_object( $product ) ) {
$product = wc_get_product( $product );
}
if ( ! is_object( $product ) || ! self::is_syncing_enabled() || 'day' == WC_Subscriptions_Product::get_period( $product ) || ! WC_Subscriptions_Product::is_subscription( $product ) ) {
return false;
}
$payment_date = self::get_products_payment_day( $product );
return ( ! is_array( $payment_date ) && $payment_date > 0 ) || ( isset( $payment_date['day'] ) && $payment_date['day'] > 0 );
}
/**
* Determine whether a product, specified with $product, should have its first payment processed on a
* at the time of sign-up but prorated to the sync day.
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.5.10
*
* @param WC_Product $product
*
* @return bool
*/
public static function is_product_prorated( $product ) {
if ( false === self::is_sync_proration_enabled() || false === self::is_product_synced( $product ) ) {
$is_product_prorated = false;
} elseif ( 'yes' == get_option( self::$setting_id_proration, 'no' ) && 0 == WC_Subscriptions_Product::get_trial_length( $product ) ) {
$is_product_prorated = true;
} elseif ( 'virtual' == get_option( self::$setting_id_proration, 'no' ) && $product->is_virtual() && 0 == WC_Subscriptions_Product::get_trial_length( $product ) ) {
$is_product_prorated = true;
} else {
$is_product_prorated = false;
}
return $is_product_prorated;
}
/**
* Determine whether the payment for a subscription should be the full price upfront.
*
* This method is particularly concerned with synchronized subscriptions. It will only return
* true when the following conditions are met:
*
* - There is no free trial
* - The subscription is synchronized
* - The store owner has determined that new subscribers need to pay for their subscription upfront.
*
* Additionally, if the store owner sets a number of days prior to the synchronization day that do not
* require an upfront payment, this method will check to see whether the current date falls within that
* period for the given product.
*
* @author Jeremy Pry
*
* @param WC_Product $product The product to check.
* @param string $from_date Optional. A MySQL formatted date/time string from which to calculate from. The default is an empty string which is today's date/time.
*
* @return bool Whether an upfront payment is required for the product.
*/
public static function is_payment_upfront( $product, $from_date = '' ) {
static $results = array();
$is_upfront = null;
if ( array_key_exists( $product->get_id(), $results ) ) {
return $results[ $product->get_id() ];
}
// Normal cases where we aren't concerned with an upfront payment.
if (
0 !== WC_Subscriptions_Product::get_trial_length( $product ) ||
! self::is_product_synced( $product )
) {
$is_upfront = false;
}
// Maybe account for number of days without a fee.
if ( null === $is_upfront ) {
$no_fee_days = self::get_number_of_grace_period_days();
$payment_date = self::calculate_first_payment_date( $product, 'timestamp', $from_date );
$from_timestamp = $from_date ? wcs_date_to_time( $from_date ) : gmdate( 'U' );
$site_offset = (int) ( get_option( 'gmt_offset' ) * HOUR_IN_SECONDS );
// The payment date is today - check for it in site time.
if ( gmdate( 'Ymd', $payment_date + $site_offset ) === gmdate( 'Ymd', $from_timestamp + $site_offset ) ) {
$is_upfront = true;
} elseif ( 'recurring' !== get_option( self::$setting_id_proration, 'no' ) ) {
$is_upfront = false;
} elseif ( $no_fee_days > 0 ) {
// When proration setting is 'recurring' and there is a grace period.
$buffer_date = $payment_date - ( $no_fee_days * DAY_IN_SECONDS );
$is_upfront = $from_timestamp < wcs_date_to_time( gmdate( 'Y-m-d 23:59:59', $buffer_date ) );
} else {
$is_upfront = true;
}
}
/**
* Filter whether payment is upfront for a given product.
*
* @param bool $is_upfront Whether the product needs to be paid upfront.
* @param WC_Product $product The current product.
*/
$results[ $product->get_id() ] = apply_filters( 'woocommerce_subscriptions_payment_upfront', $is_upfront, $product );
return $results[ $product->get_id() ];
}
/**
* Get the day of the week, month or year on which a subscription's payments should be
* synchronised to.
*
* @return int The day the products payments should be processed, or 0 if the payments should not be sync'd to a specific day.
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.5
*/
public static function get_products_payment_day( $product ) {
if ( ! self::is_syncing_enabled() ) {
$payment_date = 0;
} else {
$payment_date = WC_Subscriptions_Product::get_meta_data( $product, 'subscription_payment_sync_date', 0 );
}
return apply_filters( 'woocommerce_subscriptions_product_sync_date', $payment_date, $product );
}
/**
* Calculate the first payment date for a synced subscription.
*
* The date is calculated in UTC timezone.
*
* @param WC_Product $product A subscription product.
* @param string $type (optional) The format to return the first payment date in, either 'mysql' or 'timestamp'. Default 'mysql'.
* @param string $from_date (optional) The date to calculate the first payment from in GMT/UTC timezone. If not set, it will use the current date. This should not include any trial period on the product.
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.5
*/
public static function calculate_first_payment_date( $product, $type = 'mysql', $from_date = '' ) {
$first_payment_timestamp = 0;
if ( ! is_object( $product ) ) {
$product = wc_get_product( $product );
}
if ( ! self::is_product_synced( $product ) ) {
return 0;
}
$period = WC_Subscriptions_Product::get_period( $product );
$trial_length = WC_Subscriptions_Product::get_trial_length( $product );
// For billing intervals > 1:
// When the proration setting is 'recurring', there is a full upfront payment for the entire billing interval
// So, the first payment date should be calculated after the entire interval
// When the proration setting is 'no' or 'yes', the upfront payment is until the next date occurrence (1 week/month/year).
// So, the first payment date should be calculated with 1 as the interval
$interval = get_option( self::$setting_id_proration, 'no' ) === 'recurring' ? WC_Subscriptions_Product::get_interval( $product ) : 1;
$from_date_param = $from_date;
if ( empty( $from_date ) ) {
$from_date = gmdate( 'Y-m-d H:i:s' );
}
// If the subscription has a free trial period, the first payment should be synced to a day after the free trial
if ( $trial_length > 0 ) {
$from_date = WC_Subscriptions_Product::get_trial_expiration_date( $product, $from_date );
}
$from_timestamp = wcs_date_to_time( $from_date ) + ( (int) ( get_option( 'gmt_offset' ) * HOUR_IN_SECONDS ) ); // Site time
$payment_day = self::get_products_payment_day( $product );
$no_fee_days = self::get_number_of_grace_period_days();
if ( 'week' == $period ) {
// Get the day of the week for the from date
$from_day = (int) gmdate( 'N', $from_timestamp );
// To account for rollover of the weekdays. For example, if from day is Saturday and the payment date is Monday,
// and the grace period is 2, Saturday is day 6 and Monday is day 1.
$add_days = $payment_day < $from_day ? 0 : 7;
// Calculate difference between the the two days after adding number of weekdays and compare against grace period
if ( ( $payment_day + $add_days - $from_day ) <= $no_fee_days ) {
$from_timestamp = wcs_add_time( $interval - 1, $period, $from_timestamp );
}
// strtotime() will figure out if the day is in the future or today (see: https://gist.github.com/thenbrent/9698083)
$first_payment_timestamp = wcs_strtotime_dark_knight( self::$weekdays[ $payment_day ], $from_timestamp );
} elseif ( 'month' == $period ) {
// strtotime() needs to know the month, so we need to determine if the payment day has occurred this month yet or if we want the last day of the month (see: https://gist.github.com/thenbrent/9698083)
if ( $payment_day > 27 ) { // we actually want the last day of the month
$payment_day = gmdate( 't', $from_timestamp ); // the number of days in the month
}
$from_day = (int) gmdate( 'j', $from_timestamp );
// If 'from day' is before 'sync day' in the month
if ( $from_day <= $payment_day ) {
if ( $from_day + $no_fee_days >= $payment_day ) { // In grace period
$month = gmdate( 'F', $from_timestamp );
$month_number = gmdate( 'm', $from_timestamp );
} else { // If not in grace period, then the sync day has passed by. So, reduce interval by 1.
$month = gmdate( 'F', wcs_add_months( $from_timestamp, $interval - 1 ) );
$month_number = gmdate( 'm', wcs_add_months( $from_timestamp, $interval - 1 ) );
}
} else { // If 'from day' is after 'sync day' in the month
$days_in_month = (int) gmdate( 't', $from_timestamp );
// Use 'days in month' to account for end of month dates
if ( $from_day + $no_fee_days - $days_in_month >= $payment_day ) { // In grace period
$month = gmdate( 'F', wcs_add_months( $from_timestamp, 1 ) );
$month_number = gmdate( 'm', wcs_add_months( $from_timestamp, 1 ) );
} else { // Not in grace period, so add interval number of months
$month = gmdate( 'F', wcs_add_months( $from_timestamp, $interval ) );
$month_number = gmdate( 'm', wcs_add_months( $from_timestamp, $interval ) );
}
}
// when a certain number of months are added and the first payment date moves to next year
if ( $month_number < gmdate( 'm', $from_timestamp ) || $interval >= 12 ) {
$year = gmdate( 'Y', $from_timestamp );
$year++;
$first_payment_timestamp = wcs_strtotime_dark_knight( "{$payment_day} {$month} {$year}", $from_timestamp );
} else {
$first_payment_timestamp = wcs_strtotime_dark_knight( "{$payment_day} {$month}", $from_timestamp );
}
} elseif ( 'year' == $period ) {
// We can't use $wp_locale here because it is translated
$month_map = array(
'01' => 'January',
'02' => 'February',
'03' => 'March',
'04' => 'April',
'05' => 'May',
'06' => 'June',
'07' => 'July',
'08' => 'August',
'09' => 'September',
'10' => 'October',
'11' => 'November',
'12' => 'December',
);
$month = $month_map[ $payment_day['month'] ];
$payment_month_day = sprintf( '%02d%02d', $payment_day['month'], $payment_day['day'] );
$year = gmdate( 'Y', $from_timestamp );
$from_month_day = gmdate( 'md', $from_timestamp );
if ( $from_month_day > $payment_month_day ) { // If 'from day' is after 'sync day' in the year
$year++;
}
$first_payment_timestamp = 0;
if ( $from_timestamp + ( $no_fee_days * DAY_IN_SECONDS ) >=
wcs_strtotime_dark_knight( "{$payment_day['day']} {$month} {$year}" ) ) { // In grace period
$first_payment_timestamp = wcs_strtotime_dark_knight( "{$payment_day['day']} {$month} {$year}", $from_timestamp );
} else { // If not in grace period, then the sync day has passed by. So, reduce interval by 1.
$year += $interval - 1;
$first_payment_timestamp = wcs_strtotime_dark_knight( "{$payment_day['day']} {$month} {$year}", wcs_add_time( $interval - 1, $period, $from_timestamp ) );
}
}
// We calculated a timestamp for midnight on the specific day in the site's timezone, let's push it to 3am to account for any daylight savings changes
$first_payment_timestamp += 3 * HOUR_IN_SECONDS;
// And convert it to the UTC equivalent of 3am on that day
$first_payment_timestamp -= ( (int) ( get_option( 'gmt_offset' ) * HOUR_IN_SECONDS ) );
$first_payment = ( 'mysql' == $type && 0 != $first_payment_timestamp ) ? gmdate( 'Y-m-d H:i:s', $first_payment_timestamp ) : $first_payment_timestamp;
return apply_filters( 'woocommerce_subscriptions_synced_first_payment_date', $first_payment, $product, $type, $from_date, $from_date_param );
}
/**
* Return an i18n'ified associative array of sync options for 'year' as billing period
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v3.0.0
*/
public static function get_year_sync_options() {
global $wp_locale;
$year_sync_options[0] = __( 'Do not synchronise', 'woocommerce-subscriptions' );
$year_sync_options += $wp_locale->month;
return $year_sync_options;
}
/**
* Return an i18n'ified associative array of all possible subscription periods.
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.5
*/
public static function get_billing_period_ranges( $billing_period = '' ) {
global $wp_locale;
if ( empty( self::$billing_period_ranges ) ) {
foreach ( array( 'week', 'month' ) as $key ) {
self::$billing_period_ranges[ $key ][0] = __( 'Do not synchronise', 'woocommerce-subscriptions' );
}
// Week
$weekdays = array_merge( $wp_locale->weekday, array( $wp_locale->weekday[0] ) );
unset( $weekdays[0] );
foreach ( $weekdays as $i => $weekly_billing_period ) {
// translators: placeholder is a day of the week
self::$billing_period_ranges['week'][ $i ] = sprintf( __( '%s each week', 'woocommerce-subscriptions' ), $weekly_billing_period );
}
// Month
foreach ( range( 1, 27 ) as $i ) {
// translators: placeholder is a number of day with language specific suffix applied (e.g. "1st", "3rd", "5th", etc...)
self::$billing_period_ranges['month'][ $i ] = sprintf( __( '%s day of the month', 'woocommerce-subscriptions' ), wcs_append_numeral_suffix( $i ) );
}
self::$billing_period_ranges['month'][28] = __( 'Last day of the month', 'woocommerce-subscriptions' );
self::$billing_period_ranges = apply_filters( 'woocommerce_subscription_billing_period_ranges', self::$billing_period_ranges );
}
if ( empty( $billing_period ) ) {
return self::$billing_period_ranges;
} elseif ( isset( self::$billing_period_ranges[ $billing_period ] ) ) {
return self::$billing_period_ranges[ $billing_period ];
} else {
return array();
}
}
/**
* Add the first payment date to a products summary section
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.5
*/
public static function products_first_payment_date( $echo = false ) {
global $product;
$first_payment_date = '
';
if ( false !== $echo ) {
echo wp_kses( $first_payment_date, array( 'p' => array( 'class' => array() ), 'small' => array() ) ); // phpcs:ignore WordPress.Arrays.ArrayDeclarationSpacing.AssociativeArrayFound
}
return $first_payment_date;
}
/**
* Return a string explaining when the first payment will be completed for a synchronized subscription product.
*
* For synchronized subscription products, this method calculates and formats a human-readable string
* indicating when the first payment will be processed. The string will indicate if the payment is:
* - Due today
* - Prorated with the next payment date
* - Just the first payment date
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.5
*
* @param WC_Product|WC_Product_Subscription|WC_Product_Variable_Subscription $product The subscription product to get the first payment date for.
* @return string A formatted string explaining the first payment date. Empty string if product is not synchronized.
*/
public static function get_products_first_payment_date( $product ) {
$first_payment_date = '';
if ( self::is_product_synced( $product ) ) {
$first_payment_timestamp = self::calculate_first_payment_date( $product->get_id(), 'timestamp' );
if ( 0 != $first_payment_timestamp ) {
$is_first_payment_today = self::is_today( $first_payment_timestamp );
if ( $is_first_payment_today ) {
$payment_date_string = __( 'Today!', 'woocommerce-subscriptions' );
} else {
$payment_date_string = date_i18n( wc_date_format(), $first_payment_timestamp + ( (int) ( get_option( 'gmt_offset' ) * HOUR_IN_SECONDS ) ) );
}
if ( self::is_product_prorated( $product ) && ! $is_first_payment_today ) {
// translators: placeholder is a date
$first_payment_date = sprintf( __( 'First payment prorated. Next payment: %s', 'woocommerce-subscriptions' ), $payment_date_string );
} else {
// translators: placeholder is a date
$first_payment_date = sprintf( __( 'First payment: %s', 'woocommerce-subscriptions' ), $payment_date_string );
}
$first_payment_date = '' . $first_payment_date . '';
}
}
return apply_filters( 'woocommerce_subscriptions_synced_first_payment_date_string', $first_payment_date, $product );
}
/**
* If a product is synchronised to a date in the future, make sure that is set as the product's first payment date
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.0
*/
public static function products_first_renewal_payment_time( $first_renewal_timestamp, $product_id, $from_date, $timezone ) {
$unmodified_first_renewal_timestamp = $first_renewal_timestamp;
if ( self::is_product_synced( $product_id ) ) {
$next_renewal_timestamp = self::calculate_first_payment_date( $product_id, 'timestamp', $from_date );
if ( ! self::is_today( $next_renewal_timestamp ) ) {
if ( 'site' == $timezone ) {
$next_renewal_timestamp += ( (int) ( get_option( 'gmt_offset' ) * HOUR_IN_SECONDS ) );
}
$first_renewal_timestamp = $next_renewal_timestamp;
}
}
/**
* Filter the first renewal payment date string for a product.
*
* @since 7.7.0
*
* @param int $first_renewal_timestamp The timestamp of the first renewal payment date.
* @param int $product_id The product ID.
* @param string $from_date The date to calculate the first payment from in GMT/UTC timezone.
* @param string $timezone The timezone to use for the first payment date.
* @param int $unmodified_first_renewal_timestamp The unmodified timestamp of the first renewal payment date.
*/
return apply_filters( 'woocommerce_subscriptions_synced_first_renewal_payment_timestamp', $first_renewal_timestamp, $product_id, $from_date, $timezone, $unmodified_first_renewal_timestamp );
}
/**
* Make sure a synchronised subscription's price includes a free trial, unless it's first payment is today.
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.5
*/
public static function maybe_set_free_trial( $total = '' ) {
foreach ( WC()->cart->get_cart() as $cart_item_key => $cart_item ) {
if (
self::is_product_synced( $cart_item['data'] ) &&
! self::is_payment_upfront( $cart_item['data'] ) &&
! self::is_product_prorated( $cart_item['data'] ) &&
! self::is_today( self::calculate_first_payment_date( $cart_item['data'], 'timestamp' ) ) &&
( ! isset( $cart_item['subscription_resubscribe'] ) || ! self::is_sync_proration_enabled() ) // Dont override trial length set while resubscribing unless proration is disabled.
) {
$current_trial_length = WC_Subscriptions_Product::get_trial_length( WC()->cart->cart_contents[ $cart_item_key ]['data'] );
$new_trial_length = ( $current_trial_length > 1 ) ? $current_trial_length : 1;
wcs_set_objects_property( WC()->cart->cart_contents[ $cart_item_key ]['data'], 'subscription_trial_length', $new_trial_length, 'set_prop_only' );
}
}
return $total;
}
/**
* Make sure a synchronised subscription's price includes a free trial, unless it's first payment is today.
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.5
*/
public static function maybe_unset_free_trial( $total = '' ) {
foreach ( WC()->cart->get_cart() as $cart_item_key => $cart_item ) {
// Dont override trial length set while resubscribing, unless proration is disabled.
if ( self::is_product_synced( $cart_item['data'] ) && ( ! isset( $cart_item['subscription_resubscribe'] ) || ! self::is_sync_proration_enabled() ) ) {
// When reinstating the trial length, set resubscribes trial length to 0 so we don't grant a second trial period.
if ( isset( $cart_item['subscription_resubscribe'] ) ) {
$trial_length = 0;
} else {
$trial_length = WC_Subscriptions_Product::get_trial_length( wcs_get_canonical_product_id( $cart_item ) );
}
wcs_set_objects_property( WC()->cart->cart_contents[ $cart_item_key ]['data'], 'subscription_trial_length', $trial_length, 'set_prop_only' );
}
}
return $total;
}
/**
* Check if the cart includes a subscription that needs to be synced.
*
* @return bool Returns true if any item in the cart is a subscription sync request, otherwise, false.
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.5
*/
public static function cart_contains_synced_subscription( $cart = null ) {
$cart = ( empty( $cart ) && isset( WC()->cart ) ) ? WC()->cart : $cart;
$contains_synced = false;
if ( self::is_syncing_enabled() && ! empty( $cart ) && ! wcs_cart_contains_renewal() ) {
foreach ( $cart->cart_contents as $cart_item_key => $cart_item ) {
if ( self::is_product_synced( $cart_item['data'] ) ) {
$contains_synced = $cart_item;
break;
}
}
}
return $contains_synced;
}
/**
* Maybe set the time of a product's trial expiration to be the same as the synced first payment date for products where the first
* renewal payment date falls on the same day as the trial expiration date, but the trial expiration time is later in the day.
*
* When making sure the first payment is after the trial expiration in @see self::calculate_first_payment_date() we only check
* whether the first payment day comes after the trial expiration day, because we don't want to pushing the first payment date
* a month or year in the future because of a few hours difference between it and the trial expiration. However, this means we
* could still end up with a trial end time after the first payment time, even though they are both on the same day because the
* trial end time is normally calculated from the start time, which can be any time of day, but the first renewal time is always
* set to be 3am in the site's timezone. For example, the first payment date might be calculate to be 3:00 on the 21st April 2017,
* while the trial end date is on the same day at 3:01 (or any time after that on the same day). So we need to check both the time and day. We also don't want to make the first payment date/time skip a year because of a few hours difference. That means we need to either modify the trial end time to be 3:00am or make the first payment time occur at the same time as the trial end time. The former is pretty hard to change, but the later will sync'd payments will be at a different times if there is a free trial ending on the same day, which could be confusing. o_0
*
* Fixes #1328
*
* @param mixed $trial_expiration_date MySQL formatted date on which the subscription's trial will end, or 0 if it has no trial
* @param mixed $product_id The product object or post ID of the subscription product
* @return mixed MySQL formatted date on which the subscription's trial is set to end, or 0 if it has no trial
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.0.13
*/
public static function recalculate_product_trial_expiration_date( $trial_expiration_date, $product_id ) {
if ( $trial_expiration_date > 0 && self::is_product_synced( $product_id ) ) {
$trial_expiration_timestamp = wcs_date_to_time( $trial_expiration_date );
remove_filter( 'woocommerce_subscriptions_product_trial_expiration_date', __METHOD__ ); // avoid infinite loop
$first_payment_timestamp = self::calculate_first_payment_date( $product_id, 'timestamp' );
add_filter( 'woocommerce_subscriptions_product_trial_expiration_date', __METHOD__, 10, 2 ); // avoid infinite loop
// First make sure the day is in the past so that we don't end up jumping a month or year because of a few hours difference between now and the billing date
// Use site time to check if the trial expiration and first payment fall on the same day
$site_offset = (int) ( get_option( 'gmt_offset' ) * HOUR_IN_SECONDS );
if ( $trial_expiration_timestamp > $first_payment_timestamp && gmdate( 'Ymd', $first_payment_timestamp + $site_offset ) === gmdate( 'Ymd', $trial_expiration_timestamp + $site_offset ) ) {
$trial_expiration_date = date( 'Y-m-d H:i:s', $first_payment_timestamp );
}
}
return $trial_expiration_date;
}
/**
* Make sure the expiration date is calculated from the synced start date for products where the start date
* will be synced.
*
* @param string $expiration_date MySQL formatted date on which the subscription is set to expire
* @param mixed $product_id The product/post ID of the subscription
* @param mixed $from_date A MySQL formatted date/time string from which to calculate the expiration date, or empty (default), which will use today's date/time.
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.5
*/
public static function recalculate_product_expiration_date( $expiration_date, $product_id, $from_date ) {
if ( self::is_product_synced( $product_id ) && ( $subscription_length = WC_Subscriptions_Product::get_length( $product_id ) ) > 0 ) {
$subscription_period = WC_Subscriptions_Product::get_period( $product_id );
$first_payment_date = self::calculate_first_payment_date( $product_id, 'timestamp' );
$expiration_date = date( 'Y-m-d H:i:s', wcs_add_time( $subscription_length, $subscription_period, $first_payment_date ) );
}
return $expiration_date;
}
/**
* Check if a given timestamp (in the UTC timezone) is equivalent to today in the site's time.
*
* @param int $timestamp A time in UTC timezone to compare to today.
*/
public static function is_today( $timestamp ) {
// Convert timestamp to site's time
$timestamp += (int) ( get_option( 'gmt_offset' ) * HOUR_IN_SECONDS );
return gmdate( 'Y-m-d', current_time( 'timestamp' ) ) == gmdate( 'Y-m-d', $timestamp );
}
/**
* Filters WC_Subscriptions_Order::get_sign_up_fee() to make sure the sign-up fee for a subscription product
* that is synchronised is returned correctly.
*
* @param float $sign_up_fee The initial sign-up fee charged when the subscription product in the order was first purchased, if any.
* @param WC_Subscription $subscription The subscription object.
* @param int $product_id The post ID of the subscription WC_Product object purchased in the order. Defaults to the ID of the first product purchased in the order.
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.0
*/
public static function get_synced_sign_up_fee( $sign_up_fee, $subscription, $product_id ) {
if ( wcs_is_subscription( $subscription ) && self::subscription_contains_synced_product( $subscription ) && count( wcs_get_line_items_with_a_trial( $subscription->get_id() ) ) < 0 ) {
$sign_up_fee = max( $subscription->get_total_initial_payment() - $subscription->get_total(), 0 );
}
return $sign_up_fee;
}
/**
* Removes the "set_subscription_prices_for_calculation" filter from the WC Product's woocommerce_get_price hook once
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.5.10
*
* @param int $price The current price.
* @param WC_Product $product The product object.
*
* @return int
*/
public static function set_prorated_price_for_calculation( $price, $product ) {
if ( WC_Subscriptions_Product::is_subscription( $product ) && self::is_product_prorated( $product ) && 'none' == WC_Subscriptions_Cart::get_calculation_type() ) {
$next_payment_date = self::calculate_first_payment_date( $product, 'timestamp' );
if ( self::is_today( $next_payment_date ) ) {
return $price;
}
$days_in_cycle = 0;
switch ( WC_Subscriptions_Product::get_period( $product ) ) {
case 'week':
$days_in_cycle = 7 * WC_Subscriptions_Product::get_interval( $product );
break;
case 'month':
$days_in_cycle = (int) gmdate( 't' ) * WC_Subscriptions_Product::get_interval( $product );
break;
case 'year':
$days_in_cycle = ( 365 + (int) gmdate( 'L' ) ) * WC_Subscriptions_Product::get_interval( $product );
break;
}
$days_until_next_payment = ceil( ( $next_payment_date - gmdate( 'U' ) ) / ( 60 * 60 * 24 ) );
$sign_up_fee = WC_Subscriptions_Product::get_sign_up_fee( $product );
if ( $sign_up_fee > 0 && 0 == WC_Subscriptions_Product::get_trial_length( $product ) ) {
$price = $sign_up_fee + ( $days_until_next_payment * ( ( $price - $sign_up_fee ) / $days_in_cycle ) );
} else {
$price = $days_until_next_payment * ( $price / $days_in_cycle );
}
// Now round the amount to the number of decimals displayed for prices to avoid rounding errors in the total calculations (we don't want to use WC_DISCOUNT_ROUNDING_PRECISION here because it can still lead to rounding errors). For full details, see: https://github.com/Prospress/woocommerce-subscriptions/pull/1134#issuecomment-178395062
$price = round( $price, wc_get_price_decimals() );
}
return $price;
}
/**
* Retrieve the full translated weekday word.
*
* Week starts on translated Monday and can be fetched
* by using 1 (one). So the week starts with 1 (one)
* and ends on Sunday with is fetched by using 7 (seven).
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.5.8
* @access public
*
* @param int $weekday_number 1 for Monday through 7 Sunday
* @return string Full translated weekday
*/
public static function get_weekday( $weekday_number ) {
global $wp_locale;
if ( 7 == $weekday_number ) {
$weekday = $wp_locale->get_weekday( 0 );
} else {
$weekday = $wp_locale->get_weekday( $weekday_number );
}
return $weekday;
}
/**
* Override quantities used to lower stock levels by when using synced subscriptions. If it's a synced product
* that does not have proration enabled and the payment date is not today, do not lower stock levels.
*
* @param integer $qty the original quantity that would be taken out of the stock level
* @param array $order order data
* @param array $order_item item data for each item in the order
*
* @return int
*/
public static function maybe_do_not_reduce_stock( $qty, $order, $order_item ) {
if ( wcs_order_contains_subscription( $order, array( 'parent', 'resubscribe' ) ) && 0 == $order_item['line_total'] ) {
$subscriptions = wcs_get_subscriptions_for_order( $order );
$product_id = wcs_get_canonical_product_id( $order_item );
foreach ( $subscriptions as $subscription ) {
if ( self::subscription_contains_synced_product( $subscription ) && $subscription->has_product( $product_id ) ) {
foreach ( $subscription->get_items() as $subscription_item ) {
if ( wcs_get_canonical_product_id( $subscription_item ) == $product_id && 0 < $subscription_item['line_total'] ) {
$qty = 0;
}
}
}
}
}
return $qty;
}
/**
* Adds meta on a subscription that contains a synced product.
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.0
*
* @param WC_Subscription|int $subscription Subscription object or ID.
*/
public static function maybe_add_subscription_meta( $subscription ) {
if ( ! is_object( $subscription ) ) {
$subscription = wcs_get_subscription( $subscription );
}
if ( $subscription && ! self::subscription_contains_synced_product( $subscription ) ) {
/** @var WC_Order_Item_Product $item */
foreach ( $subscription->get_items() as $item ) {
$product = $item->get_product();
if ( self::is_product_synced( $product ) ) {
$subscription->update_meta_data( '_contains_synced_subscription', 'true' );
$subscription->save();
break;
}
}
}
}
/**
* When adding an item to an order/subscription via the Add/Edit Subscription administration interface, check if we should be setting
* the sync meta on the subscription.
*
* @param int $item_id The order item ID of an item that was just added to the order
* @param array $item The order item details
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.0
*/
public static function ajax_maybe_add_meta_for_item( $item_id, $item ) {
check_ajax_referer( 'order-item', 'security' );
if ( self::is_product_synced( wcs_get_canonical_product_id( $item ) ) ) {
self::maybe_add_subscription_meta( absint( $_POST['order_id'] ) );
}
}
/**
* When adding a product to an order/subscription via the WC_Subscription::add_product() method, check if we should be setting
* the sync meta on the subscription.
*
* @param int $subscription_id The post ID of a WC_Order or child object
* @param int $item_id The order item ID of an item that was just added to the order
* @param object $product The WC_Product for which an item was just added
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.0
*/
public static function maybe_add_meta_for_new_product( $subscription_id, $item_id, $product ) {
if ( self::is_product_synced( $product ) ) {
self::maybe_add_subscription_meta( $subscription_id );
}
}
/**
* Checks if a given subscription is synced to a certain day.
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.0
*
* @param int|WC_Subscription $subscription Accepts either a subscription object or ID.
* @return bool True if the subscription is synced, false otherwise.
*/
public static function subscription_contains_synced_product( $subscription ) {
if ( ! is_object( $subscription ) ) {
$subscription = wcs_get_subscription( $subscription );
}
return is_a( $subscription, 'WC_Subscription' ) && 'true' === $subscription->get_meta( '_contains_synced_subscription' );
}
/**
* Alters the subscription grouping key to ensure synced products are grouped separately.
*
* @param string $key The subscription product's grouping key.
* @param array|WC_Order_Item_Product $item The cart item or order item that the key is being generated for.
*
* @return string The subscription product grouping key with a synced product flag if the product is synced.
*/
public static function add_to_recurring_product_grouping_key( $key, $item ) {
$product = false;
if ( is_a( $item, 'WC_Order_Item_Product' ) ) {
$product = $item->get_product();
} elseif ( is_array( $item ) && isset( $item['data'] ) ) {
$product = $item['data'];
}
if ( $product && false === strpos( $key, '_synced' ) && self::is_product_synced( $product ) ) {
$key .= '_synced';
}
return $key;
}
/**
* When adding a product line item to an order/subscription via the WC_Abstract_Order::add_product() method, check if we should be setting
* the sync meta on the subscription.
*
* Attached to WC 3.0+ hooks and uses WC 3.0 methods.
*
* @param int $item_id The new line item id
* @param WC_Order_Item $item
* @param int $subscription_id The post ID of a WC_Subscription
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.2.3
*/
public static function maybe_add_meta_for_new_line_item( $item_id, $item, $subscription_id ) {
if ( is_callable( array( $item, 'get_product' ) ) ) {
$product = $item->get_product();
if ( self::is_product_synced( $product ) ) {
self::maybe_add_subscription_meta( $subscription_id );
}
}
}
/**
* Store a synced product's signup fee on the line item on the subscription and order.
*
* When calculating prorated sign up fees during switches it's necessary to get the sign-up fee paid.
* For synced product purchases we cannot rely on the order line item price as that might include a prorated recurring price or no recurring price all.
*
* Attached to WC 3.0+ hooks and uses WC 3.0 methods.
*
* @param WC_Order_Item_Product $item The order item object.
* @param string $cart_item_key The hash used to identify the item in the cart
* @param array $cart_item The cart item's data.
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.3.0
*/
public static function maybe_add_line_item_meta( $item, $cart_item_key, $cart_item ) {
if ( self::is_product_synced( $cart_item['data'] ) && ! self::is_today( self::calculate_first_payment_date( $cart_item['data'], 'timestamp' ) ) ) {
$item->add_meta_data( '_synced_sign_up_fee', WC_Subscriptions_Product::get_sign_up_fee( $cart_item['data'] ) );
}
}
/**
* Store a synced product's signup fee on the line item on the subscription and order.
*
* This function is a pre WooCommerce 3.0 version of @see WC_Subscriptions_Synchroniser::maybe_add_line_item_meta()
*
* @param int $item_id The order item ID.
* @param array $cart_item The cart item's data.
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.3.0
*/
public static function maybe_add_order_item_meta( $item_id, $cart_item ) {
if ( self::is_product_synced( $cart_item['data'] ) && ! self::is_today( self::calculate_first_payment_date( $cart_item['data'], 'timestamp' ) ) ) {
wc_update_order_item_meta( $item_id, '_synced_sign_up_fee', WC_Subscriptions_Product::get_sign_up_fee( $cart_item['data'] ) );
}
}
/**
* Hides synced subscription meta on the edit order and subscription screen on non-debug sites.
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.6.2
* @param array $hidden_meta_keys the list of meta keys hidden on the edit order and subscription screen.
* @return array $hidden_meta_keys
*/
public static function hide_order_itemmeta( $hidden_meta_keys ) {
if ( apply_filters( 'woocommerce_subscriptions_hide_synchronization_itemmeta', ! defined( 'WCS_DEBUG' ) || true !== WCS_DEBUG ) ) {
$hidden_meta_keys[] = '_synced_sign_up_fee';
}
return $hidden_meta_keys;
}
/**
* Gets the number of sign-up grace period days.
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v3.0.6
* @return int The number of days in the grace period. 0 will be returned if the store isn't charging the full recurring price on sign-up -- a prerequisite for setting a grace period.
*/
private static function get_number_of_grace_period_days() {
return get_option( self::$setting_id_proration, 'no' ) === 'recurring' ? get_option( self::$setting_id_days_no_fee ) : 0;
}
/* Deprecated Functions */
/**
* Automatically set the order's status to complete if all the subscriptions in an order
* are synced and the order total is zero.
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.5.17
*/
public static function order_autocomplete( $new_order_status, $order_id ) {
_deprecated_function( __METHOD__, '2.1.3', 'WC_Subscriptions_Order::maybe_autocomplete_order' );
return WC_Subscriptions_Order::maybe_autocomplete_order( $new_order_status, $order_id );
}
/**
* Add the first payment date to the end of the subscription to clarify when the first payment will be processed
*
* Deprecated because the first renewal date is displayed by default now on recurring totals.
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.5
* @deprecated 1.0.0 - Migrated from WooCommerce Subscriptions v2.0
*/
public static function customise_subscription_price_string( $subscription_string ) {
_deprecated_function( __METHOD__, '2.0' );
$cart_item = self::cart_contains_synced_subscription();
if ( false !== $cart_item && '' !== WC_Subscriptions_Product::get_period( $cart_item['data'] ) && ( 'year' != WC_Subscriptions_Product::get_period( $cart_item['data'] ) || WC_Subscriptions_Product::get_trial_length( $cart_item['data'] ) > 0 ) ) {
$first_payment_date = self::get_products_first_payment_date( $cart_item['data'] );
if ( '' != $first_payment_date ) {
$price_and_start_date = sprintf( '%s %s', $subscription_string, $first_payment_date );
$subscription_string = apply_filters( 'woocommerce_subscriptions_synced_start_date_string', $price_and_start_date, $subscription_string, $cart_item );
}
}
return $subscription_string;
}
/**
* Hid the trial period for a synchronised subscription unless the related product actually has a trial period (because
* we use a trial period to set the original order totals to 0).
*
* Deprecated because free trials are no longer displayed on cart totals, only the first renewal date is displayed.
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.5
* @deprecated 1.0.0 - Migrated from WooCommerce Subscriptions v2.0
*/
public static function maybe_hide_free_trial( $subscription_details ) {
_deprecated_function( __METHOD__, '2.0' );
$cart_item = self::cart_contains_synced_subscription();
if ( false !== $cart_item && ! self::is_product_prorated( $cart_item['data'] ) ) { // cart contains a sync
$product_id = WC_Subscriptions_Cart::get_items_product_id( $cart_item );
if ( wc_price( 0 ) == $subscription_details['initial_amount'] && 0 == $subscription_details['trial_length'] ) {
$subscription_details['initial_amount'] = '';
}
}
return $subscription_details;
}
/**
* Let other functions know shipping should not be charged on the initial order when
* the cart contains a synchronised subscription and no other items which need shipping.
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.5.8
* @deprecated 1.0.0 - Migrated from WooCommerce Subscriptions v2.0
*/
public static function charge_shipping_up_front( $charge_shipping_up_front ) {
_deprecated_function( __METHOD__, '2.0' );
// the cart contains only the synchronised subscription
if ( true === $charge_shipping_up_front && self::cart_contains_synced_subscription() ) {
// the cart contains only a subscription, see if the payment date is today and if not, then it doesn't need shipping
if ( 1 == count( WC()->cart->cart_contents ) ) {
foreach ( WC()->cart->get_cart() as $cart_item_key => $cart_item ) {
if ( self::is_product_synced( $cart_item['data'] ) && ! self::is_product_prorated( $cart_item['data'] ) && ! self::is_today( self::calculate_first_payment_date( $cart_item['data'], 'timestamp' ) ) ) {
$charge_shipping_up_front = false;
break;
}
}
// cart contains other items, see if any require shipping
} else {
$other_items_need_shipping = false;
foreach ( WC()->cart->cart_contents as $cart_item_key => $cart_item ) {
if ( ( ! WC_Subscriptions_Product::is_subscription( $cart_item['data'] ) || self::is_product_prorated( $cart_item['data'] ) ) && $cart_item['data']->needs_shipping() ) {
$other_items_need_shipping = true;
}
}
if ( false === $other_items_need_shipping ) {
$charge_shipping_up_front = false;
}
}
}
return $charge_shipping_up_front;
}
/**
* Make sure anything requesting the first payment date for a synced subscription on the front-end receives
* a date which takes into account the day on which payments should be processed.
*
* This is necessary as the self::calculate_first_payment_date() is not called when the subscription is active
* (which it isn't until the first payment is completed and the subscription is activated).
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.5
* @deprecated 1.0.0 - Migrated from WooCommerce Subscriptions v2.0
*/
public static function get_first_payment_date( $first_payment_date, $order, $product_id, $type ) {
_deprecated_function( __METHOD__, '2.0' );
$subscription = wcs_get_subscription_from_key( $order . '_' . $product_id );
if ( self::order_contains_synced_subscription( wcs_get_objects_property( $order, 'id' ) ) && 1 >= $subscription->get_payment_count() ) {
// Don't prematurely set the first payment date when manually adding a subscription from the admin
if ( ! is_admin() || 'active' == $subscription->get_status() ) {
$first_payment_timestamp = self::calculate_first_payment_date( $product_id, 'timestamp', wcs_get_datetime_utc_string( wcs_get_objects_property( $order, 'date_created' ) ) );
if ( 0 != $first_payment_timestamp ) {
$first_payment_date = ( 'mysql' == $type ) ? gmdate( 'Y-m-d H:i:s', $first_payment_timestamp ) : $first_payment_timestamp;
}
}
}
return $first_payment_date;
}
/**
* Tell anything hooking to 'woocommerce_subscriptions_calculated_next_payment_date'
* to use the synchronised first payment date as the next payment date (if the first
* payment date isn't today, meaning the first payment won't be charged today).
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.5.14
* @deprecated 1.0.0 - Migrated from WooCommerce Subscriptions v2.0
*/
public static function maybe_set_payment_date( $payment_date, $order, $product_id, $type ) {
_deprecated_function( __METHOD__, '2.0' );
$first_payment_date = self::get_first_payment_date( $payment_date, $order, $product_id, 'timestamp' );
if ( ! self::is_today( $first_payment_date ) ) {
$payment_date = ( 'timestamp' == $type ) ? $first_payment_date : gmdate( 'Y-m-d H:i:s', $first_payment_date );
}
return $payment_date;
}
/**
* Check if a given order included a subscription that is synced to a certain day.
*
* Deprecated because _order_contains_synced_subscription is no longer stored on the order @see self::subscription_contains_synced_product
*
* @param int $order_id The ID or a WC_Order item to check.
* @return bool Returns true if the order contains a synced subscription, otherwise, false.
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.5
* @deprecated 1.0.0 - Migrated from WooCommerce Subscriptions v2.0
*/
public static function order_contains_synced_subscription( $order_id ) {
_deprecated_function( __METHOD__, '2.0', __CLASS__ . '::subscription_contains_synced_product()' );
if ( is_object( $order_id ) ) {
$order = $order_id;
} else {
$order = wc_get_order( $order_id );
}
return 'true' === $order->get_meta( '_order_contains_synced_subscription', true );
}
/**
* If the order being generated is for a synced subscription, keep a record of the syncing related meta data.
*
* Deprecated because _order_contains_synced_subscription is no longer stored on the order @see self::add_subscription_sync_meta
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.5
* @deprecated 1.0.0 - Migrated from WooCommerce Subscriptions v2.0
*/
public static function add_order_meta( $order_id, $posted ) {
_deprecated_function( __METHOD__, '2.0' );
global $woocommerce;
if ( $cart_item = self::cart_contains_synced_subscription() ) {
update_post_meta( $order_id, '_order_contains_synced_subscription', 'true' );
}
}
/**
* If the subscription being generated is synced, set the syncing related meta data correctly.
*
* Deprecated because editing a subscription's values is now done from the Edit Subscription screen.
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.5
* @deprecated 1.0.0 - Migrated from WooCommerce Subscriptions v2.0
*/
public static function prefill_order_item_meta( $item, $item_id ) {
_deprecated_function( __METHOD__, '2.0' );
return $item;
}
/**
* Filters WC_Subscriptions_Order::get_sign_up_fee() to make sure the sign-up fee for a subscription product
* that is synchronised is returned correctly.
*
* @param float $sign_up_fee The initial sign-up fee charged when the subscription product in the order was first purchased, if any.
* @param mixed $order A WC_Order object or the ID of the order which the subscription was purchased in.
* @param int $product_id The post ID of the subscription WC_Product object purchased in the order. Defaults to the ID of the first product purchased in the order.
* @return float The initial sign-up fee charged when the subscription product in the order was first purchased, if any.
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.5.3
* @deprecated 1.0.0 - Migrated from WooCommerce Subscriptions v2.0
*/
public static function get_sign_up_fee( $sign_up_fee, $order, $product_id, $non_subscription_total ) {
_deprecated_function( __METHOD__, '2.0', __CLASS__ . '::get_synced_sign_up_fee' );
if ( 'shop_order' === WC_Data_Store::load( 'order' )->get_order_type( $order ) && self::order_contains_synced_subscription( wcs_get_objects_property( $order, 'id' ) ) && WC_Subscriptions_Order::get_subscription_trial_length( $order ) < 1 ) {
$sign_up_fee = max( WC_Subscriptions_Order::get_total_initial_payment( $order ) - $non_subscription_total, 0 );
}
return $sign_up_fee;
}
/**
* Check if the cart includes a subscription that needs to be prorated.
*
* @return bool Returns any item in the cart that is synced and requires proration, otherwise, false.
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v1.5
* @deprecated 1.0.0 - Migrated from WooCommerce Subscriptions v2.0
*/
public static function cart_contains_prorated_subscription() {
_deprecated_function( __METHOD__, '2.0' );
$cart_contains_prorated_subscription = false;
$synced_cart_item = self::cart_contains_synced_subscription();
if ( false !== $synced_cart_item && self::is_product_prorated( $synced_cart_item['data'] ) ) {
$cart_contains_prorated_subscription = $synced_cart_item;
}
return $cart_contains_prorated_subscription;
}
/**
* Maybe recalculate the trial end date for synced subscription products that contain the unnecessary
* "one day trial" period.
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.0
* @deprecated 1.0.0 - Migrated from WooCommerce Subscriptions v2.0.14
*/
public static function recalculate_trial_end_date( $trial_end_date, $recurring_cart, $product ) {
_deprecated_function( __METHOD__, '2.0.14' );
if ( self::is_product_synced( $product ) ) {
$product_id = wcs_get_canonical_product_id( $product );
$trial_end_date = WC_Subscriptions_Product::get_trial_expiration_date( $product_id );
}
return $trial_end_date;
}
/**
* Maybe recalculate the end date for synced subscription products that contain the unnecessary
* "one day trial" period.
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.0.9
* @deprecated 1.0.0 - Migrated from WooCommerce Subscriptions v2.0.14
*/
public static function recalculate_end_date( $end_date, $recurring_cart, $product ) {
_deprecated_function( __METHOD__, '2.0.14' );
if ( self::is_product_synced( $product ) ) {
$product_id = wcs_get_canonical_product_id( $product );
$end_date = WC_Subscriptions_Product::get_expiration_date( $product_id );
}
return $end_date;
}
/**
* Alters the recurring cart item key to ensure synced products are grouped separately.
*
* @since 1.0.0 - Migrated from WooCommerce Subscriptions v2.0
* @deprecated 6.5.0
*
* @param string $cart_key The recurring cart item key.
* @param array $cart_item The cart item's data.
*
* @return string The cart item recurring cart key with a synced product flag if the product is synced.
*/
public static function add_to_recurring_cart_key( $cart_key, $cart_item ) {
wcs_deprecated_function( __METHOD__, '6.5.0', __CLASS__ . '::add_to_recurring_product_grouping_key' );
return self::add_to_recurring_product_grouping_key( $cart_key, $cart_item );
}
}