Class yii\validators\UrlValidator
| Inheritance | yii\validators\UrlValidator » yii\validators\Validator » yii\base\Component » yii\base\BaseObject |
|---|---|
| Implements | yii\base\Configurable |
| Available since version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2/blob/master/framework/validators/UrlValidator.php |
UrlValidator validates that the attribute value is a valid http or https URL.
Note that this validator only checks if the URL scheme and host part are correct. It does not check the remaining parts of a URL.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $attributes | array|string | Attributes to be validated by this validator. | yii\validators\Validator |
| $builtInValidators | array | List of built-in validators (name => class or configuration) | yii\validators\Validator |
| $defaultScheme | string | The default URI scheme. | yii\validators\UrlValidator |
| $enableClientValidation | boolean | Whether to enable client-side validation for this validator. | yii\validators\Validator |
| $enableIDN | boolean | Whether validation process should take into account IDN (internationalized domain names). | yii\validators\UrlValidator |
| $except | array|string | Scenarios that the validator should not be applied to. | yii\validators\Validator |
| $isEmpty | callable | A PHP callable that replaces the default implementation of isEmpty(). | yii\validators\Validator |
| $message | string | The user-defined error message. | yii\validators\Validator |
| $on | array|string | Scenarios that the validator can be applied to. | yii\validators\Validator |
| $pattern | string | The regular expression used to validate the attribute value. | yii\validators\UrlValidator |
| $skipOnEmpty | boolean | Whether this validation rule should be skipped if the attribute value is null or an empty string. | yii\validators\Validator |
| $skipOnError | boolean | Whether this validation rule should be skipped if the attribute being validated already has some validation error according to some previous rules. | yii\validators\Validator |
| $validSchemes | array | List of URI schemes which should be considered valid. | yii\validators\UrlValidator |
| $when | callable | A PHP callable whose return value determines whether this validator should be applied. | yii\validators\Validator |
| $whenClient | string | A JavaScript function name whose return value determines whether this validator should be applied on the client-side. | yii\validators\Validator |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\base\Component |
| __clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component |
| __construct() | Constructor. | yii\base\BaseObject |
| __get() | Returns the value of a component property. | yii\base\Component |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Component |
| __set() | Sets the value of a component property. | yii\base\Component |
| __unset() | Sets a component property to be null. | yii\base\Component |
| addError() | Adds an error about the specified attribute to the model object. | yii\validators\Validator |
| attachBehavior() | Attaches a behavior to this component. | yii\base\Component |
| attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component |
| behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component |
| canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Component |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Component |
| className() | Returns the fully qualified name of this class. | yii\base\BaseObject |
| clientValidateAttribute() | {@inheritdoc} | yii\validators\UrlValidator |
| createValidator() | Creates a validator object. | yii\validators\Validator |
| detachBehavior() | Detaches a behavior from the component. | yii\base\Component |
| detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component |
| getAttributeNames() | Returns cleaned attribute names without the ! character at the beginning. |
yii\validators\Validator |
| getBehavior() | Returns the named behavior object. | yii\base\Component |
| getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component |
| getClientOptions() | {@inheritdoc} | yii\validators\UrlValidator |
| getValidationAttributes() | Returns a list of attributes this validator applies to. | yii\validators\Validator |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component |
| hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Component |
| hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component |
| init() | {@inheritdoc} | yii\validators\UrlValidator |
| isActive() | Returns a value indicating whether the validator is active for the given scenario and attribute. | yii\validators\Validator |
| isEmpty() | Checks if the given value is empty. | yii\validators\Validator |
| off() | Detaches an existing event handler from this component. | yii\base\Component |
| on() | Attaches an event handler to an event. | yii\base\Component |
| trigger() | Triggers an event. | yii\base\Component |
| validate() | Validates a given value. | yii\validators\Validator |
| validateAttribute() | {@inheritdoc} | yii\validators\UrlValidator |
| validateAttributes() | Validates the specified object. | yii\validators\Validator |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| formatMessage() | Formats a mesage using the I18N, or simple strtr if \Yii::$app is not available. |
yii\validators\Validator |
| validateValue() | {@inheritdoc} | yii\validators\UrlValidator |
Property Details
The default URI scheme. If the input doesn't contain the scheme part, the default scheme will be prepended to it (thus changing the input). Defaults to null, meaning a URL must contain the scheme part.
Whether validation process should take into account IDN (internationalized
domain names). Defaults to false meaning that validation of URLs containing IDN will always
fail. Note that in order to use IDN validation you have to install and enable intl PHP
extension, otherwise an exception would be thrown.
The regular expression used to validate the attribute value.
The pattern may contain a {schemes} token that will be replaced
by a regular expression which represents the $validSchemes.
public string $pattern = '/^{schemes}:\/\/(([A-Z0-9][A-Z0-9_-]*)(\.[A-Z0-9][A-Z0-9_-]*)+)(?::\d{1,5})?(?:$|[?\/#])/i'
List of URI schemes which should be considered valid. By default, http and https are considered to be valid schemes.
Method Details
{@inheritdoc}
| public void clientValidateAttribute ( $model, $attribute, $view ) | ||
| $model | ||
| $attribute | ||
| $view | ||
{@inheritdoc}
| public void getClientOptions ( $model, $attribute ) | ||
| $model | ||
| $attribute | ||
{@inheritdoc}
| public void init ( ) |
{@inheritdoc}
| public void validateAttribute ( $model, $attribute ) | ||
| $model | ||
| $attribute | ||
{@inheritdoc}
| protected void validateValue ( $value ) | ||
| $value | ||