class Agreement in Agreement 3.0.x

Agreement migrate destination plugin.

Plugin annotation

@MigrateDestination(
  id = "agreement",
  destination_module = "agreement",
)

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\agreement\Plugin\migrate\destination\Agreement implements ContainerFactoryPluginInterface

7 string references to 'Agreement'

agreement.info.yml in ./agreement.info.yml

agreement.info.yml

agreement.schema.yml in config/schema/agreement.schema.yml

config/schema/agreement.schema.yml

agreement.views.schema.yml in config/schema/agreement.views.schema.yml

config/schema/agreement.views.schema.yml

AgreementType::fields in src/Plugin/migrate/source/d7/AgreementType.php

Returns available fields on the source.

agreement_views_data in ./agreement.views.inc

Implements hook_views_data().

... See full list

File

src/Plugin/migrate/destination/Agreement.php, line 23

Namespace

Drupal\agreement\Plugin\migrate\destination

class Agreement extends DestinationBase implements ContainerFactoryPluginInterface {

  /**
   * Database connection.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $connection;

  /**
   * Initialize method.
   *
   * @param array $configuration
   *   The plugin configuration array.
   * @param string $plugin_id
   *   The plugin ID.
   * @param array $plugin_definition
   *   The plugin definition array.
   * @param \Drupal\migrate\Plugin\MigrationInterface $migration
   *   The migration.
   * @param \Drupal\Core\Database\Connection $connection
   *   The database connection.
   */
  public function __construct(array $configuration, $plugin_id, array $plugin_definition, MigrationInterface $migration, Connection $connection) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $migration);
    $this->connection = $connection;
  }

  /**
   * {@inheritdoc}
   */
  public function getIds() {
    return [
      'id' => [
        'type' => 'integer',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function fields(MigrationInterface $migration = NULL) {
    return [
      'id' => $this
        ->t('Unique Identifier'),
      'type' => $this
        ->t('Agreement type name'),
      'uid' => $this
        ->t('User Identifier'),
      'sid' => $this
        ->t('Session Identifier'),
      'agreed' => $this
        ->t('Agreed?'),
      'agreed_date' => $this
        ->t('Agreement timestamp'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function import(Row $row, array $old_destination_id_values = []) {
    $values = array_intersect_key($row
      ->getDestination(), $this
      ->fields());
    try {
      $status = $this->connection
        ->merge('agreement')
        ->key('id')
        ->fields($values)
        ->execute();
    } catch (DatabaseExceptionWrapper $e) {
      throw new MigrateSkipProcessException($e
        ->getMessage());
    }
    return $status ? [
      $row
        ->getDestinationProperty('id'),
    ] : NULL;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration = NULL) {
    $db_key = !empty($configuration['database_key']) ? $configuration['database_key'] : NULL;
    return new static($configuration, $plugin_id, $plugin_definition, $migration, Database::getConnection('default', $db_key));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Agreement::$connection	protected	property	Database connection.
Agreement::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
Agreement::fields	public	function	Returns an array of destination fields. Overrides MigrateDestinationInterface::fields
Agreement::getIds	public	function	Gets the destination IDs. Overrides MigrateDestinationInterface::getIds
Agreement::import	public	function	Import the row. Overrides MigrateDestinationInterface::import
Agreement::__construct	public	function	Initialize method. Overrides DestinationBase::__construct
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
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::rollback	public	function	Delete the specified destination object from the target Drupal. Overrides MigrateDestinationInterface::rollback	2
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
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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	2
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.	4
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.