OptionsResolverInterface ^deprecated

OptionsResolverInterface setDefaults(array $defaultValues)

Устанавливает значения по умолчанию для опций.

Опции могут быть значениями любого типа или замыканиями, которые вычисляют значение опции лениво. Эти замыкания должны иметь одну из следующих подписей:

function (Options $options) function (Options $options, $value)

Второй параметр, передаваемый в замыкание, — это ранее установленное значение по умолчанию, в случае если вы перезаписываете существующее значение по умолчанию.

Замыкания должны возвращать лениво созданное значение опции.

Параметры

array

$defaultValues

Список имён опций в качестве ключей и значений по умолчанию или замыканий в качестве значений.

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

OptionsResolverInterface

Экземпляр решателя.

OptionsResolverInterface replaceDefaults(array $defaultValues)

Заменяет значения по умолчанию опций.

Старые значения по умолчанию удаляются, что означает, что замыкания, переданные здесь, не могут получить доступ к предыдущему значению по умолчанию. Это может быть полезно для повышения производительности, если предыдущее значение по умолчанию вычисляется дорогостоящим замыканием.

Параметры

array

$defaultValues

Список имён опций в качестве ключей и значений по умолчанию или замыканий в качестве значений.

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

OptionsResolverInterface

Экземпляр решателя.

OptionsResolverInterface setOptional(array $optionNames)

Устанавливает опциональные опции.

Этот метод объявляет допустимые имена опций без установки значений по умолчанию для них. Если эти опции не переданы в {@link resolve()} и для них не установлено значение по умолчанию, они будут отсутствовать в конечном массиве опций. Это может быть полезно, если вы хотите определить, установлена ли опция или нет, потому что в противном случае {@link resolve()} вызовет исключение для неизвестных опций.

Параметры

array

$optionNames

Список имён опций.

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

OptionsResolverInterface

Экземпляр решателя.

OptionsResolverInterface setRequired(array $optionNames)

Устанавливает обязательные опции.

Если эти опции не переданы в {@link resolve()} и для них не установлено значение по умолчанию, будет выброшено исключение.

Параметры

array

$optionNames

Список имён опций.

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

OptionsResolverInterface

Экземпляр решателя.

OptionsResolverInterface setAllowedValues(array $allowedValues)

Устанавливает допустимые значения для списка опций.

Параметры

array

$allowedValues

Список имён опций в качестве ключей и массивов с допустимыми значениями для этой опции в качестве значений.

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

OptionsResolverInterface

Экземпляр решателя.

Исключения

InvalidOptionsException

Если опция не определена (см. {@link isKnown()}), для которой установлено допустимое значение.

OptionsResolverInterface addAllowedValues(array $allowedValues)

Добавляет допустимые значения для списка опций.

Значения объединяются с ранее определёнными допустимыми значениями.

Параметры

array

$allowedValues

Список имён опций в качестве ключей и массивов с допустимыми значениями для этой опции в качестве значений.

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

OptionsResolverInterface

Экземпляр решателя.

Исключения

InvalidOptionsException

Если опция не определена (см. {@link isKnown()}), для которой установлено допустимое значение.

OptionsResolverInterface setAllowedTypes(array $allowedTypes)

Устанавливает допустимые типы для списка опций.

Параметры

array

$allowedTypes

Список имён опций в качестве ключей и имён типов, переданных как строка или массив в качестве значений.

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

OptionsResolverInterface

Экземпляр решателя.

Исключения

InvalidOptionsException

Если опция не определена, для которой установлено допустимое значение типа.

OptionsResolverInterface addAllowedTypes(array $allowedTypes)

Добавляет допустимые типы для списка опций.

Типы объединяются с ранее определёнными допустимыми типами.

Параметры

array

$allowedTypes

Список имён опций в качестве ключей и имён типов, переданных как строка или массив в качестве значений.

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

OptionsResolverInterface

Экземпляр решателя.

Исключения

InvalidOptionsException

Если опция не определена, для которой установлено допустимое значение типа.

OptionsResolverInterface setNormalizers(array $normalizers)

Устанавливает нормализаторы, которые применяются к разрешённым опциям.

Нормализаторы должны быть замыканиями с следующей подписью:

function (Options $options, $value)

Второй параметр, передаваемый в замыкание, — значение опции.

Замыкание должно возвращать нормализованное значение.

Параметры

array

$normalizers

Массив замыканий.

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

OptionsResolverInterface

Экземпляр решателя.

bool isKnown(string $option)

Возвращает, является ли опция известной.

Опция считается известной, если она была передана в {@link setDefaults()}, {@link setRequired()} или {@link setOptional()} ранее.

Параметры

string

$option

Имя опции.

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

bool	Является ли опция известной.

bool isRequired(string $option)

Возвращает, является ли опция обязательной.

Опция считается обязательной, если она была передана в {@link setRequired()}, но не в {@link setDefaults()}. То есть, опция объявлена обязательной и для неё не установлено значение по умолчанию.

Параметры

string

$option

Имя опции.

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

bool	Является ли опция обязательной.

array resolve(array $options = array())

Возвращает комбинацию значения по умолчанию и переданных опций.

Параметры

array

$options

Пользовательские значения опций.

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

array

Список опций и их значений.

Исключения

InvalidOptionsException	Если какая-либо из переданных опций не определена или не содержит допустимого значения.
MissingOptionsException	Если отсутствует обязательная опция.
OptionDefinitionException	Если обнаружена циклическая зависимость между двумя ленивыми опциями.