class PurchasableEntitySubscriptionTrait in Commerce Recurring Framework 8

Provides a trait to enable purchasing of subscriptions.

Plugin annotation

@CommerceEntityTrait(
  id = "purchasable_entity_subscription",
  label = @Translation("Allow subscriptions"),
  entity_types = {"commerce_product_variation"}
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\commerce\Plugin\Commerce\EntityTrait\EntityTraitBase implements EntityTraitInterface
      • class \Drupal\commerce_recurring\Plugin\Commerce\EntityTrait\PurchasableEntitySubscriptionTrait

File

src/Plugin/Commerce/EntityTrait/PurchasableEntitySubscriptionTrait.php, line 17

Namespace

Drupal\commerce_recurring\Plugin\Commerce\EntityTrait

class PurchasableEntitySubscriptionTrait extends EntityTraitBase {

  /**
   * {@inheritdoc}
   */
  public function buildFieldDefinitions() {
    $fields = [];
    $fields['billing_schedule'] = BundleFieldDefinition::create('entity_reference')
      ->setLabel(t('Billing schedule'))
      ->setRequired(TRUE)
      ->setSetting('target_type', 'commerce_billing_schedule')
      ->setDisplayOptions('form', [
      'type' => 'options_select',
    ])
      ->setDisplayConfigurable('form', TRUE);
    $fields['subscription_type'] = BundleFieldDefinition::create('commerce_plugin_item:commerce_subscription_type')
      ->setLabel(t('Subscription type'))
      ->setRequired(TRUE)
      ->setDisplayOptions('form', [
      'type' => 'commerce_plugin_select',
      'weight' => 0,
    ])
      ->setDisplayConfigurable('form', TRUE);
    return $fields;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
EntityTraitBase::getEntityTypeIds	public	function	Gets the entity type IDs. Overrides EntityTraitInterface::getEntityTypeIds
EntityTraitBase::getLabel	public	function	Gets the entity trait label. Overrides EntityTraitInterface::getLabel
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
PurchasableEntitySubscriptionTrait::buildFieldDefinitions	public	function	Builds the field definitions. Overrides EntityTraitBase::buildFieldDefinitions
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.