Référence de la classe OptionConfigurator

Fonctions membres publiques
	__construct (string $name, OptionsResolver $resolver)
	allowedTypes (string ... $types)
	allowedValues (... $values)
	default ($value)
	define (string $option)
	deprecated (string $package, string $version, $message='The option "%name%" is deprecated.')
	normalize (\Closure $normalizer)
	required ()
	info (string $info)

Attributs privés
	$name
	$resolver

Documentation des constructeurs et destructeur

__construct()

__construct	(	string	$name,
		OptionsResolver	$resolver
	)

Références OptionConfigurator\$name, OptionConfigurator\$resolver, et name.

Documentation des fonctions membres

allowedTypes()

allowedTypes

(

string ...

$types

)

Adds allowed types for this option.

Renvoie

$this

Exceptions

AccessException

If called from a lazy option or normalizer

Références $this, et name.

allowedValues()

allowedValues

(

$values

)

Sets allowed values for this option.

Paramètres

mixed

...$values One or more acceptable values/closures

Renvoie

$this

Exceptions

AccessException

If called from a lazy option or normalizer

Références $this, et name.

default()

default

(

$value

)

Sets the default value for this option.

Paramètres

mixed

$value

The default value of the option

Renvoie

$this

Exceptions

AccessException

If called from a lazy option or normalizer

Références $this, $value, et name.

define()

define

(

string

$option

)

Defines an option configurator with the given name.

Références $option.

deprecated()

deprecated	(	string	$package,
		string	$version,
			$message = 'The option "%name%" is deprecated.'
	)

Marks this option as deprecated.

Paramètres

string	$package	The name of the composer package that is triggering the deprecation
string	$version	The version of the package that introduced the deprecation
string | \Closure	$message	The deprecation message to use

Renvoie

$this

Références $message, $this, $version, et name.

info()

info

(

string

$info

)

Sets an info message for an option.

Renvoie

$this

Exceptions

AccessException

If called from a lazy option or normalizer

Références $this, et name.

normalize()

normalize

(

\Closure

$normalizer

)

Sets the normalizer for this option.

Renvoie

$this

Exceptions

AccessException

If called from a lazy option or normalizer

Références $this, et name.

required()

required

(

)

Marks this option as required.

Renvoie

$this

Exceptions

AccessException

If called from a lazy option or normalizer

Références $this, et name.

Documentation des champs

$name

$name

private

Référencé par OptionConfigurator\__construct().

$resolver

$resolver

private

Référencé par OptionConfigurator\__construct().

---

La documentation de cette classe a été générée à partir du fichier suivant :

• OptionConfigurator.php