class BlockedIp
Same name and namespace in other branches
- 11.x core/modules/ban/src/Plugin/migrate/destination/BlockedIp.php \Drupal\ban\Plugin\migrate\destination\BlockedIp
Destination for blocked IP addresses.
Plugin annotation
@MigrateDestination(
id = "blocked_ip"
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
- class \Drupal\migrate\Plugin\migrate\destination\DestinationBase extends \Drupal\migrate\Plugin\MigrateDestinationInterface, \Drupal\migrate\Plugin\RequirementsInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\ban\Plugin\migrate\destination\BlockedIp extends \Drupal\Core\Plugin\ContainerFactoryPluginInterface implements \Drupal\migrate\Plugin\migrate\destination\DestinationBase
- class \Drupal\migrate\Plugin\migrate\destination\DestinationBase extends \Drupal\migrate\Plugin\MigrateDestinationInterface, \Drupal\migrate\Plugin\RequirementsInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
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 19
Namespace
Drupal\ban\Plugin\migrate\destinationView 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'),
];
}
}Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.