class CommentNameConstraint

Supports validating comment author names.

Hierarchy

class \Symfony\Component\Validator\Constraint
- 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 12

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 Sort descending	Modifiers	Object type	Summary	Overriden Title	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::$groups	public	property	The groups that the constraint belongs to.
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.		2
Constraint::CLASS_CONSTRAINT	public	constant	Marks a constraint that can be put onto classes.
Constraint::DEFAULT_GROUP	public	constant	The name of the group given to all constraints with no explicit group.
Constraint::ERROR_NAMES	protected	constant	Maps error codes to the names of their constants.		59
Constraint::getDefaultOption	public	function	Returns the name of the default option.		28
Constraint::getErrorName	public static	function	Returns the name of the given error code.
Constraint::getRequiredOptions	public	function	Returns the name of the required options.		22
Constraint::getTargets	public	function	Returns whether the constraint can be put onto classes, properties or both.		8
Constraint::normalizeOptions	protected	function
Constraint::PROPERTY_CONSTRAINT	public	constant	Marks a constraint that can be put onto properties.
Constraint::validatedBy	public	function	Returns the name of the class that validates this constraint.		9
Constraint::__construct	public	function	Initializes the constraint with options.		58
Constraint::__get	public	function	Returns the value of a lazily initialized option.		2
Constraint::__isset	public	function			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.