class IpFieldValidationRule in Field Validation 8

IpFieldValidationRule.

Plugin annotation


@FieldValidationRule(
  id = "ip_field_validation_rule",
  label = @Translation("IP"),
  description = @Translation("Verifies that user-entered values are IP address.")
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\field_validation\FieldValidationRuleBase implements ContainerFactoryPluginInterface, FieldValidationRuleInterface
    class \Drupal\field_validation\ConfigurableFieldValidationRuleBase implements ConfigurableFieldValidationRuleInterface
    class \Drupal\field_validation\Plugin\FieldValidationRule\IpFieldValidationRule

Expanded class hierarchy of IpFieldValidationRule

File

src/Plugin/FieldValidationRule/IpFieldValidationRule.php, line 18

Namespace

Drupal\field_validation\Plugin\FieldValidationRule

View source

class IpFieldValidationRule extends ConfigurableFieldValidationRuleBase {

  /**
   * {@inheritdoc}
   */
  public function addFieldValidationRule(FieldValidationRuleSetInterface $field_validation_rule_set) {
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function getSummary() {
    $summary = parent::getSummary();
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'version' => NULL,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['version'] = [
      '#title' => $this
        ->t('IP Version'),
      '#type' => 'select',
      '#options' => [
        '4' => $this
          ->t('V4'),
        '6' => $this
          ->t('V6'),
        'all' => $this
          ->t('ALL'),
        '4_no_priv' => $this
          ->t('V4_NO_PRIV'),
        '6_no_priv' => $this
          ->t('V6_NO_PRIV'),
        'all_no_priv' => $this
          ->t('ALL_NO_PRIV'),
        '4_no_res' => $this
          ->t('V4_NO_RES'),
        '6_no_res' => $this
          ->t('V6_NO_RES'),
        'all_no_res' => $this
          ->t('ALL_NO_RES'),
        '4_public' => $this
          ->t('V4_ONLY_PUBLIC'),
        '6_public' => $this
          ->t('V6_ONLY_PUBLIC'),
        'all_public' => $this
          ->t('ALL_ONLY_PUBLIC'),
      ],
      '#default_value' => $this->configuration['version'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    $this->configuration['version'] = $form_state
      ->getValue('version');
  }
  public function validate($params) {
    $value = isset($params['value']) ? $params['value'] : '';
    $rule = isset($params['rule']) ? $params['rule'] : null;
    $context = isset($params['context']) ? $params['context'] : null;
    $settings = array();
    if (!empty($rule) && !empty($rule->configuration)) {
      $settings = $rule->configuration;
    }
    if ($value !== '' && !is_null($value)) {
      $version = isset($settings['version']) ? $settings['version'] : '';
      switch ($version) {
        case '4':
          $flag = FILTER_FLAG_IPV4;
          break;
        case '6':
          $flag = FILTER_FLAG_IPV6;
          break;
        case '4_no_priv':
          $flag = FILTER_FLAG_IPV4 | FILTER_FLAG_NO_PRIV_RANGE;
          break;
        case '6_no_priv':
          $flag = FILTER_FLAG_IPV6 | FILTER_FLAG_NO_PRIV_RANGE;
          break;
        case 'all_no_priv':
          $flag = FILTER_FLAG_NO_PRIV_RANGE;
          break;
        case '4_no_res':
          $flag = FILTER_FLAG_IPV4 | FILTER_FLAG_NO_RES_RANGE;
          break;
        case '6_no_res':
          $flag = FILTER_FLAG_IPV6 | FILTER_FLAG_NO_RES_RANGE;
          break;
        case 'all_no_res':
          $flag = FILTER_FLAG_NO_RES_RANGE;
          break;
        case '4_public':
          $flag = FILTER_FLAG_IPV4 | FILTER_FLAG_NO_PRIV_RANGE | FILTER_FLAG_NO_RES_RANGE;
          break;
        case '6_public':
          $flag = FILTER_FLAG_IPV6 | FILTER_FLAG_NO_PRIV_RANGE | FILTER_FLAG_NO_RES_RANGE;
          break;
        case 'all_public':
          $flag = FILTER_FLAG_NO_PRIV_RANGE | FILTER_FLAG_NO_RES_RANGE;
          break;
        default:
          $flag = NULL;
          break;
      }
      if (!filter_var($value, FILTER_VALIDATE_IP, $flag)) {
        $context
          ->addViolation($rule
          ->getErrorMessage());
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurableFieldValidationRuleBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
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
FieldValidationRuleBase::$column	protected	property	The column of the FieldValidationRule.
FieldValidationRuleBase::$error_message	protected	property	The error message of the FieldValidationRule.
FieldValidationRuleBase::$field_name	protected	property	The field name of the FieldValidationRule.
FieldValidationRuleBase::$logger	protected	property	A logger instance.
FieldValidationRuleBase::$title	protected	property	The title of the FieldValidationRule.
FieldValidationRuleBase::$uuid	protected	property	The FieldValidationRule ID.
FieldValidationRuleBase::$weight	protected	property	The weight of the FieldValidationRule.
FieldValidationRuleBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
FieldValidationRuleBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
FieldValidationRuleBase::getColumn	public	function	Returns the column of the field_validation_rule. Overrides FieldValidationRuleInterface::getColumn
FieldValidationRuleBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
FieldValidationRuleBase::getDerivativeExtension	public	function	Returns the extension the derivative would have have after adding this field_validation_rule. Overrides FieldValidationRuleInterface::getDerivativeExtension
FieldValidationRuleBase::getErrorMessage	public	function	Returns the error message of the field_validation_rule. Overrides FieldValidationRuleInterface::getErrorMessage
FieldValidationRuleBase::getFieldName	public	function	Returns the field name of the field_validation_rule. Overrides FieldValidationRuleInterface::getFieldName
FieldValidationRuleBase::getTitle	public	function	Returns the title of the field_validation_rule. Overrides FieldValidationRuleInterface::getTitle
FieldValidationRuleBase::getUuid	public	function	Returns the unique ID representing the field_validation_rule. Overrides FieldValidationRuleInterface::getUuid
FieldValidationRuleBase::getWeight	public	function	Returns the weight of the field_validation_rule. Overrides FieldValidationRuleInterface::getWeight
FieldValidationRuleBase::label	public	function	Returns the field_validation_rule label. Overrides FieldValidationRuleInterface::label
FieldValidationRuleBase::setColumn	public	function	Sets the column for this field_validation_rule. Overrides FieldValidationRuleInterface::setColumn
FieldValidationRuleBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
FieldValidationRuleBase::setErrorMessage	public	function	Sets the error message for this field_validation_rule. Overrides FieldValidationRuleInterface::setErrorMessage
FieldValidationRuleBase::setFieldName	public	function	Sets the field name for this field_validation_rule. Overrides FieldValidationRuleInterface::setFieldName
FieldValidationRuleBase::setTitle	public	function	Sets the title for this field_validation_rule. Overrides FieldValidationRuleInterface::setTitle
FieldValidationRuleBase::setWeight	public	function	Sets the weight for this field_validation_rule. Overrides FieldValidationRuleInterface::setWeight
FieldValidationRuleBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
IpFieldValidationRule::addFieldValidationRule	public	function	Applies a field_validation_rule to the field_validation_rule_set. Overrides FieldValidationRuleInterface::addFieldValidationRule
IpFieldValidationRule::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm
IpFieldValidationRule::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides FieldValidationRuleBase::defaultConfiguration
IpFieldValidationRule::getSummary	public	function	Returns a render array summarizing the configuration of the field_validation_rule. Overrides FieldValidationRuleBase::getSummary
IpFieldValidationRule::submitConfigurationForm	public	function	Form submission handler. Overrides ConfigurableFieldValidationRuleBase::submitConfigurationForm
IpFieldValidationRule::validate	public	function	Overrides FieldValidationRuleBase::validate
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.

You are here

class IpFieldValidationRule in Field Validation 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation