give / src / Framework / FieldsAPI / Concerns / IsRequired.php

IsRequired.php in GiveWP – Donation Plugin and Fundraising Platform 4.16.9, at src/Framework/FieldsAPI/Concerns/IsRequired.php

44 lines 958 B

Raw Download Zip

1	<?php
2
3	namespace Give\Framework\FieldsAPI\Concerns;
4
5	trait IsRequired
6	{
7	/**
8	* Marks the field as required or not.
9	*
10	* @since 2.24.0 switch to new validation system
11	*/
12	public function required($value = true): self
13	{
14	if ( $value ) {
15	$this->validationRules->rules('required');
16	} else {
17	$this->validationRules->removeRuleWithId('required');
18	}
19
20	return $this;
21	}
22
23	/**
24	* Returns whether the field is required or not.
25	*
26	* @since 2.24.0 switch to new validation system
27	*/
28	public function isRequired(): bool
29	{
30	return $this->hasRule('required');
31	}
32
33	/**
34	* @deprecated Use the Validator to generate errors
35	*/
36	public function getRequiredError(): array
37	{
38	return [
39	'error_id' => $this->name,
40	'error_message' => __('Please enter a value for ', 'give') . $this->name,
41	];
42	}
43	}
44