class BlockedIp

Destination for blocked IP addresses.

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
  - class \Drupal\migrate\Plugin\migrate\destination\DestinationBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\migrate\Plugin\MigrateDestinationInterface, \Drupal\migrate\Plugin\RequirementsInterface
    - class \Drupal\ban\Plugin\migrate\destination\BlockedIp extends \Drupal\migrate\Plugin\migrate\destination\DestinationBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface

Expanded class hierarchy of BlockedIp

1 string reference to 'BlockedIp'

UserFloodSubscriber::getSubscribedEvents in core/modules/user/src/EventSubscriber/UserFloodSubscriber.php: Returns an array of event names this subscriber wants to listen to.

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.		5
PluginInspectionInterface::getPluginId	public	function	Gets the plugin ID of the plugin instance.		2