ExprBuilder
class ExprBuilder
This class builds an if expression.
Properties
$ifPart | |||
$thenPart |
Methods
__construct(NodeDefinition $node) | ||
$this | always(Closure $then = null) Marks the expression as being always used. | |
$this | ifTrue(Closure $closure = null) Sets a closure to use as tests. | |
$this | ifString() Tests if the value is a string. | |
$this | ifNull() Tests if the value is null. | |
ExprBuilder | ifEmpty() Tests if the value is empty. | |
$this | ifArray() Tests if the value is an array. | |
$this | ifInArray(array $array) Tests if the value is in an array. | |
$this | ifNotInArray(array $array) Tests if the value is not in an array. | |
$this | castToArray() Transforms variables of any type into an array. | |
$this | then(Closure $closure) Sets the closure to run if the test pass. | |
$this | thenEmptyArray() Sets a closure returning an empty array. | |
$this | thenInvalid(string $message) Sets a closure marking the value as invalid at validation time. | |
$this | thenUnset() Sets a closure unsetting this key of the array at validation time. | |
NodeDefinition|ArrayNodeDefinition|VariableNodeDefinition | end() Returns the related node. | |
static array | buildExpressions(array $expressions) Builds the expressions. |
Details
__construct(NodeDefinition $node)
Parameters
NodeDefinition | $node |
$this always(Closure $then = null)
Marks the expression as being always used.
Parameters
Closure | $then |
Return Value
$this |
$this ifTrue(Closure $closure = null)
Sets a closure to use as tests.
The default one tests if the value is true.
Parameters
Closure | $closure |
Return Value
$this |
$this ifString()
Tests if the value is a string.
Return Value
$this |
$this ifNull()
Tests if the value is null.
Return Value
$this |
ExprBuilder ifEmpty()
Tests if the value is empty.
Return Value
ExprBuilder |
$this ifArray()
Tests if the value is an array.
Return Value
$this |
$this ifInArray(array $array)
Tests if the value is in an array.
Parameters
array | $array |
Return Value
$this |
$this ifNotInArray(array $array)
Tests if the value is not in an array.
Parameters
array | $array |
Return Value
$this |
$this castToArray()
Transforms variables of any type into an array.
Return Value
$this |
$this then(Closure $closure)
Sets the closure to run if the test pass.
Parameters
Closure | $closure |
Return Value
$this |
$this thenEmptyArray()
Sets a closure returning an empty array.
Return Value
$this |
$this thenInvalid(string $message)
Sets a closure marking the value as invalid at validation time.
if you want to add the value of the node in your message just use a %s placeholder.
Parameters
string | $message |
Return Value
$this |
Exceptions
InvalidArgumentException |
$this thenUnset()
Sets a closure unsetting this key of the array at validation time.
Return Value
$this |
Exceptions
UnsetKeyException |
NodeDefinition|ArrayNodeDefinition|VariableNodeDefinition end()
Returns the related node.
Return Value
NodeDefinition|ArrayNodeDefinition|VariableNodeDefinition |
Exceptions
RuntimeException |
static array buildExpressions(array $expressions)
Builds the expressions.
Parameters
array | $expressions | An array of ExprBuilder instances to build |
Return Value
array |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/Config/Definition/Builder/ExprBuilder.html