MediaSourceEntityConstraintsInterface.php

Same filename in other branches
  1. 9 core/modules/media/src/MediaSourceEntityConstraintsInterface.php
  2. 8.9.x core/modules/media/src/MediaSourceEntityConstraintsInterface.php
  3. 11.x core/modules/media/src/MediaSourceEntityConstraintsInterface.php

Namespace

Drupal\media

File

core/modules/media/src/MediaSourceEntityConstraintsInterface.php

View source
<?php

namespace Drupal\media;


/**
 * Defines an interface for a media source with entity constraints.
 *
 * This allows a media source to optionally add entity validation constraints
 * for media items. To add constraints at the source field level, a media source
 * can also implement MediaSourceFieldConstraintsInterface.
 *
 * @see \Drupal\media\MediaSourceInterface
 * @see \Drupal\media\MediaSourceFieldConstraintsInterface.php
 * @see \Drupal\media\MediaSourceBase
 * @see \Drupal\media\Entity\Media
 */
interface MediaSourceEntityConstraintsInterface extends MediaSourceInterface {
    
    /**
     * Gets media source-specific validation constraints for a media item.
     *
     * @return \Symfony\Component\Validator\Constraint[]
     *   An array of validation constraint definitions, keyed by plugin IDs. The
     *   corresponding values are options for each validation plugin.
     *   Each constraint definition can be used for instantiating
     *   \Symfony\Component\Validator\Constraint objects.
     */
    public function getEntityConstraints();

}

Interfaces

Title Deprecated Summary
MediaSourceEntityConstraintsInterface Defines an interface for a media source with entity constraints.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.