Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. Locale.php

class Locale

Validates that a value is a valid locale (e.g. fr, fr_FR, etc.).

@author Bernhard Schussek <bschussek@gmail.com>

Hierarchy

  • class \Symfony\Component\Validator\Constraint
    • class \Symfony\Component\Validator\Constraints\Locale extends \Symfony\Component\Validator\Constraint

Expanded class hierarchy of Locale

See also

https://unicode-org.github.io/icu/userguide/locale/

48 string references to 'Locale'
CKEditor5::getJSSettings in core/modules/ckeditor5/src/Plugin/Editor/CKEditor5.php
Returns JavaScript settings to be attached.
CKEditor5::getLibraries in core/modules/ckeditor5/src/Plugin/Editor/CKEditor5.php
Returns libraries to be attached.
Ckeditor5Hooks::jsAlter in core/modules/ckeditor5/src/Hook/Ckeditor5Hooks.php
Implements hook_js_alter().
Ckeditor5Hooks::libraryInfoAlter in core/modules/ckeditor5/src/Hook/Ckeditor5Hooks.php
Implements hook_library_info_alter().
ContentTranslationHooks::help in core/modules/content_translation/src/Hook/ContentTranslationHooks.php
Implements hook_help().

... See full list

File

vendor/symfony/validator/Constraints/Locale.php, line 25

Namespace

Symfony\Component\Validator\Constraints
View source
class Locale extends Constraint {
    public const NO_SUCH_LOCALE_ERROR = 'a0af4293-1f1a-4a1c-a328-979cba6182a2';
    protected const ERROR_NAMES = [
        self::NO_SUCH_LOCALE_ERROR => 'NO_SUCH_LOCALE_ERROR',
    ];
    public string $message = 'This value is not a valid locale.';
    public bool $canonicalize = true;
    
    /**
     * @param array<string,mixed>|null $options
     * @param bool|null                $canonicalize Whether to canonicalize the value before validation (defaults to true) (see {@see https://www.php.net/manual/en/locale.canonicalize.php})
     * @param string[]|null            $groups
     */
    public function __construct(?array $options = null, ?string $message = null, ?bool $canonicalize = null, ?array $groups = null, mixed $payload = null) {
        if (!class_exists(Locales::class)) {
            throw new LogicException('The Intl component is required to use the Locale constraint. Try running "composer require symfony/intl".');
        }
        parent::__construct($options, $groups, $payload);
        $this->message = $message ?? $this->message;
        $this->canonicalize = $canonicalize ?? $this->canonicalize;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title 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::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::__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.
Locale::$canonicalize public property
Locale::$message public property
Locale::ERROR_NAMES protected constant Maps error codes to the names of their constants. Overrides Constraint::ERROR_NAMES
Locale::NO_SUCH_LOCALE_ERROR public constant
Locale::__construct public function Overrides Constraint::__construct
RSS feed
Powered by Drupal