class Rolling in Commerce Recurring Framework 8

Provides a rolling interval billing schedule.

Billing periods generated by this plugin always start at the beginning of the subscription. For example, if a monthly subscription is opened on Oct 12th, the generated billing period will be Oct 12th - Nov 12th.

Plugin annotation


@CommerceBillingSchedule(
  id = "rolling",
  label = @Translation("Rolling interval"),
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\commerce_recurring\Plugin\Commerce\BillingSchedule\BillingScheduleBase implements BillingScheduleInterface
    class \Drupal\commerce_recurring\Plugin\Commerce\BillingSchedule\IntervalBase
    class \Drupal\commerce_recurring\Plugin\Commerce\BillingSchedule\Rolling

Expanded class hierarchy of Rolling

2 files declare their use of Rolling

BillingScheduleTest.php in tests/src/Kernel/Entity/BillingScheduleTest.php
RollingTest.php in tests/src/Kernel/Plugin/Commerce/BillingSchedule/RollingTest.php

File

src/Plugin/Commerce/BillingSchedule/Rolling.php, line 20

Namespace

Drupal\commerce_recurring\Plugin\Commerce\BillingSchedule

View source

class Rolling extends IntervalBase {

  /**
   * {@inheritdoc}
   */
  public function generateFirstBillingPeriod(DrupalDateTime $start_date) {
    return new BillingPeriod($start_date, $this
      ->getInterval()
      ->add($start_date));
  }

  /**
   * {@inheritdoc}
   */
  public function generateNextBillingPeriod(DrupalDateTime $start_date, BillingPeriod $billing_period) {
    $next_start_date = $billing_period
      ->getEndDate();
    $next_end_date = $this
      ->getInterval()
      ->add($next_start_date);

    // Retain the original billing day when possible.
    // Jan 31st -> Feb 28th -> March 31st (not March 28th).
    $billing_day = $start_date
      ->format('d');
    if ($this
      ->getInterval()
      ->getUnit() == 'month' && $next_end_date
      ->format('d') != $billing_day) {
      if ($billing_day <= $next_end_date
        ->format('t')) {
        $next_end_date
          ->setDate($next_end_date
          ->format('Y'), $next_end_date
          ->format('m'), $billing_day);
      }
    }
    return new BillingPeriod($next_start_date, $next_end_date);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BillingScheduleBase::$entityId	protected	property	The ID of the parent config entity.
BillingScheduleBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
BillingScheduleBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
BillingScheduleBase::getLabel	public	function	Gets the billing schedule label. Overrides BillingScheduleInterface::getLabel
BillingScheduleBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
BillingScheduleBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
BillingScheduleBase::__construct	public	function	Constructs a new BillingScheduleBase object. Overrides PluginBase::__construct
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
IntervalBase::allowTrials	public	function	Checks whether the billing schedule allows trials. Overrides BillingScheduleInterface::allowTrials
IntervalBase::buildConfigurationForm	public	function	Form constructor. Overrides BillingScheduleBase::buildConfigurationForm	1
IntervalBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides BillingScheduleBase::defaultConfiguration	1
IntervalBase::generateTrialPeriod	public	function	Generates the trial period. Overrides BillingScheduleInterface::generateTrialPeriod
IntervalBase::getInterval	protected	function	Gets the current interval.
IntervalBase::submitConfigurationForm	public	function	Form submission handler. Overrides BillingScheduleBase::submitConfigurationForm	1
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
Rolling::generateFirstBillingPeriod	public	function	Generates the first billing period. Overrides BillingScheduleInterface::generateFirstBillingPeriod
Rolling::generateNextBillingPeriod	public	function	Generates the next billing period. Overrides BillingScheduleInterface::generateNextBillingPeriod
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.

You are here