interface BillingScheduleInterface in Commerce Recurring Framework 8

Defines the interface for billing schedules.

This configuration entity stores configuration for billing schedule plugins.

Hierarchy

• interface \Drupal\Core\Config\Entity\ConfigEntityInterface; interface \Drupal\Core\Entity\EntityWithPluginCollectionInterface
  • interface \Drupal\commerce_recurring\Entity\BillingScheduleInterface

8 files declare their use of BillingScheduleInterface

BillingScheduleForm.php in src/Form/BillingScheduleForm.php

BillingScheduleTest.php in tests/src/FunctionalJavascript/BillingScheduleTest.php

BillingScheduleTest.php in tests/src/Kernel/Entity/BillingScheduleTest.php

CronTest.php in tests/src/Kernel/CronTest.php

InitialOrderProcessor.php in src/InitialOrderProcessor.php

... See full list

File

src/Entity/BillingScheduleInterface.php, line 13

Namespace

Drupal\commerce_recurring\Entity

interface BillingScheduleInterface extends ConfigEntityInterface, EntityWithPluginCollectionInterface {

  /**
   * Available billing types.
   */
  const BILLING_TYPE_PREPAID = 'prepaid';
  const BILLING_TYPE_POSTPAID = 'postpaid';

  /**
   * Gets the display label.
   *
   * This label is customer-facing.
   *
   * @return string
   *   The display label.
   */
  public function getDisplayLabel();

  /**
   * Sets the display label.
   *
   * @param string $display_label
   *   The display label.
   *
   * @return $this
   */
  public function setDisplayLabel($display_label);

  /**
   * Gets the billing type.
   *
   * The billing type can be either:
   * - Prepaid: Subscription is paid at the beginning of the period.
   * - Postpaid: Subscription is paid at the end of the period.
   *
   * @return string
   *   The billing type, one of the BILLING_TYPE_ constants.
   */
  public function getBillingType();

  /**
   * Sets the billing type.
   *
   * @param string $billing_type
   *   The billing type.
   *
   * @return $this
   */
  public function setBillingType($billing_type);

  /**
   * Gets the retry schedule.
   *
   * Controls the dunning process that starts after a declined payment.
   * For example, [1, 3, 5] means that a recurring order's payment will be
   * retried 3 times, with 1, 3, and 5 days between retries.
   *
   * @return array
   *   The retry schedule.
   */
  public function getRetrySchedule();

  /**
   * Sets the retry schedule.
   *
   * @param array $schedule
   *   The retry schedule.
   *
   * @return $this
   */
  public function setRetrySchedule(array $schedule);

  /**
   * Gets the unpaid subscription state.
   *
   * This is the state that the subscription will transition to after the end
   * of the dunning cycle. Common values:
   * - active (indicating that the subscription should stay active)
   * - canceled (indicating that the subscription should be canceled).
   *
   * @return string
   *   The subscription state.
   */
  public function getUnpaidSubscriptionState();

  /**
   * Sets the unpaid subscription state.
   *
   * @param string $state
   *   The subscription state.
   *
   * @return $this
   */
  public function setUnpaidSubscriptionState($state);

  /**
   * Gets the billing schedule plugin ID.
   *
   * @return string
   *   The billing schedule plugin ID.
   */
  public function getPluginId();

  /**
   * Sets the billing schedule plugin ID.
   *
   * @param string $plugin_id
   *   The billing schedule plugin ID.
   *
   * @return $this
   */
  public function setPluginId($plugin_id);

  /**
   * Gets the billing schedule plugin configuration.
   *
   * @return array
   *   The billing schedule plugin configuration.
   */
  public function getPluginConfiguration();

  /**
   * Sets the billing schedule plugin configuration.
   *
   * @param array $configuration
   *   The billing schedule plugin configuration.
   *
   * @return $this
   */
  public function setPluginConfiguration(array $configuration);

  /**
   * Gets the billing schedule plugin.
   *
   * @return \Drupal\commerce_recurring\Plugin\Commerce\BillingSchedule\BillingScheduleInterface
   *   The billing schedule plugin.
   */
  public function getPlugin();

  /**
   * Gets the prorater plugin ID.
   *
   * @return string
   *   The prorater plugin ID.
   */
  public function getProraterId();

  /**
   * Sets the prorater plugin ID.
   *
   * @param string $prorater_id
   *   The prorater plugin ID.
   *
   * @return $this
   */
  public function setProraterId($prorater_id);

  /**
   * Gets the prorater plugin configuration.
   *
   * @return array
   *   The prorater plugin configuration.
   */
  public function getProraterConfiguration();

  /**
   * Sets the prorater plugin configuration.
   *
   * @param array $configuration
   *   The prorater plugin configuration.
   *
   * @return $this
   */
  public function setProraterConfiguration(array $configuration);

  /**
   * Gets the prorater plugin.
   *
   * @return \Drupal\commerce_recurring\Plugin\Commerce\Prorater\ProraterInterface
   *   The prorater plugin.
   */
  public function getProrater();

}

Members

Name	Modifiers	Type	Description	Overrides
AccessibleInterface::access	public	function	Checks data value access.	9
BillingScheduleInterface::BILLING_TYPE_POSTPAID		constant
BillingScheduleInterface::BILLING_TYPE_PREPAID		constant	Available billing types.
BillingScheduleInterface::getBillingType	public	function	Gets the billing type.	1
BillingScheduleInterface::getDisplayLabel	public	function	Gets the display label.	1
BillingScheduleInterface::getPlugin	public	function	Gets the billing schedule plugin.	1
BillingScheduleInterface::getPluginConfiguration	public	function	Gets the billing schedule plugin configuration.	1
BillingScheduleInterface::getPluginId	public	function	Gets the billing schedule plugin ID.	1
BillingScheduleInterface::getProrater	public	function	Gets the prorater plugin.	1
BillingScheduleInterface::getProraterConfiguration	public	function	Gets the prorater plugin configuration.	1
BillingScheduleInterface::getProraterId	public	function	Gets the prorater plugin ID.	1
BillingScheduleInterface::getRetrySchedule	public	function	Gets the retry schedule.	1
BillingScheduleInterface::getUnpaidSubscriptionState	public	function	Gets the unpaid subscription state.	1
BillingScheduleInterface::setBillingType	public	function	Sets the billing type.	1
BillingScheduleInterface::setDisplayLabel	public	function	Sets the display label.	1
BillingScheduleInterface::setPluginConfiguration	public	function	Sets the billing schedule plugin configuration.	1
BillingScheduleInterface::setPluginId	public	function	Sets the billing schedule plugin ID.	1
BillingScheduleInterface::setProraterConfiguration	public	function	Sets the prorater plugin configuration.	1
BillingScheduleInterface::setProraterId	public	function	Sets the prorater plugin ID.	1
BillingScheduleInterface::setRetrySchedule	public	function	Sets the retry schedule.	1
BillingScheduleInterface::setUnpaidSubscriptionState	public	function	Sets the unpaid subscription state.	1
CacheableDependencyInterface::getCacheContexts	public	function	The cache contexts associated with this object.	34
CacheableDependencyInterface::getCacheMaxAge	public	function	The maximum age for which this object may be cached.	34
CacheableDependencyInterface::getCacheTags	public	function	The cache tags associated with this object.	27
ConfigEntityInterface::calculateDependencies	public	function	Calculates dependencies and stores them in the dependency property.	2
ConfigEntityInterface::disable	public	function	Disables the configuration entity.	2
ConfigEntityInterface::enable	public	function	Enables the configuration entity.	2
ConfigEntityInterface::get	public	function	Returns the value of a property.	2
ConfigEntityInterface::getDependencies	public	function	Gets the configuration dependencies.	2
ConfigEntityInterface::hasTrustedData	public	function	Gets whether on not the data is trusted.	2
ConfigEntityInterface::isInstallable	public	function	Checks whether this entity is installable.	2
ConfigEntityInterface::isUninstalling	public	function	Returns whether this entity is being changed during the uninstall process.	2
ConfigEntityInterface::onDependencyRemoval	public	function	Informs the entity that entities it depends on will be deleted.	2
ConfigEntityInterface::set	public	function	Sets the value of a property.	2
ConfigEntityInterface::setStatus	public	function	Sets the status of the configuration entity.	2
ConfigEntityInterface::status	public	function	Returns whether the configuration entity is enabled.	2
ConfigEntityInterface::trustData	public	function	Sets that the data should be trusted.	2
EntityInterface::bundle	public	function	Gets the bundle of the entity.	2
EntityInterface::create	public static	function	Constructs a new entity object, without permanently saving it.	2
EntityInterface::createDuplicate	public	function	Creates a duplicate of the entity.	2
EntityInterface::delete	public	function	Deletes an entity permanently.	2
EntityInterface::enforceIsNew	public	function	Enforces an entity to be new.	2
EntityInterface::getCacheTagsToInvalidate	public	function	Returns the cache tags that should be used to invalidate caches.	2
EntityInterface::getConfigDependencyKey	public	function	Gets the key that is used to store configuration dependencies.	2
EntityInterface::getConfigDependencyName	public	function	Gets the configuration dependency name.	2
EntityInterface::getConfigTarget	public	function	Gets the configuration target identifier for the entity.	2
EntityInterface::getEntityType	public	function	Gets the entity type definition.	2
EntityInterface::getEntityTypeId	public	function	Gets the ID of the type of the entity.	2
EntityInterface::getOriginalId	public	function	Gets the original ID.	2
EntityInterface::getTypedData	public	function	Gets a typed data object for this entity object.	2
EntityInterface::hasLinkTemplate	public	function	Indicates if a link template exists for a given key.	2
EntityInterface::id	public	function	Gets the identifier.	2
EntityInterface::isNew	public	function	Determines whether the entity is new.	2
EntityInterface::label	public	function	Gets the label of the entity.	2
EntityInterface::language	public	function	Gets the language of the entity.	2
EntityInterface::link Deprecated	public	function	Deprecated way of generating a link to the entity. See toLink().	2
EntityInterface::load	public static	function	Loads an entity.	2
EntityInterface::loadMultiple	public static	function	Loads one or more entities.	2
EntityInterface::postCreate	public	function	Acts on a created entity before hooks are invoked.	2
EntityInterface::postDelete	public static	function	Acts on deleted entities before the delete hook is invoked.	2
EntityInterface::postLoad	public static	function	Acts on loaded entities.	3
EntityInterface::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked.	2
EntityInterface::preCreate	public static	function	Changes the values of an entity before it is created.	2
EntityInterface::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked.	2
EntityInterface::preSave	public	function	Acts on an entity before the presave hook is invoked.	2
EntityInterface::referencedEntities	public	function	Gets a list of entities referenced by this entity.	2
EntityInterface::save	public	function	Saves an entity permanently.	2
EntityInterface::setOriginalId	public	function	Sets the original ID.	2
EntityInterface::toArray	public	function	Gets an array of all property values.	3
EntityInterface::toLink	public	function	Generates the HTML for a link to this entity.	2
EntityInterface::toUrl	public	function	Gets the URL object for the entity.	2
EntityInterface::uriRelationships	public	function	Gets a list of URI relationships supported by this entity.	2
EntityInterface::url Deprecated	public	function	Gets the public URL for this entity.	2
EntityInterface::urlInfo Deprecated	public	function	Gets the URL object for the entity.	2
EntityInterface::uuid	public	function	Gets the entity UUID (Universally Unique Identifier).	2
ObjectWithPluginCollectionInterface::getPluginCollections	public	function	Gets the plugin collections used by this object.	11
RefinableCacheableDependencyInterface::addCacheableDependency	public	function	Adds a dependency on an object: merges its cacheability metadata.	1
RefinableCacheableDependencyInterface::addCacheContexts	public	function	Adds cache contexts.	1
RefinableCacheableDependencyInterface::addCacheTags	public	function	Adds cache tags.	1
RefinableCacheableDependencyInterface::mergeCacheMaxAge	public	function	Merges the maximum age (in seconds) with the existing maximum age.	1
SynchronizableInterface::isSyncing	public	function	Returns whether this entity is being changed as part of a synchronization.	1
SynchronizableInterface::setSyncing	public	function	Sets the status of the synchronization flag.	1
ThirdPartySettingsInterface::getThirdPartyProviders	public	function	Gets the list of third parties that store information.	5
ThirdPartySettingsInterface::getThirdPartySetting	public	function	Gets the value of a third-party setting.	5
ThirdPartySettingsInterface::getThirdPartySettings	public	function	Gets all third-party settings of a given module.	5
ThirdPartySettingsInterface::setThirdPartySetting	public	function	Sets the value of a third-party setting.	5
ThirdPartySettingsInterface::unsetThirdPartySetting	public	function	Unsets a third-party setting.	5