You are here

Home » API reference » Field Validation 8 » PlainTextFieldValidationRule.php

class PlainTextFieldValidationRule in Field Validation 8

PlainTextFieldValidationRule.

Plugin annotation


@FieldValidationRule(
  id = "plain_text_field_validation_rule",
  label = @Translation("Plain text (disallow tags)"),
  description = @Translation("Verifies that user-entered data doesn't contain HTML tags.")
)

Hierarchy

Expanded class hierarchy of PlainTextFieldValidationRule

File

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

Namespace

Drupal\field_validation\Plugin\FieldValidationRule
View source 
class PlainTextFieldValidationRule 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 [];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
  }
  public function validate($params) {
    $value = isset($params['value']) ? $params['value'] : '';
    $rule = isset($params['rule']) ? $params['rule'] : null;
    $context = isset($params['context']) ? $params['context'] : null;
    if ($value != '' && strcmp($value, strip_tags($value))) {
      $context
        ->addViolation($rule
        ->getErrorMessage());
    }
  }

}

Members

Namesort descending 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
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PlainTextFieldValidationRule::addFieldValidationRule public function Applies a field_validation_rule to the field_validation_rule_set. Overrides FieldValidationRuleInterface::addFieldValidationRule
PlainTextFieldValidationRule::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm
PlainTextFieldValidationRule::defaultConfiguration public function Gets default configuration for this plugin. Overrides FieldValidationRuleBase::defaultConfiguration
PlainTextFieldValidationRule::getSummary public function Returns a render array summarizing the configuration of the field_validation_rule. Overrides FieldValidationRuleBase::getSummary
PlainTextFieldValidationRule::submitConfigurationForm public function Form submission handler. Overrides ConfigurableFieldValidationRuleBase::submitConfigurationForm
PlainTextFieldValidationRule::validate public function Overrides FieldValidationRuleBase::validate
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.