Url ¶
Validates that a value is a valid URL string.
Applies to | property or method |
Class | Url |
Validator | UrlValidator |
Basic Usage ¶
-
Attributes
属性
-
YAML
YAML
-
XML
XML
-
PHP
PHP
1 2 3 4 5 6 7 8 9 10 |
// src/Entity/Author.php
namespace App\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Author
{
#[Assert\Url]
protected $bioUrl;
}
|
This constraint doesn't check that the host of the given URL really exists, because the information of the DNS records is not reliable. Use the checkdnsrr PHP function if you still want to check that.
Note
As with most of the other constraints, null
and empty strings are
considered valid values. This is to allow them to be optional values.
If the value is mandatory, a common solution is to combine this constraint
with NotBlank.
Options ¶
groups
¶
type: array
| string
It defines the validation group or groups of this constraint. Read more about validation groups.
message
¶
type: string
default: This value is not a valid URL.
This message is shown if the URL is invalid.
You can use the following parameters in this message:
Parameter | Description |
---|---|
{{ value }} |
The current (invalid) value |
{{ label }} |
Corresponding form field label |
-
Attributes
属性
-
YAML
YAML
-
XML
XML
-
PHP
PHP
1 2 3 4 5 6 7 8 9 10 11 12 |
// src/Entity/Author.php
namespace App\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Author
{
#[Assert\Url(
message: 'The url {{ value }} is not a valid url',
)]
protected $bioUrl;
}
|
normalizer
¶
type: a PHP callable default: null
This option allows to define the PHP callable applied to the given value before checking if it is valid.
For example, you may want to pass the 'trim'
string to apply the
trim PHP function in order to ignore leading and trailing
whitespace during validation.
payload
¶
type: mixed
default: null
This option can be used to attach arbitrary domain-specific data to a constraint. The configured payload is not used by the Validator component, but its processing is completely up to you.
For example, you may want to use several error levels to present failed constraints differently in the front-end depending on the severity of the error.
protocols
¶
type: array
default: ['http', 'https']
The protocols considered to be valid for the URL. For example, if you also consider
the ftp://
type URLs to be valid, redefine the protocols
array, listing
http
, https
, and also ftp
.
-
Attributes
属性
-
YAML
YAML
-
XML
XML
-
PHP
PHP
1 2 3 4 5 6 7 8 9 10 11 12 |
// src/Entity/Author.php
namespace App\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Author
{
#[Assert\Url(
protocols: ['http', 'https', 'ftp'],
)]
protected $bioUrl;
}
|
relativeProtocol
¶
type: boolean
default: false
If true
, the protocol is considered optional when validating the syntax of
the given URL. This means that both http://
and https://
are valid but
also relative URLs that contain no protocol (e.g. //example.com
).
-
Attributes
属性
-
YAML
YAML
-
XML
XML
-
PHP
PHP
1 2 3 4 5 6 7 8 9 10 11 12 |
// src/Entity/Author.php
namespace App\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Author
{
#[Assert\Url(
relativeProtocol: true,
)]
protected $bioUrl;
}
|