FormEntry.php
131 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\Session\SessionDonation\SessionObjects; |
| 4 | |
| 5 | use Give\Framework\Exceptions\Primitives\InvalidArgumentException; |
| 6 | use Give\Helpers\ArrayDataSet; |
| 7 | use Give\Session\Objects; |
| 8 | |
| 9 | /** |
| 10 | * Class FormEntry |
| 11 | * |
| 12 | * This class use to represent donation form entries as object. |
| 13 | * |
| 14 | * @package Give\Session\SessionDonation\SessionObjects |
| 15 | */ |
| 16 | class FormEntry implements Objects |
| 17 | { |
| 18 | /** |
| 19 | * Form Id. |
| 20 | * |
| 21 | * @var string |
| 22 | */ |
| 23 | public $formId; |
| 24 | |
| 25 | /** |
| 26 | * Form Title. |
| 27 | * |
| 28 | * @var string |
| 29 | */ |
| 30 | public $formTitle; |
| 31 | |
| 32 | /** |
| 33 | * Page url on which donation page exist. |
| 34 | * |
| 35 | * @var string |
| 36 | */ |
| 37 | public $currentUrl; |
| 38 | |
| 39 | /** |
| 40 | * Donation level id. |
| 41 | * |
| 42 | * @var string |
| 43 | */ |
| 44 | public $priceId; |
| 45 | |
| 46 | /** |
| 47 | * Donation amount |
| 48 | * |
| 49 | * @var string |
| 50 | */ |
| 51 | public $totalAmount; |
| 52 | |
| 53 | /** |
| 54 | * First name |
| 55 | * |
| 56 | * @var string |
| 57 | */ |
| 58 | public $firstName; |
| 59 | |
| 60 | /** |
| 61 | * Last name. |
| 62 | * |
| 63 | * @var string |
| 64 | */ |
| 65 | public $lastName; |
| 66 | |
| 67 | /** |
| 68 | * Company name. |
| 69 | * |
| 70 | * @var string |
| 71 | */ |
| 72 | public $companyName; |
| 73 | |
| 74 | /** |
| 75 | * Donor email |
| 76 | * |
| 77 | * @var string |
| 78 | */ |
| 79 | public $donorEmail; |
| 80 | |
| 81 | /** |
| 82 | * WP user id. |
| 83 | * |
| 84 | * @var string |
| 85 | */ |
| 86 | public $wpUserId; |
| 87 | |
| 88 | /** |
| 89 | * Payment gateway. |
| 90 | * |
| 91 | * @var string |
| 92 | */ |
| 93 | public $paymentGateway; |
| 94 | |
| 95 | /** |
| 96 | * Take array and return object. |
| 97 | * |
| 98 | * @param $array |
| 99 | * |
| 100 | * @return FormEntry |
| 101 | */ |
| 102 | public static function fromArray($array) |
| 103 | { |
| 104 | $renameTo = [ |
| 105 | 'amount' => 'totalAmount', |
| 106 | 'first' => 'firstName', |
| 107 | 'last' => 'lastName', |
| 108 | 'email' => 'donorEmail', |
| 109 | 'userId' => 'wpUserId', |
| 110 | 'gateway' => 'paymentGateway', |
| 111 | ]; |
| 112 | |
| 113 | $array = ArrayDataSet::renameKeys($array, $renameTo); |
| 114 | $expectedKeys = ['formId', 'totalAmount', 'firstName', 'email', 'gateway']; |
| 115 | |
| 116 | if ( ! ArrayDataSet::hasRequiredKeys($array, $expectedKeys)) { |
| 117 | throw new InvalidArgumentException( |
| 118 | 'Invalid FormEntries object, must have the exact following keys: ' . implode(', ', $expectedKeys) |
| 119 | ); |
| 120 | } |
| 121 | |
| 122 | $formEntries = new self(); |
| 123 | |
| 124 | foreach ($array as $key => $value) { |
| 125 | $formEntries->{$key} = $value; |
| 126 | } |
| 127 | |
| 128 | return $formEntries; |
| 129 | } |
| 130 | } |
| 131 |