Skip to content

StringValidator ​

Type
Class
Namespace
craft\validators
Inherits
craft\validators\StringValidator » yii\validators\StringValidator » yii\validators\Validator » yii\base\Component » yii\base\BaseObject
Implements
yii\base\Configurable
Since
3.0.0

Class StringValidator.

View source

Public Properties ​

PropertyDescription
attributeNamesarray – Attribute names.
attributesarray, string – Attributes to be validated by this validator.
behaviorsyii\base\Behavior – List of behaviors attached to this component.
builtInValidatorsarray – List of built-in validators (name => class or configuration)
containsMb4string – User-defined error message used when the value contains 4+ byte characters (like emoji) and the database doesn’t support it.
disallowMb4boolean – Whether the string should be checked for 4+ byte characters (like emoji)
enableClientValidationboolean – Whether to enable client-side validation for this validator.
encodingstring, null – The encoding of the string value to be validated (e.g. 'UTF-8').
exceptarray, string – Scenarios that the validator should not be applied to.
isEmptycallable, null – A PHP callable that replaces the default implementation of isEmpty().
lengthinteger, array – Specifies the length limit of the value to be validated.
maxinteger, null – Maximum length.
messagestring – User-defined error message used when the value is not a string.
mininteger, null – Minimum length.
notEqualstring – User-defined error message used when the length of the value is not equal to length.
onarray, string – Scenarios that the validator can be applied to.
skipOnEmptyboolean – Whether this validation rule should be skipped if the attribute value is null or an empty string.
skipOnErrorboolean – Whether this validation rule should be skipped if the attribute being validated already has some validation error according to some previous rules.
strictboolean – Whether to require the value to be a string data type.
tooLongstring – User-defined error message used when the length of the value is greater than max.
tooShortstring – User-defined error message used when the length of the value is smaller than min.
trimboolean – Whether the string should be trimmed of whitespace
validationAttributesarray, null – List of attribute names.
whencallable, null – A PHP callable whose return value determines whether this validator should be applied.
whenClientstring, null – A JavaScript function name whose return value determines whether this validator should be applied on the client-side.

containsMb4 ​

Type
string
Default value
null

User-defined error message used when the value contains 4+ byte characters (like emoji) and the database doesn’t support it.

View source

disallowMb4 ​

Type
boolean
Default value
false

Whether the string should be checked for 4+ byte characters (like emoji)

View source

trim ​

DEPRECATED

Deprecated in 3.0.32. Use Yii’s 'trim' validator instead.

Type
boolean
Default value
false
Since
3.0.18

Whether the string should be trimmed of whitespace

View source

Public Methods ​

MethodDescription
__call()Calls the named method which is not a class method.
__clone()This method is called after the object is created by cloning an existing one.
__construct()Constructor.
__get()Returns the value of a component property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets the value of a component property.
__unset()Sets a component property to be null.
addError()Adds an error about the specified attribute to the model object.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
behaviors()Returns a list of behaviors that this component should behave as.
canGetProperty()Returns a value indicating whether a property can be read.
canSetProperty()Returns a value indicating whether a property can be set.
className()Returns the fully qualified name of this class.
clientValidateAttribute()Returns the JavaScript needed for performing client-side validation.
createValidator()Creates a validator object.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
ensureBehaviors()Makes sure that the behaviors declared in behaviors() are attached to this component.
getAttributeNames()Returns cleaned attribute names without the ! character at the beginning.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getClientOptions()Returns the client-side validation options.
getValidationAttributes()Returns a list of attributes this validator applies to.
hasEventHandlers()Returns a value indicating whether there is any handler attached to the named event.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined for this component.
init()Initializes the object.
isActive()Returns a value indicating whether the validator is active for the given scenario and attribute.
isEmpty()Checks if the given value is empty.
off()Detaches an existing event handler from this component.
on()Attaches an event handler to an event.
trigger()Triggers an event.
validate()Validates a given value.
validateAttribute()Validates a single attribute.
validateAttributes()Validates the specified object.
validateValue()Validates a value.

init() ​

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

View source

validateAttribute() ​

Validates a single attribute.

Child classes must implement this method to provide the actual validation logic.

View source

Arguments ​

  • $model (yii\base\Model) – The data model to be validated
  • $attribute (string) – The name of the attribute to be validated.

validateValue() ​

Validates a value.

A validator class can implement this method to support data validation out of the context of a data model.

View source

Arguments ​

  • $value (mixed) – The data value to be validated.

Returns ​

array, null – The error message and the array of parameters to be inserted into the error message.

php
if (!$valid) {
return [$this->message, [
'param1' => $this->param1,
'formattedLimit' => Yii::$app->formatter->asShortSize($this->getSizeLimit()),
'mimeTypes' => implode(', ', $this->mimeTypes),
'param4' => 'etc...',
]];
}

#### Throws

- [yii\base\NotSupportedException](https://www.yiiframework.com/doc/api/2.0/yii-base-notsupportedexception)\
  if the validator does not supporting data validation without a model




## Protected Methods

| Method                                                                                                                                            | Description
| ------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------
| [formatMessage()](https://www.yiiframework.com/doc/api/2.0/yii-validators-validator#formatMessage()-detail "Defined by yii\validators\Validator") | Formats a mesage using the I18N, or simple strtr if `\Yii::$app` is not available.