<?php
/**
* Subscription Early Renewal Manager Class
*
* @package WooCommerce Subscriptions
* @subpackage WCS_Early_Renewal
* @category Class
* @since 2.3.0
*/
if ( ! defined( 'ABSPATH' ) ) {
exit; // Exit if accessed directly
}
class WCS_Early_Renewal_Manager {
/**
* The early renewal enabled setting ID.
*
* @var string
*/
protected static $setting_id;
/**
* The early renewal via modal enabled setting ID.
*
* @var string
*/
protected static $via_modal_setting_id;
/**
* Initialize filters and hooks for class.
*
* @since 2.3.0
*/
public static function init() {
self::$setting_id = WC_Subscriptions_Admin::$option_prefix . '_enable_early_renewal';
self::$via_modal_setting_id = WC_Subscriptions_Admin::$option_prefix . '_enable_early_renewal_via_modal';
add_filter( 'woocommerce_subscription_settings', array( __CLASS__, 'add_settings' ) );
}
/**
* Add a setting to enable/disable the early renewal feature.
*
* @since 2.3.0
* @param array Settings array.
* @return array
*/
public static function add_settings( $settings ) {
$early_renewal_settings = array(
array(
'id' => self::$setting_id,
'name' => __( 'Early Renewal', 'woocommerce-subscriptions' ),
'desc' => __( 'Accept Early Renewal Payments', 'woocommerce-subscriptions' ),
'desc_tip' => __( 'With early renewals enabled, customers can renew their subscriptions before the next payment date.', 'woocommerce-subscriptions' ),
'default' => 'no',
'type' => 'checkbox',
'checkboxgroup' => 'start',
'show_if_checked' => 'option',
),
array(
'id' => self::$via_modal_setting_id,
'desc' => __( 'Accept Early Renewal Payments via a Modal', 'woocommerce-subscriptions' ),
'desc_tip' => sprintf(
/* translators: 1-2: opening/closing <strong> tags , 2-3: opening/closing tags for a link to docs on early renewal. */
__( 'Allow customers to bypass the checkout and renew their subscription early from their %1$sMy Account > View Subscription%2$s page. %3$sLearn more.%4$s', 'woocommerce-subscriptions' ),
'<strong>', '</strong>',
'<a href="https://docs.woocommerce.com/document/subscriptions/early-renewal/">', '</a>'
),
'default' => 'no',
'type' => 'checkbox',
'checkboxgroup' => 'end',
'show_if_checked' => 'yes',
),
);
WC_Subscriptions_Admin::insert_setting_after( $settings, 'woocommerce_subscriptions_turn_off_automatic_payments', $early_renewal_settings, 'multiple_settings' );
return $settings;
}
/**
* A helper function to check if the early renewal feature is enabled or not.
*
* If the setting hasn't been set yet, by default it is off for existing stores and on for new stores.
*
* @since 2.3.0
* @return bool
*/
public static function is_early_renewal_enabled() {
$enabled = get_option( self::$setting_id );
if ( false === $enabled ) {
$enabled = wcs_do_subscriptions_exist() ? 'no' : 'yes';
update_option( self::$setting_id, $enabled );
}
return apply_filters( 'wcs_is_early_renewal_enabled', 'yes' === $enabled );
}
/**
* Finds if the store has enabled early renewal via a modal.
*
* @since 2.6.0
* @return bool
*/
public static function is_early_renewal_via_modal_enabled() {
return self::is_early_renewal_enabled() && apply_filters( 'wcs_is_early_renewal_via_modal_enabled', 'yes' === get_option( self::$via_modal_setting_id, 'no' ) );
}
/**
* Gets the dates which need to be updated after an early renewal is processed.
*
* @since 2.6.0
*
* @param WC_Subscription $subscription The subscription to calculate the dates for.
* @return array The subscription dates which need to be updated. For example array( $date_type => $mysql_form_date_string ).
*/
public static function get_dates_to_update( $subscription ) {
$next_payment_time = $subscription->get_time( 'next_payment' );
$dates_to_update = array();
if ( $next_payment_time > 0 && $next_payment_time > current_time( 'timestamp', true ) ) {
$next_payment_timestamp = wcs_add_time( $subscription->get_billing_interval(), $subscription->get_billing_period(), $next_payment_time );
if ( $subscription->get_time( 'end' ) === 0 || $next_payment_timestamp < $subscription->get_time( 'end' ) ) {
$dates_to_update['next_payment'] = gmdate( 'Y-m-d H:i:s', $next_payment_timestamp );
} else {
// Delete the next payment date if the calculated next payment date occurs after the end date.
$dates_to_update['next_payment'] = 0;
}
} elseif ( $subscription->get_time( 'end' ) > 0 ) {
$dates_to_update['end'] = gmdate( 'Y-m-d H:i:s', wcs_add_time( $subscription->get_billing_interval(), $subscription->get_billing_period(), $subscription->get_time( 'end' ) ) );
}
return $dates_to_update;
}
}