HasValidationRules.php
130 lines
| 1 | <?php |
| 2 | /** |
| 3 | * @license GPL-2.0-or-later |
| 4 | * |
| 5 | * Modified by impress-org on 23-January-2024 using Strauss. |
| 6 | * @see https://github.com/BrianHenryIE/strauss |
| 7 | */ |
| 8 | |
| 9 | declare(strict_types=1); |
| 10 | |
| 11 | namespace Give\Vendors\StellarWP\Validation\Concerns; |
| 12 | |
| 13 | use Give\Vendors\StellarWP\Validation\Config; |
| 14 | use Give\Vendors\StellarWP\Validation\Contracts\ValidationRule; |
| 15 | use Give\Vendors\StellarWP\Validation\ValidationRuleSet; |
| 16 | |
| 17 | /** |
| 18 | * Apply this trait to a class to enable it to have validation rules. These rules may be passed to the front-end |
| 19 | * or used with the Validator to validate data. |
| 20 | * |
| 21 | * @since 1.0.0 |
| 22 | */ |
| 23 | trait HasValidationRules |
| 24 | { |
| 25 | /** |
| 26 | * @var ValidationRuleSet |
| 27 | */ |
| 28 | protected $validationRules; |
| 29 | |
| 30 | /** |
| 31 | * @since 1.0.0 |
| 32 | */ |
| 33 | public function __construct() |
| 34 | { |
| 35 | $this->validationRules = Config::getServiceContainer()->get(ValidationRuleSet::class); |
| 36 | } |
| 37 | |
| 38 | /** |
| 39 | * @see ValidationRuleSet::rules() |
| 40 | * |
| 41 | * @since 1.0.0 |
| 42 | */ |
| 43 | public function rules(...$rules): self |
| 44 | { |
| 45 | $this->validationRules->rules(...$rules); |
| 46 | |
| 47 | return $this; |
| 48 | } |
| 49 | |
| 50 | /** |
| 51 | * @see ValidationRuleSet::hasRule() |
| 52 | * |
| 53 | * @since 1.0.0 |
| 54 | */ |
| 55 | public function hasRule(string $ruleId): bool |
| 56 | { |
| 57 | return $this->validationRules->hasRule($ruleId); |
| 58 | } |
| 59 | |
| 60 | /** |
| 61 | * @see ValidationRuleSet::hasRules() |
| 62 | * |
| 63 | * @since 1.3.1 |
| 64 | */ |
| 65 | public function hasRules(): bool |
| 66 | { |
| 67 | return $this->validationRules->hasRules(); |
| 68 | } |
| 69 | |
| 70 | /** |
| 71 | * @see ValidationRuleSet::getRule() |
| 72 | * |
| 73 | * @since 1.0.0 |
| 74 | */ |
| 75 | public function getRule(string $ruleId): ValidationRule |
| 76 | { |
| 77 | return $this->validationRules->getRule($ruleId); |
| 78 | } |
| 79 | |
| 80 | /** |
| 81 | * @see ValidationRuleSet::replaceRule() |
| 82 | * |
| 83 | * @since 1.3.1 |
| 84 | */ |
| 85 | public function replaceRule(string $ruleId, $rule): bool |
| 86 | { |
| 87 | return $this->validationRules->replaceRule($ruleId, $rule); |
| 88 | } |
| 89 | |
| 90 | /** |
| 91 | * @see ValidationRuleSet::replaceOrAppendRule() |
| 92 | * |
| 93 | * @since 1.3.1 |
| 94 | */ |
| 95 | public function replaceOrAppendRule(string $ruleId, $rule): bool |
| 96 | { |
| 97 | return $this->validationRules->replaceOrAppendRule($ruleId, $rule); |
| 98 | } |
| 99 | |
| 100 | /** |
| 101 | * @see ValidationRuleSet::replaceOrPrependRule() |
| 102 | * |
| 103 | * @since 1.3.1 |
| 104 | */ |
| 105 | public function replaceOrPrependRule(string $ruleId, $rule): bool |
| 106 | { |
| 107 | return $this->validationRules->replaceOrPrependRule($ruleId, $rule); |
| 108 | } |
| 109 | |
| 110 | /** |
| 111 | * @see ValidationRuleSet::forgetRule() |
| 112 | * |
| 113 | * @since 1.0.0 |
| 114 | */ |
| 115 | public function forgetRule(string $ruleId): self |
| 116 | { |
| 117 | $this->validationRules->removeRuleWithId($ruleId); |
| 118 | |
| 119 | return $this; |
| 120 | } |
| 121 | |
| 122 | /** |
| 123 | * @since 1.0.0 |
| 124 | */ |
| 125 | public function getValidationRules(): ValidationRuleSet |
| 126 | { |
| 127 | return $this->validationRules; |
| 128 | } |
| 129 | } |
| 130 |