class IpAddressField in IP address fields 8

Same name and namespace in other branches

2.0.x src/Plugin/Field/FieldType/IpAddressField.php \Drupal\field_ipaddress\Plugin\Field\FieldType\IpAddressField

Plugin implementation of the 'ipaddress' field type.

Plugin annotation


@FieldType(
  id = "ipaddress",
  label = @Translation("IP Address"),
  description = @Translation("Create and store IP addresses or ranges."),
  default_widget = "ipaddress_default",
  default_formatter = "ipaddress_default"
)

Hierarchy

class \Drupal\Core\TypedData\TypedData implements PluginInspectionInterface, TypedDataInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
- class \Drupal\Core\TypedData\Plugin\DataType\Map implements \Drupal\Core\TypedData\Plugin\DataType\IteratorAggregate, ComplexDataInterface
  - class \Drupal\Core\Field\FieldItemBase implements FieldItemInterface
    class \Drupal\field_ipaddress\Plugin\Field\FieldType\IpAddressField implements FieldItemInterface

Expanded class hierarchy of IpAddressField

File

src/Plugin/Field/FieldType/IpAddressField.php, line 25

Namespace

Drupal\field_ipaddress\Plugin\Field\FieldType

View source

class IpAddressField extends FieldItemBase implements FieldItemInterface {

  /**
   * {@inheritdoc}
   */
  public static function defaultStorageSettings() {
    return [] + parent::defaultStorageSettings();
  }

  /**
   * {@inheritdoc}
   */
  public static function propertyDefinitions(FieldStorageDefinitionInterface $field_definition) {
    $properties['ip_start'] = DataDefinition::create('any')
      ->setLabel(t('IP value minimum'))
      ->setDescription(t('The IP minimum value, as a binary number.'));
    $properties['ip_end'] = DataDefinition::create('any')
      ->setLabel(t('IP value maximum'))
      ->setDescription(t('The IP maximum value, as a binary number.'));
    return $properties;
  }

  /**
   * {@inheritdoc}
   */
  public static function schema(FieldStorageDefinitionInterface $field_definition) {
    return [
      'columns' => [
        // For IPv4 we store IP numbers as 4 byte binary (32 bit)
        // for IPv6 we store 16 byte binary (128 bit)
        // this follows the in_addr as used by the PHP function
        // inet_pton().
        'ip_start' => [
          'description' => 'The minimum IP address stored as a binary number.',
          'type' => 'blob',
          'size' => 'tiny',
          'mysql_type' => 'varbinary(16)',
          'not null' => TRUE,
          'binary' => TRUE,
        ],
        'ip_end' => [
          'description' => 'The maximum IP address stored as a binary number.',
          'type' => 'blob',
          'size' => 'tiny',
          'mysql_type' => 'varbinary(16)',
          'not null' => TRUE,
          'binary' => TRUE,
        ],
      ],
      'indexes' => [
        'ip_start' => [
          'ip_start',
        ],
        'ip_end' => [
          'ip_end',
        ],
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function generateSampleValue(FieldDefinitionInterface $field_definition) {

    // First random i IPv4 or IPv6.
    $family = rand(0, 1) == 1;

    // IPv6 contains 16 bytes, IPv4 contains 4 bytes.
    $bytes = $family == 1 ? 16 : 4;

    // Use a built in PHP function to generate random bytes.
    $values['ip_start'] = openssl_random_pseudo_bytes($bytes);

    // Extract first part excluding last byte.
    $values['ip_end'] = substr($values['ip_start'], 0, $bytes - 1);
    $last_byte = substr($values['ip_start'], -1);
    $from_last_number = end(unpack('C', $last_byte));
    $to_last_number = rand($from_last_number, 255);

    // Add last number.
    $values['ip_end'] .= pack('C', $to_last_number);
    return $values;
  }

  /**
   * {@inheritdoc}
   */
  public function isEmpty() {
    $value = $this
      ->get('ip_start')
      ->getValue();
    return $value === NULL || $value == '';
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultFieldSettings() {
    return [
      'allow_range' => TRUE,
      'allow_family' => 4,
      'ip4_range' => '',
      'ip6_range' => '',
    ] + parent::defaultFieldSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function fieldSettingsForm(array $form, FormStateInterface $form_state) {
    $element = [];
    $settings = $this
      ->getSettings();
    $element['allow_family'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('IP version(s) allowed'),
      '#options' => [
        IpAddress::IP_FAMILY_4 => $this
          ->t('IPv4'),
        IpAddress::IP_FAMILY_6 => $this
          ->t('IPv6'),
        IpAddress::IP_FAMILY_ALL => $this
          ->t('Both IPv4 and IPv6'),
      ],
      '#description' => $this
        ->t('Select the IP address family (or families) that are allowed.'),
      '#default_value' => $settings['allow_family'],
    ];
    $element['allow_range'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Allow IP Range'),
      '#default_value' => $settings['allow_range'],
    ];
    $element['ip4_range'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Allowed IPv4 range.'),
      '#description' => $this
        ->t('The range of IPv4 addresses to allow. Leave blank to allow any valid IPv4 address.'),
      '#states' => [
        'visible' => [
          [
            ':input[name="settings[allow_range]"]' => [
              'checked' => TRUE,
            ],
            ':input[name="settings[allow_family]"]' => [
              'value' => IpAddress::IP_FAMILY_4,
            ],
          ],
          [
            ':input[name="settings[allow_range]"]' => [
              'checked' => TRUE,
            ],
            ':input[name="settings[allow_family]"]' => [
              'value' => IpAddress::IP_FAMILY_ALL,
            ],
          ],
        ],
      ],
      '#default_value' => $settings['ip4_range'],
      '#element_validate' => [
        [
          $this,
          'validateIpAddressElement',
        ],
      ],
    ];
    $element['ip6_range'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Allowed IPv6 range.'),
      '#description' => $this
        ->t('The range of IPv6 addresses to allow. Leave blank to allow any valid IPv6 address.'),
      '#states' => [
        'visible' => [
          [
            ':input[name="settings[allow_range]"]' => [
              'checked' => TRUE,
            ],
            ':input[name="settings[allow_family]"]' => [
              'value' => IpAddress::IP_FAMILY_6,
            ],
          ],
          [
            ':input[name="settings[allow_range]"]' => [
              'checked' => TRUE,
            ],
            ':input[name="settings[allow_family]"]' => [
              'value' => IpAddress::IP_FAMILY_ALL,
            ],
          ],
        ],
      ],
      '#default_value' => $settings['ip6_range'],
      '#element_validate' => [
        [
          $this,
          'validateIpAddressElement',
        ],
      ],
    ];
    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) {
    $value = $form_state
      ->getValue($element['#parents']);
    if (trim($value) == '') {
      return;
    }

    // Instantiate our IP, will throw \Exception if invalid.
    try {
      $ip_address = new IpAddress($value);
    } catch (\Exception $e) {
      $form_state
        ->setError($element, t('Invalid IP or range.'));
      return;
    }

    // These fields can only accept IP ranges.
    if ($ip_address
      ->start() == $ip_address
      ->end()) {
      $form_state
        ->setError($element, t('Value must be an IP range.'));
    }
    if ($element['#name'] == 'settings[ip4_range]' && $ip_address
      ->family() != IpAddress::IP_FAMILY_4) {
      $form_state
        ->setError($element, t('Value must be an IPv4 range.'));
    }
    if ($element['#name'] == 'settings[ip6_range]' && $ip_address
      ->family() != IpAddress::IP_FAMILY_6) {
      $form_state
        ->setError($element, t('Value must be an IPv6 range.'));
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
FieldItemBase::calculateDependencies	public static	function	Calculates dependencies for field items. Overrides FieldItemInterface::calculateDependencies	2
FieldItemBase::calculateStorageDependencies	public static	function	Calculates dependencies for field items on the storage level. Overrides FieldItemInterface::calculateStorageDependencies	1
FieldItemBase::delete	public	function	Defines custom delete behavior for field values. Overrides FieldItemInterface::delete	2
FieldItemBase::deleteRevision	public	function	Defines custom revision delete behavior for field values. Overrides FieldItemInterface::deleteRevision
FieldItemBase::fieldSettingsFromConfigData	public static	function	Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface::fieldSettingsFromConfigData	1
FieldItemBase::fieldSettingsToConfigData	public static	function	Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface::fieldSettingsToConfigData	1
FieldItemBase::getEntity	public	function	Gets the entity that field belongs to. Overrides FieldItemInterface::getEntity
FieldItemBase::getFieldDefinition	public	function	Gets the field definition. Overrides FieldItemInterface::getFieldDefinition
FieldItemBase::getLangcode	public	function	Gets the langcode of the field values held in the object. Overrides FieldItemInterface::getLangcode
FieldItemBase::getSetting	protected	function	Returns the value of a field setting.
FieldItemBase::getSettings	protected	function	Returns the array of field settings.
FieldItemBase::mainPropertyName	public static	function	Returns the name of the main property, if any. Overrides FieldItemInterface::mainPropertyName	8
FieldItemBase::onDependencyRemoval	public static	function	Informs the plugin that a dependency of the field will be deleted. Overrides FieldItemInterface::onDependencyRemoval	1
FieldItemBase::postSave	public	function	Defines custom post-save behavior for field values. Overrides FieldItemInterface::postSave	2
FieldItemBase::preSave	public	function	Defines custom presave behavior for field values. Overrides FieldItemInterface::preSave	7
FieldItemBase::setValue	public	function	Sets the data value. Overrides Map::setValue	4
FieldItemBase::storageSettingsForm	public	function	Returns a form for the storage-level settings. Overrides FieldItemInterface::storageSettingsForm	8
FieldItemBase::storageSettingsFromConfigData	public static	function	Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface::storageSettingsFromConfigData	2
FieldItemBase::storageSettingsToConfigData	public static	function	Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface::storageSettingsToConfigData	2
FieldItemBase::view	public	function	Returns a renderable array for a single field item. Overrides FieldItemInterface::view
FieldItemBase::writePropertyValue	protected	function	Different to the parent Map class, we avoid creating property objects as far as possible in order to optimize performance. Thus we just update $this->values if no property object has been created yet. Overrides Map::writePropertyValue
FieldItemBase::__construct	public	function	Constructs a TypedData object given its definition and context. Overrides TypedData::__construct	1
FieldItemBase::__get	public	function	Magic method: Gets a property value. Overrides FieldItemInterface::__get	2
FieldItemBase::__isset	public	function	Magic method: Determines whether a property is set. Overrides FieldItemInterface::__isset
FieldItemBase::__set	public	function	Magic method: Sets a property value. Overrides FieldItemInterface::__set	1
FieldItemBase::__unset	public	function	Magic method: Unsets a property. Overrides FieldItemInterface::__unset
IpAddressField::defaultFieldSettings	public static	function	Defines the field-level settings for this plugin. Overrides FieldItemBase::defaultFieldSettings
IpAddressField::defaultStorageSettings	public static	function	Defines the storage-level settings for this plugin. Overrides FieldItemBase::defaultStorageSettings
IpAddressField::fieldSettingsForm	public	function	Returns a form for the field-level settings. Overrides FieldItemBase::fieldSettingsForm
IpAddressField::generateSampleValue	public static	function	Generates placeholder field values. Overrides FieldItemBase::generateSampleValue
IpAddressField::isEmpty	public	function	Determines whether the data structure is empty. Overrides Map::isEmpty
IpAddressField::propertyDefinitions	public static	function	Defines field item properties. Overrides FieldItemInterface::propertyDefinitions
IpAddressField::schema	public static	function	Returns the schema for the field. Overrides FieldItemInterface::schema
IpAddressField::validateIpAddressElement	public	function	Custom validator.
Map::$definition	protected	property	The data definition. Overrides TypedData::$definition
Map::$properties	protected	property	The array of properties.
Map::$values	protected	property	An array of values for the contained properties.
Map::applyDefaultValue	public	function	Applies the default value. Overrides TypedData::applyDefaultValue	4
Map::get	public	function	Gets a property object. Overrides ComplexDataInterface::get
Map::getIterator	public	function
Map::getProperties	public	function	Gets an array of property objects. Overrides ComplexDataInterface::getProperties
Map::getString	public	function	Returns a string representation of the data. Overrides TypedData::getString
Map::getValue	public	function	Gets the data value. Overrides TypedData::getValue	1
Map::onChange	public	function	Overrides TraversableTypedDataInterface::onChange	4
Map::set	public	function	Sets a property value. Overrides ComplexDataInterface::set
Map::toArray	public	function	Returns an array of all property values. Overrides ComplexDataInterface::toArray	1
Map::__clone	public	function	Magic method: Implements a deep clone.
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.
TypedData::$name	protected	property	The property name.
TypedData::$parent	protected	property	The parent typed data object.
TypedData::createInstance	public static	function	Constructs a TypedData object given its definition and context. Overrides TypedDataInterface::createInstance
TypedData::getConstraints	public	function	Gets a list of validation constraints. Overrides TypedDataInterface::getConstraints	9
TypedData::getDataDefinition	public	function	Gets the data definition. Overrides TypedDataInterface::getDataDefinition
TypedData::getName	public	function	Returns the name of a property or item. Overrides TypedDataInterface::getName
TypedData::getParent	public	function	Returns the parent data structure; i.e. either complex data or a list. Overrides TypedDataInterface::getParent
TypedData::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
TypedData::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
TypedData::getPropertyPath	public	function	Returns the property path of the data. Overrides TypedDataInterface::getPropertyPath
TypedData::getRoot	public	function	Returns the root of the typed data tree. Overrides TypedDataInterface::getRoot
TypedData::setContext	public	function	Sets the context of a property or item via a context aware parent. Overrides TypedDataInterface::setContext
TypedData::validate	public	function	Validates the currently set data value. Overrides TypedDataInterface::validate
TypedDataTrait::$typedDataManager	protected	property	The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager	public	function	Gets the typed data manager.	2
TypedDataTrait::setTypedDataManager	public	function	Sets the typed data manager.	2

You are here

class IpAddressField in IP address fields 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation