class Required in Clientside Validation 8

Provides a 'required' validator.

Plugin annotation

@CvValidator(
  id = "required",
  name = @Translation("Required"),
  supports = {
    "attributes" = {"required", "states"}
  }
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\clientside_validation\CvValidatorBase implements CvValidatorInterface uses StringTranslationTrait
    • class \Drupal\clientside_validation\Plugin\CvValidator\Required

File

src/Plugin/CvValidator/Required.php, line 19

Namespace

Drupal\clientside_validation\Plugin\CvValidator

class Required extends CvValidatorBase {

  /**
   * An array of conditionally required states.
   *
   * @var array
   */
  protected $states = [
    'required' => 'required',
    'optional' => 'optional',
    '!required' => '!required',
    '!optional' => '!optional',
  ];

  /**
   * {@inheritdoc}
   */
  protected function getRules($element, FormStateInterface $form_state) {
    $is_required = $this
      ->getAttributeValue($element, 'required');
    $states = $this
      ->getAttributeValue($element, 'states') ?: [];
    if (is_array($states)) {
      $is_conditionally_required = array_diff_key($this->states, $states);
    }
    else {
      $is_conditionally_required = $this->states;
    }

    // Drupal already adds the required attribute, so we don't need to set the
    // required rule.
    if ($is_required || $is_conditionally_required) {
      $message = $element['#required_error'] ?? $this
        ->t('@title is required.', [
        '@title' => $this
          ->getElementTitle($element),
      ]);
      return [
        'messages' => [
          'required' => $message,
        ],
      ];
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CvValidatorBase::addValidation	public	function	Makes the necessary changes to the form element so it can be validated. Overrides CvValidatorInterface::addValidation	1
CvValidatorBase::getAttributeValue	protected	function	Get the value of an attribute of an element.
CvValidatorBase::getElementTitle	protected	function	Get title for form element.
CvValidatorBase::getName	public	function	Return the name of the validator flavor. Overrides CvValidatorInterface::getName
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
Required::$states	protected	property	An array of conditionally required states.
Required::getRules	protected	function	Get the validation rules for this form element. Overrides CvValidatorBase::getRules
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.