class PhoneNumberSettings in SMS Framework 8

Destination plugin for SMS phone number verifications.

Plugin annotation

@MigrateDestination(
  id = "entity:phone_number_settings"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\migrate\Plugin\migrate\destination\DestinationBase implements MigrateDestinationInterface, RequirementsInterface
      • class \Drupal\migrate\Plugin\migrate\destination\Entity implements DependentPluginInterface, ContainerFactoryPluginInterface uses DependencyTrait, EntityFieldDefinitionTrait
        • class \Drupal\migrate\Plugin\migrate\destination\EntityConfigBase
          • class \Drupal\sms\Plugin\migrate\destination\PhoneNumberSettings

File

src/Plugin/migrate/destination/PhoneNumberSettings.php, line 19

Namespace

Drupal\sms\Plugin\migrate\destination

class PhoneNumberSettings extends EntityConfigBase {

  /**
   * {@inheritdoc}
   */
  public function import(Row $row, array $old_destination_id_values = []) {
    $return = parent::import($row, $old_destination_id_values);
    if ($return) {

      // After successful import of the phone_number_setting, the phone number
      // field should be created and attached to the user entity type.

      /** @var \Drupal\sms\Entity\PhoneNumberSettingsInterface $phone_number_setting */
      $phone_number_setting = $this->storage
        ->load(reset($return));
      $this
        ->createPhoneNumberField($phone_number_setting);
    }
    return $return;
  }

  /**
   * {@inheritdoc}
   */
  public function rollback(array $destination_identifier) {

    /** @var \Drupal\sms\Entity\PhoneNumberSettingsInterface $phone_number_settings */
    $phone_number_settings = $this->storage
      ->load(reset($destination_identifier));
    $entity_type_id = $phone_number_settings
      ->getPhoneNumberEntityTypeId();
    $bundle = $phone_number_settings
      ->getPhoneNumberBundle();
    $field_name = $phone_number_settings
      ->getFieldName('phone_number');

    // Delete entity form display component.
    $entity_form_display = EntityFormDisplay::load($entity_type_id . '.' . $bundle . '.default');
    if ($entity_form_display) {
      $entity_form_display
        ->removeComponent($field_name);
    }

    // Delete the field storage and field instance.
    FieldStorageConfig::loadByName($entity_type_id, $field_name)
      ->delete();

    // Remove the phone number settings.
    parent::rollback($destination_identifier);
  }

  /**
   * Creates a phone number field.
   *
   * @param \Drupal\sms\Entity\PhoneNumberSettingsInterface $phone_number_settings
   *   The phone number settings for a given entity type.
   *
   * @see \Drupal\sms\Form\PhoneNumberSettingsForm::createNewField()
   */
  protected function createPhoneNumberField(PhoneNumberSettingsInterface $phone_number_settings) {
    PhoneNumberSettingsForm::createNewField($phone_number_settings
      ->getPhoneNumberEntityTypeId(), $phone_number_settings
      ->getPhoneNumberBundle(), $phone_number_settings
      ->getFieldName('phone_number'));
  }

}

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
DependencyTrait::$dependencies	protected	property	The object's dependencies.
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency.
DestinationBase::$migration	protected	property	The migration.
DestinationBase::$rollbackAction	protected	property	The rollback action to be saved for the last imported item.
DestinationBase::$supportsRollback	protected	property	Indicates whether the destination can be rolled back.
DestinationBase::checkRequirements	public	function	Checks if requirements for this plugin are OK. Overrides RequirementsInterface::checkRequirements
DestinationBase::getDestinationModule	public	function	Gets the destination module handling the destination data. Overrides MigrateDestinationInterface::getDestinationModule	1
DestinationBase::rollbackAction	public	function	The rollback action for the last imported item. Overrides MigrateDestinationInterface::rollbackAction
DestinationBase::setRollbackAction	protected	function	For a destination item being updated, set the appropriate rollback action.
DestinationBase::supportsRollback	public	function	Whether the destination can be rolled back or not. Overrides MigrateDestinationInterface::supportsRollback
Entity::$bundles	protected	property	The list of the bundles of this entity type.
Entity::$storage	protected	property	The entity storage.
Entity::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
Entity::fields	public	function	Returns an array of destination fields. Overrides MigrateDestinationInterface::fields
Entity::getBundle	public	function	Gets the bundle for the row taking into account the default.
Entity::getEntity	protected	function	Creates or loads an entity.	5
Entity::getEntityId	protected	function	Gets the entity ID of the row.	2
Entity::getKey	protected	function	Returns a specific entity key.
EntityConfigBase::$configFactory	protected	property	The configuration factory.
EntityConfigBase::$languageManager	protected	property	The language manager.
EntityConfigBase::create	public static	function	Creates an instance of the plugin. Overrides Entity::create	2
EntityConfigBase::generateId	protected	function	Generates an entity ID.
EntityConfigBase::getIds	public	function	Gets the destination IDs. Overrides MigrateDestinationInterface::getIds	3
EntityConfigBase::isTranslationDestination	protected	function	Get whether this destination is for translations.
EntityConfigBase::updateEntity	protected	function	Updates an entity with the contents of a row.	1
EntityConfigBase::updateEntityProperty	protected	function	Updates a (possible nested) entity property with a value.	1
EntityConfigBase::__construct	public	function	Construct a new entity. Overrides Entity::__construct	2
EntityFieldDefinitionTrait::getDefinitionFromEntity	protected	function	Gets the field definition from a specific entity base field.
EntityFieldDefinitionTrait::getEntityTypeId	protected static	function	Finds the entity type from configuration or plugin ID.	5
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PhoneNumberSettings::createPhoneNumberField	protected	function	Creates a phone number field.
PhoneNumberSettings::import	public	function	Import the row. Overrides EntityConfigBase::import
PhoneNumberSettings::rollback	public	function	Delete the specified destination object from the target Drupal. Overrides EntityConfigBase::rollback
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.