You are here

Home » API reference » IP address fields 8 » IpAddressWidgetBase.php

class IpAddressWidgetBase in IP address fields 8

Same name and namespace in other branches
  1. 2.0.x src/Plugin/Field/FieldWidget/IpAddressWidgetBase.php \Drupal\field_ipaddress\Plugin\Field\FieldWidget\IpAddressWidgetBase

Base class for the 'ipaddress_*' widgets.

Hierarchy

Expanded class hierarchy of IpAddressWidgetBase

File

src/Plugin/Field/FieldWidget/IpAddressWidgetBase.php, line 14

Namespace

Drupal\field_ipaddress\Plugin\Field\FieldWidget
View source 
class IpAddressWidgetBase extends WidgetBase {

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $element = [
      'value' => $element + [
        '#type' => 'textfield',
      ],
    ];
    $element['#element_validate'] = [
      [
        $this,
        'validateIpAddressElement',
      ],
    ];
    $value = $items[$delta]
      ->getValue();
    if (!empty($value['ip_start'])) {
      $element['value']['#default_value'] = inet_ntop($value['ip_start']);
      if ($value['ip_start'] != $value['ip_end']) {
        $element['value']['#default_value'] .= '-' . inet_ntop($value['ip_end']);
      }
    }
    return $element;
  }

  /**
   * Custom validator.
   *
   * @param array $element
   *   The element being validated.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Current form state.
   * @param array $form
   *   Current form.
   */
  public function validateIpAddressElement(array &$element, FormStateInterface $form_state, array $form) {
    $settings = $this->fieldDefinition
      ->getSettings();
    $value = trim($element['value']['#value']);
    if ($value === '') {
      return;
    }

    // Instantiate our IP, will throw \Exception if invalid.
    try {
      $ip_address = new IpAddress($value);
    } catch (\Exception $e) {

      // Make error messages a bit more relevant.
      if ($settings['allow_range']) {
        $form_state
          ->setError($element, t('Invalid IP or range.'));
      }
      else {
        $form_state
          ->setError($element, t('Invalid IP.'));
      }
      return;
    }
    if (!$settings['allow_range'] && $ip_address
      ->start() != $ip_address
      ->end()) {
      $form_state
        ->setError($element, t('Ranges not allowed, single IP only.'));
    }
    if ($settings['allow_family'] != IpAddress::IP_FAMILY_ALL && $settings['allow_family'] != $ip_address
      ->family()) {
      if ($settings['allow_family'] == IpAddress::IP_FAMILY_4) {
        $form_state
          ->setError($element, t('Only IPv4 addresses allowed.'));
      }
      else {
        $form_state
          ->setError($element, t('Only IPv6 addresses allowed.'));
      }
    }
    if ($settings['ip4_range'] && $ip_address
      ->family() == IpAddress::IP_FAMILY_4) {

      // No validation for $ip4_range here, it should have already been done
      // on field settings form.
      $range = new IpAddress($settings['ip4_range']);
      if (!$ip_address
        ->inRange($range
        ->start(), $range
        ->end())) {
        $form_state
          ->setError($element, t('IP must be within the range @min-@max', [
          '@min' => $range
            ->start(),
          '@max' => $range
            ->end(),
        ]));
      }
    }
    if ($settings['ip6_range'] && $ip_address
      ->family() == IpAddress::IP_FAMILY_6) {

      // No validation for $ip6_range here, it should have already been done
      // on field settings form.
      $range = new IpAddress($settings['ip6_range']);
      if (!$ip_address
        ->inRange($range
        ->start(), $range
        ->end())) {
        $form_state
          ->setError($element, t('IP must be within the range @min-@max', [
          '@min' => $range
            ->start(),
          '@max' => $range
            ->end(),
        ]));
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function massageFormValues(array $values, array $form, FormStateInterface $form_state) {

    // Convert to storage format.
    foreach ($values as &$item) {
      if (!empty($value = trim($item['value']))) {
        $value = new IpAddress($value);
        $item['ip_start'] = inet_pton($value
          ->start());
        $item['ip_end'] = inet_pton($value
          ->end());
      }
    }
    return $values;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AllowedTagsXssTrait::allowedTags public function Returns a list of tags allowed by AllowedTagsXssTrait::fieldFilterXss().
AllowedTagsXssTrait::displayAllowedTags public function Returns a human-readable list of allowed tags for display in help texts.
AllowedTagsXssTrait::fieldFilterXss public function Filters an HTML string to prevent XSS vulnerabilities.
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
IpAddressWidgetBase::formElement public function Returns the form for a single field widget. Overrides WidgetInterface::formElement 1
IpAddressWidgetBase::massageFormValues public function Massages the form values into the format expected for field values. Overrides WidgetBase::massageFormValues
IpAddressWidgetBase::validateIpAddressElement public function Custom validator.
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.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsInterface::defaultSettings 42
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
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.
WidgetBase::$fieldDefinition protected property The field definition.
WidgetBase::$settings protected property The widget settings. Overrides PluginSettingsBase::$settings
WidgetBase::addMoreAjax public static function Ajax callback for the "Add another item" button.
WidgetBase::addMoreSubmit public static function Submission handler for the "Add another item" button.
WidgetBase::afterBuild public static function After-build handler for field elements in a form.
WidgetBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 5
WidgetBase::errorElement public function Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface::errorElement 8
WidgetBase::extractFormValues public function Extracts field values from submitted form values. Overrides WidgetBaseInterface::extractFormValues 2
WidgetBase::flagErrors public function Reports field-level validation errors against actual form elements. Overrides WidgetBaseInterface::flagErrors 2
WidgetBase::form public function Creates a form element for a field. Overrides WidgetBaseInterface::form 3
WidgetBase::formMultipleElements protected function Special handling to create form elements for multiple values. 1
WidgetBase::formSingleElement protected function Generates the form element for a single copy of the widget.
WidgetBase::getFieldSetting protected function Returns the value of a field setting.
WidgetBase::getFieldSettings protected function Returns the array of field settings.
WidgetBase::getFilteredDescription protected function Returns the filtered field description.
WidgetBase::getWidgetState public static function Retrieves processing information about the widget from $form_state. Overrides WidgetBaseInterface::getWidgetState
WidgetBase::getWidgetStateParents protected static function Returns the location of processing information within $form_state.
WidgetBase::handlesMultipleValues protected function Returns whether the widget handles multiple values.
WidgetBase::isApplicable public static function Returns if the widget can be used for the provided field. Overrides WidgetInterface::isApplicable 4
WidgetBase::isDefaultValueWidget protected function Returns whether the widget used for default value form.
WidgetBase::settingsForm public function Returns a form to configure settings for the widget. Overrides WidgetInterface::settingsForm 16
WidgetBase::settingsSummary public function Returns a short summary for the current widget settings. Overrides WidgetInterface::settingsSummary 15
WidgetBase::setWidgetState public static function Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState
WidgetBase::__construct public function Constructs a WidgetBase object. Overrides PluginBase::__construct 5