Spec-Zone.ru › Symfony 4.1

YamlFileLoader

class YamlFileLoader extends FileLoader

Загружает метаданные валидации из файла YAML.

Постоянные значения

DEFAULT_NAMESPACE

Пространство имён для загрузки ограничений по умолчанию.

Свойства

protected $namespaces из AbstractLoader
protected $file из FileLoader
protected array $classes Массив описаний классов YAML.

Методы

addNamespaceAlias(string $alias, string $namespace)

Добавляет псевдоним пространства имён.

из AbstractLoader
Constraint newConstraint(string $name, mixed $options = null)

Создаёт новый экземпляр ограничения для заданного имени ограничения.

из AbstractLoader
__construct(string $file)

Создаёт новый загрузчик.

из FileLoader
bool loadClassMetadata(ClassMetadata $metadata)

Загружает метаданные валидации в экземпляр {@link ClassMetadata}.

string[] getMappedClasses()

Возвращает имена классов, сопоставленных в этом файле.

array parseNodes(array $nodes)

Парсит коллекцию узлов YAML.

Детали

protected addNamespaceAlias(string $alias, string $namespace)

Добавляет псевдоним пространства имён.

Псевдоним пространства имён можно использовать для ссылки на ограничения из определённых пространств имён в {@link newConstraint()}:

$this->addNamespaceAlias('mynamespace', '\\Acme\\Package\\Constraints\\');

$constraint = $this->newConstraint('mynamespace:NotNull');

Параметры

string $alias Псевдоним
string $namespace Пространство имён PHP

protected Constraint newConstraint(string $name, mixed $options = null)

Создаёт новый экземпляр ограничения для заданного имени ограничения.

Параметры

string $name Имя ограничения. Может быть относительным к пространству имён ограничений по умолчанию или полным именем класса. Также ограничение может быть представлено с псевдонимом пространства имён и двоеточием. Псевдоним пространства имён должен быть определён с помощью {@link addNamespaceAlias()}.
mixed $options Параметры ограничения

Возвращаемое значение

Constraint

Исключения

MappingException Если префикс пространства имён не определён

__construct(string $file)

Создаёт новый загрузчик.

Параметры

string $file Файл сопоставления для загрузки

Исключения

MappingException Если файл не существует или недоступен для чтения

bool loadClassMetadata(ClassMetadata $metadata)

Загружает метаданные валидации в экземпляр {@link ClassMetadata}.

Параметры

ClassMetadata $metadata

Возвращаемое значение

bool Успешность загрузки

string[] getMappedClasses()

Возвращает имена классов, сопоставленных в этом файле.

Возвращаемое значение

string[] Имена классов

protected array parseNodes(array $nodes)

Парсит коллекцию узлов YAML.

Параметры

array $nodes Узлы YAML

Возвращаемое значение

array Массив значений или экземпляров Constraint

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Validator/Mapping/Loader/YamlFileLoader.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API