simple-payments.php
270 lines
| 1 | <?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName |
| 2 | /** |
| 3 | * Simple Payments lets users embed a PayPal button fully integrated with wpcom to sell products on the site. |
| 4 | * This is not a proper module yet, because not all the pieces are in place. Until everything is shipped, it can be turned |
| 5 | * into module that can be enabled/disabled. |
| 6 | * |
| 7 | * @package automattic/jetpack |
| 8 | */ |
| 9 | |
| 10 | use Automattic\Jetpack\Paypal_Payments\Simple_Payments as PayPal_Simple_Payments; |
| 11 | |
| 12 | /** |
| 13 | * Jetpack_Simple_Payments |
| 14 | */ |
| 15 | class Jetpack_Simple_Payments { |
| 16 | // These have to be under 20 chars because that is CPT limit. |
| 17 | |
| 18 | /** |
| 19 | * Post type order. |
| 20 | * |
| 21 | * @var string |
| 22 | */ |
| 23 | public static $post_type_order = 'jp_pay_order'; |
| 24 | |
| 25 | /** |
| 26 | * Post type product. |
| 27 | * |
| 28 | * @var string |
| 29 | */ |
| 30 | public static $post_type_product = 'jp_pay_product'; |
| 31 | |
| 32 | /** |
| 33 | * Define simple payment shortcode. |
| 34 | * |
| 35 | * @var string |
| 36 | */ |
| 37 | public static $shortcode = 'simple-payment'; |
| 38 | |
| 39 | /** |
| 40 | * Define simple payment CSS prefix. |
| 41 | * |
| 42 | * @var string |
| 43 | */ |
| 44 | public static $css_classname_prefix = 'jetpack-simple-payments'; |
| 45 | |
| 46 | /** |
| 47 | * Which plan the user is on. |
| 48 | * |
| 49 | * @var string value_bundle or jetpack_premium |
| 50 | */ |
| 51 | public static $required_plan; |
| 52 | |
| 53 | /** |
| 54 | * Instance of the class. |
| 55 | * |
| 56 | * @var Jetpack_Simple_Payments |
| 57 | */ |
| 58 | private static $instance; |
| 59 | |
| 60 | /** |
| 61 | * Construction function. |
| 62 | */ |
| 63 | private function __construct() {} |
| 64 | |
| 65 | /** |
| 66 | * Original singleton. |
| 67 | * |
| 68 | * @todo Remove this when nothing calles getInstance anymore. |
| 69 | */ |
| 70 | public static function getInstance() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid |
| 71 | return self::get_instance(); |
| 72 | } |
| 73 | |
| 74 | /** |
| 75 | * Create instance of class. |
| 76 | */ |
| 77 | public static function get_instance() { |
| 78 | if ( ! self::$instance ) { |
| 79 | self::$instance = new self(); |
| 80 | self::$instance->init_hook_action(); |
| 81 | self::$required_plan = ( defined( 'IS_WPCOM' ) && IS_WPCOM ) ? 'value_bundle' : 'jetpack_premium'; |
| 82 | } |
| 83 | return self::$instance; |
| 84 | } |
| 85 | |
| 86 | /** |
| 87 | * Actions that are run on init. |
| 88 | */ |
| 89 | public function init_hook_action() { |
| 90 | return PayPal_Simple_Payments::get_instance()->init_hook_action(); |
| 91 | } |
| 92 | |
| 93 | /** |
| 94 | * Enqueue the static assets needed in the frontend. |
| 95 | */ |
| 96 | public function enqueue_frontend_assets() { |
| 97 | return PayPal_Simple_Payments::get_instance()->enqueue_frontend_assets(); |
| 98 | } |
| 99 | |
| 100 | /** |
| 101 | * Add an inline script for setting up the PayPal checkout button. |
| 102 | * |
| 103 | * @param int $id Product ID. |
| 104 | * @param int $dom_id ID of the DOM element with the purchase message. |
| 105 | * @param boolean $is_multiple Whether multiple items of the same product can be purchased. |
| 106 | */ |
| 107 | public function setup_paypal_checkout_button( $id, $dom_id, $is_multiple ) { |
| 108 | return PayPal_Simple_Payments::get_instance()->setup_paypal_checkout_button( $id, $dom_id, $is_multiple ); |
| 109 | } |
| 110 | |
| 111 | /** |
| 112 | * Remove auto paragraph from product description. |
| 113 | * |
| 114 | * @param string $content - the content of the post. |
| 115 | */ |
| 116 | public function remove_auto_paragraph_from_product_description( $content ) { |
| 117 | return PayPal_Simple_Payments::get_instance()->remove_auto_paragraph_from_product_description( $content ); |
| 118 | } |
| 119 | |
| 120 | /** Return the blog ID */ |
| 121 | public function get_blog_id() { |
| 122 | return PayPal_Simple_Payments::get_instance()->get_blog_id(); |
| 123 | } |
| 124 | |
| 125 | /** |
| 126 | * Used to check whether Simple Payments are enabled for given site. |
| 127 | * |
| 128 | * @return bool True if Simple Payments are enabled, false otherwise. |
| 129 | */ |
| 130 | public function is_enabled_jetpack_simple_payments() { |
| 131 | return PayPal_Simple_Payments::is_enabled_jetpack_simple_payments(); |
| 132 | } |
| 133 | |
| 134 | /** |
| 135 | * Creates the content from a shortcode |
| 136 | * |
| 137 | * @param array $attrs Shortcode attributes. |
| 138 | * @param mixed $content unused. |
| 139 | * |
| 140 | * @return string|void |
| 141 | */ |
| 142 | public function parse_shortcode( $attrs, $content = false ) { |
| 143 | return PayPal_Simple_Payments::get_instance()->parse_shortcode( $attrs, $content ); |
| 144 | } |
| 145 | |
| 146 | /** |
| 147 | * Output an admin warning if user can't use Pay with PayPal. |
| 148 | * |
| 149 | * @param array $data unused. |
| 150 | */ |
| 151 | public function output_admin_warning( $data ) { |
| 152 | return PayPal_Simple_Payments::get_instance()->output_admin_warning( $data ); |
| 153 | } |
| 154 | |
| 155 | /** |
| 156 | * Get the HTML output to use as PayPal purchase box. |
| 157 | * |
| 158 | * @param string $dom_id ID of the DOM element with the purchase message. |
| 159 | * @param boolean $is_multiple Whether multiple items of the same product can be purchased. |
| 160 | * |
| 161 | * @return string |
| 162 | */ |
| 163 | public function output_purchase_box( $dom_id, $is_multiple ) { |
| 164 | return PayPal_Simple_Payments::get_instance()->output_purchase_box( $dom_id, $is_multiple ); |
| 165 | } |
| 166 | |
| 167 | /** |
| 168 | * Get the HTML output to replace the `simple-payments` shortcode. |
| 169 | * |
| 170 | * @param array $data Product data. |
| 171 | * @return string |
| 172 | */ |
| 173 | public function output_shortcode( $data ) { |
| 174 | return PayPal_Simple_Payments::get_instance()->output_shortcode( $data ); |
| 175 | } |
| 176 | |
| 177 | /** |
| 178 | * Allows custom post types to be used by REST API. |
| 179 | * |
| 180 | * @param array $post_types - the allows post types. |
| 181 | * @see hook 'rest_api_allowed_post_types' |
| 182 | * @return array |
| 183 | */ |
| 184 | public function allow_rest_api_types( $post_types ) { |
| 185 | return PayPal_Simple_Payments::get_instance()->allow_rest_api_types( $post_types ); |
| 186 | } |
| 187 | |
| 188 | /** |
| 189 | * Merge $post_meta with additional meta information. |
| 190 | * |
| 191 | * @param array $post_meta - the post's meta information. |
| 192 | */ |
| 193 | public function allow_sync_post_meta( $post_meta ) { |
| 194 | return PayPal_Simple_Payments::get_instance()->allow_sync_post_meta( $post_meta ); |
| 195 | } |
| 196 | |
| 197 | /** |
| 198 | * Enable Simple payments custom meta values for access through the REST API. |
| 199 | * Field's value will be exposed on a .meta key in the endpoint response, |
| 200 | * and WordPress will handle setting up the callbacks for reading and writing |
| 201 | * to that meta key. |
| 202 | * |
| 203 | * @link https://developer.wordpress.org/rest-api/extending-the-rest-api/modifying-responses/ |
| 204 | */ |
| 205 | public function register_meta_fields_in_rest_api() { |
| 206 | return PayPal_Simple_Payments::get_instance()->register_meta_fields_in_rest_api(); |
| 207 | } |
| 208 | |
| 209 | /** |
| 210 | * Sanitize three-character ISO-4217 Simple payments currency |
| 211 | * |
| 212 | * List has to be in sync with list at the block's client side and widget's backend side: |
| 213 | * |
| 214 | * @param array $currency - list of currencies. |
| 215 | * @link https://github.com/Automattic/jetpack/blob/31efa189ad223c0eb7ad085ac0650a23facf9ef5/extensions/blocks/simple-payments/constants.js#L9-L39 |
| 216 | * @link https://github.com/Automattic/jetpack/blob/31efa189ad223c0eb7ad085ac0650a23facf9ef5/modules/widgets/simple-payments.php#L19-L44 |
| 217 | * |
| 218 | * Currencies should be supported by PayPal: |
| 219 | * @link https://developer.paypal.com/docs/api/reference/currency-codes/ |
| 220 | * |
| 221 | * Indian Rupee (INR) not supported because at the time of the creation of this file |
| 222 | * because it's limited to in-country PayPal India accounts only. |
| 223 | * Discussion: https://github.com/Automattic/wp-calypso/pull/28236 |
| 224 | */ |
| 225 | public static function sanitize_currency( $currency ) { |
| 226 | return PayPal_Simple_Payments::sanitize_currency( $currency ); |
| 227 | } |
| 228 | |
| 229 | /** |
| 230 | * Sanitize price: |
| 231 | * |
| 232 | * Positive integers and floats |
| 233 | * Supports two decimal places. |
| 234 | * Maximum length: 10. |
| 235 | * |
| 236 | * See `price` from PayPal docs: |
| 237 | * |
| 238 | * @link https://developer.paypal.com/docs/api/orders/v1/#definition-item |
| 239 | * |
| 240 | * @param string $price - the price we want to sanitize. |
| 241 | * @return null|string |
| 242 | */ |
| 243 | public static function sanitize_price( $price ) { |
| 244 | return PayPal_Simple_Payments::sanitize_price( $price ); |
| 245 | } |
| 246 | |
| 247 | /** |
| 248 | * Sets up the custom post types for the module. |
| 249 | */ |
| 250 | public function setup_cpts() { |
| 251 | return PayPal_Simple_Payments::get_instance()->setup_cpts(); |
| 252 | } |
| 253 | |
| 254 | /** |
| 255 | * Validate the block attributes |
| 256 | * |
| 257 | * @param array $attrs The block attributes, expected to contain: |
| 258 | * * email - an email address. |
| 259 | * * price - a float between 0.01 and 9999999999.99. |
| 260 | * * productId - the ID of the product being paid for. |
| 261 | * |
| 262 | * @return bool |
| 263 | */ |
| 264 | public function is_valid( $attrs ) { |
| 265 | return PayPal_Simple_Payments::get_instance()->is_valid( $attrs ); |
| 266 | } |
| 267 | } |
| 268 | |
| 269 | PayPal_Simple_Payments::get_instance(); |
| 270 |