Valdi\RulesBuilder¶
-
class
Valdi\RulesBuilder¶ - To ease the building of the rules array.
-
property
$rules¶ Holds the rules under construction.
-
create()¶ Creates and returns an instance.
Returns: RulesBuilder $ the new instance
-
__construct()¶ Constructor.
-
field()¶ Adds a rule for a field to the set. This function takes a variable amount of parameters in order to cover the rule parameters. Example for a rule without parameter: field(‘myField’, ‘required’) Example for a rule with two parameters: field(‘myField’, ‘between’, 3, 7)
Parameters: - $field (string) – the field for the rule
- $rule (string) – the rule to add
Returns: RulesBuilder $ the instance of the called RulesBuilder in order to chain the rules creation
-
rule()¶ Adds a rule to the set. This function takes a variable amount of parameters in order to cover the rule parameters. Example for a rule without parameter: rule(‘required’) Example for a rule with two parameters: rule(‘between’, 3, 7)
Parameters: - $rule (string) – the rule to add
Returns: RulesBuilder $ the instance of the called RulesBuilder in order to chain the rules creation
-
build()¶ Gets the created rules. Afterwards, the RulesBuilder is emptied and ready to be used again.
Returns: array $ the created rules
-
property