You are here

class BlockedIP in Zircon Profile 8.0

Same name and namespace in other branches
  1. 8 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

Expanded class hierarchy of BlockedIP

File

core/modules/ban/src/Plugin/migrate/destination/BlockedIp.php, line 24
Contains \Drupal\ban\Plugin\migrate\destination\BlockedIP.

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 definiiton.
   * @param \Drupal\migrate\Entity\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(MigrationInterface $migration = NULL) {
    return [
      'ip' => $this
        ->t('The blocked IP address.'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function import(Row $row, array $old_destination_id_values = array()) {
    $this->banManager
      ->banIp($row
      ->getDestinationProperty('ip'));
  }

}

Members

Namesort descending Modifiers Type Description 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 Get 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
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
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::rollback public function Delete the specified destination object from the target Drupal. Overrides MigrateDestinationInterface::rollback 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
PluginBase::$configuration protected property Configuration information passed into the plugin. 2
PluginBase::$pluginDefinition protected property The plugin implementation definition.
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
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
StringTranslationTrait::$stringTranslation protected property The string translation service.
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.