class BlockedIp

Same name and namespace in other branches
  1. 9 core/modules/ban/src/Plugin/migrate/destination/BlockedIp.php \Drupal\ban\Plugin\migrate\destination\BlockedIp
  2. 8.9.x core/modules/ban/src/Plugin/migrate/destination/BlockedIp.php \Drupal\ban\Plugin\migrate\destination\BlockedIp
  3. 11.x core/modules/ban/src/Plugin/migrate/destination/BlockedIp.php \Drupal\ban\Plugin\migrate\destination\BlockedIp

Destination for blocked IP addresses.

Hierarchy

Expanded class hierarchy of BlockedIp

1 file declares its use of BlockedIp
DestinationCategoryTest.php in core/modules/migrate_drupal/tests/src/Kernel/Plugin/migrate/DestinationCategoryTest.php
1 string reference to 'BlockedIp'
UserFloodSubscriber::getSubscribedEvents in core/modules/user/src/EventSubscriber/UserFloodSubscriber.php

File

core/modules/ban/src/Plugin/migrate/destination/BlockedIp.php, line 16

Namespace

Drupal\ban\Plugin\migrate\destination
View source
class BlockedIp extends DestinationBase implements ContainerFactoryPluginInterface {
  
  /**
   * The IP ban manager.
   *
   * @var \Drupal\ban\BanIpManagerInterface
   */
  protected $banManager;
  
  /**
   * Constructs a BlockedIp object.
   *
   * @param array $configuration
   *   Plugin configuration.
   * @param string $plugin_id
   *   The plugin ID.
   * @param mixed $plugin_definition
   *   The plugin definition.
   * @param \Drupal\migrate\Plugin\MigrationInterface $migration
   *   The current migration.
   * @param \Drupal\ban\BanIpManagerInterface $ban_manager
   *   The IP manager service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, BanIpManagerInterface $ban_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $migration);
    $this->banManager = $ban_manager;
  }
  
  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition, ?MigrationInterface $migration = NULL) {
    return new static($configuration, $plugin_id, $plugin_definition, $migration, $container->get('ban.ip_manager'));
  }
  
  /**
   * {@inheritdoc}
   */
  public function getIds() {
    return [
      'ip' => [
        'type' => 'string',
      ],
    ];
  }
  
  /**
   * {@inheritdoc}
   */
  public function fields() {
    return [
      'ip' => $this->t('The blocked IP address.'),
    ];
  }
  
  /**
   * {@inheritdoc}
   */
  public function import(Row $row, array $old_destination_id_values = []) {
    $this->banManager
      ->banIp($row->getDestinationProperty('ip'));
    return [
      'ip' => $row->getDestinationProperty('ip'),
    ];
  }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
BlockedIp::$banManager protected property The IP ban manager.
BlockedIp::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
BlockedIp::fields public function Returns an array of destination fields. Overrides MigrateDestinationInterface::fields
BlockedIp::getIds public function Gets the destination IDs. Overrides MigrateDestinationInterface::getIds
BlockedIp::import public function Import the row. Overrides MigrateDestinationInterface::import
BlockedIp::__construct public function Constructs a BlockedIp object. Overrides DestinationBase::__construct
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
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.