You are here

class CommentNameConstraint in Zircon Profile 8.0

Same name and namespace in other branches
  1. 8 core/modules/comment/src/Plugin/Validation/Constraint/CommentNameConstraint.php \Drupal\comment\Plugin\Validation\Constraint\CommentNameConstraint

Supports validating comment author names.

Plugin annotation


@Constraint(
  id = "CommentName",
  label = @Translation("Comment author name", context = "Validation"),
  type = "entity:comment"
)

Hierarchy

Expanded class hierarchy of CommentNameConstraint

File

core/modules/comment/src/Plugin/Validation/Constraint/CommentNameConstraint.php, line 21
Contains \Drupal\comment\Plugin\Validation\Constraint\CommentNameConstraint.

Namespace

Drupal\comment\Plugin\Validation\Constraint
View source
class CommentNameConstraint extends CompositeConstraintBase {

  /**
   * Message shown when an anonymous user comments using a registered name.
   *
   * @var string
   */
  public $messageNameTaken = 'The name you used (%name) belongs to a registered user.';

  /**
   * Message shown when an admin changes the comment-author to an invalid user.
   *
   * @var string
   */
  public $messageRequired = 'You have to specify a valid author.';

  /**
   * Message shown when the name doesn't match the author's name.
   *
   * @var string
   */
  public $messageMatch = 'The specified author name does not match the comment author.';

  /**
   * {@inheritdoc}
   */
  public function coversFields() {
    return [
      'name',
      'uid',
    ];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CommentNameConstraint::$messageMatch public property Message shown when the name doesn't match the author's name.
CommentNameConstraint::$messageNameTaken public property Message shown when an anonymous user comments using a registered name.
CommentNameConstraint::$messageRequired public property Message shown when an admin changes the comment-author to an invalid user.
CommentNameConstraint::coversFields public function An array of entity fields which should be passed to the validator. Overrides CompositeConstraintBase::coversFields
Constraint::$errorNames protected static property Maps error codes to the names of their constants. 16
Constraint::$payload public property Domain-specific data attached to a constraint.
Constraint::addImplicitGroupName public function Adds the given group if this constraint is in the Default group. 1
Constraint::CLASS_CONSTRAINT constant Marks a constraint that can be put onto classes.
Constraint::DEFAULT_GROUP constant The name of the group given to all constraints with no explicit group.
Constraint::getDefaultOption public function Returns the name of the default option. 18
Constraint::getErrorName public static function Returns the name of the given error code.
Constraint::getRequiredOptions public function Returns the name of the required options. 11
Constraint::getTargets public function Returns whether the constraint can be put onto classes, properties or both. 11
Constraint::PROPERTY_CONSTRAINT constant Marks a constraint that can be put onto properties.
Constraint::validatedBy public function Returns the name of the class that validates this constraint. 11
Constraint::__construct public function Initializes the constraint with options. 11
Constraint::__get public function Returns the value of a lazily initialized option. 1
Constraint::__set public function Sets the value of a lazily initialized option. 1
Constraint::__sleep public function Optimizes the serialized value to minimize storage space.