PersistenceScope.php
101 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\Framework\FieldsAPI\ValueObjects; |
| 4 | |
| 5 | /** |
| 6 | * The scope of the field for use in persistence. The two built-in scopes are donation and donor, but the scope may be |
| 7 | * any custom string. Using a custom scope allows for an add-on to either not store the field, or store it in a custom |
| 8 | * location. |
| 9 | * |
| 10 | * @since 2.32.0 |
| 11 | */ |
| 12 | class PersistenceScope |
| 13 | { |
| 14 | const DONATION = 'donation'; |
| 15 | const DONOR = 'donor'; |
| 16 | const CALLBACK = 'callback'; |
| 17 | |
| 18 | /** |
| 19 | * @var string |
| 20 | */ |
| 21 | private $scope; |
| 22 | |
| 23 | /** |
| 24 | * @since 2.32.0 |
| 25 | */ |
| 26 | public static function donation(): self |
| 27 | { |
| 28 | return new self(self::DONATION); |
| 29 | } |
| 30 | |
| 31 | /** |
| 32 | * @since 2.32.0 |
| 33 | */ |
| 34 | public static function donor(): self |
| 35 | { |
| 36 | return new self(self::DONOR); |
| 37 | } |
| 38 | |
| 39 | /** |
| 40 | * @since 2.32.0 |
| 41 | */ |
| 42 | public static function callback(): self |
| 43 | { |
| 44 | return new self(self::CALLBACK); |
| 45 | } |
| 46 | |
| 47 | /** |
| 48 | * @since 2.32.0 |
| 49 | */ |
| 50 | public function __construct(string $scope) |
| 51 | { |
| 52 | $this->scope = $scope; |
| 53 | } |
| 54 | |
| 55 | /** |
| 56 | * @since 2.32.0 |
| 57 | */ |
| 58 | public function isDonation(): bool |
| 59 | { |
| 60 | return $this->scope === self::DONATION; |
| 61 | } |
| 62 | |
| 63 | /** |
| 64 | * @since 2.32.0 |
| 65 | */ |
| 66 | public function isDonor(): bool |
| 67 | { |
| 68 | return $this->scope === self::DONOR; |
| 69 | } |
| 70 | |
| 71 | /** |
| 72 | * @since 2.32.0 |
| 73 | */ |
| 74 | public function isCallback(): bool |
| 75 | { |
| 76 | return $this->scope === self::CALLBACK; |
| 77 | } |
| 78 | |
| 79 | /** |
| 80 | * @since 2.32.0 |
| 81 | * |
| 82 | * @param self|string $scope |
| 83 | */ |
| 84 | public function is($scope): bool |
| 85 | { |
| 86 | if ($scope instanceof self) { |
| 87 | $scope = $scope->scope; |
| 88 | } |
| 89 | |
| 90 | return $this->scope === $scope; |
| 91 | } |
| 92 | |
| 93 | /** |
| 94 | * @since 2.32.0 |
| 95 | */ |
| 96 | public function __toString() |
| 97 | { |
| 98 | return $this->scope; |
| 99 | } |
| 100 | } |
| 101 |