class Cardinality in Entity Browser 8

Validates that the widget returns the appropriate number of elements.

Plugin annotation

@EntityBrowserWidgetValidation(
  id = "cardinality",
  label = @Translation("Cardinality validator")
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\entity_browser\WidgetValidationBase implements ContainerFactoryPluginInterface, WidgetValidationInterface
      • class \Drupal\entity_browser\Plugin\EntityBrowser\WidgetValidation\Cardinality

File

src/Plugin/EntityBrowser/WidgetValidation/Cardinality.php, line 18

Namespace

Drupal\entity_browser\Plugin\EntityBrowser\WidgetValidation

class Cardinality extends WidgetValidationBase {

  /**
   * {@inheritdoc}
   */
  public function validate(array $entities, array $options = []) {
    $violations = new ConstraintViolationList();

    // As this validation happens at a level above the individual entities,
    // we implement logic without using Constraint Plugins.
    $count = count($entities);
    $max = $options['cardinality'];
    if ($max !== EntityBrowserElement::CARDINALITY_UNLIMITED && $count > $max) {
      $message = $this
        ->formatPlural($max, 'You can only select one item.', 'You can only select up to @number items.', [
        '@number' => $max,
      ]);
      $violation = new ConstraintViolation($message, $message, [], $count, '', $count);
      $violations
        ->add($violation);
    }
    return $violations;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Cardinality::validate	public	function	Validates the widget. Overrides WidgetValidationBase::validate
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
WidgetValidationBase::$label	protected	property	Plugin label.
WidgetValidationBase::$typedDataManager	protected	property	The Typed Data Manager service.
WidgetValidationBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
WidgetValidationBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
WidgetValidationBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
WidgetValidationBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
WidgetValidationBase::getDataDefinition	protected	function	Gets a data definition and optionally adds a constraint.
WidgetValidationBase::label	public	function	Returns the widget validation label. Overrides WidgetValidationInterface::label
WidgetValidationBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
WidgetValidationBase::validateDataDefinition	protected	function	Creates and validates instances of typed data for each Entity.
WidgetValidationBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct