class OrderItemLicensed in Commerce License 8.2

Provides an entity trait for Commerce Order Item entities.

Product variations that sell a license must use an order item that uses this trait in order for the license to be created and granted when the order goes through the checkout process.

You may use an order item without this trait, provided you either ensure synchronization of the license entity another way, or do not require it, for example in a recurring order.

Plugin annotation


@CommerceEntityTrait(
 id = "commerce_license_order_item_type",
 label = @Translation("Provides an order item type for use with licenses"),
 entity_types = {"commerce_order_item"}
)

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_license\Plugin\Commerce\EntityTrait\OrderItemLicensed

Expanded class hierarchy of OrderItemLicensed

File

src/Plugin/Commerce/EntityTrait/OrderItemLicensed.php, line 27

Namespace

Drupal\commerce_license\Plugin\Commerce\EntityTrait

View source

class OrderItemLicensed extends EntityTraitBase {

  /**
   * {@inheritdoc}
   */
  public function buildFieldDefinitions() {

    // Builds the field definitions.
    $fields = [];
    $fields['license'] = BundleFieldDefinition::create('entity_reference')
      ->setLabel(t('License'))
      ->setDescription(t('The license purchased with this order item.'))
      ->setSetting('target_type', 'commerce_license')
      ->setSetting('handler', 'default')
      ->setCardinality(1)
      ->setRequired(FALSE)
      ->setDisplayConfigurable('form', FALSE)
      ->setDisplayConfigurable('view', FALSE);
    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.
OrderItemLicensed::buildFieldDefinitions	public	function	Builds the field definitions. Overrides EntityTraitBase::buildFieldDefinitions
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
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