Class craft\validators\UrlValidator

Inheritance: craft\validators\UrlValidator » yii\validators\UrlValidator » yii\validators\Validator » yii\base\Component » yii\base\BaseObject
Implements: yii\base\Configurable
Available since version: 3.0
Source Code: https://github.com/craftcms/cms/blob/master/src/validators/UrlValidator.php

Class UrlValidator.

Public Properties
Property	Type	Description	Defined By
`$allowAlias`	boolean	Whether the value can begin with an alias	craft\validators\UrlValidator
`$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\BaseObject
`__clone()`	This method is called after the object is created by cloning an existing one.	yii\base\Component
`__construct()`	Constructor.	craft\validators\UrlValidator
`__get()`	Returns the value of an object property.	yii\base\BaseObject
`__isset()`	Checks if a property is set, i.e. defined and not null.	yii\base\BaseObject
`__set()`	Sets value of an object property.	yii\base\BaseObject
`__unset()`	Sets an object property to null.	yii\base\BaseObject
`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\BaseObject
`canSetProperty()`	Returns a value indicating whether a property can be set.	yii\base\BaseObject
`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
`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\BaseObject
`hasProperty()`	Returns a value indicating whether a property is defined.	yii\base\BaseObject
`init()`	Initializes the object.	yii\base\BaseObject
`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
`validateValue()`	{@inheritdoc}	craft\validators\UrlValidator

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

Property Details

`$allowAlias` public property #

Whether the value can begin with an alias

public boolean $allowAlias = false

Method Details

`__construct()` public method #

Constructor.

The default implementation does two things:

Initializes the object with the given configuration $config.
Call init().

If this method is overridden in a child class, it is recommended that

the last parameter of the constructor is a configuration array, like $config here.
call the parent implementation at the end of the constructor.

public void __construct ( array $config = [] )

$config array Name-value pairs that will be used to initialize the object properties

`validateValue()` public method #

{@inheritdoc}

public void validateValue ( $value )

$value

Property Details

$allowAlias public property #

Method Details

__construct() public method #

validateValue() public method #

`$allowAlias` public property #

`__construct()` public method #

`validateValue()` public method #