class CommentNameConstraint

Same name in other branches
  1. 9 core/modules/comment/src/Plugin/Validation/Constraint/CommentNameConstraint.php \Drupal\comment\Plugin\Validation\Constraint\CommentNameConstraint
  2. 10 core/modules/comment/src/Plugin/Validation/Constraint/CommentNameConstraint.php \Drupal\comment\Plugin\Validation\Constraint\CommentNameConstraint
  3. 11.x 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

  • class \Drupal\Core\Entity\Plugin\Validation\Constraint\CompositeConstraintBase extends \Symfony\Component\Validator\Constraint
    • class \Drupal\comment\Plugin\Validation\Constraint\CommentNameConstraint extends \Drupal\Core\Entity\Plugin\Validation\Constraint\CompositeConstraintBase

Expanded class hierarchy of CommentNameConstraint

File

core/modules/comment/src/Plugin/Validation/Constraint/CommentNameConstraint.php, line 16

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

Title Modifiers Object type Summary Overriden Title
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

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.