class OEmbedResourceConstraint

Checks if a value represents a valid oEmbed resource URL.

@internal This is an internal part of the oEmbed system and should only be used by oEmbed-related code in Drupal core.

Hierarchy

class \Symfony\Component\Validator\Constraint
- class \Drupal\media\Plugin\Validation\Constraint\OEmbedResourceConstraint extends \Symfony\Component\Validator\Constraint

Expanded class hierarchy of OEmbedResourceConstraint

File

core/modules/media/src/Plugin/Validation/Constraint/OEmbedResourceConstraint.php, line 16

Namespace

Drupal\media\Plugin\Validation\Constraint

View source

class OEmbedResourceConstraint extends SymfonyConstraint {
    
    /**
     * The error message if the URL does not match any known provider.
     *
     * @var string
     */
    public $unknownProviderMessage = 'The given URL does not match any known oEmbed providers.';
    
    /**
     * The error message if the URL matches a disallowed provider.
     *
     * @var string
     */
    public $disallowedProviderMessage = 'Sorry, the @name provider is not allowed.';
    
    /**
     * The error message if the URL is not a valid oEmbed resource.
     *
     * @var string
     */
    public $invalidResourceMessage = 'The provided URL does not represent a valid oEmbed resource.';
    
    /**
     * The error message if an unexpected behavior occurs.
     *
     * @var string
     */
    public $providerErrorMessage = 'An error occurred while trying to retrieve the oEmbed provider database.';

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overrides
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.
OEmbedResourceConstraint::$disallowedProviderMessage	public	property	The error message if the URL matches a disallowed provider.
OEmbedResourceConstraint::$invalidResourceMessage	public	property	The error message if the URL is not a valid oEmbed resource.
OEmbedResourceConstraint::$providerErrorMessage	public	property	The error message if an unexpected behavior occurs.
OEmbedResourceConstraint::$unknownProviderMessage	public	property	The error message if the URL does not match any known provider.