class ExtensionAvailableConstraint

Same name and namespace in other branches
  1. 11.x core/lib/Drupal/Core/Extension/Plugin/Validation/Constraint/ExtensionAvailableConstraint.php \Drupal\Core\Extension\Plugin\Validation\Constraint\ExtensionAvailableConstraint

Check if an extension (module, theme, or profile) is available.

Attributes

#[Constraint(id: 'ExtensionAvailable', label: new TranslatableMarkup('Extension is available', [], [ 'context' => 'Validation', ]))]

Hierarchy

Expanded class hierarchy of ExtensionAvailableConstraint

1 file declares its use of ExtensionAvailableConstraint
ExtensionAvailableConstraintValidatorTest.php in core/tests/Drupal/KernelTests/Core/Extension/ExtensionAvailableConstraintValidatorTest.php

File

View on git.drupalcode.org

core/lib/Drupal/Core/Extension/Plugin/Validation/Constraint/ExtensionAvailableConstraint.php, line 14

Namespace

Drupal\Core\Extension\Plugin\Validation\Constraint
View source 
class ExtensionAvailableConstraint extends SymfonyConstraint {
  
  /**
   * Constructs an ExtensionAvailableConstraint object.
   *
   * @param string $type
   *   The type of extension to look for. Can be 'module', 'theme' or 'profile'.
   * @param string $moduleNotExistsMessage
   *   The error message if the module does not exist.
   * @param string $themeNotExistsMessage
   *   The error message if the theme does not exist.
   * @param string $profileNotExistsMessage
   *   The error message if the profile does not exist.
   * @param string $couldNotLoadProfileToCheckExtension
   *   The error message if the profile could not be loaded.
   * @param array|null $groups
   *   The groups that the constraint belongs to.
   * @param mixed|null $payload
   *   Domain-specific data attached to a constraint.
   */
  public function __construct(public string $type, public string $moduleNotExistsMessage = "Module '@name' is not available.", public string $themeNotExistsMessage = "Theme '@name' is not available.", public string $profileNotExistsMessage = "Profile '@name' is not available.", public string $couldNotLoadProfileToCheckExtension = "Profile '@profile' could not be loaded to check if the extension '@extension' is available.", ?array $groups = NULL, mixed $payload = NULL) {
    parent::__construct(groups: $groups, payload: $payload);
  }

}

Members

Title Modifiers Object type Summary
ExtensionAvailableConstraint::__construct public function Constructs an ExtensionAvailableConstraint object.

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