You are here

Home » API reference » Commerce Recurring Framework 8 » BillingSchedule.php

class BillingSchedule in Commerce Recurring Framework 8

Defines the billing schedule entity class.

Plugin annotation


@ConfigEntityType(
  id = "commerce_billing_schedule",
  label = @Translation("Billing schedule"),
  label_collection = @Translation("Billing schedules"),
  label_singular = @Translation("billing schedule"),
  label_plural = @Translation("billing schedules"),
  label_count = @PluralTranslation(
    singular = "@count billing schedule",
    plural = "@count billing schedules",
  ),
  handlers = {
    "list_builder" = "\Drupal\commerce_recurring\BillingScheduleListBuilder",
    "storage" = "\Drupal\Core\Config\Entity\ConfigEntityStorage",
    "access" = "Drupal\commerce_recurring\BillingScheduleAccessControlHandler",
    "permission_provider" = "Drupal\entity\EntityPermissionProvider",
    "form" = {
      "add" = "\Drupal\commerce_recurring\Form\BillingScheduleForm",
      "edit" = "\Drupal\commerce_recurring\Form\BillingScheduleForm",
      "delete" = "\Drupal\Core\Entity\EntityDeleteForm"
    },
    "route_provider" = {
      "default" = "Drupal\Core\Entity\Routing\DefaultHtmlRouteProvider",
    },
  },
  admin_permission = "administer commerce_billing_schedule",
  config_prefix = "commerce_billing_schedule",
  entity_keys = {
    "id" = "id",
    "label" = "label",
    "uuid" = "uuid",
    "status" = "status",
  },
  config_export = {
    "id",
    "label",
    "displayLabel",
    "billingType",
    "retrySchedule",
    "unpaidSubscriptionState",
    "plugin",
    "configuration",
    "prorater",
    "proraterConfiguration",
    "status",
  },
  links = {
    "add-form" = "/admin/commerce/config/billing-schedules/add",
    "edit-form" = "/admin/commerce/config/billing-schedules/manage/{commerce_billing_schedule}",
    "delete-form" = "/admin/commerce/config/billing-schedules/manage/{commerce_billing_schedule}/delete",
    "collection" =  "/admin/commerce/config/billing-schedules"
  }
)

Hierarchy

Expanded class hierarchy of BillingSchedule

7 files declare their use of BillingSchedule
BillingScheduleForm.php in src/Form/BillingScheduleForm.php
BillingScheduleTest.php in tests/src/FunctionalJavascript/BillingScheduleTest.php
BillingScheduleTest.php in tests/src/Kernel/Entity/BillingScheduleTest.php
InitialOrderProcessorTest.php in tests/src/Kernel/InitialOrderProcessorTest.php
ProductVariationTest.php in tests/src/Kernel/Plugin/Commerce/SubscriptionType/ProductVariationTest.php

... See full list

File

src/Entity/BillingSchedule.php, line 64

Namespace

Drupal\commerce_recurring\Entity
View source 
class BillingSchedule extends ConfigEntityBase implements BillingScheduleInterface {

  /**
   * The billing schedule ID.
   *
   * @var string
   */
  protected $id;

  /**
   * The billing schedule label.
   *
   * @var string
   */
  protected $label;

  /**
   * The billing schedule display label.
   *
   * @var string
   */
  protected $displayLabel;

  /**
   * The billing type.
   *
   * One of the BillingScheduleInterface::BILLING_TYPE_ constants.
   *
   * @var string
   */
  protected $billingType = self::BILLING_TYPE_PREPAID;

  /**
   * The retry schedule.
   *
   * @var array
   */
  protected $retrySchedule = [
    1,
    3,
    5,
  ];

  /**
   * The unpaid subscription state.
   *
   * @var string
   */
  protected $unpaidSubscriptionState = 'canceled';

  /**
   * The plugin ID.
   *
   * @var string
   */
  protected $plugin;

  /**
   * The plugin configuration.
   *
   * @var array
   */
  protected $configuration = [];

  /**
   * The prorater plugin ID.
   *
   * @var string
   */
  protected $prorater = 'proportional';

  /**
   * The prorater plugin configuration.
   *
   * @var array
   */
  protected $proraterConfiguration = [];

  /**
   * The plugin collection that holds the billing schedule plugin.
   *
   * @var \Drupal\commerce\CommerceSinglePluginCollection
   */
  protected $billingSchedulePluginCollection;

  /**
   * The plugin collection that holds the prorater plugin.
   *
   * @var \Drupal\commerce\CommerceSinglePluginCollection
   */
  protected $proraterPluginCollection;

  /**
   * {@inheritdoc}
   */
  public function getDisplayLabel() {
    return $this->displayLabel;
  }

  /**
   * {@inheritdoc}
   */
  public function setDisplayLabel($display_label) {
    $this->displayLabel = $display_label;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getBillingType() {
    return $this->billingType;
  }

  /**
   * {@inheritdoc}
   */
  public function setBillingType($billing_type) {
    if (!in_array($billing_type, [
      self::BILLING_TYPE_PREPAID,
      self::BILLING_TYPE_POSTPAID,
    ])) {
      throw new \InvalidArgumentException(sprintf('Invalid billing type "%s" provided.'));
    }
    $this->billingType = $billing_type;
    return $this;
  }

  /**
   * @inheritdoc
   */
  public function getRetrySchedule() {
    return $this->retrySchedule;
  }

  /**
   * @inheritdoc
   */
  public function setRetrySchedule(array $schedule) {
    $this->retrySchedule = $schedule;
  }

  /**
   * {@inheritdoc}
   */
  public function getUnpaidSubscriptionState() {
    return $this->unpaidSubscriptionState;
  }

  /**
   * {@inheritdoc}
   */
  public function setUnpaidSubscriptionState($state) {
    $this->unpaidSubscriptionState = $state;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getPluginId() {
    return $this->plugin;
  }

  /**
   * {@inheritdoc}
   */
  public function setPluginId($plugin_id) {
    $this->plugin = $plugin_id;
    $this->configuration = [];
    $this->billingSchedulePluginCollection = NULL;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getPluginConfiguration() {
    return $this->configuration;
  }

  /**
   * {@inheritdoc}
   */
  public function setPluginConfiguration(array $configuration) {
    $this->configuration = $configuration;
    $this->billingSchedulePluginCollection = NULL;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getPlugin() {
    return $this
      ->getBillingSchedulePluginCollection()
      ->get($this->plugin);
  }

  /**
   * {@inheritdoc}
   */
  public function getProraterId() {
    return $this->prorater;
  }

  /**
   * {@inheritdoc}
   */
  public function setProraterId($prorater_id) {
    $this->prorater = $prorater_id;
    $this->proraterConfiguration = [];
    $this->proraterPluginCollection = NULL;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getProraterConfiguration() {
    return $this->proraterConfiguration;
  }

  /**
   * {@inheritdoc}
   */
  public function setProraterConfiguration(array $configuration) {
    $this->proraterConfiguration = $configuration;
    $this->proraterPluginCollection = NULL;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getProrater() {
    return $this
      ->getProraterPluginCollection()
      ->get($this->prorater);
  }

  /**
   * {@inheritdoc}
   */
  public function getPluginCollections() {
    return [
      'configuration' => $this
        ->getBillingSchedulePluginCollection(),
      'proraterConfiguration' => $this
        ->getProraterPluginCollection(),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function set($property_name, $value) {

    // Invoke the setters to clear related properties.
    if ($property_name === 'plugin') {
      $this
        ->setPluginId($value);
    }
    elseif ($property_name === 'configuration') {
      $this
        ->setPluginConfiguration($value);
    }
    else {
      return parent::set($property_name, $value);
    }
  }

  /**
   * Gets the plugin collection that holds the billing schedule plugin.
   *
   * Ensures the plugin collection is initialized before returning it.
   *
   * @return \Drupal\commerce\CommerceSinglePluginCollection
   *   The plugin collection.
   */
  protected function getBillingSchedulePluginCollection() {
    if (!$this->billingSchedulePluginCollection) {
      $plugin_manager = \Drupal::service('plugin.manager.commerce_billing_schedule');
      $this->billingSchedulePluginCollection = new CommerceSinglePluginCollection($plugin_manager, $this->plugin, $this->configuration, $this->id);
    }
    return $this->billingSchedulePluginCollection;
  }

  /**
   * Gets the plugin collection that holds the prorater plugin.
   *
   * Ensures the plugin collection is initialized before returning it.
   *
   * @return \Drupal\commerce\CommerceSinglePluginCollection
   *   The plugin collection.
   */
  protected function getProraterPluginCollection() {
    if (!$this->proraterPluginCollection) {
      $plugin_manager = \Drupal::service('plugin.manager.commerce_prorater');
      $this->proraterPluginCollection = new CommerceSinglePluginCollection($plugin_manager, $this->prorater, $this->proraterConfiguration, $this->id);
    }
    return $this->proraterPluginCollection;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BillingSchedule::$billingSchedulePluginCollection protected property The plugin collection that holds the billing schedule plugin.
BillingSchedule::$billingType protected property The billing type.
BillingSchedule::$configuration protected property The plugin configuration.
BillingSchedule::$displayLabel protected property The billing schedule display label.
BillingSchedule::$id protected property The billing schedule ID.
BillingSchedule::$label protected property The billing schedule label.
BillingSchedule::$plugin protected property The plugin ID.
BillingSchedule::$prorater protected property The prorater plugin ID.
BillingSchedule::$proraterConfiguration protected property The prorater plugin configuration.
BillingSchedule::$proraterPluginCollection protected property The plugin collection that holds the prorater plugin.
BillingSchedule::$retrySchedule protected property The retry schedule.
BillingSchedule::$unpaidSubscriptionState protected property The unpaid subscription state.
BillingSchedule::getBillingSchedulePluginCollection protected function Gets the plugin collection that holds the billing schedule plugin.
BillingSchedule::getBillingType public function Gets the billing type. Overrides BillingScheduleInterface::getBillingType
BillingSchedule::getDisplayLabel public function Gets the display label. Overrides BillingScheduleInterface::getDisplayLabel
BillingSchedule::getPlugin public function Gets the billing schedule plugin. Overrides BillingScheduleInterface::getPlugin
BillingSchedule::getPluginCollections public function Gets the plugin collections used by this object. Overrides ObjectWithPluginCollectionInterface::getPluginCollections
BillingSchedule::getPluginConfiguration public function Gets the billing schedule plugin configuration. Overrides BillingScheduleInterface::getPluginConfiguration
BillingSchedule::getPluginId public function Gets the billing schedule plugin ID. Overrides BillingScheduleInterface::getPluginId
BillingSchedule::getProrater public function Gets the prorater plugin. Overrides BillingScheduleInterface::getProrater
BillingSchedule::getProraterConfiguration public function Gets the prorater plugin configuration. Overrides BillingScheduleInterface::getProraterConfiguration
BillingSchedule::getProraterId public function Gets the prorater plugin ID. Overrides BillingScheduleInterface::getProraterId
BillingSchedule::getProraterPluginCollection protected function Gets the plugin collection that holds the prorater plugin.
BillingSchedule::getRetrySchedule public function @inheritdoc Overrides BillingScheduleInterface::getRetrySchedule
BillingSchedule::getUnpaidSubscriptionState public function Gets the unpaid subscription state. Overrides BillingScheduleInterface::getUnpaidSubscriptionState
BillingSchedule::set public function Sets the value of a property. Overrides ConfigEntityBase::set
BillingSchedule::setBillingType public function Sets the billing type. Overrides BillingScheduleInterface::setBillingType
BillingSchedule::setDisplayLabel public function Sets the display label. Overrides BillingScheduleInterface::setDisplayLabel
BillingSchedule::setPluginConfiguration public function Sets the billing schedule plugin configuration. Overrides BillingScheduleInterface::setPluginConfiguration
BillingSchedule::setPluginId public function Sets the billing schedule plugin ID. Overrides BillingScheduleInterface::setPluginId
BillingSchedule::setProraterConfiguration public function Sets the prorater plugin configuration. Overrides BillingScheduleInterface::setProraterConfiguration
BillingSchedule::setProraterId public function Sets the prorater plugin ID. Overrides BillingScheduleInterface::setProraterId
BillingSchedule::setRetrySchedule public function @inheritdoc Overrides BillingScheduleInterface::setRetrySchedule
BillingSchedule::setUnpaidSubscriptionState public function Sets the unpaid subscription state. Overrides BillingScheduleInterface::setUnpaidSubscriptionState
BillingScheduleInterface::BILLING_TYPE_POSTPAID constant
BillingScheduleInterface::BILLING_TYPE_PREPAID constant Available billing types.
CacheableDependencyTrait::$cacheContexts protected property Cache contexts.
CacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
CacheableDependencyTrait::$cacheTags protected property Cache tags.
CacheableDependencyTrait::setCacheability protected function Sets cacheability; useful for value object constructors.
ConfigEntityBase::$isUninstalling private property Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode protected property The language code of the entity's default language.
ConfigEntityBase::$originalId protected property The original ID of the configuration entity.
ConfigEntityBase::$status protected property The enabled/disabled status of the configuration entity. 4
ConfigEntityBase::$third_party_settings protected property Third party entity settings.
ConfigEntityBase::$trustedData protected property Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid protected property The UUID for this entity.
ConfigEntityBase::$_core protected property Information maintained by Drupal core about configuration.
ConfigEntityBase::addDependency protected function Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface::calculateDependencies 13
ConfigEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides EntityBase::createDuplicate 1
ConfigEntityBase::disable public function Disables the configuration entity. Overrides ConfigEntityInterface::disable 1
ConfigEntityBase::enable public function Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get public function Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate 1
ConfigEntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager protected static function Gets the configuration manager.
ConfigEntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies public function Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId public function Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig protected function Gets the typed config manager.
ConfigEntityBase::hasTrustedData public function Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete protected static function Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave protected function Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable public function Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable 2
ConfigEntityBase::isNew public function Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling public function Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::link public function Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase::link
ConfigEntityBase::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval 7
ConfigEntityBase::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete 8
ConfigEntityBase::preSave public function Acts on an entity before the presave hook is invoked. Overrides EntityBase::preSave 13
ConfigEntityBase::save public function Saves an entity permanently. Overrides EntityBase::save 1
ConfigEntityBase::setOriginalId public function Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus public function Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling public function
ConfigEntityBase::sort public static function Helper callback for uasort() to sort configuration entities by weight and label. 6
ConfigEntityBase::status public function Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status 4
ConfigEntityBase::toArray public function Gets an array of all property values. Overrides EntityBase::toArray 2
ConfigEntityBase::toUrl public function Gets the URL object for the entity. Overrides EntityBase::toUrl
ConfigEntityBase::trustData public function Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::url public function Gets the public URL for this entity. Overrides EntityBase::url
ConfigEntityBase::urlInfo public function Gets the URL object for the entity. Overrides EntityBase::urlInfo
ConfigEntityBase::__construct public function Constructs an Entity object. Overrides EntityBase::__construct 10
ConfigEntityBase::__sleep public function Overrides EntityBase::__sleep 4
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 Aliased as: traitSleep 1
DependencySerializationTrait::__wakeup public function 2
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency. Aliased as: addDependencyTrait
EntityBase::$enforceIsNew protected property Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId protected property The entity type.
EntityBase::$typedData protected property A typed data object wrapping this entity.
EntityBase::access public function Checks data value access. Overrides AccessibleInterface::access 1
EntityBase::bundle public function Gets the bundle of the entity. Overrides EntityInterface::bundle 1
EntityBase::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
EntityBase::delete public function Deletes an entity permanently. Overrides EntityInterface::delete 2
EntityBase::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityManager Deprecated protected function Gets the entity manager.
EntityBase::entityTypeBundleInfo protected function Gets the entity type bundle info service.
EntityBase::entityTypeManager protected function Gets the entity type manager.
EntityBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate protected function The list cache tags to invalidate for this entity.
EntityBase::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::id public function Gets the identifier. Overrides EntityInterface::id 11
EntityBase::label public function Gets the label of the entity. Overrides EntityInterface::label 6
EntityBase::language public function Gets the language of the entity. Overrides EntityInterface::language 1
EntityBase::languageManager protected function Gets the language manager.
EntityBase::linkTemplates protected function Gets an array link templates. 1
EntityBase::load public static function Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate 4
EntityBase::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete 16
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 2
EntityBase::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave 14
EntityBase::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 5
EntityBase::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities 1
EntityBase::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters protected function Gets an array of placeholders for this entity. 2
EntityBase::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid 1
EntityBase::uuidGenerator protected function Gets the UUID generator.
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance. 1
PluginDependencyTrait::getPluginDependencies protected function Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler protected function Wraps the module handler. 1
PluginDependencyTrait::themeHandler protected function Wraps the theme handler. 1
RefinableCacheableDependencyTrait::addCacheableDependency public function 1
RefinableCacheableDependencyTrait::addCacheContexts public function
RefinableCacheableDependencyTrait::addCacheTags public function
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function
SynchronizableEntityTrait::$isSyncing protected property Whether this entity is being created, updated or deleted through a synchronization process.
SynchronizableEntityTrait::isSyncing public function
SynchronizableEntityTrait::setSyncing public function