AyeCode /
invoicing
@@ -15,319 +15,319 @@ |
||
| 15 | 15 | class GetPaid_Post_Types { |
| 16 | 16 | |
| 17 | 17 | /** |
| 18 | - * Hook in methods. |
|
| 19 | - */ |
|
| 20 | - public function __construct() { |
|
| 21 | - add_action( 'init', array( __CLASS__, 'register_post_types' ), 1 ); |
|
| 22 | - add_action( 'init', array( __CLASS__, 'register_post_status' ), 4 ); |
|
| 23 | - add_action( 'getpaid_flush_rewrite_rules', array( __CLASS__, 'flush_rewrite_rules' ) ); |
|
| 24 | - add_action( 'getpaid_after_register_post_types', array( __CLASS__, 'maybe_flush_rewrite_rules' ) ); |
|
| 25 | - } |
|
| 18 | + * Hook in methods. |
|
| 19 | + */ |
|
| 20 | + public function __construct() { |
|
| 21 | + add_action( 'init', array( __CLASS__, 'register_post_types' ), 1 ); |
|
| 22 | + add_action( 'init', array( __CLASS__, 'register_post_status' ), 4 ); |
|
| 23 | + add_action( 'getpaid_flush_rewrite_rules', array( __CLASS__, 'flush_rewrite_rules' ) ); |
|
| 24 | + add_action( 'getpaid_after_register_post_types', array( __CLASS__, 'maybe_flush_rewrite_rules' ) ); |
|
| 25 | + } |
|
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * Register core post types. |
|
| 29 | - */ |
|
| 30 | - public static function register_post_types() { |
|
| 27 | + /** |
|
| 28 | + * Register core post types. |
|
| 29 | + */ |
|
| 30 | + public static function register_post_types() { |
|
| 31 | 31 | |
| 32 | - if ( ! is_blog_installed() || post_type_exists( 'wpi_item' ) ) { |
|
| 33 | - return; |
|
| 34 | - } |
|
| 32 | + if ( ! is_blog_installed() || post_type_exists( 'wpi_item' ) ) { |
|
| 33 | + return; |
|
| 34 | + } |
|
| 35 | 35 | |
| 36 | - // Fires before registering post types. |
|
| 37 | - do_action( 'getpaid_register_post_types' ); |
|
| 36 | + // Fires before registering post types. |
|
| 37 | + do_action( 'getpaid_register_post_types' ); |
|
| 38 | 38 | |
| 39 | - // Register item post type. |
|
| 40 | - register_post_type( |
|
| 41 | - 'wpi_item', |
|
| 42 | - apply_filters( |
|
| 43 | - 'wpinv_register_post_type_invoice_item', |
|
| 44 | - array( |
|
| 45 | - 'labels' => array( |
|
| 46 | - 'name' => _x( 'Items', 'post type general name', 'invoicing' ), |
|
| 47 | - 'singular_name' => _x( 'Item', 'post type singular name', 'invoicing' ), |
|
| 48 | - 'menu_name' => _x( 'Items', 'admin menu', 'invoicing' ), |
|
| 49 | - 'name_admin_bar' => _x( 'Item', 'add new on admin bar', 'invoicing' ), |
|
| 50 | - 'add_new' => _x( 'Add New', 'Item', 'invoicing' ), |
|
| 51 | - 'add_new_item' => __( 'Add New Item', 'invoicing' ), |
|
| 52 | - 'new_item' => __( 'New Item', 'invoicing' ), |
|
| 53 | - 'edit_item' => __( 'Edit Item', 'invoicing' ), |
|
| 54 | - 'view_item' => __( 'View Item', 'invoicing' ), |
|
| 55 | - 'all_items' => __( 'Items', 'invoicing' ), |
|
| 56 | - 'search_items' => __( 'Search items', 'invoicing' ), |
|
| 57 | - 'parent_item_colon' => __( 'Parent item:', 'invoicing' ), |
|
| 58 | - 'not_found' => __( 'No items found.', 'invoicing' ), |
|
| 59 | - 'not_found_in_trash' => __( 'No items found in trash.', 'invoicing' ) |
|
| 60 | - ), |
|
| 61 | - 'description' => __( 'This is where you can add new invoice items.', 'invoicing' ), |
|
| 62 | - 'public' => false, |
|
| 63 | - 'has_archive' => false, |
|
| 64 | - '_builtin' => false, |
|
| 65 | - 'show_ui' => true, |
|
| 66 | - 'show_in_menu' => wpinv_current_user_can_manage_invoicing() ? 'wpinv' : false, |
|
| 67 | - 'show_in_nav_menus' => false, |
|
| 68 | - 'supports' => array( 'title', 'excerpt', 'thumbnail' ), |
|
| 69 | - 'rewrite' => false, |
|
| 70 | - 'query_var' => false, |
|
| 71 | - 'map_meta_cap' => true, |
|
| 72 | - 'show_in_admin_bar' => true, |
|
| 73 | - 'can_export' => true, |
|
| 74 | - ) |
|
| 75 | - ) |
|
| 76 | - ); |
|
| 39 | + // Register item post type. |
|
| 40 | + register_post_type( |
|
| 41 | + 'wpi_item', |
|
| 42 | + apply_filters( |
|
| 43 | + 'wpinv_register_post_type_invoice_item', |
|
| 44 | + array( |
|
| 45 | + 'labels' => array( |
|
| 46 | + 'name' => _x( 'Items', 'post type general name', 'invoicing' ), |
|
| 47 | + 'singular_name' => _x( 'Item', 'post type singular name', 'invoicing' ), |
|
| 48 | + 'menu_name' => _x( 'Items', 'admin menu', 'invoicing' ), |
|
| 49 | + 'name_admin_bar' => _x( 'Item', 'add new on admin bar', 'invoicing' ), |
|
| 50 | + 'add_new' => _x( 'Add New', 'Item', 'invoicing' ), |
|
| 51 | + 'add_new_item' => __( 'Add New Item', 'invoicing' ), |
|
| 52 | + 'new_item' => __( 'New Item', 'invoicing' ), |
|
| 53 | + 'edit_item' => __( 'Edit Item', 'invoicing' ), |
|
| 54 | + 'view_item' => __( 'View Item', 'invoicing' ), |
|
| 55 | + 'all_items' => __( 'Items', 'invoicing' ), |
|
| 56 | + 'search_items' => __( 'Search items', 'invoicing' ), |
|
| 57 | + 'parent_item_colon' => __( 'Parent item:', 'invoicing' ), |
|
| 58 | + 'not_found' => __( 'No items found.', 'invoicing' ), |
|
| 59 | + 'not_found_in_trash' => __( 'No items found in trash.', 'invoicing' ) |
|
| 60 | + ), |
|
| 61 | + 'description' => __( 'This is where you can add new invoice items.', 'invoicing' ), |
|
| 62 | + 'public' => false, |
|
| 63 | + 'has_archive' => false, |
|
| 64 | + '_builtin' => false, |
|
| 65 | + 'show_ui' => true, |
|
| 66 | + 'show_in_menu' => wpinv_current_user_can_manage_invoicing() ? 'wpinv' : false, |
|
| 67 | + 'show_in_nav_menus' => false, |
|
| 68 | + 'supports' => array( 'title', 'excerpt', 'thumbnail' ), |
|
| 69 | + 'rewrite' => false, |
|
| 70 | + 'query_var' => false, |
|
| 71 | + 'map_meta_cap' => true, |
|
| 72 | + 'show_in_admin_bar' => true, |
|
| 73 | + 'can_export' => true, |
|
| 74 | + ) |
|
| 75 | + ) |
|
| 76 | + ); |
|
| 77 | 77 | |
| 78 | - // Register payment form post type. |
|
| 79 | - register_post_type( |
|
| 80 | - 'wpi_payment_form', |
|
| 81 | - apply_filters( |
|
| 82 | - 'wpinv_register_post_type_payment_form', |
|
| 83 | - array( |
|
| 84 | - 'labels' => array( |
|
| 85 | - 'name' => _x( 'Payment Forms', 'post type general name', 'invoicing' ), |
|
| 86 | - 'singular_name' => _x( 'Payment Form', 'post type singular name', 'invoicing' ), |
|
| 87 | - 'menu_name' => _x( 'Payment Forms', 'admin menu', 'invoicing' ), |
|
| 88 | - 'name_admin_bar' => _x( 'Payment Form', 'add new on admin bar', 'invoicing' ), |
|
| 89 | - 'add_new' => _x( 'Add New', 'Payment Form', 'invoicing' ), |
|
| 90 | - 'add_new_item' => __( 'Add New Payment Form', 'invoicing' ), |
|
| 91 | - 'new_item' => __( 'New Payment Form', 'invoicing' ), |
|
| 92 | - 'edit_item' => __( 'Edit Payment Form', 'invoicing' ), |
|
| 93 | - 'view_item' => __( 'View Payment Form', 'invoicing' ), |
|
| 94 | - 'all_items' => __( 'Payment Forms', 'invoicing' ), |
|
| 95 | - 'search_items' => __( 'Search Payment Forms', 'invoicing' ), |
|
| 96 | - 'parent_item_colon' => __( 'Parent Payment Forms:', 'invoicing' ), |
|
| 97 | - 'not_found' => __( 'No payment forms found.', 'invoicing' ), |
|
| 98 | - 'not_found_in_trash' => __( 'No payment forms found in trash.', 'invoicing' ) |
|
| 99 | - ), |
|
| 100 | - 'description' => __( 'Add new payment forms.', 'invoicing' ), |
|
| 101 | - 'public' => false, |
|
| 102 | - 'show_ui' => true, |
|
| 103 | - 'show_in_menu' => wpinv_current_user_can_manage_invoicing() ? 'wpinv' : true, |
|
| 104 | - 'show_in_nav_menus' => false, |
|
| 105 | - 'query_var' => false, |
|
| 106 | - 'rewrite' => true, |
|
| 107 | - 'map_meta_cap' => true, |
|
| 108 | - 'has_archive' => false, |
|
| 109 | - 'hierarchical' => false, |
|
| 110 | - 'menu_position' => null, |
|
| 111 | - 'supports' => array( 'title' ), |
|
| 112 | - 'menu_icon' => 'dashicons-media-form', |
|
| 113 | - ) |
|
| 114 | - ) |
|
| 115 | - ); |
|
| 78 | + // Register payment form post type. |
|
| 79 | + register_post_type( |
|
| 80 | + 'wpi_payment_form', |
|
| 81 | + apply_filters( |
|
| 82 | + 'wpinv_register_post_type_payment_form', |
|
| 83 | + array( |
|
| 84 | + 'labels' => array( |
|
| 85 | + 'name' => _x( 'Payment Forms', 'post type general name', 'invoicing' ), |
|
| 86 | + 'singular_name' => _x( 'Payment Form', 'post type singular name', 'invoicing' ), |
|
| 87 | + 'menu_name' => _x( 'Payment Forms', 'admin menu', 'invoicing' ), |
|
| 88 | + 'name_admin_bar' => _x( 'Payment Form', 'add new on admin bar', 'invoicing' ), |
|
| 89 | + 'add_new' => _x( 'Add New', 'Payment Form', 'invoicing' ), |
|
| 90 | + 'add_new_item' => __( 'Add New Payment Form', 'invoicing' ), |
|
| 91 | + 'new_item' => __( 'New Payment Form', 'invoicing' ), |
|
| 92 | + 'edit_item' => __( 'Edit Payment Form', 'invoicing' ), |
|
| 93 | + 'view_item' => __( 'View Payment Form', 'invoicing' ), |
|
| 94 | + 'all_items' => __( 'Payment Forms', 'invoicing' ), |
|
| 95 | + 'search_items' => __( 'Search Payment Forms', 'invoicing' ), |
|
| 96 | + 'parent_item_colon' => __( 'Parent Payment Forms:', 'invoicing' ), |
|
| 97 | + 'not_found' => __( 'No payment forms found.', 'invoicing' ), |
|
| 98 | + 'not_found_in_trash' => __( 'No payment forms found in trash.', 'invoicing' ) |
|
| 99 | + ), |
|
| 100 | + 'description' => __( 'Add new payment forms.', 'invoicing' ), |
|
| 101 | + 'public' => false, |
|
| 102 | + 'show_ui' => true, |
|
| 103 | + 'show_in_menu' => wpinv_current_user_can_manage_invoicing() ? 'wpinv' : true, |
|
| 104 | + 'show_in_nav_menus' => false, |
|
| 105 | + 'query_var' => false, |
|
| 106 | + 'rewrite' => true, |
|
| 107 | + 'map_meta_cap' => true, |
|
| 108 | + 'has_archive' => false, |
|
| 109 | + 'hierarchical' => false, |
|
| 110 | + 'menu_position' => null, |
|
| 111 | + 'supports' => array( 'title' ), |
|
| 112 | + 'menu_icon' => 'dashicons-media-form', |
|
| 113 | + ) |
|
| 114 | + ) |
|
| 115 | + ); |
|
| 116 | 116 | |
| 117 | - // Register invoice post type. |
|
| 118 | - register_post_type( |
|
| 119 | - 'wpi_invoice', |
|
| 120 | - apply_filters( |
|
| 121 | - 'wpinv_register_post_type_invoice', |
|
| 122 | - array( |
|
| 123 | - 'labels' => array( |
|
| 124 | - 'name' => __( 'Invoices', 'invoicing' ), |
|
| 125 | - 'singular_name' => __( 'Invoice', 'invoicing' ), |
|
| 126 | - 'all_items' => __( 'Invoices', 'invoicing' ), |
|
| 127 | - 'menu_name' => _x( 'Invoices', 'Admin menu name', 'invoicing' ), |
|
| 128 | - 'add_new' => __( 'Add New', 'invoicing' ), |
|
| 129 | - 'add_new_item' => __( 'Add new invoice', 'invoicing' ), |
|
| 130 | - 'edit' => __( 'Edit', 'invoicing' ), |
|
| 131 | - 'edit_item' => __( 'Edit invoice', 'invoicing' ), |
|
| 132 | - 'new_item' => __( 'New invoice', 'invoicing' ), |
|
| 133 | - 'view_item' => __( 'View invoice', 'invoicing' ), |
|
| 134 | - 'view_items' => __( 'View Invoices', 'invoicing' ), |
|
| 135 | - 'search_items' => __( 'Search invoices', 'invoicing' ), |
|
| 136 | - 'not_found' => __( 'No invoices found', 'invoicing' ), |
|
| 137 | - 'not_found_in_trash' => __( 'No invoices found in trash', 'invoicing' ), |
|
| 138 | - 'parent' => __( 'Parent invoice', 'invoicing' ), |
|
| 139 | - 'featured_image' => __( 'Invoice image', 'invoicing' ), |
|
| 140 | - 'set_featured_image' => __( 'Set invoice image', 'invoicing' ), |
|
| 141 | - 'remove_featured_image' => __( 'Remove invoice image', 'invoicing' ), |
|
| 142 | - 'use_featured_image' => __( 'Use as invoice image', 'invoicing' ), |
|
| 143 | - 'insert_into_item' => __( 'Insert into invoice', 'invoicing' ), |
|
| 144 | - 'uploaded_to_this_item' => __( 'Uploaded to this invoice', 'invoicing' ), |
|
| 145 | - 'filter_items_list' => __( 'Filter invoices', 'invoicing' ), |
|
| 146 | - 'items_list_navigation' => __( 'Invoices navigation', 'invoicing' ), |
|
| 147 | - 'items_list' => __( 'Invoices list', 'invoicing' ), |
|
| 148 | - ), |
|
| 149 | - 'description' => __( 'This is where invoices are stored.', 'invoicing' ), |
|
| 150 | - 'public' => true, |
|
| 151 | - 'has_archive' => false, |
|
| 152 | - 'publicly_queryable' => true, |
|
| 153 | - 'exclude_from_search' => true, |
|
| 154 | - 'show_ui' => true, |
|
| 155 | - 'show_in_menu' => wpinv_current_user_can_manage_invoicing() ? 'wpinv' : false, |
|
| 156 | - 'show_in_nav_menus' => false, |
|
| 157 | - 'supports' => array( 'title', 'author', 'excerpt' ), |
|
| 158 | - 'rewrite' => array( |
|
| 159 | - 'slug' => 'invoice', |
|
| 160 | - 'with_front' => false, |
|
| 161 | - ), |
|
| 162 | - 'query_var' => false, |
|
| 163 | - 'map_meta_cap' => true, |
|
| 164 | - 'show_in_admin_bar' => true, |
|
| 165 | - 'can_export' => true, |
|
| 166 | - 'hierarchical' => false, |
|
| 167 | - 'menu_position' => null, |
|
| 168 | - 'menu_icon' => 'dashicons-media-spreadsheet', |
|
| 169 | - ) |
|
| 170 | - ) |
|
| 171 | - ); |
|
| 117 | + // Register invoice post type. |
|
| 118 | + register_post_type( |
|
| 119 | + 'wpi_invoice', |
|
| 120 | + apply_filters( |
|
| 121 | + 'wpinv_register_post_type_invoice', |
|
| 122 | + array( |
|
| 123 | + 'labels' => array( |
|
| 124 | + 'name' => __( 'Invoices', 'invoicing' ), |
|
| 125 | + 'singular_name' => __( 'Invoice', 'invoicing' ), |
|
| 126 | + 'all_items' => __( 'Invoices', 'invoicing' ), |
|
| 127 | + 'menu_name' => _x( 'Invoices', 'Admin menu name', 'invoicing' ), |
|
| 128 | + 'add_new' => __( 'Add New', 'invoicing' ), |
|
| 129 | + 'add_new_item' => __( 'Add new invoice', 'invoicing' ), |
|
| 130 | + 'edit' => __( 'Edit', 'invoicing' ), |
|
| 131 | + 'edit_item' => __( 'Edit invoice', 'invoicing' ), |
|
| 132 | + 'new_item' => __( 'New invoice', 'invoicing' ), |
|
| 133 | + 'view_item' => __( 'View invoice', 'invoicing' ), |
|
| 134 | + 'view_items' => __( 'View Invoices', 'invoicing' ), |
|
| 135 | + 'search_items' => __( 'Search invoices', 'invoicing' ), |
|
| 136 | + 'not_found' => __( 'No invoices found', 'invoicing' ), |
|
| 137 | + 'not_found_in_trash' => __( 'No invoices found in trash', 'invoicing' ), |
|
| 138 | + 'parent' => __( 'Parent invoice', 'invoicing' ), |
|
| 139 | + 'featured_image' => __( 'Invoice image', 'invoicing' ), |
|
| 140 | + 'set_featured_image' => __( 'Set invoice image', 'invoicing' ), |
|
| 141 | + 'remove_featured_image' => __( 'Remove invoice image', 'invoicing' ), |
|
| 142 | + 'use_featured_image' => __( 'Use as invoice image', 'invoicing' ), |
|
| 143 | + 'insert_into_item' => __( 'Insert into invoice', 'invoicing' ), |
|
| 144 | + 'uploaded_to_this_item' => __( 'Uploaded to this invoice', 'invoicing' ), |
|
| 145 | + 'filter_items_list' => __( 'Filter invoices', 'invoicing' ), |
|
| 146 | + 'items_list_navigation' => __( 'Invoices navigation', 'invoicing' ), |
|
| 147 | + 'items_list' => __( 'Invoices list', 'invoicing' ), |
|
| 148 | + ), |
|
| 149 | + 'description' => __( 'This is where invoices are stored.', 'invoicing' ), |
|
| 150 | + 'public' => true, |
|
| 151 | + 'has_archive' => false, |
|
| 152 | + 'publicly_queryable' => true, |
|
| 153 | + 'exclude_from_search' => true, |
|
| 154 | + 'show_ui' => true, |
|
| 155 | + 'show_in_menu' => wpinv_current_user_can_manage_invoicing() ? 'wpinv' : false, |
|
| 156 | + 'show_in_nav_menus' => false, |
|
| 157 | + 'supports' => array( 'title', 'author', 'excerpt' ), |
|
| 158 | + 'rewrite' => array( |
|
| 159 | + 'slug' => 'invoice', |
|
| 160 | + 'with_front' => false, |
|
| 161 | + ), |
|
| 162 | + 'query_var' => false, |
|
| 163 | + 'map_meta_cap' => true, |
|
| 164 | + 'show_in_admin_bar' => true, |
|
| 165 | + 'can_export' => true, |
|
| 166 | + 'hierarchical' => false, |
|
| 167 | + 'menu_position' => null, |
|
| 168 | + 'menu_icon' => 'dashicons-media-spreadsheet', |
|
| 169 | + ) |
|
| 170 | + ) |
|
| 171 | + ); |
|
| 172 | 172 | |
| 173 | - // Register discount post type. |
|
| 174 | - register_post_type( |
|
| 175 | - 'wpi_discount', |
|
| 176 | - apply_filters( |
|
| 177 | - 'wpinv_register_post_type_discount', |
|
| 178 | - array( |
|
| 179 | - 'labels' => array( |
|
| 180 | - 'name' => __( 'Discounts', 'invoicing' ), |
|
| 181 | - 'singular_name' => __( 'Discount', 'invoicing' ), |
|
| 182 | - 'all_items' => __( 'Discounts', 'invoicing' ), |
|
| 183 | - 'menu_name' => _x( 'Discounts', 'Admin menu name', 'invoicing' ), |
|
| 184 | - 'add_new' => __( 'Add New', 'invoicing' ), |
|
| 185 | - 'add_new_item' => __( 'Add new discount', 'invoicing' ), |
|
| 186 | - 'edit' => __( 'Edit', 'invoicing' ), |
|
| 187 | - 'edit_item' => __( 'Edit discount', 'invoicing' ), |
|
| 188 | - 'new_item' => __( 'New discount', 'invoicing' ), |
|
| 189 | - 'view_item' => __( 'View discount', 'invoicing' ), |
|
| 190 | - 'view_items' => __( 'View Discounts', 'invoicing' ), |
|
| 191 | - 'search_items' => __( 'Search discounts', 'invoicing' ), |
|
| 192 | - 'not_found' => __( 'No discounts found', 'invoicing' ), |
|
| 193 | - 'not_found_in_trash' => __( 'No discounts found in trash', 'invoicing' ), |
|
| 194 | - 'parent' => __( 'Parent discount', 'invoicing' ), |
|
| 195 | - 'featured_image' => __( 'Discount image', 'invoicing' ), |
|
| 196 | - 'set_featured_image' => __( 'Set discount image', 'invoicing' ), |
|
| 197 | - 'remove_featured_image' => __( 'Remove discount image', 'invoicing' ), |
|
| 198 | - 'use_featured_image' => __( 'Use as discount image', 'invoicing' ), |
|
| 199 | - 'insert_into_item' => __( 'Insert into discount', 'invoicing' ), |
|
| 200 | - 'uploaded_to_this_item' => __( 'Uploaded to this discount', 'invoicing' ), |
|
| 201 | - 'filter_items_list' => __( 'Filter discounts', 'invoicing' ), |
|
| 202 | - 'items_list_navigation' => __( 'Discount navigation', 'invoicing' ), |
|
| 203 | - 'items_list' => __( 'Discounts list', 'invoicing' ), |
|
| 204 | - ), |
|
| 205 | - 'description' => __( 'This is where you can add new discounts that users can use in invoices.', 'invoicing' ), |
|
| 206 | - 'public' => false, |
|
| 207 | - 'can_export' => true, |
|
| 208 | - '_builtin' => false, |
|
| 209 | - 'publicly_queryable' => false, |
|
| 210 | - 'exclude_from_search'=> true, |
|
| 211 | - 'show_ui' => true, |
|
| 212 | - 'show_in_menu' => wpinv_current_user_can_manage_invoicing() ? 'wpinv' : false, |
|
| 213 | - 'query_var' => false, |
|
| 214 | - 'rewrite' => false, |
|
| 215 | - 'map_meta_cap' => true, |
|
| 216 | - 'has_archive' => false, |
|
| 217 | - 'hierarchical' => false, |
|
| 218 | - 'supports' => array( 'title', 'excerpt' ), |
|
| 219 | - 'show_in_nav_menus' => false, |
|
| 220 | - 'show_in_admin_bar' => true, |
|
| 221 | - 'menu_position' => null, |
|
| 222 | - ) |
|
| 223 | - ) |
|
| 224 | - ); |
|
| 173 | + // Register discount post type. |
|
| 174 | + register_post_type( |
|
| 175 | + 'wpi_discount', |
|
| 176 | + apply_filters( |
|
| 177 | + 'wpinv_register_post_type_discount', |
|
| 178 | + array( |
|
| 179 | + 'labels' => array( |
|
| 180 | + 'name' => __( 'Discounts', 'invoicing' ), |
|
| 181 | + 'singular_name' => __( 'Discount', 'invoicing' ), |
|
| 182 | + 'all_items' => __( 'Discounts', 'invoicing' ), |
|
| 183 | + 'menu_name' => _x( 'Discounts', 'Admin menu name', 'invoicing' ), |
|
| 184 | + 'add_new' => __( 'Add New', 'invoicing' ), |
|
| 185 | + 'add_new_item' => __( 'Add new discount', 'invoicing' ), |
|
| 186 | + 'edit' => __( 'Edit', 'invoicing' ), |
|
| 187 | + 'edit_item' => __( 'Edit discount', 'invoicing' ), |
|
| 188 | + 'new_item' => __( 'New discount', 'invoicing' ), |
|
| 189 | + 'view_item' => __( 'View discount', 'invoicing' ), |
|
| 190 | + 'view_items' => __( 'View Discounts', 'invoicing' ), |
|
| 191 | + 'search_items' => __( 'Search discounts', 'invoicing' ), |
|
| 192 | + 'not_found' => __( 'No discounts found', 'invoicing' ), |
|
| 193 | + 'not_found_in_trash' => __( 'No discounts found in trash', 'invoicing' ), |
|
| 194 | + 'parent' => __( 'Parent discount', 'invoicing' ), |
|
| 195 | + 'featured_image' => __( 'Discount image', 'invoicing' ), |
|
| 196 | + 'set_featured_image' => __( 'Set discount image', 'invoicing' ), |
|
| 197 | + 'remove_featured_image' => __( 'Remove discount image', 'invoicing' ), |
|
| 198 | + 'use_featured_image' => __( 'Use as discount image', 'invoicing' ), |
|
| 199 | + 'insert_into_item' => __( 'Insert into discount', 'invoicing' ), |
|
| 200 | + 'uploaded_to_this_item' => __( 'Uploaded to this discount', 'invoicing' ), |
|
| 201 | + 'filter_items_list' => __( 'Filter discounts', 'invoicing' ), |
|
| 202 | + 'items_list_navigation' => __( 'Discount navigation', 'invoicing' ), |
|
| 203 | + 'items_list' => __( 'Discounts list', 'invoicing' ), |
|
| 204 | + ), |
|
| 205 | + 'description' => __( 'This is where you can add new discounts that users can use in invoices.', 'invoicing' ), |
|
| 206 | + 'public' => false, |
|
| 207 | + 'can_export' => true, |
|
| 208 | + '_builtin' => false, |
|
| 209 | + 'publicly_queryable' => false, |
|
| 210 | + 'exclude_from_search'=> true, |
|
| 211 | + 'show_ui' => true, |
|
| 212 | + 'show_in_menu' => wpinv_current_user_can_manage_invoicing() ? 'wpinv' : false, |
|
| 213 | + 'query_var' => false, |
|
| 214 | + 'rewrite' => false, |
|
| 215 | + 'map_meta_cap' => true, |
|
| 216 | + 'has_archive' => false, |
|
| 217 | + 'hierarchical' => false, |
|
| 218 | + 'supports' => array( 'title', 'excerpt' ), |
|
| 219 | + 'show_in_nav_menus' => false, |
|
| 220 | + 'show_in_admin_bar' => true, |
|
| 221 | + 'menu_position' => null, |
|
| 222 | + ) |
|
| 223 | + ) |
|
| 224 | + ); |
|
| 225 | 225 | |
| 226 | - do_action( 'getpaid_after_register_post_types' ); |
|
| 227 | - } |
|
| 226 | + do_action( 'getpaid_after_register_post_types' ); |
|
| 227 | + } |
|
| 228 | 228 | |
| 229 | - /** |
|
| 230 | - * Register our custom post statuses. |
|
| 231 | - */ |
|
| 232 | - public static function register_post_status() { |
|
| 229 | + /** |
|
| 230 | + * Register our custom post statuses. |
|
| 231 | + */ |
|
| 232 | + public static function register_post_status() { |
|
| 233 | 233 | |
| 234 | - $invoice_statuses = apply_filters( |
|
| 235 | - 'getpaid_register_invoice_post_statuses', |
|
| 236 | - array( |
|
| 234 | + $invoice_statuses = apply_filters( |
|
| 235 | + 'getpaid_register_invoice_post_statuses', |
|
| 236 | + array( |
|
| 237 | 237 | |
| 238 | - 'wpi-pending' => array( |
|
| 239 | - 'label' => _x( 'Pending Payment', 'Invoice status', 'invoicing' ), |
|
| 240 | - 'public' => true, |
|
| 241 | - 'exclude_from_search' => true, |
|
| 242 | - 'show_in_admin_all_list' => true, |
|
| 243 | - 'show_in_admin_status_list' => true, |
|
| 244 | - /* translators: %s: number of invoices */ |
|
| 245 | - 'label_count' => _n_noop( 'Pending Payment <span class="count">(%s)</span>', 'Pending Payment <span class="count">(%s)</span>', 'invoicing' ) |
|
| 246 | - ), |
|
| 238 | + 'wpi-pending' => array( |
|
| 239 | + 'label' => _x( 'Pending Payment', 'Invoice status', 'invoicing' ), |
|
| 240 | + 'public' => true, |
|
| 241 | + 'exclude_from_search' => true, |
|
| 242 | + 'show_in_admin_all_list' => true, |
|
| 243 | + 'show_in_admin_status_list' => true, |
|
| 244 | + /* translators: %s: number of invoices */ |
|
| 245 | + 'label_count' => _n_noop( 'Pending Payment <span class="count">(%s)</span>', 'Pending Payment <span class="count">(%s)</span>', 'invoicing' ) |
|
| 246 | + ), |
|
| 247 | 247 | |
| 248 | - 'wpi-processing' => array( |
|
| 249 | - 'label' => _x( 'Processing', 'Invoice status', 'invoicing' ), |
|
| 250 | - 'public' => true, |
|
| 251 | - 'exclude_from_search' => true, |
|
| 252 | - 'show_in_admin_all_list' => true, |
|
| 253 | - 'show_in_admin_status_list' => true, |
|
| 254 | - /* translators: %s: number of invoices */ |
|
| 255 | - 'label_count' => _n_noop( 'Processing <span class="count">(%s)</span>', 'Processing <span class="count">(%s)</span>', 'invoicing' ) |
|
| 256 | - ), |
|
| 248 | + 'wpi-processing' => array( |
|
| 249 | + 'label' => _x( 'Processing', 'Invoice status', 'invoicing' ), |
|
| 250 | + 'public' => true, |
|
| 251 | + 'exclude_from_search' => true, |
|
| 252 | + 'show_in_admin_all_list' => true, |
|
| 253 | + 'show_in_admin_status_list' => true, |
|
| 254 | + /* translators: %s: number of invoices */ |
|
| 255 | + 'label_count' => _n_noop( 'Processing <span class="count">(%s)</span>', 'Processing <span class="count">(%s)</span>', 'invoicing' ) |
|
| 256 | + ), |
|
| 257 | 257 | |
| 258 | - 'wpi-onhold' => array( |
|
| 259 | - 'label' => _x( 'On Hold', 'Invoice status', 'invoicing' ), |
|
| 260 | - 'public' => true, |
|
| 261 | - 'exclude_from_search' => true, |
|
| 262 | - 'show_in_admin_all_list' => true, |
|
| 263 | - 'show_in_admin_status_list' => true, |
|
| 264 | - /* translators: %s: number of invoices */ |
|
| 265 | - 'label_count' => _n_noop( 'On Hold <span class="count">(%s)</span>', 'On Hold <span class="count">(%s)</span>', 'invoicing' ) |
|
| 266 | - ), |
|
| 258 | + 'wpi-onhold' => array( |
|
| 259 | + 'label' => _x( 'On Hold', 'Invoice status', 'invoicing' ), |
|
| 260 | + 'public' => true, |
|
| 261 | + 'exclude_from_search' => true, |
|
| 262 | + 'show_in_admin_all_list' => true, |
|
| 263 | + 'show_in_admin_status_list' => true, |
|
| 264 | + /* translators: %s: number of invoices */ |
|
| 265 | + 'label_count' => _n_noop( 'On Hold <span class="count">(%s)</span>', 'On Hold <span class="count">(%s)</span>', 'invoicing' ) |
|
| 266 | + ), |
|
| 267 | 267 | |
| 268 | - 'wpi-cancelled' => array( |
|
| 269 | - 'label' => _x( 'Cancelled', 'Invoice status', 'invoicing' ), |
|
| 270 | - 'public' => true, |
|
| 271 | - 'exclude_from_search' => true, |
|
| 272 | - 'show_in_admin_all_list' => true, |
|
| 273 | - 'show_in_admin_status_list' => true, |
|
| 274 | - /* translators: %s: number of invoices */ |
|
| 275 | - 'label_count' => _n_noop( 'Cancelled <span class="count">(%s)</span>', 'Cancelled <span class="count">(%s)</span>', 'invoicing' ) |
|
| 276 | - ), |
|
| 268 | + 'wpi-cancelled' => array( |
|
| 269 | + 'label' => _x( 'Cancelled', 'Invoice status', 'invoicing' ), |
|
| 270 | + 'public' => true, |
|
| 271 | + 'exclude_from_search' => true, |
|
| 272 | + 'show_in_admin_all_list' => true, |
|
| 273 | + 'show_in_admin_status_list' => true, |
|
| 274 | + /* translators: %s: number of invoices */ |
|
| 275 | + 'label_count' => _n_noop( 'Cancelled <span class="count">(%s)</span>', 'Cancelled <span class="count">(%s)</span>', 'invoicing' ) |
|
| 276 | + ), |
|
| 277 | 277 | |
| 278 | - 'wpi-refunded' => array( |
|
| 279 | - 'label' => _x( 'Refunded', 'Invoice status', 'invoicing' ), |
|
| 280 | - 'public' => true, |
|
| 281 | - 'exclude_from_search' => true, |
|
| 282 | - 'show_in_admin_all_list' => true, |
|
| 283 | - 'show_in_admin_status_list' => true, |
|
| 284 | - /* translators: %s: number of invoices */ |
|
| 285 | - 'label_count' => _n_noop( 'Refunded <span class="count">(%s)</span>', 'Refunded <span class="count">(%s)</span>', 'invoicing' ) |
|
| 286 | - ), |
|
| 278 | + 'wpi-refunded' => array( |
|
| 279 | + 'label' => _x( 'Refunded', 'Invoice status', 'invoicing' ), |
|
| 280 | + 'public' => true, |
|
| 281 | + 'exclude_from_search' => true, |
|
| 282 | + 'show_in_admin_all_list' => true, |
|
| 283 | + 'show_in_admin_status_list' => true, |
|
| 284 | + /* translators: %s: number of invoices */ |
|
| 285 | + 'label_count' => _n_noop( 'Refunded <span class="count">(%s)</span>', 'Refunded <span class="count">(%s)</span>', 'invoicing' ) |
|
| 286 | + ), |
|
| 287 | 287 | |
| 288 | - 'wpi-failed' => array( |
|
| 289 | - 'label' => _x( 'Failed', 'Invoice status', 'invoicing' ), |
|
| 290 | - 'public' => true, |
|
| 291 | - 'exclude_from_search' => true, |
|
| 292 | - 'show_in_admin_all_list' => true, |
|
| 293 | - 'show_in_admin_status_list' => true, |
|
| 294 | - /* translators: %s: number of invoices */ |
|
| 295 | - 'label_count' => _n_noop( 'Failed <span class="count">(%s)</span>', 'Failed <span class="count">(%s)</span>', 'invoicing' ) |
|
| 296 | - ), |
|
| 288 | + 'wpi-failed' => array( |
|
| 289 | + 'label' => _x( 'Failed', 'Invoice status', 'invoicing' ), |
|
| 290 | + 'public' => true, |
|
| 291 | + 'exclude_from_search' => true, |
|
| 292 | + 'show_in_admin_all_list' => true, |
|
| 293 | + 'show_in_admin_status_list' => true, |
|
| 294 | + /* translators: %s: number of invoices */ |
|
| 295 | + 'label_count' => _n_noop( 'Failed <span class="count">(%s)</span>', 'Failed <span class="count">(%s)</span>', 'invoicing' ) |
|
| 296 | + ), |
|
| 297 | 297 | |
| 298 | - 'wpi-renewal' => array( |
|
| 299 | - 'label' => _x( 'Renewal', 'Invoice status', 'invoicing' ), |
|
| 300 | - 'public' => true, |
|
| 301 | - 'exclude_from_search' => true, |
|
| 302 | - 'show_in_admin_all_list' => true, |
|
| 303 | - 'show_in_admin_status_list' => true, |
|
| 304 | - /* translators: %s: number of invoices */ |
|
| 305 | - 'label_count' => _n_noop( 'Renewal <span class="count">(%s)</span>', 'Renewal <span class="count">(%s)</span>', 'invoicing' ) |
|
| 306 | - ) |
|
| 307 | - ) |
|
| 308 | - ); |
|
| 298 | + 'wpi-renewal' => array( |
|
| 299 | + 'label' => _x( 'Renewal', 'Invoice status', 'invoicing' ), |
|
| 300 | + 'public' => true, |
|
| 301 | + 'exclude_from_search' => true, |
|
| 302 | + 'show_in_admin_all_list' => true, |
|
| 303 | + 'show_in_admin_status_list' => true, |
|
| 304 | + /* translators: %s: number of invoices */ |
|
| 305 | + 'label_count' => _n_noop( 'Renewal <span class="count">(%s)</span>', 'Renewal <span class="count">(%s)</span>', 'invoicing' ) |
|
| 306 | + ) |
|
| 307 | + ) |
|
| 308 | + ); |
|
| 309 | 309 | |
| 310 | - foreach ( $invoice_statuses as $invoice_statuse => $args ) { |
|
| 311 | - register_post_status( $invoice_statuse, $args ); |
|
| 312 | - } |
|
| 313 | - } |
|
| 310 | + foreach ( $invoice_statuses as $invoice_statuse => $args ) { |
|
| 311 | + register_post_status( $invoice_statuse, $args ); |
|
| 312 | + } |
|
| 313 | + } |
|
| 314 | 314 | |
| 315 | - /** |
|
| 316 | - * Flush rewrite rules. |
|
| 317 | - */ |
|
| 318 | - public static function flush_rewrite_rules() { |
|
| 319 | - flush_rewrite_rules(); |
|
| 320 | - } |
|
| 315 | + /** |
|
| 316 | + * Flush rewrite rules. |
|
| 317 | + */ |
|
| 318 | + public static function flush_rewrite_rules() { |
|
| 319 | + flush_rewrite_rules(); |
|
| 320 | + } |
|
| 321 | 321 | |
| 322 | - /** |
|
| 323 | - * Flush rules to prevent 404. |
|
| 324 | - * |
|
| 325 | - */ |
|
| 326 | - public static function maybe_flush_rewrite_rules() { |
|
| 327 | - if ( ! get_option( 'getpaid_flushed_rewrite_rules' ) ) { |
|
| 328 | - update_option( 'getpaid_flushed_rewrite_rules', '1' ); |
|
| 329 | - self::flush_rewrite_rules(); |
|
| 330 | - } |
|
| 331 | - } |
|
| 322 | + /** |
|
| 323 | + * Flush rules to prevent 404. |
|
| 324 | + * |
|
| 325 | + */ |
|
| 326 | + public static function maybe_flush_rewrite_rules() { |
|
| 327 | + if ( ! get_option( 'getpaid_flushed_rewrite_rules' ) ) { |
|
| 328 | + update_option( 'getpaid_flushed_rewrite_rules', '1' ); |
|
| 329 | + self::flush_rewrite_rules(); |
|
| 330 | + } |
|
| 331 | + } |
|
| 332 | 332 | |
| 333 | 333 | } |
@@ -13,264 +13,264 @@ |
||
| 13 | 13 | */ |
| 14 | 14 | class GetPaid_Geolocation { |
| 15 | 15 | |
| 16 | - /** |
|
| 17 | - * Holds the current user's IP Address. |
|
| 18 | - * |
|
| 19 | - * @var string |
|
| 20 | - */ |
|
| 21 | - public static $current_user_ip; |
|
| 22 | - |
|
| 23 | - /** |
|
| 24 | - * API endpoints for looking up a user IP address. |
|
| 25 | - * |
|
| 26 | - * For example, in case a user is on localhost. |
|
| 27 | - * |
|
| 28 | - * @var array |
|
| 29 | - */ |
|
| 30 | - protected static $ip_lookup_apis = array( |
|
| 31 | - 'ipify' => 'http://api.ipify.org/', |
|
| 32 | - 'ipecho' => 'http://ipecho.net/plain', |
|
| 33 | - 'ident' => 'http://ident.me', |
|
| 34 | - 'whatismyipaddress' => 'http://bot.whatismyipaddress.com', |
|
| 35 | - ); |
|
| 36 | - |
|
| 37 | - /** |
|
| 38 | - * API endpoints for geolocating an IP address |
|
| 39 | - * |
|
| 40 | - * @var array |
|
| 41 | - */ |
|
| 42 | - protected static $geoip_apis = array( |
|
| 43 | - 'ip-api.com' => 'http://ip-api.com/json/%s', |
|
| 44 | - 'ipinfo.io' => 'https://ipinfo.io/%s/json', |
|
| 45 | - ); |
|
| 46 | - |
|
| 47 | - /** |
|
| 48 | - * Get current user IP Address. |
|
| 49 | - * |
|
| 50 | - * @return string |
|
| 51 | - */ |
|
| 52 | - public static function get_ip_address() { |
|
| 53 | - return wpinv_get_ip(); |
|
| 54 | - } |
|
| 55 | - |
|
| 56 | - /** |
|
| 57 | - * Get user IP Address using an external service. |
|
| 58 | - * This can be used as a fallback for users on localhost where |
|
| 59 | - * get_ip_address() will be a local IP and non-geolocatable. |
|
| 60 | - * |
|
| 61 | - * @return string |
|
| 62 | - */ |
|
| 63 | - public static function get_external_ip_address() { |
|
| 64 | - |
|
| 65 | - $transient_name = 'external_ip_address_0.0.0.0'; |
|
| 66 | - |
|
| 67 | - if ( '' !== self::get_ip_address() ) { |
|
| 68 | - $transient_name = 'external_ip_address_' . self::get_ip_address(); |
|
| 69 | - } |
|
| 70 | - |
|
| 71 | - // Try retrieving from cache. |
|
| 72 | - $external_ip_address = get_transient( $transient_name ); |
|
| 73 | - |
|
| 74 | - if ( false === $external_ip_address ) { |
|
| 75 | - $external_ip_address = '0.0.0.0'; |
|
| 76 | - $ip_lookup_services = apply_filters( 'getpaid_geolocation_ip_lookup_apis', self::$ip_lookup_apis ); |
|
| 77 | - $ip_lookup_services_keys = array_keys( $ip_lookup_services ); |
|
| 78 | - shuffle( $ip_lookup_services_keys ); |
|
| 79 | - |
|
| 80 | - foreach ( $ip_lookup_services_keys as $service_name ) { |
|
| 81 | - $service_endpoint = $ip_lookup_services[ $service_name ]; |
|
| 82 | - $response = wp_safe_remote_get( $service_endpoint, array( 'timeout' => 2 ) ); |
|
| 83 | - |
|
| 84 | - if ( ! is_wp_error( $response ) && rest_is_ip_address( $response['body'] ) ) { |
|
| 85 | - $external_ip_address = apply_filters( 'getpaid_geolocation_ip_lookup_api_response', wpinv_clean( $response['body'] ), $service_name ); |
|
| 86 | - break; |
|
| 87 | - } |
|
| 88 | - |
|
| 89 | - } |
|
| 90 | - |
|
| 91 | - set_transient( $transient_name, $external_ip_address, WEEK_IN_SECONDS ); |
|
| 92 | - } |
|
| 93 | - |
|
| 94 | - return $external_ip_address; |
|
| 95 | - } |
|
| 96 | - |
|
| 97 | - /** |
|
| 98 | - * Geolocate an IP address. |
|
| 99 | - * |
|
| 100 | - * @param string $ip_address IP Address. |
|
| 101 | - * @param bool $fallback If true, fallbacks to alternative IP detection (can be slower). |
|
| 102 | - * @param bool $api_fallback If true, uses geolocation APIs if the database file doesn't exist (can be slower). |
|
| 103 | - * @return array |
|
| 104 | - */ |
|
| 105 | - public static function geolocate_ip( $ip_address = '', $fallback = false, $api_fallback = true ) { |
|
| 106 | - |
|
| 107 | - if ( empty( $ip_address ) ) { |
|
| 108 | - $ip_address = self::get_ip_address(); |
|
| 109 | - } |
|
| 110 | - |
|
| 111 | - // Update the current user's IP Address. |
|
| 112 | - self::$current_user_ip = $ip_address; |
|
| 113 | - |
|
| 114 | - // Filter to allow custom geolocation of the IP address. |
|
| 115 | - $country_code = apply_filters( 'getpaid_geolocate_ip', false, $ip_address, $fallback, $api_fallback ); |
|
| 116 | - |
|
| 117 | - if ( false !== $country_code ) { |
|
| 118 | - |
|
| 119 | - return array( |
|
| 120 | - 'country' => $country_code, |
|
| 121 | - 'state' => '', |
|
| 122 | - 'city' => '', |
|
| 123 | - 'postcode' => '', |
|
| 124 | - ); |
|
| 125 | - |
|
| 126 | - } |
|
| 127 | - |
|
| 128 | - $country_code = self::get_country_code_from_headers(); |
|
| 129 | - |
|
| 130 | - /** |
|
| 131 | - * Get geolocation filter. |
|
| 132 | - * |
|
| 133 | - * @since 1.0.19 |
|
| 134 | - * @param array $geolocation Geolocation data, including country, state, city, and postcode. |
|
| 135 | - * @param string $ip_address IP Address. |
|
| 136 | - */ |
|
| 137 | - $geolocation = apply_filters( |
|
| 138 | - 'getpaid_get_geolocation', |
|
| 139 | - array( |
|
| 140 | - 'country' => $country_code, |
|
| 141 | - 'state' => '', |
|
| 142 | - 'city' => '', |
|
| 143 | - 'postcode' => '', |
|
| 144 | - ), |
|
| 145 | - $ip_address |
|
| 146 | - ); |
|
| 147 | - |
|
| 148 | - // If we still haven't found a country code, let's consider doing an API lookup. |
|
| 149 | - if ( '' === $geolocation['country'] && $api_fallback ) { |
|
| 150 | - $geolocation['country'] = self::geolocate_via_api( $ip_address ); |
|
| 151 | - } |
|
| 152 | - |
|
| 153 | - // It's possible that we're in a local environment, in which case the geolocation needs to be done from the |
|
| 154 | - // external address. |
|
| 155 | - if ( '' === $geolocation['country'] && $fallback ) { |
|
| 156 | - $external_ip_address = self::get_external_ip_address(); |
|
| 157 | - |
|
| 158 | - // Only bother with this if the external IP differs. |
|
| 159 | - if ( '0.0.0.0' !== $external_ip_address && $external_ip_address !== $ip_address ) { |
|
| 160 | - return self::geolocate_ip( $external_ip_address, false, $api_fallback ); |
|
| 161 | - } |
|
| 162 | - |
|
| 163 | - } |
|
| 164 | - |
|
| 165 | - return array( |
|
| 166 | - 'country' => $geolocation['country'], |
|
| 167 | - 'state' => $geolocation['state'], |
|
| 168 | - 'city' => $geolocation['city'], |
|
| 169 | - 'postcode' => $geolocation['postcode'], |
|
| 170 | - ); |
|
| 171 | - |
|
| 172 | - } |
|
| 173 | - |
|
| 174 | - /** |
|
| 175 | - * Fetches the country code from the request headers, if one is available. |
|
| 176 | - * |
|
| 177 | - * @since 1.0.19 |
|
| 178 | - * @return string The country code pulled from the headers, or empty string if one was not found. |
|
| 179 | - */ |
|
| 180 | - protected static function get_country_code_from_headers() { |
|
| 181 | - $country_code = ''; |
|
| 182 | - |
|
| 183 | - $headers = array( |
|
| 184 | - 'MM_COUNTRY_CODE', |
|
| 185 | - 'GEOIP_COUNTRY_CODE', |
|
| 186 | - 'HTTP_CF_IPCOUNTRY', |
|
| 187 | - 'HTTP_X_COUNTRY_CODE', |
|
| 188 | - ); |
|
| 189 | - |
|
| 190 | - foreach ( $headers as $header ) { |
|
| 191 | - if ( empty( $_SERVER[ $header ] ) ) { |
|
| 192 | - continue; |
|
| 193 | - } |
|
| 194 | - |
|
| 195 | - $country_code = strtoupper( sanitize_text_field( wp_unslash( $_SERVER[ $header ] ) ) ); |
|
| 196 | - break; |
|
| 197 | - } |
|
| 198 | - |
|
| 199 | - return $country_code; |
|
| 200 | - } |
|
| 201 | - |
|
| 202 | - /** |
|
| 203 | - * Use APIs to Geolocate the user. |
|
| 204 | - * |
|
| 205 | - * Geolocation APIs can be added through the use of the getpaid_geolocation_geoip_apis filter. |
|
| 206 | - * Provide a name=>value pair for service-slug=>endpoint. |
|
| 207 | - * |
|
| 208 | - * If APIs are defined, one will be chosen at random to fulfil the request. After completing, the result |
|
| 209 | - * will be cached in a transient. |
|
| 210 | - * |
|
| 211 | - * @param string $ip_address IP address. |
|
| 212 | - * @return string |
|
| 213 | - */ |
|
| 214 | - protected static function geolocate_via_api( $ip_address ) { |
|
| 215 | - |
|
| 216 | - // Retrieve from cache... |
|
| 217 | - $country_code = get_transient( 'geoip_' . $ip_address ); |
|
| 218 | - |
|
| 219 | - // If missing, retrieve from the API. |
|
| 220 | - if ( false === $country_code ) { |
|
| 221 | - $geoip_services = apply_filters( 'getpaid_geolocation_geoip_apis', self::$geoip_apis ); |
|
| 222 | - |
|
| 223 | - if ( empty( $geoip_services ) ) { |
|
| 224 | - return ''; |
|
| 225 | - } |
|
| 226 | - |
|
| 227 | - $geoip_services_keys = array_keys( $geoip_services ); |
|
| 228 | - |
|
| 229 | - shuffle( $geoip_services_keys ); |
|
| 230 | - |
|
| 231 | - foreach ( $geoip_services_keys as $service_name ) { |
|
| 232 | - |
|
| 233 | - $service_endpoint = $geoip_services[ $service_name ]; |
|
| 234 | - $response = wp_safe_remote_get( sprintf( $service_endpoint, $ip_address ), array( 'timeout' => 2 ) ); |
|
| 235 | - $country_code = sanitize_text_field( strtoupper( self::handle_geolocation_response( $response, $service_name ) ) ); |
|
| 236 | - |
|
| 237 | - if ( ! empty( $country_code ) ) { |
|
| 238 | - break; |
|
| 239 | - } |
|
| 240 | - |
|
| 241 | - } |
|
| 242 | - |
|
| 243 | - set_transient( 'geoip_' . $ip_address, $country_code, WEEK_IN_SECONDS ); |
|
| 244 | - } |
|
| 245 | - |
|
| 246 | - return $country_code; |
|
| 247 | - } |
|
| 248 | - |
|
| 249 | - /** |
|
| 250 | - * Handles geolocation response |
|
| 251 | - * |
|
| 252 | - * @param WP_Error|String $geolocation_response |
|
| 253 | - * @param String $geolocation_service |
|
| 254 | - * @return string Country code |
|
| 255 | - */ |
|
| 256 | - protected static function handle_geolocation_response( $geolocation_response, $geolocation_service ) { |
|
| 257 | - |
|
| 258 | - if ( is_wp_error( $geolocation_response ) || empty( $geolocation_response['body'] ) ) { |
|
| 259 | - return ''; |
|
| 260 | - } |
|
| 261 | - |
|
| 262 | - if ( $geolocation_service === 'ipinfo.io' ) { |
|
| 263 | - $data = json_decode( $geolocation_response['body'] ); |
|
| 264 | - return empty( $data ) || empty( $data->country ) ? '' : $data->country; |
|
| 265 | - } |
|
| 266 | - |
|
| 267 | - if ( $geolocation_service === 'ip-api.com' ) { |
|
| 268 | - $data = json_decode( $geolocation_response['body'] ); |
|
| 269 | - return empty( $data ) || empty( $data->countryCode ) ? '' : $data->countryCode; |
|
| 270 | - } |
|
| 271 | - |
|
| 272 | - return apply_filters( 'getpaid_geolocation_geoip_response_' . $geolocation_service, '', $geolocation_response['body'] ); |
|
| 273 | - |
|
| 274 | - } |
|
| 16 | + /** |
|
| 17 | + * Holds the current user's IP Address. |
|
| 18 | + * |
|
| 19 | + * @var string |
|
| 20 | + */ |
|
| 21 | + public static $current_user_ip; |
|
| 22 | + |
|
| 23 | + /** |
|
| 24 | + * API endpoints for looking up a user IP address. |
|
| 25 | + * |
|
| 26 | + * For example, in case a user is on localhost. |
|
| 27 | + * |
|
| 28 | + * @var array |
|
| 29 | + */ |
|
| 30 | + protected static $ip_lookup_apis = array( |
|
| 31 | + 'ipify' => 'http://api.ipify.org/', |
|
| 32 | + 'ipecho' => 'http://ipecho.net/plain', |
|
| 33 | + 'ident' => 'http://ident.me', |
|
| 34 | + 'whatismyipaddress' => 'http://bot.whatismyipaddress.com', |
|
| 35 | + ); |
|
| 36 | + |
|
| 37 | + /** |
|
| 38 | + * API endpoints for geolocating an IP address |
|
| 39 | + * |
|
| 40 | + * @var array |
|
| 41 | + */ |
|
| 42 | + protected static $geoip_apis = array( |
|
| 43 | + 'ip-api.com' => 'http://ip-api.com/json/%s', |
|
| 44 | + 'ipinfo.io' => 'https://ipinfo.io/%s/json', |
|
| 45 | + ); |
|
| 46 | + |
|
| 47 | + /** |
|
| 48 | + * Get current user IP Address. |
|
| 49 | + * |
|
| 50 | + * @return string |
|
| 51 | + */ |
|
| 52 | + public static function get_ip_address() { |
|
| 53 | + return wpinv_get_ip(); |
|
| 54 | + } |
|
| 55 | + |
|
| 56 | + /** |
|
| 57 | + * Get user IP Address using an external service. |
|
| 58 | + * This can be used as a fallback for users on localhost where |
|
| 59 | + * get_ip_address() will be a local IP and non-geolocatable. |
|
| 60 | + * |
|
| 61 | + * @return string |
|
| 62 | + */ |
|
| 63 | + public static function get_external_ip_address() { |
|
| 64 | + |
|
| 65 | + $transient_name = 'external_ip_address_0.0.0.0'; |
|
| 66 | + |
|
| 67 | + if ( '' !== self::get_ip_address() ) { |
|
| 68 | + $transient_name = 'external_ip_address_' . self::get_ip_address(); |
|
| 69 | + } |
|
| 70 | + |
|
| 71 | + // Try retrieving from cache. |
|
| 72 | + $external_ip_address = get_transient( $transient_name ); |
|
| 73 | + |
|
| 74 | + if ( false === $external_ip_address ) { |
|
| 75 | + $external_ip_address = '0.0.0.0'; |
|
| 76 | + $ip_lookup_services = apply_filters( 'getpaid_geolocation_ip_lookup_apis', self::$ip_lookup_apis ); |
|
| 77 | + $ip_lookup_services_keys = array_keys( $ip_lookup_services ); |
|
| 78 | + shuffle( $ip_lookup_services_keys ); |
|
| 79 | + |
|
| 80 | + foreach ( $ip_lookup_services_keys as $service_name ) { |
|
| 81 | + $service_endpoint = $ip_lookup_services[ $service_name ]; |
|
| 82 | + $response = wp_safe_remote_get( $service_endpoint, array( 'timeout' => 2 ) ); |
|
| 83 | + |
|
| 84 | + if ( ! is_wp_error( $response ) && rest_is_ip_address( $response['body'] ) ) { |
|
| 85 | + $external_ip_address = apply_filters( 'getpaid_geolocation_ip_lookup_api_response', wpinv_clean( $response['body'] ), $service_name ); |
|
| 86 | + break; |
|
| 87 | + } |
|
| 88 | + |
|
| 89 | + } |
|
| 90 | + |
|
| 91 | + set_transient( $transient_name, $external_ip_address, WEEK_IN_SECONDS ); |
|
| 92 | + } |
|
| 93 | + |
|
| 94 | + return $external_ip_address; |
|
| 95 | + } |
|
| 96 | + |
|
| 97 | + /** |
|
| 98 | + * Geolocate an IP address. |
|
| 99 | + * |
|
| 100 | + * @param string $ip_address IP Address. |
|
| 101 | + * @param bool $fallback If true, fallbacks to alternative IP detection (can be slower). |
|
| 102 | + * @param bool $api_fallback If true, uses geolocation APIs if the database file doesn't exist (can be slower). |
|
| 103 | + * @return array |
|
| 104 | + */ |
|
| 105 | + public static function geolocate_ip( $ip_address = '', $fallback = false, $api_fallback = true ) { |
|
| 106 | + |
|
| 107 | + if ( empty( $ip_address ) ) { |
|
| 108 | + $ip_address = self::get_ip_address(); |
|
| 109 | + } |
|
| 110 | + |
|
| 111 | + // Update the current user's IP Address. |
|
| 112 | + self::$current_user_ip = $ip_address; |
|
| 113 | + |
|
| 114 | + // Filter to allow custom geolocation of the IP address. |
|
| 115 | + $country_code = apply_filters( 'getpaid_geolocate_ip', false, $ip_address, $fallback, $api_fallback ); |
|
| 116 | + |
|
| 117 | + if ( false !== $country_code ) { |
|
| 118 | + |
|
| 119 | + return array( |
|
| 120 | + 'country' => $country_code, |
|
| 121 | + 'state' => '', |
|
| 122 | + 'city' => '', |
|
| 123 | + 'postcode' => '', |
|
| 124 | + ); |
|
| 125 | + |
|
| 126 | + } |
|
| 127 | + |
|
| 128 | + $country_code = self::get_country_code_from_headers(); |
|
| 129 | + |
|
| 130 | + /** |
|
| 131 | + * Get geolocation filter. |
|
| 132 | + * |
|
| 133 | + * @since 1.0.19 |
|
| 134 | + * @param array $geolocation Geolocation data, including country, state, city, and postcode. |
|
| 135 | + * @param string $ip_address IP Address. |
|
| 136 | + */ |
|
| 137 | + $geolocation = apply_filters( |
|
| 138 | + 'getpaid_get_geolocation', |
|
| 139 | + array( |
|
| 140 | + 'country' => $country_code, |
|
| 141 | + 'state' => '', |
|
| 142 | + 'city' => '', |
|
| 143 | + 'postcode' => '', |
|
| 144 | + ), |
|
| 145 | + $ip_address |
|
| 146 | + ); |
|
| 147 | + |
|
| 148 | + // If we still haven't found a country code, let's consider doing an API lookup. |
|
| 149 | + if ( '' === $geolocation['country'] && $api_fallback ) { |
|
| 150 | + $geolocation['country'] = self::geolocate_via_api( $ip_address ); |
|
| 151 | + } |
|
| 152 | + |
|
| 153 | + // It's possible that we're in a local environment, in which case the geolocation needs to be done from the |
|
| 154 | + // external address. |
|
| 155 | + if ( '' === $geolocation['country'] && $fallback ) { |
|
| 156 | + $external_ip_address = self::get_external_ip_address(); |
|
| 157 | + |
|
| 158 | + // Only bother with this if the external IP differs. |
|
| 159 | + if ( '0.0.0.0' !== $external_ip_address && $external_ip_address !== $ip_address ) { |
|
| 160 | + return self::geolocate_ip( $external_ip_address, false, $api_fallback ); |
|
| 161 | + } |
|
| 162 | + |
|
| 163 | + } |
|
| 164 | + |
|
| 165 | + return array( |
|
| 166 | + 'country' => $geolocation['country'], |
|
| 167 | + 'state' => $geolocation['state'], |
|
| 168 | + 'city' => $geolocation['city'], |
|
| 169 | + 'postcode' => $geolocation['postcode'], |
|
| 170 | + ); |
|
| 171 | + |
|
| 172 | + } |
|
| 173 | + |
|
| 174 | + /** |
|
| 175 | + * Fetches the country code from the request headers, if one is available. |
|
| 176 | + * |
|
| 177 | + * @since 1.0.19 |
|
| 178 | + * @return string The country code pulled from the headers, or empty string if one was not found. |
|
| 179 | + */ |
|
| 180 | + protected static function get_country_code_from_headers() { |
|
| 181 | + $country_code = ''; |
|
| 182 | + |
|
| 183 | + $headers = array( |
|
| 184 | + 'MM_COUNTRY_CODE', |
|
| 185 | + 'GEOIP_COUNTRY_CODE', |
|
| 186 | + 'HTTP_CF_IPCOUNTRY', |
|
| 187 | + 'HTTP_X_COUNTRY_CODE', |
|
| 188 | + ); |
|
| 189 | + |
|
| 190 | + foreach ( $headers as $header ) { |
|
| 191 | + if ( empty( $_SERVER[ $header ] ) ) { |
|
| 192 | + continue; |
|
| 193 | + } |
|
| 194 | + |
|
| 195 | + $country_code = strtoupper( sanitize_text_field( wp_unslash( $_SERVER[ $header ] ) ) ); |
|
| 196 | + break; |
|
| 197 | + } |
|
| 198 | + |
|
| 199 | + return $country_code; |
|
| 200 | + } |
|
| 201 | + |
|
| 202 | + /** |
|
| 203 | + * Use APIs to Geolocate the user. |
|
| 204 | + * |
|
| 205 | + * Geolocation APIs can be added through the use of the getpaid_geolocation_geoip_apis filter. |
|
| 206 | + * Provide a name=>value pair for service-slug=>endpoint. |
|
| 207 | + * |
|
| 208 | + * If APIs are defined, one will be chosen at random to fulfil the request. After completing, the result |
|
| 209 | + * will be cached in a transient. |
|
| 210 | + * |
|
| 211 | + * @param string $ip_address IP address. |
|
| 212 | + * @return string |
|
| 213 | + */ |
|
| 214 | + protected static function geolocate_via_api( $ip_address ) { |
|
| 215 | + |
|
| 216 | + // Retrieve from cache... |
|
| 217 | + $country_code = get_transient( 'geoip_' . $ip_address ); |
|
| 218 | + |
|
| 219 | + // If missing, retrieve from the API. |
|
| 220 | + if ( false === $country_code ) { |
|
| 221 | + $geoip_services = apply_filters( 'getpaid_geolocation_geoip_apis', self::$geoip_apis ); |
|
| 222 | + |
|
| 223 | + if ( empty( $geoip_services ) ) { |
|
| 224 | + return ''; |
|
| 225 | + } |
|
| 226 | + |
|
| 227 | + $geoip_services_keys = array_keys( $geoip_services ); |
|
| 228 | + |
|
| 229 | + shuffle( $geoip_services_keys ); |
|
| 230 | + |
|
| 231 | + foreach ( $geoip_services_keys as $service_name ) { |
|
| 232 | + |
|
| 233 | + $service_endpoint = $geoip_services[ $service_name ]; |
|
| 234 | + $response = wp_safe_remote_get( sprintf( $service_endpoint, $ip_address ), array( 'timeout' => 2 ) ); |
|
| 235 | + $country_code = sanitize_text_field( strtoupper( self::handle_geolocation_response( $response, $service_name ) ) ); |
|
| 236 | + |
|
| 237 | + if ( ! empty( $country_code ) ) { |
|
| 238 | + break; |
|
| 239 | + } |
|
| 240 | + |
|
| 241 | + } |
|
| 242 | + |
|
| 243 | + set_transient( 'geoip_' . $ip_address, $country_code, WEEK_IN_SECONDS ); |
|
| 244 | + } |
|
| 245 | + |
|
| 246 | + return $country_code; |
|
| 247 | + } |
|
| 248 | + |
|
| 249 | + /** |
|
| 250 | + * Handles geolocation response |
|
| 251 | + * |
|
| 252 | + * @param WP_Error|String $geolocation_response |
|
| 253 | + * @param String $geolocation_service |
|
| 254 | + * @return string Country code |
|
| 255 | + */ |
|
| 256 | + protected static function handle_geolocation_response( $geolocation_response, $geolocation_service ) { |
|
| 257 | + |
|
| 258 | + if ( is_wp_error( $geolocation_response ) || empty( $geolocation_response['body'] ) ) { |
|
| 259 | + return ''; |
|
| 260 | + } |
|
| 261 | + |
|
| 262 | + if ( $geolocation_service === 'ipinfo.io' ) { |
|
| 263 | + $data = json_decode( $geolocation_response['body'] ); |
|
| 264 | + return empty( $data ) || empty( $data->country ) ? '' : $data->country; |
|
| 265 | + } |
|
| 266 | + |
|
| 267 | + if ( $geolocation_service === 'ip-api.com' ) { |
|
| 268 | + $data = json_decode( $geolocation_response['body'] ); |
|
| 269 | + return empty( $data ) || empty( $data->countryCode ) ? '' : $data->countryCode; |
|
| 270 | + } |
|
| 271 | + |
|
| 272 | + return apply_filters( 'getpaid_geolocation_geoip_response_' . $geolocation_service, '', $geolocation_response['body'] ); |
|
| 273 | + |
|
| 274 | + } |
|
| 275 | 275 | |
| 276 | 276 | } |
@@ -12,125 +12,125 @@ discard block |
||
| 12 | 12 | */ |
| 13 | 13 | class WPInv_Session_Handler extends WPInv_Session { |
| 14 | 14 | |
| 15 | - /** |
|
| 16 | - * Cookie name used for the session. |
|
| 17 | - * |
|
| 18 | - * @var string cookie name |
|
| 19 | - */ |
|
| 20 | - protected $_cookie; |
|
| 21 | - |
|
| 22 | - /** |
|
| 23 | - * Stores session expiry. |
|
| 24 | - * |
|
| 25 | - * @var int session due to expire timestamp |
|
| 26 | - */ |
|
| 27 | - protected $_session_expiring; |
|
| 28 | - |
|
| 29 | - /** |
|
| 30 | - * Stores session due to expire timestamp. |
|
| 31 | - * |
|
| 32 | - * @var string session expiration timestamp |
|
| 33 | - */ |
|
| 34 | - protected $_session_expiration; |
|
| 35 | - |
|
| 36 | - /** |
|
| 37 | - * True when the cookie exists. |
|
| 38 | - * |
|
| 39 | - * @var bool Based on whether a cookie exists. |
|
| 40 | - */ |
|
| 41 | - protected $_has_cookie = false; |
|
| 42 | - |
|
| 43 | - /** |
|
| 44 | - * Table name for session data. |
|
| 45 | - * |
|
| 46 | - * @var string Custom session table name |
|
| 47 | - */ |
|
| 48 | - protected $_table; |
|
| 49 | - |
|
| 50 | - /** |
|
| 51 | - * Constructor for the session class. |
|
| 52 | - */ |
|
| 53 | - public function __construct() { |
|
| 54 | - |
|
| 55 | - $this->_cookie = apply_filters( 'wpinv_cookie', 'wpinv_session_' . COOKIEHASH ); |
|
| 15 | + /** |
|
| 16 | + * Cookie name used for the session. |
|
| 17 | + * |
|
| 18 | + * @var string cookie name |
|
| 19 | + */ |
|
| 20 | + protected $_cookie; |
|
| 21 | + |
|
| 22 | + /** |
|
| 23 | + * Stores session expiry. |
|
| 24 | + * |
|
| 25 | + * @var int session due to expire timestamp |
|
| 26 | + */ |
|
| 27 | + protected $_session_expiring; |
|
| 28 | + |
|
| 29 | + /** |
|
| 30 | + * Stores session due to expire timestamp. |
|
| 31 | + * |
|
| 32 | + * @var string session expiration timestamp |
|
| 33 | + */ |
|
| 34 | + protected $_session_expiration; |
|
| 35 | + |
|
| 36 | + /** |
|
| 37 | + * True when the cookie exists. |
|
| 38 | + * |
|
| 39 | + * @var bool Based on whether a cookie exists. |
|
| 40 | + */ |
|
| 41 | + protected $_has_cookie = false; |
|
| 42 | + |
|
| 43 | + /** |
|
| 44 | + * Table name for session data. |
|
| 45 | + * |
|
| 46 | + * @var string Custom session table name |
|
| 47 | + */ |
|
| 48 | + protected $_table; |
|
| 49 | + |
|
| 50 | + /** |
|
| 51 | + * Constructor for the session class. |
|
| 52 | + */ |
|
| 53 | + public function __construct() { |
|
| 54 | + |
|
| 55 | + $this->_cookie = apply_filters( 'wpinv_cookie', 'wpinv_session_' . COOKIEHASH ); |
|
| 56 | 56 | add_action( 'init', array( $this, 'init' ), -1 ); |
| 57 | - add_action( 'wp_logout', array( $this, 'destroy_session' ) ); |
|
| 58 | - add_action( 'wp', array( $this, 'set_customer_session_cookie' ), 10 ); |
|
| 59 | - add_action( 'shutdown', array( $this, 'save_data' ), 20 ); |
|
| 60 | - |
|
| 61 | - } |
|
| 62 | - |
|
| 63 | - /** |
|
| 64 | - * Init hooks and session data. |
|
| 65 | - * |
|
| 66 | - * @since 3.3.0 |
|
| 67 | - */ |
|
| 68 | - public function init() { |
|
| 69 | - $this->init_session_cookie(); |
|
| 70 | - |
|
| 71 | - if ( ! is_user_logged_in() ) { |
|
| 72 | - add_filter( 'nonce_user_logged_out', array( $this, 'nonce_user_logged_out' ), 10, 2 ); |
|
| 73 | - } |
|
| 74 | - } |
|
| 75 | - |
|
| 76 | - /** |
|
| 77 | - * Setup cookie and customer ID. |
|
| 78 | - * |
|
| 79 | - * @since 3.6.0 |
|
| 80 | - */ |
|
| 81 | - public function init_session_cookie() { |
|
| 82 | - $cookie = $this->get_session_cookie(); |
|
| 83 | - |
|
| 84 | - if ( $cookie ) { |
|
| 85 | - $this->_customer_id = $cookie[0]; |
|
| 86 | - $this->_session_expiration = $cookie[1]; |
|
| 87 | - $this->_session_expiring = $cookie[2]; |
|
| 88 | - $this->_has_cookie = true; |
|
| 89 | - $this->_data = $this->get_session_data(); |
|
| 90 | - |
|
| 91 | - // If the user logs in, update session. |
|
| 92 | - if ( is_user_logged_in() && get_current_user_id() != $this->_customer_id ) { |
|
| 93 | - $this->_customer_id = get_current_user_id(); |
|
| 94 | - $this->_dirty = true; |
|
| 95 | - $this->save_data(); |
|
| 96 | - $this->set_customer_session_cookie( true ); |
|
| 97 | - } |
|
| 98 | - |
|
| 99 | - // Update session if its close to expiring. |
|
| 100 | - if ( time() > $this->_session_expiring ) { |
|
| 101 | - $this->set_session_expiration(); |
|
| 102 | - $this->update_session_timestamp( $this->_customer_id, $this->_session_expiration ); |
|
| 103 | - } |
|
| 104 | - } else { |
|
| 105 | - $this->set_session_expiration(); |
|
| 106 | - $this->_customer_id = $this->generate_customer_id(); |
|
| 107 | - $this->_data = $this->get_session_data(); |
|
| 108 | - } |
|
| 109 | - } |
|
| 110 | - |
|
| 111 | - /** |
|
| 112 | - * Sets the session cookie on-demand (usually after adding an item to the cart). |
|
| 113 | - * |
|
| 114 | - * Since the cookie name (as of 2.1) is prepended with wp, cache systems like batcache will not cache pages when set. |
|
| 115 | - * |
|
| 116 | - * Warning: Cookies will only be set if this is called before the headers are sent. |
|
| 117 | - * |
|
| 118 | - * @param bool $set Should the session cookie be set. |
|
| 119 | - */ |
|
| 120 | - public function set_customer_session_cookie( $set ) { |
|
| 121 | - if ( $set ) { |
|
| 122 | - $to_hash = $this->_customer_id . '|' . $this->_session_expiration; |
|
| 123 | - $cookie_hash = hash_hmac( 'md5', $to_hash, wp_hash( $to_hash ) ); |
|
| 124 | - $cookie_value = $this->_customer_id . '||' . $this->_session_expiration . '||' . $this->_session_expiring . '||' . $cookie_hash; |
|
| 125 | - $this->_has_cookie = true; |
|
| 126 | - |
|
| 127 | - if ( ! isset( $_COOKIE[ $this->_cookie ] ) || $_COOKIE[ $this->_cookie ] !== $cookie_value ) { |
|
| 128 | - $this->setcookie( $this->_cookie, $cookie_value, $this->_session_expiration, $this->use_secure_cookie(), true ); |
|
| 129 | - } |
|
| 130 | - } |
|
| 131 | - } |
|
| 132 | - |
|
| 133 | - public function setcookie($name, $value, $expire = 0, $secure = false, $httponly = false){ |
|
| 57 | + add_action( 'wp_logout', array( $this, 'destroy_session' ) ); |
|
| 58 | + add_action( 'wp', array( $this, 'set_customer_session_cookie' ), 10 ); |
|
| 59 | + add_action( 'shutdown', array( $this, 'save_data' ), 20 ); |
|
| 60 | + |
|
| 61 | + } |
|
| 62 | + |
|
| 63 | + /** |
|
| 64 | + * Init hooks and session data. |
|
| 65 | + * |
|
| 66 | + * @since 3.3.0 |
|
| 67 | + */ |
|
| 68 | + public function init() { |
|
| 69 | + $this->init_session_cookie(); |
|
| 70 | + |
|
| 71 | + if ( ! is_user_logged_in() ) { |
|
| 72 | + add_filter( 'nonce_user_logged_out', array( $this, 'nonce_user_logged_out' ), 10, 2 ); |
|
| 73 | + } |
|
| 74 | + } |
|
| 75 | + |
|
| 76 | + /** |
|
| 77 | + * Setup cookie and customer ID. |
|
| 78 | + * |
|
| 79 | + * @since 3.6.0 |
|
| 80 | + */ |
|
| 81 | + public function init_session_cookie() { |
|
| 82 | + $cookie = $this->get_session_cookie(); |
|
| 83 | + |
|
| 84 | + if ( $cookie ) { |
|
| 85 | + $this->_customer_id = $cookie[0]; |
|
| 86 | + $this->_session_expiration = $cookie[1]; |
|
| 87 | + $this->_session_expiring = $cookie[2]; |
|
| 88 | + $this->_has_cookie = true; |
|
| 89 | + $this->_data = $this->get_session_data(); |
|
| 90 | + |
|
| 91 | + // If the user logs in, update session. |
|
| 92 | + if ( is_user_logged_in() && get_current_user_id() != $this->_customer_id ) { |
|
| 93 | + $this->_customer_id = get_current_user_id(); |
|
| 94 | + $this->_dirty = true; |
|
| 95 | + $this->save_data(); |
|
| 96 | + $this->set_customer_session_cookie( true ); |
|
| 97 | + } |
|
| 98 | + |
|
| 99 | + // Update session if its close to expiring. |
|
| 100 | + if ( time() > $this->_session_expiring ) { |
|
| 101 | + $this->set_session_expiration(); |
|
| 102 | + $this->update_session_timestamp( $this->_customer_id, $this->_session_expiration ); |
|
| 103 | + } |
|
| 104 | + } else { |
|
| 105 | + $this->set_session_expiration(); |
|
| 106 | + $this->_customer_id = $this->generate_customer_id(); |
|
| 107 | + $this->_data = $this->get_session_data(); |
|
| 108 | + } |
|
| 109 | + } |
|
| 110 | + |
|
| 111 | + /** |
|
| 112 | + * Sets the session cookie on-demand (usually after adding an item to the cart). |
|
| 113 | + * |
|
| 114 | + * Since the cookie name (as of 2.1) is prepended with wp, cache systems like batcache will not cache pages when set. |
|
| 115 | + * |
|
| 116 | + * Warning: Cookies will only be set if this is called before the headers are sent. |
|
| 117 | + * |
|
| 118 | + * @param bool $set Should the session cookie be set. |
|
| 119 | + */ |
|
| 120 | + public function set_customer_session_cookie( $set ) { |
|
| 121 | + if ( $set ) { |
|
| 122 | + $to_hash = $this->_customer_id . '|' . $this->_session_expiration; |
|
| 123 | + $cookie_hash = hash_hmac( 'md5', $to_hash, wp_hash( $to_hash ) ); |
|
| 124 | + $cookie_value = $this->_customer_id . '||' . $this->_session_expiration . '||' . $this->_session_expiring . '||' . $cookie_hash; |
|
| 125 | + $this->_has_cookie = true; |
|
| 126 | + |
|
| 127 | + if ( ! isset( $_COOKIE[ $this->_cookie ] ) || $_COOKIE[ $this->_cookie ] !== $cookie_value ) { |
|
| 128 | + $this->setcookie( $this->_cookie, $cookie_value, $this->_session_expiration, $this->use_secure_cookie(), true ); |
|
| 129 | + } |
|
| 130 | + } |
|
| 131 | + } |
|
| 132 | + |
|
| 133 | + public function setcookie($name, $value, $expire = 0, $secure = false, $httponly = false){ |
|
| 134 | 134 | if ( ! headers_sent() ) { |
| 135 | 135 | setcookie( $name, $value, $expire, COOKIEPATH ? COOKIEPATH : '/', COOKIE_DOMAIN, $secure, apply_filters( 'wpinv_cookie_httponly', $httponly, $name, $value, $expire, $secure ) ); |
| 136 | 136 | } elseif ( defined( 'WP_DEBUG' ) && WP_DEBUG ) { |
@@ -139,86 +139,86 @@ discard block |
||
| 139 | 139 | } |
| 140 | 140 | } |
| 141 | 141 | |
| 142 | - /** |
|
| 143 | - * Should the session cookie be secure? |
|
| 144 | - * |
|
| 145 | - * @since 3.6.0 |
|
| 146 | - * @return bool |
|
| 147 | - */ |
|
| 148 | - protected function use_secure_cookie() { |
|
| 142 | + /** |
|
| 143 | + * Should the session cookie be secure? |
|
| 144 | + * |
|
| 145 | + * @since 3.6.0 |
|
| 146 | + * @return bool |
|
| 147 | + */ |
|
| 148 | + protected function use_secure_cookie() { |
|
| 149 | 149 | $is_https = false !== strstr( get_option( 'home' ), 'https:' ); |
| 150 | - return apply_filters( 'wpinv_session_use_secure_cookie', $is_https && is_ssl() ); |
|
| 151 | - } |
|
| 152 | - |
|
| 153 | - /** |
|
| 154 | - * Return true if the current user has an active session, i.e. a cookie to retrieve values. |
|
| 155 | - * |
|
| 156 | - * @return bool |
|
| 157 | - */ |
|
| 158 | - public function has_session() { |
|
| 159 | - return isset( $_COOKIE[ $this->_cookie ] ) || $this->_has_cookie || is_user_logged_in(); // @codingStandardsIgnoreLine. |
|
| 160 | - } |
|
| 161 | - |
|
| 162 | - /** |
|
| 163 | - * Set session expiration. |
|
| 164 | - */ |
|
| 165 | - public function set_session_expiration() { |
|
| 166 | - $this->_session_expiring = time() + intval( apply_filters( 'wpinv_session_expiring', 60 * 60 * 47 ) ); // 47 Hours. |
|
| 167 | - $this->_session_expiration = time() + intval( apply_filters( 'wpinv_session_expiration', 60 * 60 * 48 ) ); // 48 Hours. |
|
| 168 | - } |
|
| 169 | - |
|
| 170 | - /** |
|
| 171 | - * Generates session ids. |
|
| 172 | - * |
|
| 173 | - * @return string |
|
| 174 | - */ |
|
| 175 | - public function generate_customer_id() { |
|
| 176 | - require_once ABSPATH . 'wp-includes/class-phpass.php'; |
|
| 177 | - $hasher = new PasswordHash( 8, false ); |
|
| 178 | - return md5( $hasher->get_random_bytes( 32 ) ); |
|
| 179 | - } |
|
| 180 | - |
|
| 181 | - /** |
|
| 182 | - * Get the session cookie, if set. Otherwise return false. |
|
| 183 | - * |
|
| 184 | - * Session cookies without a customer ID are invalid. |
|
| 185 | - * |
|
| 186 | - * @return bool|array |
|
| 187 | - */ |
|
| 188 | - public function get_session_cookie() { |
|
| 189 | - $cookie_value = isset( $_COOKIE[ $this->_cookie ] ) ? wp_unslash( $_COOKIE[ $this->_cookie ] ) : false; // @codingStandardsIgnoreLine. |
|
| 190 | - |
|
| 191 | - if ( empty( $cookie_value ) || ! is_string( $cookie_value ) ) { |
|
| 192 | - return false; |
|
| 193 | - } |
|
| 194 | - |
|
| 195 | - list( $customer_id, $session_expiration, $session_expiring, $cookie_hash ) = explode( '||', $cookie_value ); |
|
| 196 | - |
|
| 197 | - if ( empty( $customer_id ) ) { |
|
| 198 | - return false; |
|
| 199 | - } |
|
| 200 | - |
|
| 201 | - // Validate hash. |
|
| 202 | - $to_hash = $customer_id . '|' . $session_expiration; |
|
| 203 | - $hash = hash_hmac( 'md5', $to_hash, wp_hash( $to_hash ) ); |
|
| 204 | - |
|
| 205 | - if ( empty( $cookie_hash ) || ! hash_equals( $hash, $cookie_hash ) ) { |
|
| 206 | - return false; |
|
| 207 | - } |
|
| 208 | - |
|
| 209 | - return array( $customer_id, $session_expiration, $session_expiring, $cookie_hash ); |
|
| 210 | - } |
|
| 211 | - |
|
| 212 | - /** |
|
| 213 | - * Get session data. |
|
| 214 | - * |
|
| 215 | - * @return array |
|
| 216 | - */ |
|
| 217 | - public function get_session_data() { |
|
| 218 | - return $this->has_session() ? (array) $this->get_session( $this->_customer_id ) : array(); |
|
| 219 | - } |
|
| 220 | - |
|
| 221 | - public function generate_key($customer_id){ |
|
| 150 | + return apply_filters( 'wpinv_session_use_secure_cookie', $is_https && is_ssl() ); |
|
| 151 | + } |
|
| 152 | + |
|
| 153 | + /** |
|
| 154 | + * Return true if the current user has an active session, i.e. a cookie to retrieve values. |
|
| 155 | + * |
|
| 156 | + * @return bool |
|
| 157 | + */ |
|
| 158 | + public function has_session() { |
|
| 159 | + return isset( $_COOKIE[ $this->_cookie ] ) || $this->_has_cookie || is_user_logged_in(); // @codingStandardsIgnoreLine. |
|
| 160 | + } |
|
| 161 | + |
|
| 162 | + /** |
|
| 163 | + * Set session expiration. |
|
| 164 | + */ |
|
| 165 | + public function set_session_expiration() { |
|
| 166 | + $this->_session_expiring = time() + intval( apply_filters( 'wpinv_session_expiring', 60 * 60 * 47 ) ); // 47 Hours. |
|
| 167 | + $this->_session_expiration = time() + intval( apply_filters( 'wpinv_session_expiration', 60 * 60 * 48 ) ); // 48 Hours. |
|
| 168 | + } |
|
| 169 | + |
|
| 170 | + /** |
|
| 171 | + * Generates session ids. |
|
| 172 | + * |
|
| 173 | + * @return string |
|
| 174 | + */ |
|
| 175 | + public function generate_customer_id() { |
|
| 176 | + require_once ABSPATH . 'wp-includes/class-phpass.php'; |
|
| 177 | + $hasher = new PasswordHash( 8, false ); |
|
| 178 | + return md5( $hasher->get_random_bytes( 32 ) ); |
|
| 179 | + } |
|
| 180 | + |
|
| 181 | + /** |
|
| 182 | + * Get the session cookie, if set. Otherwise return false. |
|
| 183 | + * |
|
| 184 | + * Session cookies without a customer ID are invalid. |
|
| 185 | + * |
|
| 186 | + * @return bool|array |
|
| 187 | + */ |
|
| 188 | + public function get_session_cookie() { |
|
| 189 | + $cookie_value = isset( $_COOKIE[ $this->_cookie ] ) ? wp_unslash( $_COOKIE[ $this->_cookie ] ) : false; // @codingStandardsIgnoreLine. |
|
| 190 | + |
|
| 191 | + if ( empty( $cookie_value ) || ! is_string( $cookie_value ) ) { |
|
| 192 | + return false; |
|
| 193 | + } |
|
| 194 | + |
|
| 195 | + list( $customer_id, $session_expiration, $session_expiring, $cookie_hash ) = explode( '||', $cookie_value ); |
|
| 196 | + |
|
| 197 | + if ( empty( $customer_id ) ) { |
|
| 198 | + return false; |
|
| 199 | + } |
|
| 200 | + |
|
| 201 | + // Validate hash. |
|
| 202 | + $to_hash = $customer_id . '|' . $session_expiration; |
|
| 203 | + $hash = hash_hmac( 'md5', $to_hash, wp_hash( $to_hash ) ); |
|
| 204 | + |
|
| 205 | + if ( empty( $cookie_hash ) || ! hash_equals( $hash, $cookie_hash ) ) { |
|
| 206 | + return false; |
|
| 207 | + } |
|
| 208 | + |
|
| 209 | + return array( $customer_id, $session_expiration, $session_expiring, $cookie_hash ); |
|
| 210 | + } |
|
| 211 | + |
|
| 212 | + /** |
|
| 213 | + * Get session data. |
|
| 214 | + * |
|
| 215 | + * @return array |
|
| 216 | + */ |
|
| 217 | + public function get_session_data() { |
|
| 218 | + return $this->has_session() ? (array) $this->get_session( $this->_customer_id ) : array(); |
|
| 219 | + } |
|
| 220 | + |
|
| 221 | + public function generate_key($customer_id){ |
|
| 222 | 222 | if(!$customer_id){ |
| 223 | 223 | return; |
| 224 | 224 | } |
@@ -226,68 +226,68 @@ discard block |
||
| 226 | 226 | return 'wpi_trans_'.$customer_id; |
| 227 | 227 | } |
| 228 | 228 | |
| 229 | - /** |
|
| 230 | - * Save data. |
|
| 231 | - */ |
|
| 232 | - public function save_data() { |
|
| 233 | - // Dirty if something changed - prevents saving nothing new. |
|
| 234 | - if ( $this->_dirty && $this->has_session() ) { |
|
| 229 | + /** |
|
| 230 | + * Save data. |
|
| 231 | + */ |
|
| 232 | + public function save_data() { |
|
| 233 | + // Dirty if something changed - prevents saving nothing new. |
|
| 234 | + if ( $this->_dirty && $this->has_session() ) { |
|
| 235 | 235 | |
| 236 | 236 | set_transient( $this->generate_key($this->_customer_id), $this->_data, $this->_session_expiration); |
| 237 | 237 | |
| 238 | - $this->_dirty = false; |
|
| 239 | - } |
|
| 240 | - } |
|
| 241 | - |
|
| 242 | - /** |
|
| 243 | - * Destroy all session data. |
|
| 244 | - */ |
|
| 245 | - public function destroy_session() { |
|
| 246 | - $this->delete_session( $this->_customer_id ); |
|
| 247 | - $this->forget_session(); |
|
| 248 | - } |
|
| 249 | - |
|
| 250 | - /** |
|
| 251 | - * Forget all session data without destroying it. |
|
| 252 | - */ |
|
| 253 | - public function forget_session() { |
|
| 254 | - $this->setcookie( $this->_cookie, '', time() - YEAR_IN_SECONDS, $this->use_secure_cookie(), true ); |
|
| 255 | - |
|
| 256 | - wpinv_empty_cart(); |
|
| 257 | - |
|
| 258 | - $this->_data = array(); |
|
| 259 | - $this->_dirty = false; |
|
| 260 | - $this->_customer_id = $this->generate_customer_id(); |
|
| 261 | - } |
|
| 262 | - |
|
| 263 | - /** |
|
| 264 | - * When a user is logged out, ensure they have a unique nonce by using the customer/session ID. |
|
| 265 | - * |
|
| 266 | - * @param int $uid User ID. |
|
| 267 | - * @return string |
|
| 268 | - */ |
|
| 269 | - public function nonce_user_logged_out( $uid ) { |
|
| 270 | - |
|
| 271 | - // Check if one of our nonces. |
|
| 272 | - if ( substr( $uid, 0, 5 ) === 'wpinv' || substr( $uid, 0, 7 ) === 'getpaid' ) { |
|
| 273 | - return $this->has_session() && $this->_customer_id ? $this->_customer_id : $uid; |
|
| 274 | - } |
|
| 275 | - |
|
| 276 | - return $uid; |
|
| 277 | - } |
|
| 278 | - |
|
| 279 | - /** |
|
| 280 | - * Returns the session. |
|
| 281 | - * |
|
| 282 | - * @param string $customer_id Customer ID. |
|
| 283 | - * @param mixed $default Default session value. |
|
| 284 | - * @return string|array |
|
| 285 | - */ |
|
| 286 | - public function get_session( $customer_id, $default = false ) { |
|
| 287 | - |
|
| 288 | - if ( defined( 'WP_SETUP_CONFIG' ) ) { |
|
| 289 | - return array(); |
|
| 290 | - } |
|
| 238 | + $this->_dirty = false; |
|
| 239 | + } |
|
| 240 | + } |
|
| 241 | + |
|
| 242 | + /** |
|
| 243 | + * Destroy all session data. |
|
| 244 | + */ |
|
| 245 | + public function destroy_session() { |
|
| 246 | + $this->delete_session( $this->_customer_id ); |
|
| 247 | + $this->forget_session(); |
|
| 248 | + } |
|
| 249 | + |
|
| 250 | + /** |
|
| 251 | + * Forget all session data without destroying it. |
|
| 252 | + */ |
|
| 253 | + public function forget_session() { |
|
| 254 | + $this->setcookie( $this->_cookie, '', time() - YEAR_IN_SECONDS, $this->use_secure_cookie(), true ); |
|
| 255 | + |
|
| 256 | + wpinv_empty_cart(); |
|
| 257 | + |
|
| 258 | + $this->_data = array(); |
|
| 259 | + $this->_dirty = false; |
|
| 260 | + $this->_customer_id = $this->generate_customer_id(); |
|
| 261 | + } |
|
| 262 | + |
|
| 263 | + /** |
|
| 264 | + * When a user is logged out, ensure they have a unique nonce by using the customer/session ID. |
|
| 265 | + * |
|
| 266 | + * @param int $uid User ID. |
|
| 267 | + * @return string |
|
| 268 | + */ |
|
| 269 | + public function nonce_user_logged_out( $uid ) { |
|
| 270 | + |
|
| 271 | + // Check if one of our nonces. |
|
| 272 | + if ( substr( $uid, 0, 5 ) === 'wpinv' || substr( $uid, 0, 7 ) === 'getpaid' ) { |
|
| 273 | + return $this->has_session() && $this->_customer_id ? $this->_customer_id : $uid; |
|
| 274 | + } |
|
| 275 | + |
|
| 276 | + return $uid; |
|
| 277 | + } |
|
| 278 | + |
|
| 279 | + /** |
|
| 280 | + * Returns the session. |
|
| 281 | + * |
|
| 282 | + * @param string $customer_id Customer ID. |
|
| 283 | + * @param mixed $default Default session value. |
|
| 284 | + * @return string|array |
|
| 285 | + */ |
|
| 286 | + public function get_session( $customer_id, $default = false ) { |
|
| 287 | + |
|
| 288 | + if ( defined( 'WP_SETUP_CONFIG' ) ) { |
|
| 289 | + return array(); |
|
| 290 | + } |
|
| 291 | 291 | |
| 292 | 292 | $key = $this->generate_key($customer_id); |
| 293 | 293 | $value = get_transient($key); |
@@ -296,30 +296,30 @@ discard block |
||
| 296 | 296 | $value = $default; |
| 297 | 297 | } |
| 298 | 298 | |
| 299 | - return maybe_unserialize( $value ); |
|
| 300 | - } |
|
| 299 | + return maybe_unserialize( $value ); |
|
| 300 | + } |
|
| 301 | 301 | |
| 302 | - /** |
|
| 303 | - * Delete the session from the cache and database. |
|
| 304 | - * |
|
| 305 | - * @param int $customer_id Customer ID. |
|
| 306 | - */ |
|
| 307 | - public function delete_session( $customer_id ) { |
|
| 302 | + /** |
|
| 303 | + * Delete the session from the cache and database. |
|
| 304 | + * |
|
| 305 | + * @param int $customer_id Customer ID. |
|
| 306 | + */ |
|
| 307 | + public function delete_session( $customer_id ) { |
|
| 308 | 308 | |
| 309 | 309 | $key = $this->generate_key($customer_id); |
| 310 | 310 | |
| 311 | - delete_transient($key); |
|
| 312 | - } |
|
| 311 | + delete_transient($key); |
|
| 312 | + } |
|
| 313 | 313 | |
| 314 | - /** |
|
| 315 | - * Update the session expiry timestamp. |
|
| 316 | - * |
|
| 317 | - * @param string $customer_id Customer ID. |
|
| 318 | - * @param int $timestamp Timestamp to expire the cookie. |
|
| 319 | - */ |
|
| 320 | - public function update_session_timestamp( $customer_id, $timestamp ) { |
|
| 314 | + /** |
|
| 315 | + * Update the session expiry timestamp. |
|
| 316 | + * |
|
| 317 | + * @param string $customer_id Customer ID. |
|
| 318 | + * @param int $timestamp Timestamp to expire the cookie. |
|
| 319 | + */ |
|
| 320 | + public function update_session_timestamp( $customer_id, $timestamp ) { |
|
| 321 | 321 | |
| 322 | 322 | set_transient( $this->generate_key($customer_id), maybe_serialize( $this->_data ), $timestamp); |
| 323 | 323 | |
| 324 | - } |
|
| 324 | + } |
|
| 325 | 325 | } |
@@ -13,42 +13,42 @@ |
||
| 13 | 13 | |
| 14 | 14 | foreach ( array_keys( $widget->get_subscriptions_table_columns() ) as $column ) : |
| 15 | 15 | |
| 16 | - $class = sanitize_html_class( $column ); |
|
| 17 | - echo "<td class='getpaid-subscriptions-table-column-$class'>"; |
|
| 16 | + $class = sanitize_html_class( $column ); |
|
| 17 | + echo "<td class='getpaid-subscriptions-table-column-$class'>"; |
|
| 18 | 18 | |
| 19 | - do_action( "getpaid_subscriptions_before_frontend_subscription_table_$column", $subscription ); |
|
| 19 | + do_action( "getpaid_subscriptions_before_frontend_subscription_table_$column", $subscription ); |
|
| 20 | 20 | |
| 21 | - switch( $column ) : |
|
| 21 | + switch( $column ) : |
|
| 22 | 22 | |
| 23 | - case 'subscription': |
|
| 24 | - $subscription_id = (int) $subscription->get_id(); |
|
| 25 | - $url = esc_url( $subscription->get_view_url() ); |
|
| 26 | - $id_label = sprintf( |
|
| 27 | - esc_attr_x( '#%s', 'subscription id', 'invoicing' ), |
|
| 28 | - $subscription->get_id() |
|
| 29 | - ); |
|
| 30 | - echo $widget->add_row_actions( "<a href='$url' class='font-weight-bold text-decoration-none'>$id_label</a>", $subscription ); |
|
| 31 | - break; |
|
| 23 | + case 'subscription': |
|
| 24 | + $subscription_id = (int) $subscription->get_id(); |
|
| 25 | + $url = esc_url( $subscription->get_view_url() ); |
|
| 26 | + $id_label = sprintf( |
|
| 27 | + esc_attr_x( '#%s', 'subscription id', 'invoicing' ), |
|
| 28 | + $subscription->get_id() |
|
| 29 | + ); |
|
| 30 | + echo $widget->add_row_actions( "<a href='$url' class='font-weight-bold text-decoration-none'>$id_label</a>", $subscription ); |
|
| 31 | + break; |
|
| 32 | 32 | |
| 33 | - case 'status': |
|
| 34 | - echo sanitize_text_field( $subscription->get_status_label() ); |
|
| 35 | - break; |
|
| 33 | + case 'status': |
|
| 34 | + echo sanitize_text_field( $subscription->get_status_label() ); |
|
| 35 | + break; |
|
| 36 | 36 | |
| 37 | - case 'renewal-date': |
|
| 38 | - $renewal = getpaid_format_date_value( $subscription->get_next_renewal_date() ); |
|
| 39 | - echo $subscription->is_active() ? sanitize_text_field( $renewal ) : "—"; |
|
| 40 | - break; |
|
| 37 | + case 'renewal-date': |
|
| 38 | + $renewal = getpaid_format_date_value( $subscription->get_next_renewal_date() ); |
|
| 39 | + echo $subscription->is_active() ? sanitize_text_field( $renewal ) : "—"; |
|
| 40 | + break; |
|
| 41 | 41 | |
| 42 | - case 'amount': |
|
| 43 | - $frequency = getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' ); |
|
| 44 | - $amount = wpinv_price( $subscription->get_recurring_amount(), $subscription->get_parent_payment()->get_currency() ); |
|
| 45 | - echo wp_kses_post( "<span>$amount</span> / <span class='getpaid-item-recurring-period'>$frequency</span>" ); |
|
| 46 | - break; |
|
| 42 | + case 'amount': |
|
| 43 | + $frequency = getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' ); |
|
| 44 | + $amount = wpinv_price( $subscription->get_recurring_amount(), $subscription->get_parent_payment()->get_currency() ); |
|
| 45 | + echo wp_kses_post( "<span>$amount</span> / <span class='getpaid-item-recurring-period'>$frequency</span>" ); |
|
| 46 | + break; |
|
| 47 | 47 | |
| 48 | - endswitch; |
|
| 48 | + endswitch; |
|
| 49 | 49 | |
| 50 | - do_action( "getpaid_subscriptions_frontend_subscription_table_$column", $subscription ); |
|
| 50 | + do_action( "getpaid_subscriptions_frontend_subscription_table_$column", $subscription ); |
|
| 51 | 51 | |
| 52 | - echo '</td>'; |
|
| 52 | + echo '</td>'; |
|
| 53 | 53 | |
| 54 | 54 | endforeach; |
@@ -11,26 +11,26 @@ discard block |
||
| 11 | 11 | |
| 12 | 12 | // Totals rows. |
| 13 | 13 | $totals = apply_filters( |
| 14 | - 'getpaid_payment_form_cart_table_totals', |
|
| 15 | - array( |
|
| 16 | - 'subtotal' => __( 'Subtotal', 'invoicing' ), |
|
| 17 | - 'tax' => __( 'Tax', 'invoicing' ), |
|
| 18 | - 'fees' => __( 'Fee', 'invoicing' ), |
|
| 19 | - 'discount' => __( 'Discount', 'invoicing' ), |
|
| 20 | - 'total' => __( 'Total', 'invoicing' ), |
|
| 21 | - ), |
|
| 22 | - $form |
|
| 14 | + 'getpaid_payment_form_cart_table_totals', |
|
| 15 | + array( |
|
| 16 | + 'subtotal' => __( 'Subtotal', 'invoicing' ), |
|
| 17 | + 'tax' => __( 'Tax', 'invoicing' ), |
|
| 18 | + 'fees' => __( 'Fee', 'invoicing' ), |
|
| 19 | + 'discount' => __( 'Discount', 'invoicing' ), |
|
| 20 | + 'total' => __( 'Total', 'invoicing' ), |
|
| 21 | + ), |
|
| 22 | + $form |
|
| 23 | 23 | ); |
| 24 | 24 | |
| 25 | 25 | $currency = $form->get_currency(); |
| 26 | 26 | $country = wpinv_get_default_country(); |
| 27 | 27 | |
| 28 | 28 | if ( ! empty( $form->invoice ) ) { |
| 29 | - $country = $form->invoice->get_country(); |
|
| 29 | + $country = $form->invoice->get_country(); |
|
| 30 | 30 | } |
| 31 | 31 | |
| 32 | 32 | if ( ! wpinv_use_taxes() && isset( $totals['tax'] ) ) { |
| 33 | - unset( $totals['tax'] ); |
|
| 33 | + unset( $totals['tax'] ); |
|
| 34 | 34 | } |
| 35 | 35 | |
| 36 | 36 | do_action( 'getpaid_before_payment_form_cart_totals', $form, $totals ); |
@@ -61,13 +61,13 @@ discard block |
||
| 61 | 61 | |
| 62 | 62 | <?php |
| 63 | 63 | |
| 64 | - // Total tax. |
|
| 65 | - if ( in_array( $key, array( 'tax', 'discount', 'subtotal', 'total', 'fees' ) ) ) { |
|
| 66 | - echo wpinv_price( 0, $currency ); |
|
| 67 | - } |
|
| 64 | + // Total tax. |
|
| 65 | + if ( in_array( $key, array( 'tax', 'discount', 'subtotal', 'total', 'fees' ) ) ) { |
|
| 66 | + echo wpinv_price( 0, $currency ); |
|
| 67 | + } |
|
| 68 | 68 | |
| 69 | - do_action( "getpaid_payment_form_cart_totals_$key", $form ); |
|
| 70 | - ?> |
|
| 69 | + do_action( "getpaid_payment_form_cart_totals_$key", $form ); |
|
| 70 | + ?> |
|
| 71 | 71 | |
| 72 | 72 | </div> |
| 73 | 73 | |
@@ -37,25 +37,25 @@ |
||
| 37 | 37 | public function get_privacy_message() { |
| 38 | 38 | |
| 39 | 39 | $content = '<div class="wp-suggested-text">' . |
| 40 | - '<h2>' . __( 'Invoices and checkout', 'invoicing' ) . '</h2>' . |
|
| 41 | - '<p class="privacy-policy-tutorial">' . __( 'Example privacy texts.', 'invoicing' ) . '</p>' . |
|
| 42 | - '<p>' . __( 'We collect information about you during the checkout process on our site. This information may include, but is not limited to, your name, email address, phone number, address, IP and any other details that might be requested from you for the purpose of processing your payment and retaining your invoice details for legal reasons.', 'invoicing' ) . '</p>' . |
|
| 43 | - '<p>' . __( 'Handling this data also allows us to:', 'invoicing' ) . '</p>' . |
|
| 44 | - '<ul>' . |
|
| 45 | - '<li>' . __( '- Send you important account/invoice/service information.', 'invoicing' ) . '</li>' . |
|
| 46 | - '<li>' . __( '- Estimate taxes based on your location.', 'invoicing' ) . '</li>' . |
|
| 47 | - '<li>' . __( '- Respond to your queries or complaints.', 'invoicing' ) . '</li>' . |
|
| 48 | - '<li>' . __( '- Process payments and to prevent fraudulent transactions. We do this on the basis of our legitimate business interests.', 'invoicing' ) . '</li>' . |
|
| 49 | - '<li>' . __( '- Retain historical payment and invoice history. We do this on the basis of legal obligations.', 'invoicing' ) . '</li>' . |
|
| 50 | - '<li>' . __( '- Set up and administer your account, provide technical and/or customer support, and to verify your identity. We do this on the basis of our legitimate business interests.', 'invoicing' ) . '</li>' . |
|
| 51 | - '</ul>' . |
|
| 52 | - '<p>' . __( 'In addition to collecting information at checkout we may also use and store your contact details when manually creating invoices for require payments relating to prior contractual agreements or agreed terms.', 'invoicing' ) . '</p>' . |
|
| 53 | - '<h2>' . __( 'What we share with others', 'invoicing' ) . '</h2>' . |
|
| 54 | - '<p>' . __( 'We share information with third parties who help us provide our payment and invoicing services to you; for example --', 'invoicing' ) . '</p>' . |
|
| 55 | - '<p class="privacy-policy-tutorial">' . __( 'In this subsection you should list which third party payment processors you’re using to take payments since these may handle customer data. We’ve included PayPal as an example, but you should remove this if you’re not using PayPal.', 'invoicing' ) . '</p>' . |
|
| 56 | - '<p>' . __( 'We accept payments through PayPal. When processing payments, some of your data will be passed to PayPal, including information required to process or support the payment, such as the purchase total and billing information.', 'invoicing' ) . '</p>' . |
|
| 57 | - '<p>' . __( 'Please see the <a href="https://www.paypal.com/us/webapps/mpp/ua/privacy-full">PayPal Privacy Policy</a> for more details.', 'invoicing' ) . '</p>' . |
|
| 58 | - '</div>'; |
|
| 40 | + '<h2>' . __( 'Invoices and checkout', 'invoicing' ) . '</h2>' . |
|
| 41 | + '<p class="privacy-policy-tutorial">' . __( 'Example privacy texts.', 'invoicing' ) . '</p>' . |
|
| 42 | + '<p>' . __( 'We collect information about you during the checkout process on our site. This information may include, but is not limited to, your name, email address, phone number, address, IP and any other details that might be requested from you for the purpose of processing your payment and retaining your invoice details for legal reasons.', 'invoicing' ) . '</p>' . |
|
| 43 | + '<p>' . __( 'Handling this data also allows us to:', 'invoicing' ) . '</p>' . |
|
| 44 | + '<ul>' . |
|
| 45 | + '<li>' . __( '- Send you important account/invoice/service information.', 'invoicing' ) . '</li>' . |
|
| 46 | + '<li>' . __( '- Estimate taxes based on your location.', 'invoicing' ) . '</li>' . |
|
| 47 | + '<li>' . __( '- Respond to your queries or complaints.', 'invoicing' ) . '</li>' . |
|
| 48 | + '<li>' . __( '- Process payments and to prevent fraudulent transactions. We do this on the basis of our legitimate business interests.', 'invoicing' ) . '</li>' . |
|
| 49 | + '<li>' . __( '- Retain historical payment and invoice history. We do this on the basis of legal obligations.', 'invoicing' ) . '</li>' . |
|
| 50 | + '<li>' . __( '- Set up and administer your account, provide technical and/or customer support, and to verify your identity. We do this on the basis of our legitimate business interests.', 'invoicing' ) . '</li>' . |
|
| 51 | + '</ul>' . |
|
| 52 | + '<p>' . __( 'In addition to collecting information at checkout we may also use and store your contact details when manually creating invoices for require payments relating to prior contractual agreements or agreed terms.', 'invoicing' ) . '</p>' . |
|
| 53 | + '<h2>' . __( 'What we share with others', 'invoicing' ) . '</h2>' . |
|
| 54 | + '<p>' . __( 'We share information with third parties who help us provide our payment and invoicing services to you; for example --', 'invoicing' ) . '</p>' . |
|
| 55 | + '<p class="privacy-policy-tutorial">' . __( 'In this subsection you should list which third party payment processors you’re using to take payments since these may handle customer data. We’ve included PayPal as an example, but you should remove this if you’re not using PayPal.', 'invoicing' ) . '</p>' . |
|
| 56 | + '<p>' . __( 'We accept payments through PayPal. When processing payments, some of your data will be passed to PayPal, including information required to process or support the payment, such as the purchase total and billing information.', 'invoicing' ) . '</p>' . |
|
| 57 | + '<p>' . __( 'Please see the <a href="https://www.paypal.com/us/webapps/mpp/ua/privacy-full">PayPal Privacy Policy</a> for more details.', 'invoicing' ) . '</p>' . |
|
| 58 | + '</div>'; |
|
| 59 | 59 | |
| 60 | 60 | return apply_filters( 'wpinv_privacy_policy_content', $content ); |
| 61 | 61 | } |
@@ -12,109 +12,109 @@ |
||
| 12 | 12 | */ |
| 13 | 13 | class GetPaid_Payment_Form_Submission_Fees { |
| 14 | 14 | |
| 15 | - /** |
|
| 16 | - * The fee validation error. |
|
| 17 | - * @var string |
|
| 18 | - */ |
|
| 19 | - public $fee_error; |
|
| 20 | - |
|
| 21 | - /** |
|
| 22 | - * Submission fees. |
|
| 23 | - * @var array |
|
| 24 | - */ |
|
| 25 | - public $fees = array(); |
|
| 15 | + /** |
|
| 16 | + * The fee validation error. |
|
| 17 | + * @var string |
|
| 18 | + */ |
|
| 19 | + public $fee_error; |
|
| 20 | + |
|
| 21 | + /** |
|
| 22 | + * Submission fees. |
|
| 23 | + * @var array |
|
| 24 | + */ |
|
| 25 | + public $fees = array(); |
|
| 26 | + |
|
| 27 | + /** |
|
| 28 | + * Class constructor |
|
| 29 | + * |
|
| 30 | + * @param GetPaid_Payment_Form_Submission $submission |
|
| 31 | + */ |
|
| 32 | + public function __construct( $submission ) { |
|
| 33 | + |
|
| 34 | + // Process any existing invoice fees. |
|
| 35 | + if ( $submission->has_invoice() ) { |
|
| 36 | + $this->fees = $submission->get_invoice()->get_fees(); |
|
| 37 | + } |
|
| 38 | + |
|
| 39 | + // Process price fields. |
|
| 40 | + $data = $submission->get_data(); |
|
| 41 | + $payment_form = $submission->get_payment_form(); |
|
| 42 | + |
|
| 43 | + foreach ( $payment_form->get_elements() as $element ) { |
|
| 44 | + |
|
| 45 | + if ( 'price_input' == $element['type'] ) { |
|
| 46 | + $this->process_price_input( $element, $data, $submission ); |
|
| 47 | + } |
|
| 48 | + |
|
| 49 | + if ( 'price_select' == $element['type'] ) { |
|
| 50 | + $this->process_price_select( $element, $data ); |
|
| 51 | + } |
|
| 52 | + |
|
| 53 | + } |
|
| 54 | + |
|
| 55 | + } |
|
| 56 | + |
|
| 57 | + /** |
|
| 58 | + * Process a price input field. |
|
| 59 | + * |
|
| 60 | + * @param array $element |
|
| 61 | + * @param array $data |
|
| 62 | + * @param GetPaid_Payment_Form_Submission $submission |
|
| 63 | + */ |
|
| 64 | + public function process_price_input( $element, $data, $submission ) { |
|
| 65 | + |
|
| 66 | + // Abort if not passed. |
|
| 67 | + if ( empty( $data[ $element['id'] ] ) ) { |
|
| 68 | + return; |
|
| 69 | + } |
|
| 70 | + |
|
| 71 | + $amount = (float) wpinv_sanitize_amount( $data[ $element['id'] ] ); |
|
| 72 | + $minimum = empty( $element['minimum'] ) ? 0 : (float) wpinv_sanitize_amount( $element['minimum'] ); |
|
| 73 | + |
|
| 74 | + if ( $amount < $minimum ) { |
|
| 75 | + throw new Exception( sprintf( __( 'The minimum allowed amount is %s', 'invoicing' ), wpinv_price( $minimum, $submission->get_currency() ) ) ); |
|
| 76 | + } |
|
| 77 | + |
|
| 78 | + $this->fees[ $element['label'] ] = array( |
|
| 79 | + 'name' => $element['label'], |
|
| 80 | + 'initial_fee' => $amount, |
|
| 81 | + 'recurring_fee' => 0, |
|
| 82 | + ); |
|
| 83 | + |
|
| 84 | + } |
|
| 26 | 85 | |
| 27 | 86 | /** |
| 28 | - * Class constructor |
|
| 29 | - * |
|
| 30 | - * @param GetPaid_Payment_Form_Submission $submission |
|
| 31 | - */ |
|
| 32 | - public function __construct( $submission ) { |
|
| 33 | - |
|
| 34 | - // Process any existing invoice fees. |
|
| 35 | - if ( $submission->has_invoice() ) { |
|
| 36 | - $this->fees = $submission->get_invoice()->get_fees(); |
|
| 37 | - } |
|
| 38 | - |
|
| 39 | - // Process price fields. |
|
| 40 | - $data = $submission->get_data(); |
|
| 41 | - $payment_form = $submission->get_payment_form(); |
|
| 42 | - |
|
| 43 | - foreach ( $payment_form->get_elements() as $element ) { |
|
| 44 | - |
|
| 45 | - if ( 'price_input' == $element['type'] ) { |
|
| 46 | - $this->process_price_input( $element, $data, $submission ); |
|
| 47 | - } |
|
| 48 | - |
|
| 49 | - if ( 'price_select' == $element['type'] ) { |
|
| 50 | - $this->process_price_select( $element, $data ); |
|
| 51 | - } |
|
| 52 | - |
|
| 53 | - } |
|
| 54 | - |
|
| 55 | - } |
|
| 56 | - |
|
| 57 | - /** |
|
| 58 | - * Process a price input field. |
|
| 59 | - * |
|
| 60 | - * @param array $element |
|
| 61 | - * @param array $data |
|
| 62 | - * @param GetPaid_Payment_Form_Submission $submission |
|
| 63 | - */ |
|
| 64 | - public function process_price_input( $element, $data, $submission ) { |
|
| 65 | - |
|
| 66 | - // Abort if not passed. |
|
| 67 | - if ( empty( $data[ $element['id'] ] ) ) { |
|
| 68 | - return; |
|
| 69 | - } |
|
| 70 | - |
|
| 71 | - $amount = (float) wpinv_sanitize_amount( $data[ $element['id'] ] ); |
|
| 72 | - $minimum = empty( $element['minimum'] ) ? 0 : (float) wpinv_sanitize_amount( $element['minimum'] ); |
|
| 73 | - |
|
| 74 | - if ( $amount < $minimum ) { |
|
| 75 | - throw new Exception( sprintf( __( 'The minimum allowed amount is %s', 'invoicing' ), wpinv_price( $minimum, $submission->get_currency() ) ) ); |
|
| 76 | - } |
|
| 77 | - |
|
| 78 | - $this->fees[ $element['label'] ] = array( |
|
| 79 | - 'name' => $element['label'], |
|
| 80 | - 'initial_fee' => $amount, |
|
| 81 | - 'recurring_fee' => 0, |
|
| 82 | - ); |
|
| 83 | - |
|
| 84 | - } |
|
| 85 | - |
|
| 86 | - /** |
|
| 87 | - * Process a price select field. |
|
| 88 | - * |
|
| 89 | - * @param array $element |
|
| 90 | - * @param array $data |
|
| 91 | - */ |
|
| 92 | - public function process_price_select( $element, $data ) { |
|
| 93 | - |
|
| 94 | - // Abort if not passed. |
|
| 95 | - if ( empty( $data[ $element['id'] ] ) ) { |
|
| 96 | - return; |
|
| 97 | - } |
|
| 98 | - |
|
| 99 | - $options = getpaid_convert_price_string_to_options( $element['options'] ); |
|
| 100 | - $selected = wpinv_parse_list( $data[ $element['id'] ] ); |
|
| 101 | - $total = 0; |
|
| 102 | - |
|
| 103 | - foreach ( $selected as $price ) { |
|
| 104 | - |
|
| 105 | - if ( ! isset( $options[ $price ] ) ) { |
|
| 106 | - throw new Exception( __( 'You have selected an invalid amount', 'invoicing' ) ); |
|
| 107 | - } |
|
| 108 | - |
|
| 109 | - $total += (float) wpinv_sanitize_amount( $price ); |
|
| 110 | - } |
|
| 111 | - |
|
| 112 | - $this->fees[ $element['label'] ] = array( |
|
| 113 | - 'name' => $element['label'], |
|
| 114 | - 'initial_fee' => $total, |
|
| 115 | - 'recurring_fee' => 0, |
|
| 116 | - ); |
|
| 117 | - |
|
| 118 | - } |
|
| 87 | + * Process a price select field. |
|
| 88 | + * |
|
| 89 | + * @param array $element |
|
| 90 | + * @param array $data |
|
| 91 | + */ |
|
| 92 | + public function process_price_select( $element, $data ) { |
|
| 93 | + |
|
| 94 | + // Abort if not passed. |
|
| 95 | + if ( empty( $data[ $element['id'] ] ) ) { |
|
| 96 | + return; |
|
| 97 | + } |
|
| 98 | + |
|
| 99 | + $options = getpaid_convert_price_string_to_options( $element['options'] ); |
|
| 100 | + $selected = wpinv_parse_list( $data[ $element['id'] ] ); |
|
| 101 | + $total = 0; |
|
| 102 | + |
|
| 103 | + foreach ( $selected as $price ) { |
|
| 104 | + |
|
| 105 | + if ( ! isset( $options[ $price ] ) ) { |
|
| 106 | + throw new Exception( __( 'You have selected an invalid amount', 'invoicing' ) ); |
|
| 107 | + } |
|
| 108 | + |
|
| 109 | + $total += (float) wpinv_sanitize_amount( $price ); |
|
| 110 | + } |
|
| 111 | + |
|
| 112 | + $this->fees[ $element['label'] ] = array( |
|
| 113 | + 'name' => $element['label'], |
|
| 114 | + 'initial_fee' => $total, |
|
| 115 | + 'recurring_fee' => 0, |
|
| 116 | + ); |
|
| 117 | + |
|
| 118 | + } |
|
| 119 | 119 | |
| 120 | 120 | } |
@@ -42,86 +42,86 @@ discard block |
||
| 42 | 42 | <tr class="wpinv-item wpinv-item-<?php echo $invoice_status = $invoice->get_status(); ?>"> |
| 43 | 43 | <?php |
| 44 | 44 | |
| 45 | - foreach ( wpinv_get_user_invoices_columns( $post_type ) as $column_id => $column_name ) : |
|
| 45 | + foreach ( wpinv_get_user_invoices_columns( $post_type ) as $column_id => $column_name ) : |
|
| 46 | 46 | |
| 47 | - $column_id = sanitize_html_class( $column_id ); |
|
| 48 | - $class = empty( $column_name['class'] ) ? '' : sanitize_html_class( $column_name['class'] ); |
|
| 47 | + $column_id = sanitize_html_class( $column_id ); |
|
| 48 | + $class = empty( $column_name['class'] ) ? '' : sanitize_html_class( $column_name['class'] ); |
|
| 49 | 49 | |
| 50 | - echo "<td class='$column_id $class'>"; |
|
| 51 | - switch ( $column_id ) { |
|
| 50 | + echo "<td class='$column_id $class'>"; |
|
| 51 | + switch ( $column_id ) { |
|
| 52 | 52 | |
| 53 | - case 'invoice-number': |
|
| 54 | - echo wpinv_invoice_link( $invoice ); |
|
| 55 | - break; |
|
| 53 | + case 'invoice-number': |
|
| 54 | + echo wpinv_invoice_link( $invoice ); |
|
| 55 | + break; |
|
| 56 | 56 | |
| 57 | - case 'created-date': |
|
| 58 | - echo getpaid_format_date_value( $invoice->get_date_created() ); |
|
| 59 | - break; |
|
| 57 | + case 'created-date': |
|
| 58 | + echo getpaid_format_date_value( $invoice->get_date_created() ); |
|
| 59 | + break; |
|
| 60 | 60 | |
| 61 | - case 'payment-date': |
|
| 61 | + case 'payment-date': |
|
| 62 | 62 | |
| 63 | - if ( $invoice->needs_payment() ) { |
|
| 64 | - echo "—"; |
|
| 65 | - } else { |
|
| 66 | - echo getpaid_format_date_value( $invoice->get_date_completed() ); |
|
| 67 | - } |
|
| 63 | + if ( $invoice->needs_payment() ) { |
|
| 64 | + echo "—"; |
|
| 65 | + } else { |
|
| 66 | + echo getpaid_format_date_value( $invoice->get_date_completed() ); |
|
| 67 | + } |
|
| 68 | 68 | |
| 69 | - break; |
|
| 69 | + break; |
|
| 70 | 70 | |
| 71 | - case 'invoice-status': |
|
| 72 | - echo $invoice->get_status_label_html(); |
|
| 71 | + case 'invoice-status': |
|
| 72 | + echo $invoice->get_status_label_html(); |
|
| 73 | 73 | |
| 74 | - break; |
|
| 74 | + break; |
|
| 75 | 75 | |
| 76 | - case 'invoice-total': |
|
| 77 | - echo wpinv_price( $invoice->get_total(), $invoice->get_currency() ); |
|
| 76 | + case 'invoice-total': |
|
| 77 | + echo wpinv_price( $invoice->get_total(), $invoice->get_currency() ); |
|
| 78 | 78 | |
| 79 | - break; |
|
| 79 | + break; |
|
| 80 | 80 | |
| 81 | - case 'invoice-actions': |
|
| 81 | + case 'invoice-actions': |
|
| 82 | 82 | |
| 83 | - $actions = array( |
|
| 83 | + $actions = array( |
|
| 84 | 84 | |
| 85 | - 'pay' => array( |
|
| 86 | - 'url' => $invoice->get_checkout_payment_url(), |
|
| 87 | - 'name' => __( 'Pay Now', 'invoicing' ), |
|
| 88 | - 'class' => 'btn-success' |
|
| 89 | - ), |
|
| 85 | + 'pay' => array( |
|
| 86 | + 'url' => $invoice->get_checkout_payment_url(), |
|
| 87 | + 'name' => __( 'Pay Now', 'invoicing' ), |
|
| 88 | + 'class' => 'btn-success' |
|
| 89 | + ), |
|
| 90 | 90 | |
| 91 | - 'print' => array( |
|
| 92 | - 'url' => $invoice->get_view_url(), |
|
| 93 | - 'name' => __( 'View', 'invoicing' ), |
|
| 94 | - 'class' => 'btn-secondary', |
|
| 95 | - 'attrs' => 'target="_blank"' |
|
| 96 | - ) |
|
| 97 | - ); |
|
| 91 | + 'print' => array( |
|
| 92 | + 'url' => $invoice->get_view_url(), |
|
| 93 | + 'name' => __( 'View', 'invoicing' ), |
|
| 94 | + 'class' => 'btn-secondary', |
|
| 95 | + 'attrs' => 'target="_blank"' |
|
| 96 | + ) |
|
| 97 | + ); |
|
| 98 | 98 | |
| 99 | - if ( ! $invoice->needs_payment() ) { |
|
| 100 | - unset( $actions['pay'] ); |
|
| 101 | - } |
|
| 99 | + if ( ! $invoice->needs_payment() ) { |
|
| 100 | + unset( $actions['pay'] ); |
|
| 101 | + } |
|
| 102 | 102 | |
| 103 | - $actions = apply_filters( 'wpinv_user_invoices_actions', $actions, $invoice, $post_type ); |
|
| 103 | + $actions = apply_filters( 'wpinv_user_invoices_actions', $actions, $invoice, $post_type ); |
|
| 104 | 104 | |
| 105 | - foreach ( $actions as $key => $action ) { |
|
| 106 | - $class = !empty($action['class']) ? sanitize_html_class($action['class']) : ''; |
|
| 107 | - echo '<a href="' . esc_url( $action['url'] ) . '" class="btn btn-sm btn-block ' . $class . ' ' . sanitize_html_class( $key ) . '" ' . ( !empty($action['attrs']) ? $action['attrs'] : '' ) . '>' . $action['name'] . '</a>'; |
|
| 108 | - } |
|
| 105 | + foreach ( $actions as $key => $action ) { |
|
| 106 | + $class = !empty($action['class']) ? sanitize_html_class($action['class']) : ''; |
|
| 107 | + echo '<a href="' . esc_url( $action['url'] ) . '" class="btn btn-sm btn-block ' . $class . ' ' . sanitize_html_class( $key ) . '" ' . ( !empty($action['attrs']) ? $action['attrs'] : '' ) . '>' . $action['name'] . '</a>'; |
|
| 108 | + } |
|
| 109 | 109 | |
| 110 | - break; |
|
| 110 | + break; |
|
| 111 | 111 | |
| 112 | - default: |
|
| 113 | - do_action( "wpinv_user_invoices_column_$column_id", $invoice ); |
|
| 114 | - break; |
|
| 112 | + default: |
|
| 113 | + do_action( "wpinv_user_invoices_column_$column_id", $invoice ); |
|
| 114 | + break; |
|
| 115 | 115 | |
| 116 | 116 | |
| 117 | - } |
|
| 117 | + } |
|
| 118 | 118 | |
| 119 | - do_action( "wpinv_user_invoices_column_after_$column_id", $invoice ); |
|
| 119 | + do_action( "wpinv_user_invoices_column_after_$column_id", $invoice ); |
|
| 120 | 120 | |
| 121 | - echo '</td>'; |
|
| 121 | + echo '</td>'; |
|
| 122 | 122 | |
| 123 | - endforeach; |
|
| 124 | - ?> |
|
| 123 | + endforeach; |
|
| 124 | + ?> |
|
| 125 | 125 | </tr> |
| 126 | 126 | |
| 127 | 127 | <?php endforeach; ?> |
@@ -135,14 +135,14 @@ discard block |
||
| 135 | 135 | <?php if ( 1 < $invoices->max_num_pages ) : ?> |
| 136 | 136 | <div class="invoicing-Pagination"> |
| 137 | 137 | <?php |
| 138 | - $big = 999999; |
|
| 139 | - |
|
| 140 | - echo paginate_links( array( |
|
| 141 | - 'base' => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ), |
|
| 142 | - 'format' => '?paged=%#%', |
|
| 143 | - 'total' => $invoices->max_num_pages, |
|
| 144 | - ) ); |
|
| 145 | - ?> |
|
| 138 | + $big = 999999; |
|
| 139 | + |
|
| 140 | + echo paginate_links( array( |
|
| 141 | + 'base' => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ), |
|
| 142 | + 'format' => '?paged=%#%', |
|
| 143 | + 'total' => $invoices->max_num_pages, |
|
| 144 | + ) ); |
|
| 145 | + ?> |
|
| 146 | 146 | </div> |
| 147 | 147 | <?php endif; ?> |
| 148 | 148 | |
@@ -18,179 +18,179 @@ |
||
| 18 | 18 | */ |
| 19 | 19 | class GetPaid_REST_Report_Top_Sellers_Controller extends GetPaid_REST_Report_Sales_Controller { |
| 20 | 20 | |
| 21 | - /** |
|
| 22 | - * Route base. |
|
| 23 | - * |
|
| 24 | - * @var string |
|
| 25 | - */ |
|
| 26 | - protected $rest_base = 'reports/top_sellers'; |
|
| 27 | - |
|
| 28 | - /** |
|
| 29 | - * Get top sellers report. |
|
| 30 | - * |
|
| 31 | - * @param WP_REST_Request $request |
|
| 32 | - * @return array|WP_Error |
|
| 33 | - */ |
|
| 34 | - public function get_items( $request ) { |
|
| 35 | - |
|
| 36 | - // Prepare items. |
|
| 37 | - $this->report_range = $this->get_date_range( $request ); |
|
| 38 | - $report_data = $this->get_report_data(); |
|
| 39 | - |
|
| 40 | - $top_sellers = array(); |
|
| 41 | - |
|
| 42 | - foreach ( $report_data as $item ) { |
|
| 43 | - |
|
| 44 | - $item_obj = new WPInv_Item( $item ); |
|
| 45 | - $item_name = $item->invoice_item_name; |
|
| 46 | - $item_qty = floatval( $item->invoice_item_qty ); |
|
| 47 | - $item_id = absint( $item->invoice_item_id ); |
|
| 48 | - $price = sanitize_text_field( wpinv_price( $item->invoice_item_price ) ); |
|
| 49 | - |
|
| 50 | - $item_obj = new WPInv_Item( $item_id ); |
|
| 51 | - |
|
| 52 | - if ( $item_obj->exists() ) { |
|
| 53 | - $item_name = $item_obj->get_name(); |
|
| 54 | - } else { |
|
| 55 | - $item_id = 0; |
|
| 56 | - } |
|
| 57 | - |
|
| 58 | - $top_sellers[] = array( |
|
| 59 | - 'name' =>sanitize_text_field( $item_name ), |
|
| 60 | - 'item_id' => $item_id, |
|
| 61 | - 'quantity' => $item_qty, |
|
| 62 | - 'earnings' => wpinv_round_amount( $item->invoice_item_price ), |
|
| 63 | - 'earnings_formatted' => sanitize_text_field( wpinv_price( $price ) ), |
|
| 64 | - ); |
|
| 65 | - |
|
| 66 | - } |
|
| 67 | - |
|
| 68 | - $data = array(); |
|
| 69 | - foreach ( $top_sellers as $top_seller ) { |
|
| 70 | - $item = $this->prepare_item_for_response( (object) $top_seller, $request ); |
|
| 71 | - $data[] = $this->prepare_response_for_collection( $item ); |
|
| 72 | - } |
|
| 73 | - |
|
| 74 | - return rest_ensure_response( $data ); |
|
| 75 | - |
|
| 76 | - } |
|
| 77 | - |
|
| 78 | - /** |
|
| 79 | - * Prepare a report sales object for serialization. |
|
| 80 | - * |
|
| 81 | - * @param stdClass $top_seller |
|
| 82 | - * @param WP_REST_Request $request Request object. |
|
| 83 | - * @return WP_REST_Response $response Response data. |
|
| 84 | - */ |
|
| 85 | - public function prepare_item_for_response( $top_seller, $request ) { |
|
| 86 | - $data = (array) $top_seller; |
|
| 87 | - |
|
| 88 | - $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
| 89 | - $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 90 | - $data = $this->filter_response_by_context( $data, $context ); |
|
| 91 | - |
|
| 92 | - // Wrap the data in a response object. |
|
| 93 | - $response = rest_ensure_response( $data ); |
|
| 94 | - $links = array( |
|
| 95 | - 'about' => array( |
|
| 96 | - 'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ), |
|
| 97 | - ), |
|
| 98 | - ); |
|
| 99 | - |
|
| 100 | - if ( ! empty( $top_seller->item_id ) ) { |
|
| 101 | - $links['item'] = array( |
|
| 102 | - 'href' => rest_url( sprintf( '/%s/items/%s', $this->namespace, $top_seller->item_id ) ), |
|
| 103 | - 'embeddable' => true, |
|
| 104 | - ); |
|
| 105 | - } |
|
| 106 | - |
|
| 107 | - $response->add_links( $links ); |
|
| 108 | - return apply_filters( 'getpaid_rest_prepare_report_' . $this->rest_base, $response, $top_seller, $request ); |
|
| 109 | - } |
|
| 110 | - |
|
| 111 | - /** |
|
| 112 | - * Get all data needed for this report and store in the class. |
|
| 113 | - */ |
|
| 114 | - protected function query_report_data() { |
|
| 115 | - |
|
| 116 | - $this->report_data = GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 117 | - array( |
|
| 118 | - 'data' => array( |
|
| 119 | - 'quantity' => array( |
|
| 120 | - 'type' => 'invoice_item', |
|
| 121 | - 'function' => 'SUM', |
|
| 122 | - 'name' => 'invoice_item_qty', |
|
| 123 | - ), |
|
| 124 | - 'item_id' => array( |
|
| 125 | - 'type' => 'invoice_item', |
|
| 126 | - 'function' => '', |
|
| 127 | - 'name' => 'invoice_item_id', |
|
| 128 | - ), |
|
| 129 | - 'item_name' => array( |
|
| 130 | - 'type' => 'invoice_item', |
|
| 131 | - 'function' => '', |
|
| 132 | - 'name' => 'invoice_item_name', |
|
| 133 | - ), |
|
| 134 | - 'price' => array( |
|
| 135 | - 'type' => 'invoice_item', |
|
| 136 | - 'function' => 'SUM', |
|
| 137 | - 'name' => 'invoice_item_price', |
|
| 138 | - ), |
|
| 139 | - ), |
|
| 140 | - 'group_by' => 'invoice_item_id', |
|
| 141 | - 'order_by' => 'invoice_item_qty DESC', |
|
| 142 | - 'query_type' => 'get_results', |
|
| 143 | - 'limit' => 10, |
|
| 144 | - 'filter_range' => $this->report_range, |
|
| 145 | - ) |
|
| 146 | - ); |
|
| 147 | - |
|
| 148 | - } |
|
| 149 | - |
|
| 150 | - /** |
|
| 151 | - * Get the Report's schema, conforming to JSON Schema. |
|
| 152 | - * |
|
| 153 | - * @return array |
|
| 154 | - */ |
|
| 155 | - public function get_item_schema() { |
|
| 156 | - $schema = array( |
|
| 157 | - '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
| 158 | - 'title' => $this->rest_base, |
|
| 159 | - 'type' => 'object', |
|
| 160 | - 'properties' => array( |
|
| 161 | - 'name' => array( |
|
| 162 | - 'description' => __( 'Item name.', 'invoicing' ), |
|
| 163 | - 'type' => 'string', |
|
| 164 | - 'context' => array( 'view' ), |
|
| 165 | - 'readonly' => true, |
|
| 166 | - ), |
|
| 167 | - 'item_id' => array( |
|
| 168 | - 'description' => __( 'Item ID.', 'invoicing' ), |
|
| 169 | - 'type' => 'integer', |
|
| 170 | - 'context' => array( 'view' ), |
|
| 171 | - 'readonly' => true, |
|
| 172 | - ), |
|
| 173 | - 'quantity' => array( |
|
| 174 | - 'description' => __( 'Total number of purchases.', 'invoicing' ), |
|
| 175 | - 'type' => 'number', |
|
| 176 | - 'context' => array( 'view' ), |
|
| 177 | - 'readonly' => true, |
|
| 178 | - ), |
|
| 179 | - 'earnings' => array( |
|
| 180 | - 'description' => __( 'Total earnings for the item.', 'invoicing' ), |
|
| 181 | - 'type' => 'number', |
|
| 182 | - 'context' => array( 'view' ), |
|
| 183 | - 'readonly' => true, |
|
| 184 | - ), |
|
| 185 | - 'earnings_formatted"' => array( |
|
| 186 | - 'description' => __( 'Total earnings (formatted) for the item.', 'invoicing' ), |
|
| 187 | - 'type' => 'string', |
|
| 188 | - 'context' => array( 'view' ), |
|
| 189 | - 'readonly' => true, |
|
| 190 | - ), |
|
| 191 | - ), |
|
| 192 | - ); |
|
| 193 | - |
|
| 194 | - return $this->add_additional_fields_schema( $schema ); |
|
| 195 | - } |
|
| 21 | + /** |
|
| 22 | + * Route base. |
|
| 23 | + * |
|
| 24 | + * @var string |
|
| 25 | + */ |
|
| 26 | + protected $rest_base = 'reports/top_sellers'; |
|
| 27 | + |
|
| 28 | + /** |
|
| 29 | + * Get top sellers report. |
|
| 30 | + * |
|
| 31 | + * @param WP_REST_Request $request |
|
| 32 | + * @return array|WP_Error |
|
| 33 | + */ |
|
| 34 | + public function get_items( $request ) { |
|
| 35 | + |
|
| 36 | + // Prepare items. |
|
| 37 | + $this->report_range = $this->get_date_range( $request ); |
|
| 38 | + $report_data = $this->get_report_data(); |
|
| 39 | + |
|
| 40 | + $top_sellers = array(); |
|
| 41 | + |
|
| 42 | + foreach ( $report_data as $item ) { |
|
| 43 | + |
|
| 44 | + $item_obj = new WPInv_Item( $item ); |
|
| 45 | + $item_name = $item->invoice_item_name; |
|
| 46 | + $item_qty = floatval( $item->invoice_item_qty ); |
|
| 47 | + $item_id = absint( $item->invoice_item_id ); |
|
| 48 | + $price = sanitize_text_field( wpinv_price( $item->invoice_item_price ) ); |
|
| 49 | + |
|
| 50 | + $item_obj = new WPInv_Item( $item_id ); |
|
| 51 | + |
|
| 52 | + if ( $item_obj->exists() ) { |
|
| 53 | + $item_name = $item_obj->get_name(); |
|
| 54 | + } else { |
|
| 55 | + $item_id = 0; |
|
| 56 | + } |
|
| 57 | + |
|
| 58 | + $top_sellers[] = array( |
|
| 59 | + 'name' =>sanitize_text_field( $item_name ), |
|
| 60 | + 'item_id' => $item_id, |
|
| 61 | + 'quantity' => $item_qty, |
|
| 62 | + 'earnings' => wpinv_round_amount( $item->invoice_item_price ), |
|
| 63 | + 'earnings_formatted' => sanitize_text_field( wpinv_price( $price ) ), |
|
| 64 | + ); |
|
| 65 | + |
|
| 66 | + } |
|
| 67 | + |
|
| 68 | + $data = array(); |
|
| 69 | + foreach ( $top_sellers as $top_seller ) { |
|
| 70 | + $item = $this->prepare_item_for_response( (object) $top_seller, $request ); |
|
| 71 | + $data[] = $this->prepare_response_for_collection( $item ); |
|
| 72 | + } |
|
| 73 | + |
|
| 74 | + return rest_ensure_response( $data ); |
|
| 75 | + |
|
| 76 | + } |
|
| 77 | + |
|
| 78 | + /** |
|
| 79 | + * Prepare a report sales object for serialization. |
|
| 80 | + * |
|
| 81 | + * @param stdClass $top_seller |
|
| 82 | + * @param WP_REST_Request $request Request object. |
|
| 83 | + * @return WP_REST_Response $response Response data. |
|
| 84 | + */ |
|
| 85 | + public function prepare_item_for_response( $top_seller, $request ) { |
|
| 86 | + $data = (array) $top_seller; |
|
| 87 | + |
|
| 88 | + $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
| 89 | + $data = $this->add_additional_fields_to_object( $data, $request ); |
|
| 90 | + $data = $this->filter_response_by_context( $data, $context ); |
|
| 91 | + |
|
| 92 | + // Wrap the data in a response object. |
|
| 93 | + $response = rest_ensure_response( $data ); |
|
| 94 | + $links = array( |
|
| 95 | + 'about' => array( |
|
| 96 | + 'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ), |
|
| 97 | + ), |
|
| 98 | + ); |
|
| 99 | + |
|
| 100 | + if ( ! empty( $top_seller->item_id ) ) { |
|
| 101 | + $links['item'] = array( |
|
| 102 | + 'href' => rest_url( sprintf( '/%s/items/%s', $this->namespace, $top_seller->item_id ) ), |
|
| 103 | + 'embeddable' => true, |
|
| 104 | + ); |
|
| 105 | + } |
|
| 106 | + |
|
| 107 | + $response->add_links( $links ); |
|
| 108 | + return apply_filters( 'getpaid_rest_prepare_report_' . $this->rest_base, $response, $top_seller, $request ); |
|
| 109 | + } |
|
| 110 | + |
|
| 111 | + /** |
|
| 112 | + * Get all data needed for this report and store in the class. |
|
| 113 | + */ |
|
| 114 | + protected function query_report_data() { |
|
| 115 | + |
|
| 116 | + $this->report_data = GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 117 | + array( |
|
| 118 | + 'data' => array( |
|
| 119 | + 'quantity' => array( |
|
| 120 | + 'type' => 'invoice_item', |
|
| 121 | + 'function' => 'SUM', |
|
| 122 | + 'name' => 'invoice_item_qty', |
|
| 123 | + ), |
|
| 124 | + 'item_id' => array( |
|
| 125 | + 'type' => 'invoice_item', |
|
| 126 | + 'function' => '', |
|
| 127 | + 'name' => 'invoice_item_id', |
|
| 128 | + ), |
|
| 129 | + 'item_name' => array( |
|
| 130 | + 'type' => 'invoice_item', |
|
| 131 | + 'function' => '', |
|
| 132 | + 'name' => 'invoice_item_name', |
|
| 133 | + ), |
|
| 134 | + 'price' => array( |
|
| 135 | + 'type' => 'invoice_item', |
|
| 136 | + 'function' => 'SUM', |
|
| 137 | + 'name' => 'invoice_item_price', |
|
| 138 | + ), |
|
| 139 | + ), |
|
| 140 | + 'group_by' => 'invoice_item_id', |
|
| 141 | + 'order_by' => 'invoice_item_qty DESC', |
|
| 142 | + 'query_type' => 'get_results', |
|
| 143 | + 'limit' => 10, |
|
| 144 | + 'filter_range' => $this->report_range, |
|
| 145 | + ) |
|
| 146 | + ); |
|
| 147 | + |
|
| 148 | + } |
|
| 149 | + |
|
| 150 | + /** |
|
| 151 | + * Get the Report's schema, conforming to JSON Schema. |
|
| 152 | + * |
|
| 153 | + * @return array |
|
| 154 | + */ |
|
| 155 | + public function get_item_schema() { |
|
| 156 | + $schema = array( |
|
| 157 | + '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
| 158 | + 'title' => $this->rest_base, |
|
| 159 | + 'type' => 'object', |
|
| 160 | + 'properties' => array( |
|
| 161 | + 'name' => array( |
|
| 162 | + 'description' => __( 'Item name.', 'invoicing' ), |
|
| 163 | + 'type' => 'string', |
|
| 164 | + 'context' => array( 'view' ), |
|
| 165 | + 'readonly' => true, |
|
| 166 | + ), |
|
| 167 | + 'item_id' => array( |
|
| 168 | + 'description' => __( 'Item ID.', 'invoicing' ), |
|
| 169 | + 'type' => 'integer', |
|
| 170 | + 'context' => array( 'view' ), |
|
| 171 | + 'readonly' => true, |
|
| 172 | + ), |
|
| 173 | + 'quantity' => array( |
|
| 174 | + 'description' => __( 'Total number of purchases.', 'invoicing' ), |
|
| 175 | + 'type' => 'number', |
|
| 176 | + 'context' => array( 'view' ), |
|
| 177 | + 'readonly' => true, |
|
| 178 | + ), |
|
| 179 | + 'earnings' => array( |
|
| 180 | + 'description' => __( 'Total earnings for the item.', 'invoicing' ), |
|
| 181 | + 'type' => 'number', |
|
| 182 | + 'context' => array( 'view' ), |
|
| 183 | + 'readonly' => true, |
|
| 184 | + ), |
|
| 185 | + 'earnings_formatted"' => array( |
|
| 186 | + 'description' => __( 'Total earnings (formatted) for the item.', 'invoicing' ), |
|
| 187 | + 'type' => 'string', |
|
| 188 | + 'context' => array( 'view' ), |
|
| 189 | + 'readonly' => true, |
|
| 190 | + ), |
|
| 191 | + ), |
|
| 192 | + ); |
|
| 193 | + |
|
| 194 | + return $this->add_additional_fields_schema( $schema ); |
|
| 195 | + } |
|
| 196 | 196 | } |
