class LicenseWithField in Commerce License 8.2

License type for testing a field can be set when granting and revoking.

Plugin annotation

@CommerceLicenseType(
  id = "with_field",
  label = @Translation("License with field"),
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\commerce_license\Plugin\Commerce\LicenseType\LicenseTypeBase implements LicenseTypeInterface
      • class \Drupal\commerce_license_test\Plugin\Commerce\LicenseType\TestLicenseBase
        • class \Drupal\commerce_license_test\Plugin\Commerce\LicenseType\LicenseWithField

File

tests/modules/commerce_license_test/src/Plugin/Commerce/LicenseType/LicenseWithField.php, line 16

Namespace

Drupal\commerce_license_test\Plugin\Commerce\LicenseType

class LicenseWithField extends TestLicenseBase {

  /**
   * {@inheritdoc}
   */
  public function grantLicense(LicenseInterface $license) {

    // Set the value on our field.
    $license
      ->set('test_field', 'granted');
  }

  /**
   * {@inheritdoc}
   */
  public function revokeLicense(LicenseInterface $license) {

    // Set the value on our field.
    $license
      ->set('test_field', 'revoked');
  }

  /**
   * {@inheritdoc}
   */
  public function buildFieldDefinitions() {
    $fields = parent::buildFieldDefinitions();
    $fields['test_field'] = BundleFieldDefinition::create('text')
      ->setLabel(t('Test field'))
      ->setDescription(t('A test field that this plugin will set values on.'))
      ->setCardinality(1);
    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
LicenseTypeBase::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm	1
LicenseTypeBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
LicenseTypeBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration	1
LicenseTypeBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
LicenseTypeBase::getLabel	public	function	Gets the license type label. Overrides LicenseTypeInterface::getLabel
LicenseTypeBase::getWorkflowId	public	function	Gets the workflow ID this this license type should use. Overrides LicenseTypeInterface::getWorkflowId
LicenseTypeBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
LicenseTypeBase::setConfigurationValuesOnLicense	public	function	Copy configuration values to a license entity. Overrides LicenseTypeInterface::setConfigurationValuesOnLicense
LicenseTypeBase::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm	1
LicenseTypeBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm	1
LicenseTypeBase::__construct	public	function	Constructs a new plugin instance. Overrides PluginBase::__construct
LicenseWithField::buildFieldDefinitions	public	function	Builds the field definitions for entities of this bundle. Overrides LicenseTypeBase::buildFieldDefinitions
LicenseWithField::grantLicense	public	function	Reacts to the license being activated. Overrides TestLicenseBase::grantLicense
LicenseWithField::revokeLicense	public	function	Reacts to the license being revoked. Overrides TestLicenseBase::revokeLicense
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.
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.
TestLicenseBase::buildLabel	public	function	Builds a label for the given license. Overrides LicenseTypeInterface::buildLabel