class ClientIp in User restrictions 8

Defines a restriction type by client IP.

Plugin annotation

@UserRestrictionType(
  id = "client_ip",
  label = "Client IP",
  weight = 0
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\user_restrictions\Plugin\UserRestrictionType\UserRestrictionTypeBase implements UserRestrictionTypeInterface uses StringTranslationTrait
      • class \Drupal\user_restrictions\Plugin\UserRestrictionType\ClientIp

File

src/Plugin/UserRestrictionType/ClientIp.php, line 19

Namespace

Drupal\user_restrictions\Plugin\UserRestrictionType

class ClientIp extends UserRestrictionTypeBase {

  /**
   * The request stack.
   *
   * @var \Symfony\Component\HttpFoundation\RequestStack
   */
  protected $requestStack;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_manager, RequestStack $request_stack, LoggerInterface $logger) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $entity_manager, $logger);
    $this->requestStack = $request_stack;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('entity_type.manager'), $container
      ->get('request_stack'), $container
      ->get('logger.channel.user_restrictions'));
  }

  /**
   * {@inheritdoc}
   */
  public function matches(array $data) {
    $client_ip = $this->requestStack
      ->getCurrentRequest()
      ->getClientIp();
    $restriction = parent::matchesValue($client_ip);
    if ($restriction) {
      $this->logger
        ->notice('Restricted client IP %client_ip matching %restriction has been blocked.', [
        '%client_ip' => $client_ip,
        '%restriction' => $restriction
          ->toLink($restriction
          ->label(), 'edit-form'),
      ]);
    }
    return $restriction;
  }

  /**
   * {@inheritdoc}
   */
  public function getErrorMessage() {
    return $this
      ->t('Accessing the site from the IP %value is not allowed.', [
      '%value' => $this->requestStack
        ->getCurrentRequest()
        ->getClientIp(),
    ]);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ClientIp::$requestStack	protected	property	The request stack.
ClientIp::create	public static	function	Creates an instance of the plugin. Overrides UserRestrictionTypeBase::create
ClientIp::getErrorMessage	public	function	Get error message displayed to the user. Overrides UserRestrictionTypeBase::getErrorMessage
ClientIp::matches	public	function	Check if the given data matches the restriction. Overrides UserRestrictionTypeInterface::matches
ClientIp::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides UserRestrictionTypeBase::__construct
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
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
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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	3
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.	1
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.
UserRestrictionTypeBase::$entityStorage	protected	property	The entity storage interfacce.
UserRestrictionTypeBase::$logger	protected	property	The logger instance.
UserRestrictionTypeBase::$patterns	protected	property	List of patterns for the restriction type.
UserRestrictionTypeBase::getLabel	public	function	Get the plugin label. Overrides UserRestrictionTypeInterface::getLabel
UserRestrictionTypeBase::getPatterns	public	function	Get the list of regular expression patterns of the type. Overrides UserRestrictionTypeInterface::getPatterns
UserRestrictionTypeBase::matchesValue	protected	function	Check if the specified value matches the restriction.