class-wc-payment-token-cc.php
199 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Class WC_Payment_Token_CC file. |
| 4 | * |
| 5 | * @package WooCommerce\PaymentTokens |
| 6 | */ |
| 7 | |
| 8 | if ( ! defined( 'ABSPATH' ) ) { |
| 9 | exit; // Exit if accessed directly. |
| 10 | } |
| 11 | |
| 12 | /** |
| 13 | * WooCommerce Credit Card Payment Token. |
| 14 | * |
| 15 | * Representation of a payment token for credit cards. |
| 16 | * |
| 17 | * @class WC_Payment_Token_CC |
| 18 | * @version 3.0.0 |
| 19 | * @since 2.6.0 |
| 20 | * @package WooCommerce\PaymentTokens |
| 21 | */ |
| 22 | class WC_Payment_Token_CC extends WC_Payment_Token { |
| 23 | |
| 24 | /** |
| 25 | * Token Type String. |
| 26 | * |
| 27 | * @var string |
| 28 | */ |
| 29 | protected $type = 'CC'; |
| 30 | |
| 31 | /** |
| 32 | * Stores Credit Card payment token data. |
| 33 | * |
| 34 | * @var array |
| 35 | */ |
| 36 | protected $extra_data = array( |
| 37 | 'last4' => '', |
| 38 | 'expiry_year' => '', |
| 39 | 'expiry_month' => '', |
| 40 | 'card_type' => '', |
| 41 | ); |
| 42 | |
| 43 | /** |
| 44 | * Get type to display to user. |
| 45 | * |
| 46 | * @since 2.6.0 |
| 47 | * @param string $deprecated Deprecated since WooCommerce 3.0. |
| 48 | * @return string |
| 49 | */ |
| 50 | public function get_display_name( $deprecated = '' ) { |
| 51 | $display = sprintf( |
| 52 | /* translators: 1: credit card type 2: last 4 digits 3: expiry month 4: expiry year */ |
| 53 | __( '%1$s ending in %2$s (expires %3$s/%4$s)', 'woocommerce' ), |
| 54 | wc_get_credit_card_type_label( $this->get_card_type() ), |
| 55 | $this->get_last4(), |
| 56 | $this->get_expiry_month(), |
| 57 | substr( $this->get_expiry_year(), 2 ) |
| 58 | ); |
| 59 | return $display; |
| 60 | } |
| 61 | |
| 62 | /** |
| 63 | * Hook prefix |
| 64 | * |
| 65 | * @since 3.0.0 |
| 66 | */ |
| 67 | protected function get_hook_prefix() { |
| 68 | return 'woocommerce_payment_token_cc_get_'; |
| 69 | } |
| 70 | |
| 71 | /** |
| 72 | * Validate credit card payment tokens. |
| 73 | * |
| 74 | * These fields are required by all credit card payment tokens: |
| 75 | * expiry_month - string Expiration date (MM) for the card |
| 76 | * expiry_year - string Expiration date (YYYY) for the card |
| 77 | * last4 - string Last 4 digits of the card |
| 78 | * card_type - string Card type (visa, mastercard, etc) |
| 79 | * |
| 80 | * @since 2.6.0 |
| 81 | * @return boolean True if the passed data is valid |
| 82 | */ |
| 83 | public function validate() { |
| 84 | if ( false === parent::validate() ) { |
| 85 | return false; |
| 86 | } |
| 87 | |
| 88 | if ( ! $this->get_last4( 'edit' ) ) { |
| 89 | return false; |
| 90 | } |
| 91 | |
| 92 | if ( ! $this->get_expiry_year( 'edit' ) ) { |
| 93 | return false; |
| 94 | } |
| 95 | |
| 96 | if ( ! $this->get_expiry_month( 'edit' ) ) { |
| 97 | return false; |
| 98 | } |
| 99 | |
| 100 | if ( ! $this->get_card_type( 'edit' ) ) { |
| 101 | return false; |
| 102 | } |
| 103 | |
| 104 | if ( 4 !== strlen( $this->get_expiry_year( 'edit' ) ) ) { |
| 105 | return false; |
| 106 | } |
| 107 | |
| 108 | if ( 2 !== strlen( $this->get_expiry_month( 'edit' ) ) ) { |
| 109 | return false; |
| 110 | } |
| 111 | |
| 112 | return true; |
| 113 | } |
| 114 | |
| 115 | /** |
| 116 | * Returns the card type (mastercard, visa, ...). |
| 117 | * |
| 118 | * @since 2.6.0 |
| 119 | * @param string $context What the value is for. Valid values are view and edit. |
| 120 | * @return string Card type |
| 121 | */ |
| 122 | public function get_card_type( $context = 'view' ) { |
| 123 | return $this->get_prop( 'card_type', $context ); |
| 124 | } |
| 125 | |
| 126 | /** |
| 127 | * Set the card type (mastercard, visa, ...). |
| 128 | * |
| 129 | * @since 2.6.0 |
| 130 | * @param string $type Credit card type (mastercard, visa, ...). |
| 131 | */ |
| 132 | public function set_card_type( $type ) { |
| 133 | $this->set_prop( 'card_type', $type ); |
| 134 | } |
| 135 | |
| 136 | /** |
| 137 | * Returns the card expiration year (YYYY). |
| 138 | * |
| 139 | * @since 2.6.0 |
| 140 | * @param string $context What the value is for. Valid values are view and edit. |
| 141 | * @return string Expiration year |
| 142 | */ |
| 143 | public function get_expiry_year( $context = 'view' ) { |
| 144 | return $this->get_prop( 'expiry_year', $context ); |
| 145 | } |
| 146 | |
| 147 | /** |
| 148 | * Set the expiration year for the card (YYYY format). |
| 149 | * |
| 150 | * @since 2.6.0 |
| 151 | * @param string $year Credit card expiration year. |
| 152 | */ |
| 153 | public function set_expiry_year( $year ) { |
| 154 | $this->set_prop( 'expiry_year', $year ); |
| 155 | } |
| 156 | |
| 157 | /** |
| 158 | * Returns the card expiration month (MM). |
| 159 | * |
| 160 | * @since 2.6.0 |
| 161 | * @param string $context What the value is for. Valid values are view and edit. |
| 162 | * @return string Expiration month |
| 163 | */ |
| 164 | public function get_expiry_month( $context = 'view' ) { |
| 165 | return $this->get_prop( 'expiry_month', $context ); |
| 166 | } |
| 167 | |
| 168 | /** |
| 169 | * Set the expiration month for the card (formats into MM format). |
| 170 | * |
| 171 | * @since 2.6.0 |
| 172 | * @param string $month Credit card expiration month. |
| 173 | */ |
| 174 | public function set_expiry_month( $month ) { |
| 175 | $this->set_prop( 'expiry_month', str_pad( $month, 2, '0', STR_PAD_LEFT ) ); |
| 176 | } |
| 177 | |
| 178 | /** |
| 179 | * Returns the last four digits. |
| 180 | * |
| 181 | * @since 2.6.0 |
| 182 | * @param string $context What the value is for. Valid values are view and edit. |
| 183 | * @return string Last 4 digits |
| 184 | */ |
| 185 | public function get_last4( $context = 'view' ) { |
| 186 | return $this->get_prop( 'last4', $context ); |
| 187 | } |
| 188 | |
| 189 | /** |
| 190 | * Set the last four digits. |
| 191 | * |
| 192 | * @since 2.6.0 |
| 193 | * @param string $last4 Credit card last four digits. |
| 194 | */ |
| 195 | public function set_last4( $last4 ) { |
| 196 | $this->set_prop( 'last4', $last4 ); |
| 197 | } |
| 198 | } |
| 199 |