AyeCode /
invoicing
@@ -12,49 +12,49 @@ discard block |
||
| 12 | 12 | */ |
| 13 | 13 | class GetPaid_Reports { |
| 14 | 14 | |
| 15 | - /** |
|
| 16 | - * Class constructor. |
|
| 17 | - * |
|
| 18 | - */ |
|
| 19 | - public function __construct() { |
|
| 20 | - add_action( 'admin_menu', array( $this, 'register_reports_page' ), 20 ); |
|
| 21 | - add_action( 'wpinv_reports_tab_reports', array( $this, 'display_reports_tab' ) ); |
|
| 22 | - add_action( 'wpinv_reports_tab_export', array( $this, 'display_exports_tab' ) ); |
|
| 23 | - add_action( 'getpaid_authenticated_admin_action_download_graph', array( $this, 'download_graph' ) ); |
|
| 24 | - add_action( 'getpaid_authenticated_admin_action_export_invoices', array( $this, 'export_invoices' ) ); |
|
| 25 | - |
|
| 26 | - } |
|
| 27 | - |
|
| 28 | - /** |
|
| 29 | - * Registers the reports page. |
|
| 30 | - * |
|
| 31 | - */ |
|
| 32 | - public function register_reports_page() { |
|
| 33 | - |
|
| 34 | - add_submenu_page( |
|
| 15 | + /** |
|
| 16 | + * Class constructor. |
|
| 17 | + * |
|
| 18 | + */ |
|
| 19 | + public function __construct() { |
|
| 20 | + add_action( 'admin_menu', array( $this, 'register_reports_page' ), 20 ); |
|
| 21 | + add_action( 'wpinv_reports_tab_reports', array( $this, 'display_reports_tab' ) ); |
|
| 22 | + add_action( 'wpinv_reports_tab_export', array( $this, 'display_exports_tab' ) ); |
|
| 23 | + add_action( 'getpaid_authenticated_admin_action_download_graph', array( $this, 'download_graph' ) ); |
|
| 24 | + add_action( 'getpaid_authenticated_admin_action_export_invoices', array( $this, 'export_invoices' ) ); |
|
| 25 | + |
|
| 26 | + } |
|
| 27 | + |
|
| 28 | + /** |
|
| 29 | + * Registers the reports page. |
|
| 30 | + * |
|
| 31 | + */ |
|
| 32 | + public function register_reports_page() { |
|
| 33 | + |
|
| 34 | + add_submenu_page( |
|
| 35 | 35 | 'wpinv', |
| 36 | 36 | __( 'Reports', 'invoicing' ), |
| 37 | 37 | __( 'Reports', 'invoicing' ), |
| 38 | 38 | wpinv_get_capability(), |
| 39 | 39 | 'wpinv-reports', |
| 40 | 40 | array( $this, 'display_reports_page' ) |
| 41 | - ); |
|
| 41 | + ); |
|
| 42 | 42 | |
| 43 | - } |
|
| 43 | + } |
|
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * Displays the reports page. |
|
| 47 | - * |
|
| 48 | - */ |
|
| 49 | - public function display_reports_page() { |
|
| 45 | + /** |
|
| 46 | + * Displays the reports page. |
|
| 47 | + * |
|
| 48 | + */ |
|
| 49 | + public function display_reports_page() { |
|
| 50 | 50 | |
| 51 | - // Prepare variables. |
|
| 52 | - $tabs = $this->get_tabs(); |
|
| 53 | - $current_tab = isset( $_GET['tab'] ) ? sanitize_text_field( $_GET['tab'] ) : 'reports'; |
|
| 54 | - $current_tab = array_key_exists( $current_tab, $tabs ) ? $current_tab : 'reports'; |
|
| 51 | + // Prepare variables. |
|
| 52 | + $tabs = $this->get_tabs(); |
|
| 53 | + $current_tab = isset( $_GET['tab'] ) ? sanitize_text_field( $_GET['tab'] ) : 'reports'; |
|
| 54 | + $current_tab = array_key_exists( $current_tab, $tabs ) ? $current_tab : 'reports'; |
|
| 55 | 55 | |
| 56 | - // Display the current tab. |
|
| 57 | - ?> |
|
| 56 | + // Display the current tab. |
|
| 57 | + ?> |
|
| 58 | 58 | |
| 59 | 59 | <div class="wrap"> |
| 60 | 60 | |
@@ -63,19 +63,19 @@ discard block |
||
| 63 | 63 | <nav class="nav-tab-wrapper"> |
| 64 | 64 | |
| 65 | 65 | <?php |
| 66 | - foreach( $tabs as $key => $label ) { |
|
| 66 | + foreach( $tabs as $key => $label ) { |
|
| 67 | 67 | |
| 68 | - $key = sanitize_text_field( $key ); |
|
| 69 | - $label = sanitize_text_field( $label ); |
|
| 70 | - $class = $key == $current_tab ? 'nav-tab nav-tab-active' : 'nav-tab'; |
|
| 71 | - $url = esc_url( |
|
| 72 | - add_query_arg( 'tab', $key, admin_url( 'admin.php?page=wpinv-reports' ) ) |
|
| 73 | - ); |
|
| 68 | + $key = sanitize_text_field( $key ); |
|
| 69 | + $label = sanitize_text_field( $label ); |
|
| 70 | + $class = $key == $current_tab ? 'nav-tab nav-tab-active' : 'nav-tab'; |
|
| 71 | + $url = esc_url( |
|
| 72 | + add_query_arg( 'tab', $key, admin_url( 'admin.php?page=wpinv-reports' ) ) |
|
| 73 | + ); |
|
| 74 | 74 | |
| 75 | - echo "\n\t\t\t<a href='$url' class='$class'>$label</a>"; |
|
| 75 | + echo "\n\t\t\t<a href='$url' class='$class'>$label</a>"; |
|
| 76 | 76 | |
| 77 | - } |
|
| 78 | - ?> |
|
| 77 | + } |
|
| 78 | + ?> |
|
| 79 | 79 | |
| 80 | 80 | </nav> |
| 81 | 81 | |
@@ -86,77 +86,77 @@ discard block |
||
| 86 | 86 | </div> |
| 87 | 87 | <?php |
| 88 | 88 | |
| 89 | - // Wordfence loads an unsupported version of chart js on our page. |
|
| 90 | - wp_deregister_style( 'chart-js' ); |
|
| 91 | - wp_deregister_script( 'chart-js' ); |
|
| 92 | - wp_enqueue_script( 'chart-js', WPINV_PLUGIN_URL . 'assets/js/chart.bundle.min.js', array( 'jquery' ), '2.9.4', true ); |
|
| 93 | - wp_enqueue_style( 'chart-js', WPINV_PLUGIN_URL . 'assets/css/chart.min.css', array(), '2.9.4' ); |
|
| 94 | - |
|
| 95 | - } |
|
| 96 | - |
|
| 97 | - /** |
|
| 98 | - * Retrieves reports page tabs. |
|
| 99 | - * |
|
| 100 | - * @return array |
|
| 101 | - */ |
|
| 102 | - public function get_tabs() { |
|
| 103 | - |
|
| 104 | - $tabs = array( |
|
| 105 | - 'reports' => __( 'Reports', 'invoicing' ), |
|
| 106 | - 'export' => __( 'Export', 'invoicing' ), |
|
| 107 | - ); |
|
| 108 | - |
|
| 109 | - return apply_filters( 'getpaid_report_tabs', $tabs ); |
|
| 110 | - } |
|
| 111 | - |
|
| 112 | - /** |
|
| 113 | - * Displays the reports tab. |
|
| 114 | - * |
|
| 115 | - */ |
|
| 116 | - public function display_reports_tab() { |
|
| 117 | - |
|
| 118 | - $reports = new GetPaid_Reports_Report(); |
|
| 119 | - $reports->display(); |
|
| 120 | - |
|
| 121 | - } |
|
| 122 | - |
|
| 123 | - /** |
|
| 124 | - * Displays the exports tab. |
|
| 125 | - * |
|
| 126 | - */ |
|
| 127 | - public function display_exports_tab() { |
|
| 128 | - |
|
| 129 | - $exports = new GetPaid_Reports_Export(); |
|
| 130 | - $exports->display(); |
|
| 131 | - |
|
| 132 | - } |
|
| 133 | - |
|
| 134 | - /** |
|
| 135 | - * Donwnloads a graph. |
|
| 136 | - * |
|
| 137 | - * @param array $args |
|
| 138 | - */ |
|
| 139 | - public function download_graph( $args ) { |
|
| 140 | - |
|
| 141 | - if ( ! empty( $args['graph'] ) ) { |
|
| 142 | - $downloader = new GetPaid_Graph_Downloader(); |
|
| 143 | - $downloader->download( $args['graph'] ); |
|
| 144 | - } |
|
| 145 | - |
|
| 146 | - } |
|
| 147 | - |
|
| 148 | - /** |
|
| 149 | - * Exports invoices. |
|
| 150 | - * |
|
| 151 | - * @param array $args |
|
| 152 | - */ |
|
| 153 | - public function export_invoices( $args ) { |
|
| 154 | - |
|
| 155 | - if ( ! empty( $args['post_type'] ) ) { |
|
| 156 | - $downloader = new GetPaid_Invoice_Exporter(); |
|
| 157 | - $downloader->export( $args['post_type'], $args ); |
|
| 158 | - } |
|
| 159 | - |
|
| 160 | - } |
|
| 89 | + // Wordfence loads an unsupported version of chart js on our page. |
|
| 90 | + wp_deregister_style( 'chart-js' ); |
|
| 91 | + wp_deregister_script( 'chart-js' ); |
|
| 92 | + wp_enqueue_script( 'chart-js', WPINV_PLUGIN_URL . 'assets/js/chart.bundle.min.js', array( 'jquery' ), '2.9.4', true ); |
|
| 93 | + wp_enqueue_style( 'chart-js', WPINV_PLUGIN_URL . 'assets/css/chart.min.css', array(), '2.9.4' ); |
|
| 94 | + |
|
| 95 | + } |
|
| 96 | + |
|
| 97 | + /** |
|
| 98 | + * Retrieves reports page tabs. |
|
| 99 | + * |
|
| 100 | + * @return array |
|
| 101 | + */ |
|
| 102 | + public function get_tabs() { |
|
| 103 | + |
|
| 104 | + $tabs = array( |
|
| 105 | + 'reports' => __( 'Reports', 'invoicing' ), |
|
| 106 | + 'export' => __( 'Export', 'invoicing' ), |
|
| 107 | + ); |
|
| 108 | + |
|
| 109 | + return apply_filters( 'getpaid_report_tabs', $tabs ); |
|
| 110 | + } |
|
| 111 | + |
|
| 112 | + /** |
|
| 113 | + * Displays the reports tab. |
|
| 114 | + * |
|
| 115 | + */ |
|
| 116 | + public function display_reports_tab() { |
|
| 117 | + |
|
| 118 | + $reports = new GetPaid_Reports_Report(); |
|
| 119 | + $reports->display(); |
|
| 120 | + |
|
| 121 | + } |
|
| 122 | + |
|
| 123 | + /** |
|
| 124 | + * Displays the exports tab. |
|
| 125 | + * |
|
| 126 | + */ |
|
| 127 | + public function display_exports_tab() { |
|
| 128 | + |
|
| 129 | + $exports = new GetPaid_Reports_Export(); |
|
| 130 | + $exports->display(); |
|
| 131 | + |
|
| 132 | + } |
|
| 133 | + |
|
| 134 | + /** |
|
| 135 | + * Donwnloads a graph. |
|
| 136 | + * |
|
| 137 | + * @param array $args |
|
| 138 | + */ |
|
| 139 | + public function download_graph( $args ) { |
|
| 140 | + |
|
| 141 | + if ( ! empty( $args['graph'] ) ) { |
|
| 142 | + $downloader = new GetPaid_Graph_Downloader(); |
|
| 143 | + $downloader->download( $args['graph'] ); |
|
| 144 | + } |
|
| 145 | + |
|
| 146 | + } |
|
| 147 | + |
|
| 148 | + /** |
|
| 149 | + * Exports invoices. |
|
| 150 | + * |
|
| 151 | + * @param array $args |
|
| 152 | + */ |
|
| 153 | + public function export_invoices( $args ) { |
|
| 154 | + |
|
| 155 | + if ( ! empty( $args['post_type'] ) ) { |
|
| 156 | + $downloader = new GetPaid_Invoice_Exporter(); |
|
| 157 | + $downloader->export( $args['post_type'], $args ); |
|
| 158 | + } |
|
| 159 | + |
|
| 160 | + } |
|
| 161 | 161 | |
| 162 | 162 | } |
@@ -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 | } |
@@ -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 | } |
@@ -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 | } |
@@ -13,629 +13,629 @@ |
||
| 13 | 13 | |
| 14 | 14 | return array( |
| 15 | 15 | |
| 16 | - 'id' => array( |
|
| 17 | - 'description' => __( 'Unique identifier for the invoice.', 'invoicing' ), |
|
| 18 | - 'type' => 'integer', |
|
| 19 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 20 | - 'readonly' => true, |
|
| 21 | - ), |
|
| 22 | - |
|
| 23 | - 'parent_id' => array( |
|
| 24 | - 'description' => __( 'Parent invoice ID.', 'invoicing' ), |
|
| 25 | - 'type' => 'integer', |
|
| 26 | - 'minimum' => 0, |
|
| 27 | - 'default' => 0, |
|
| 28 | - 'context' => array( 'view', 'edit' ), |
|
| 29 | - ), |
|
| 30 | - |
|
| 31 | - 'key' => array( |
|
| 32 | - 'description' => __( 'A unique key for the invoice.', 'invoicing' ), |
|
| 33 | - 'type' => 'string', |
|
| 34 | - 'context' => array( 'view', 'edit' ), |
|
| 35 | - 'readonly' => true, |
|
| 36 | - ), |
|
| 37 | - |
|
| 38 | - 'number' => array( |
|
| 39 | - 'description' => __( 'A unique number for the invoice.', 'invoicing' ), |
|
| 40 | - 'type' => 'string', |
|
| 41 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 42 | - ), |
|
| 43 | - |
|
| 44 | - 'type' => array( |
|
| 45 | - 'description' => __( 'Get the invoice type (e.g invoice, quote etc).', 'invoicing' ), |
|
| 46 | - 'type' => 'string', |
|
| 47 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 48 | - 'readonly' => true, |
|
| 49 | - ), |
|
| 50 | - |
|
| 51 | - 'post_type' => array( |
|
| 52 | - 'description' => __( 'Get the invoice post type (e.g wpi_invoice, wpi_quote etc).', 'invoicing' ), |
|
| 53 | - 'type' => 'string', |
|
| 54 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 55 | - 'readonly' => true, |
|
| 56 | - ), |
|
| 57 | - |
|
| 58 | - 'version' => array( |
|
| 59 | - 'description' => __( 'Version of GetPaid/Invoicing which last updated the invoice.', 'invoicing' ), |
|
| 60 | - 'type' => 'integer', |
|
| 61 | - 'context' => array( 'view', 'edit' ), |
|
| 62 | - 'readonly' => true, |
|
| 63 | - ), |
|
| 64 | - |
|
| 65 | - 'template' => array( |
|
| 66 | - 'description' => __( 'The invoice template.', 'invoicing' ), |
|
| 67 | - 'type' => 'string', |
|
| 68 | - 'default' => 'quantity', |
|
| 69 | - 'enum' => array( 'quantity', 'hours', 'amount' ), |
|
| 70 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 71 | - ), |
|
| 72 | - |
|
| 73 | - 'status' => array( |
|
| 74 | - 'description' => __( 'Invoice status.', 'invoicing' ), |
|
| 75 | - 'type' => 'string', |
|
| 76 | - 'default' => 'wpi-pending', |
|
| 77 | - 'enum' => array_keys( wpinv_get_invoice_statuses( true ) ), |
|
| 78 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 79 | - ), |
|
| 80 | - |
|
| 81 | - 'status_nicename' => array( |
|
| 82 | - 'description' => __( 'A human readable name for the invoice status.', 'invoicing' ), |
|
| 83 | - 'type' => 'string', |
|
| 84 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 85 | - 'readonly' => true, |
|
| 86 | - ), |
|
| 87 | - |
|
| 88 | - 'currency' => array( |
|
| 89 | - 'description' => __( 'The invoice currency in ISO format.', 'invoicing' ), |
|
| 90 | - 'type' => 'string', |
|
| 91 | - 'default' => wpinv_get_currency(), |
|
| 92 | - 'enum' => array_keys( wpinv_get_currencies() ), |
|
| 93 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 94 | - ), |
|
| 95 | - |
|
| 96 | - 'date_created' => array( |
|
| 97 | - 'description' => __( "The date the invoice was created, in the site's timezone.", 'invoicing' ), |
|
| 98 | - 'type' => 'string', |
|
| 99 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 100 | - ), |
|
| 101 | - |
|
| 102 | - 'date_created_gmt' => array( |
|
| 103 | - 'description' => __( 'The GMT date the invoice was created.', 'invoicing' ), |
|
| 104 | - 'type' => 'string', |
|
| 105 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 106 | - 'readonly' => true, |
|
| 107 | - ), |
|
| 108 | - |
|
| 109 | - 'date_modified' => array( |
|
| 110 | - 'description' => __( "The date the invoice was last modified, in the site's timezone.", 'invoicing' ), |
|
| 111 | - 'type' => 'string', |
|
| 112 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 113 | - 'readonly' => true, |
|
| 114 | - ), |
|
| 115 | - |
|
| 116 | - 'date_modified_gmt' => array( |
|
| 117 | - 'description' => __( 'The GMT date the invoice was last modified.', 'invoicing' ), |
|
| 118 | - 'type' => 'string', |
|
| 119 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 120 | - 'readonly' => true, |
|
| 121 | - ), |
|
| 122 | - |
|
| 123 | - 'due_date' => array( |
|
| 124 | - 'description' => __( "The invoice's due date, in the site's timezone.", 'invoicing' ), |
|
| 125 | - 'type' => 'string', |
|
| 126 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 127 | - ), |
|
| 128 | - |
|
| 129 | - 'due_date_gmt' => array( |
|
| 130 | - 'description' => __( 'The GMT date the invoice is/was due.', 'invoicing' ), |
|
| 131 | - 'type' => 'string', |
|
| 132 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 133 | - 'readonly' => true, |
|
| 134 | - ), |
|
| 135 | - |
|
| 136 | - 'completed_date' => array( |
|
| 137 | - 'description' => __( "The date the invoice was paid, in the site's timezone.", 'invoicing' ), |
|
| 138 | - 'type' => 'string', |
|
| 139 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 140 | - 'readonly' => true, |
|
| 141 | - ), |
|
| 142 | - |
|
| 143 | - 'completed_date_gmt' => array( |
|
| 144 | - 'description' => __( 'The GMT date the invoice was paid.', 'invoicing' ), |
|
| 145 | - 'type' => 'string', |
|
| 146 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 147 | - 'readonly' => true, |
|
| 148 | - ), |
|
| 149 | - |
|
| 150 | - 'total_discount' => array( |
|
| 151 | - 'description' => __( 'Total discount amount for the invoice.', 'invoicing' ), |
|
| 152 | - 'type' => 'number', |
|
| 153 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 154 | - 'readonly' => true, |
|
| 155 | - ), |
|
| 156 | - |
|
| 157 | - 'total_tax' => array( |
|
| 158 | - 'description' => __( 'Total tax amount for the invoice.', 'invoicing' ), |
|
| 159 | - 'type' => 'number', |
|
| 160 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 161 | - 'readonly' => true, |
|
| 162 | - ), |
|
| 163 | - |
|
| 164 | - 'total_fees' => array( |
|
| 165 | - 'description' => __( 'Total fees amount for the invoice.', 'invoicing' ), |
|
| 166 | - 'type' => 'number', |
|
| 167 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 168 | - 'readonly' => true, |
|
| 169 | - ), |
|
| 170 | - |
|
| 171 | - 'subtotal' => array( |
|
| 172 | - 'description' => __( 'Invoice subtotal.', 'invoicing' ), |
|
| 173 | - 'type' => 'number', |
|
| 174 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 175 | - 'readonly' => true, |
|
| 176 | - ), |
|
| 177 | - |
|
| 178 | - 'total' => array( |
|
| 179 | - 'description' => __( 'Grand total.', 'invoicing' ), |
|
| 180 | - 'type' => 'number', |
|
| 181 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 182 | - 'readonly' => true, |
|
| 183 | - ), |
|
| 184 | - |
|
| 185 | - 'initial_total' => array( |
|
| 186 | - 'description' => __( 'Initial total (for recurring invoices).', 'invoicing' ), |
|
| 187 | - 'type' => 'number', |
|
| 188 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 189 | - 'readonly' => true, |
|
| 190 | - ), |
|
| 191 | - |
|
| 192 | - 'recurring_total' => array( |
|
| 193 | - 'description' => __( 'Recurring total (for recurring invoices).', 'invoicing' ), |
|
| 194 | - 'type' => 'number', |
|
| 195 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 196 | - 'readonly' => true, |
|
| 197 | - ), |
|
| 198 | - |
|
| 199 | - 'totals' => array( |
|
| 200 | - 'description' => __( 'Invoice totals.', 'invoicing' ), |
|
| 201 | - 'type' => 'object', |
|
| 202 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 203 | - 'readonly' => true, |
|
| 204 | - ), |
|
| 205 | - |
|
| 206 | - 'fees' => array( |
|
| 207 | - 'description' => __( 'Invoice fees (Name => properties).', 'invoicing' ), |
|
| 208 | - 'type' => 'object', |
|
| 209 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 210 | - 'items' => array( |
|
| 211 | - 'type' => 'object', |
|
| 212 | - 'required' => array( 'amount' ), |
|
| 213 | - 'properties' => array( |
|
| 214 | - 'amount' => array( |
|
| 215 | - 'description' => __( 'Fee amount.', 'invoicing' ), |
|
| 216 | - 'type' => 'string', |
|
| 217 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 218 | - ), |
|
| 219 | - 'recurring' => array( |
|
| 220 | - 'description' => __( 'Whether this is a recurring or one-time fee.', 'invoicing' ), |
|
| 221 | - 'type' => array( 'boolean', 'integer' ), |
|
| 222 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 223 | - ), |
|
| 224 | - ), |
|
| 225 | - ), |
|
| 226 | - ), |
|
| 227 | - |
|
| 228 | - 'discounts' => array( |
|
| 229 | - 'description' => __( 'Invoice discounts (Name => properties).', 'invoicing' ), |
|
| 230 | - 'type' => 'object', |
|
| 231 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 232 | - 'items' => array( |
|
| 233 | - 'type' => 'object', |
|
| 234 | - 'required' => array( 'amount' ), |
|
| 235 | - 'properties' => array( |
|
| 236 | - 'amount' => array( |
|
| 237 | - 'description' => __( 'Fee amount.', 'invoicing' ), |
|
| 238 | - 'type' => 'string', |
|
| 239 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 240 | - ), |
|
| 241 | - 'recurring' => array( |
|
| 242 | - 'description' => __( 'Whether this is a recurring or one-time discount.', 'invoicing' ), |
|
| 243 | - 'type' => array( 'boolean', 'integer' ), |
|
| 244 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 245 | - ), |
|
| 246 | - ), |
|
| 247 | - ), |
|
| 248 | - ), |
|
| 249 | - |
|
| 250 | - 'taxes' => array( |
|
| 251 | - 'description' => __( 'Invoice taxes (Name => properties).', 'invoicing' ), |
|
| 252 | - 'type' => 'object', |
|
| 253 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 254 | - 'items' => array( |
|
| 255 | - 'type' => 'object', |
|
| 256 | - 'required' => array( 'amount' ), |
|
| 257 | - 'properties' => array( |
|
| 258 | - 'amount' => array( |
|
| 259 | - 'description' => __( 'Fee amount.', 'invoicing' ), |
|
| 260 | - 'type' => 'string', |
|
| 261 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 262 | - ), |
|
| 263 | - 'recurring' => array( |
|
| 264 | - 'description' => __( 'Whether this is a recurring or one-time tax.', 'invoicing' ), |
|
| 265 | - 'type' => array( 'boolean', 'integer' ), |
|
| 266 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 267 | - ), |
|
| 268 | - ), |
|
| 269 | - ), |
|
| 270 | - ), |
|
| 271 | - |
|
| 272 | - 'items' => array( |
|
| 273 | - 'description' => __( 'Invoice items.', 'invoicing' ), |
|
| 274 | - 'type' => 'array', |
|
| 275 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 276 | - 'items' => array( |
|
| 277 | - 'type' => 'object', |
|
| 278 | - 'required' => array( 'item_id' ), |
|
| 279 | - 'properties' => array( |
|
| 280 | - 'item_id' => array( |
|
| 281 | - 'description' => __( 'Item ID.', 'invoicing' ), |
|
| 282 | - 'type' => 'integer', |
|
| 283 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 284 | - ), |
|
| 285 | - 'item_name' => array( |
|
| 286 | - 'description' => __( 'Item Name.', 'invoicing' ), |
|
| 287 | - 'type' => 'string', |
|
| 288 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 289 | - ), |
|
| 290 | - 'item_description' => array( |
|
| 291 | - 'description' => __( 'Item Description.', 'invoicing' ), |
|
| 292 | - 'type' => 'string', |
|
| 293 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 294 | - ), |
|
| 295 | - 'item_price' => array( |
|
| 296 | - 'description' => __( 'Item Price.', 'invoicing' ), |
|
| 297 | - 'type' => 'number', |
|
| 298 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 299 | - ), |
|
| 300 | - 'quantity' => array( |
|
| 301 | - 'description' => __( 'Item Quantity.', 'invoicing' ), |
|
| 302 | - 'type' => 'number', |
|
| 303 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 304 | - ), |
|
| 305 | - 'subtotal' => array( |
|
| 306 | - 'description' => __( 'Item Subtotal.', 'invoicing' ), |
|
| 307 | - 'type' => 'number', |
|
| 308 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 309 | - 'readonly' => true, |
|
| 310 | - ), |
|
| 311 | - 'meta' => array( |
|
| 312 | - 'description' => __( 'Item Meta.', 'invoicing' ), |
|
| 313 | - 'type' => 'object', |
|
| 314 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 315 | - ), |
|
| 316 | - ), |
|
| 317 | - ), |
|
| 318 | - ), |
|
| 319 | - |
|
| 320 | - 'mode' => array( |
|
| 321 | - 'description' => __( 'The invoice transaction mode.', 'invoicing' ), |
|
| 322 | - 'type' => 'string', |
|
| 323 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 324 | - 'enum' => array( 'live', 'test' ), |
|
| 325 | - 'readonly' => true, |
|
| 326 | - ), |
|
| 16 | + 'id' => array( |
|
| 17 | + 'description' => __( 'Unique identifier for the invoice.', 'invoicing' ), |
|
| 18 | + 'type' => 'integer', |
|
| 19 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 20 | + 'readonly' => true, |
|
| 21 | + ), |
|
| 22 | + |
|
| 23 | + 'parent_id' => array( |
|
| 24 | + 'description' => __( 'Parent invoice ID.', 'invoicing' ), |
|
| 25 | + 'type' => 'integer', |
|
| 26 | + 'minimum' => 0, |
|
| 27 | + 'default' => 0, |
|
| 28 | + 'context' => array( 'view', 'edit' ), |
|
| 29 | + ), |
|
| 30 | + |
|
| 31 | + 'key' => array( |
|
| 32 | + 'description' => __( 'A unique key for the invoice.', 'invoicing' ), |
|
| 33 | + 'type' => 'string', |
|
| 34 | + 'context' => array( 'view', 'edit' ), |
|
| 35 | + 'readonly' => true, |
|
| 36 | + ), |
|
| 37 | + |
|
| 38 | + 'number' => array( |
|
| 39 | + 'description' => __( 'A unique number for the invoice.', 'invoicing' ), |
|
| 40 | + 'type' => 'string', |
|
| 41 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 42 | + ), |
|
| 43 | + |
|
| 44 | + 'type' => array( |
|
| 45 | + 'description' => __( 'Get the invoice type (e.g invoice, quote etc).', 'invoicing' ), |
|
| 46 | + 'type' => 'string', |
|
| 47 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 48 | + 'readonly' => true, |
|
| 49 | + ), |
|
| 50 | + |
|
| 51 | + 'post_type' => array( |
|
| 52 | + 'description' => __( 'Get the invoice post type (e.g wpi_invoice, wpi_quote etc).', 'invoicing' ), |
|
| 53 | + 'type' => 'string', |
|
| 54 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 55 | + 'readonly' => true, |
|
| 56 | + ), |
|
| 57 | + |
|
| 58 | + 'version' => array( |
|
| 59 | + 'description' => __( 'Version of GetPaid/Invoicing which last updated the invoice.', 'invoicing' ), |
|
| 60 | + 'type' => 'integer', |
|
| 61 | + 'context' => array( 'view', 'edit' ), |
|
| 62 | + 'readonly' => true, |
|
| 63 | + ), |
|
| 64 | + |
|
| 65 | + 'template' => array( |
|
| 66 | + 'description' => __( 'The invoice template.', 'invoicing' ), |
|
| 67 | + 'type' => 'string', |
|
| 68 | + 'default' => 'quantity', |
|
| 69 | + 'enum' => array( 'quantity', 'hours', 'amount' ), |
|
| 70 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 71 | + ), |
|
| 72 | + |
|
| 73 | + 'status' => array( |
|
| 74 | + 'description' => __( 'Invoice status.', 'invoicing' ), |
|
| 75 | + 'type' => 'string', |
|
| 76 | + 'default' => 'wpi-pending', |
|
| 77 | + 'enum' => array_keys( wpinv_get_invoice_statuses( true ) ), |
|
| 78 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 79 | + ), |
|
| 80 | + |
|
| 81 | + 'status_nicename' => array( |
|
| 82 | + 'description' => __( 'A human readable name for the invoice status.', 'invoicing' ), |
|
| 83 | + 'type' => 'string', |
|
| 84 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 85 | + 'readonly' => true, |
|
| 86 | + ), |
|
| 87 | + |
|
| 88 | + 'currency' => array( |
|
| 89 | + 'description' => __( 'The invoice currency in ISO format.', 'invoicing' ), |
|
| 90 | + 'type' => 'string', |
|
| 91 | + 'default' => wpinv_get_currency(), |
|
| 92 | + 'enum' => array_keys( wpinv_get_currencies() ), |
|
| 93 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 94 | + ), |
|
| 95 | + |
|
| 96 | + 'date_created' => array( |
|
| 97 | + 'description' => __( "The date the invoice was created, in the site's timezone.", 'invoicing' ), |
|
| 98 | + 'type' => 'string', |
|
| 99 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 100 | + ), |
|
| 101 | + |
|
| 102 | + 'date_created_gmt' => array( |
|
| 103 | + 'description' => __( 'The GMT date the invoice was created.', 'invoicing' ), |
|
| 104 | + 'type' => 'string', |
|
| 105 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 106 | + 'readonly' => true, |
|
| 107 | + ), |
|
| 108 | + |
|
| 109 | + 'date_modified' => array( |
|
| 110 | + 'description' => __( "The date the invoice was last modified, in the site's timezone.", 'invoicing' ), |
|
| 111 | + 'type' => 'string', |
|
| 112 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 113 | + 'readonly' => true, |
|
| 114 | + ), |
|
| 115 | + |
|
| 116 | + 'date_modified_gmt' => array( |
|
| 117 | + 'description' => __( 'The GMT date the invoice was last modified.', 'invoicing' ), |
|
| 118 | + 'type' => 'string', |
|
| 119 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 120 | + 'readonly' => true, |
|
| 121 | + ), |
|
| 122 | + |
|
| 123 | + 'due_date' => array( |
|
| 124 | + 'description' => __( "The invoice's due date, in the site's timezone.", 'invoicing' ), |
|
| 125 | + 'type' => 'string', |
|
| 126 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 127 | + ), |
|
| 128 | + |
|
| 129 | + 'due_date_gmt' => array( |
|
| 130 | + 'description' => __( 'The GMT date the invoice is/was due.', 'invoicing' ), |
|
| 131 | + 'type' => 'string', |
|
| 132 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 133 | + 'readonly' => true, |
|
| 134 | + ), |
|
| 135 | + |
|
| 136 | + 'completed_date' => array( |
|
| 137 | + 'description' => __( "The date the invoice was paid, in the site's timezone.", 'invoicing' ), |
|
| 138 | + 'type' => 'string', |
|
| 139 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 140 | + 'readonly' => true, |
|
| 141 | + ), |
|
| 142 | + |
|
| 143 | + 'completed_date_gmt' => array( |
|
| 144 | + 'description' => __( 'The GMT date the invoice was paid.', 'invoicing' ), |
|
| 145 | + 'type' => 'string', |
|
| 146 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 147 | + 'readonly' => true, |
|
| 148 | + ), |
|
| 149 | + |
|
| 150 | + 'total_discount' => array( |
|
| 151 | + 'description' => __( 'Total discount amount for the invoice.', 'invoicing' ), |
|
| 152 | + 'type' => 'number', |
|
| 153 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 154 | + 'readonly' => true, |
|
| 155 | + ), |
|
| 156 | + |
|
| 157 | + 'total_tax' => array( |
|
| 158 | + 'description' => __( 'Total tax amount for the invoice.', 'invoicing' ), |
|
| 159 | + 'type' => 'number', |
|
| 160 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 161 | + 'readonly' => true, |
|
| 162 | + ), |
|
| 163 | + |
|
| 164 | + 'total_fees' => array( |
|
| 165 | + 'description' => __( 'Total fees amount for the invoice.', 'invoicing' ), |
|
| 166 | + 'type' => 'number', |
|
| 167 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 168 | + 'readonly' => true, |
|
| 169 | + ), |
|
| 170 | + |
|
| 171 | + 'subtotal' => array( |
|
| 172 | + 'description' => __( 'Invoice subtotal.', 'invoicing' ), |
|
| 173 | + 'type' => 'number', |
|
| 174 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 175 | + 'readonly' => true, |
|
| 176 | + ), |
|
| 177 | + |
|
| 178 | + 'total' => array( |
|
| 179 | + 'description' => __( 'Grand total.', 'invoicing' ), |
|
| 180 | + 'type' => 'number', |
|
| 181 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 182 | + 'readonly' => true, |
|
| 183 | + ), |
|
| 184 | + |
|
| 185 | + 'initial_total' => array( |
|
| 186 | + 'description' => __( 'Initial total (for recurring invoices).', 'invoicing' ), |
|
| 187 | + 'type' => 'number', |
|
| 188 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 189 | + 'readonly' => true, |
|
| 190 | + ), |
|
| 191 | + |
|
| 192 | + 'recurring_total' => array( |
|
| 193 | + 'description' => __( 'Recurring total (for recurring invoices).', 'invoicing' ), |
|
| 194 | + 'type' => 'number', |
|
| 195 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 196 | + 'readonly' => true, |
|
| 197 | + ), |
|
| 198 | + |
|
| 199 | + 'totals' => array( |
|
| 200 | + 'description' => __( 'Invoice totals.', 'invoicing' ), |
|
| 201 | + 'type' => 'object', |
|
| 202 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 203 | + 'readonly' => true, |
|
| 204 | + ), |
|
| 205 | + |
|
| 206 | + 'fees' => array( |
|
| 207 | + 'description' => __( 'Invoice fees (Name => properties).', 'invoicing' ), |
|
| 208 | + 'type' => 'object', |
|
| 209 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 210 | + 'items' => array( |
|
| 211 | + 'type' => 'object', |
|
| 212 | + 'required' => array( 'amount' ), |
|
| 213 | + 'properties' => array( |
|
| 214 | + 'amount' => array( |
|
| 215 | + 'description' => __( 'Fee amount.', 'invoicing' ), |
|
| 216 | + 'type' => 'string', |
|
| 217 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 218 | + ), |
|
| 219 | + 'recurring' => array( |
|
| 220 | + 'description' => __( 'Whether this is a recurring or one-time fee.', 'invoicing' ), |
|
| 221 | + 'type' => array( 'boolean', 'integer' ), |
|
| 222 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 223 | + ), |
|
| 224 | + ), |
|
| 225 | + ), |
|
| 226 | + ), |
|
| 227 | + |
|
| 228 | + 'discounts' => array( |
|
| 229 | + 'description' => __( 'Invoice discounts (Name => properties).', 'invoicing' ), |
|
| 230 | + 'type' => 'object', |
|
| 231 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 232 | + 'items' => array( |
|
| 233 | + 'type' => 'object', |
|
| 234 | + 'required' => array( 'amount' ), |
|
| 235 | + 'properties' => array( |
|
| 236 | + 'amount' => array( |
|
| 237 | + 'description' => __( 'Fee amount.', 'invoicing' ), |
|
| 238 | + 'type' => 'string', |
|
| 239 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 240 | + ), |
|
| 241 | + 'recurring' => array( |
|
| 242 | + 'description' => __( 'Whether this is a recurring or one-time discount.', 'invoicing' ), |
|
| 243 | + 'type' => array( 'boolean', 'integer' ), |
|
| 244 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 245 | + ), |
|
| 246 | + ), |
|
| 247 | + ), |
|
| 248 | + ), |
|
| 249 | + |
|
| 250 | + 'taxes' => array( |
|
| 251 | + 'description' => __( 'Invoice taxes (Name => properties).', 'invoicing' ), |
|
| 252 | + 'type' => 'object', |
|
| 253 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 254 | + 'items' => array( |
|
| 255 | + 'type' => 'object', |
|
| 256 | + 'required' => array( 'amount' ), |
|
| 257 | + 'properties' => array( |
|
| 258 | + 'amount' => array( |
|
| 259 | + 'description' => __( 'Fee amount.', 'invoicing' ), |
|
| 260 | + 'type' => 'string', |
|
| 261 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 262 | + ), |
|
| 263 | + 'recurring' => array( |
|
| 264 | + 'description' => __( 'Whether this is a recurring or one-time tax.', 'invoicing' ), |
|
| 265 | + 'type' => array( 'boolean', 'integer' ), |
|
| 266 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 267 | + ), |
|
| 268 | + ), |
|
| 269 | + ), |
|
| 270 | + ), |
|
| 271 | + |
|
| 272 | + 'items' => array( |
|
| 273 | + 'description' => __( 'Invoice items.', 'invoicing' ), |
|
| 274 | + 'type' => 'array', |
|
| 275 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 276 | + 'items' => array( |
|
| 277 | + 'type' => 'object', |
|
| 278 | + 'required' => array( 'item_id' ), |
|
| 279 | + 'properties' => array( |
|
| 280 | + 'item_id' => array( |
|
| 281 | + 'description' => __( 'Item ID.', 'invoicing' ), |
|
| 282 | + 'type' => 'integer', |
|
| 283 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 284 | + ), |
|
| 285 | + 'item_name' => array( |
|
| 286 | + 'description' => __( 'Item Name.', 'invoicing' ), |
|
| 287 | + 'type' => 'string', |
|
| 288 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 289 | + ), |
|
| 290 | + 'item_description' => array( |
|
| 291 | + 'description' => __( 'Item Description.', 'invoicing' ), |
|
| 292 | + 'type' => 'string', |
|
| 293 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 294 | + ), |
|
| 295 | + 'item_price' => array( |
|
| 296 | + 'description' => __( 'Item Price.', 'invoicing' ), |
|
| 297 | + 'type' => 'number', |
|
| 298 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 299 | + ), |
|
| 300 | + 'quantity' => array( |
|
| 301 | + 'description' => __( 'Item Quantity.', 'invoicing' ), |
|
| 302 | + 'type' => 'number', |
|
| 303 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 304 | + ), |
|
| 305 | + 'subtotal' => array( |
|
| 306 | + 'description' => __( 'Item Subtotal.', 'invoicing' ), |
|
| 307 | + 'type' => 'number', |
|
| 308 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 309 | + 'readonly' => true, |
|
| 310 | + ), |
|
| 311 | + 'meta' => array( |
|
| 312 | + 'description' => __( 'Item Meta.', 'invoicing' ), |
|
| 313 | + 'type' => 'object', |
|
| 314 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 315 | + ), |
|
| 316 | + ), |
|
| 317 | + ), |
|
| 318 | + ), |
|
| 319 | + |
|
| 320 | + 'mode' => array( |
|
| 321 | + 'description' => __( 'The invoice transaction mode.', 'invoicing' ), |
|
| 322 | + 'type' => 'string', |
|
| 323 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 324 | + 'enum' => array( 'live', 'test' ), |
|
| 325 | + 'readonly' => true, |
|
| 326 | + ), |
|
| 327 | 327 | |
| 328 | - 'discount_code' => array( |
|
| 329 | - 'description' => __( 'The discount code used on this invoice.', 'invoicing' ), |
|
| 330 | - 'type' => 'string', |
|
| 331 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 332 | - ), |
|
| 333 | - |
|
| 334 | - 'gateway' => array( |
|
| 335 | - 'description' => __( 'The gateway used to pay this invoice.', 'invoicing' ), |
|
| 336 | - 'type' => 'string', |
|
| 337 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 338 | - ), |
|
| 339 | - |
|
| 340 | - 'gateway_title' => array( |
|
| 341 | - 'description' => __( 'The title of the gateway used to pay this invoice.', 'invoicing' ), |
|
| 342 | - 'type' => 'string', |
|
| 343 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 344 | - 'readonly' => true, |
|
| 345 | - ), |
|
| 346 | - |
|
| 347 | - 'transaction_id' => array( |
|
| 348 | - 'description' => __( 'The transaction id for this invoice.', 'invoicing' ), |
|
| 349 | - 'type' => 'string', |
|
| 350 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 351 | - ), |
|
| 328 | + 'discount_code' => array( |
|
| 329 | + 'description' => __( 'The discount code used on this invoice.', 'invoicing' ), |
|
| 330 | + 'type' => 'string', |
|
| 331 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 332 | + ), |
|
| 333 | + |
|
| 334 | + 'gateway' => array( |
|
| 335 | + 'description' => __( 'The gateway used to pay this invoice.', 'invoicing' ), |
|
| 336 | + 'type' => 'string', |
|
| 337 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 338 | + ), |
|
| 339 | + |
|
| 340 | + 'gateway_title' => array( |
|
| 341 | + 'description' => __( 'The title of the gateway used to pay this invoice.', 'invoicing' ), |
|
| 342 | + 'type' => 'string', |
|
| 343 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 344 | + 'readonly' => true, |
|
| 345 | + ), |
|
| 346 | + |
|
| 347 | + 'transaction_id' => array( |
|
| 348 | + 'description' => __( 'The transaction id for this invoice.', 'invoicing' ), |
|
| 349 | + 'type' => 'string', |
|
| 350 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 351 | + ), |
|
| 352 | 352 | |
| 353 | - 'disable_taxes' => array( |
|
| 354 | - 'description' => __( 'Whether or not taxes should be disabled for this invoice.', 'invoicing' ), |
|
| 355 | - 'type' => 'boolean ', |
|
| 356 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 357 | - ), |
|
| 358 | - |
|
| 359 | - 'is_viewed' => array( |
|
| 360 | - 'description' => __( 'Whether or not this invoice has been viewed by the user.', 'invoicing' ), |
|
| 361 | - 'type' => 'boolean ', |
|
| 362 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 363 | - 'readonly' => true, |
|
| 364 | - ), |
|
| 365 | - |
|
| 366 | - 'email_cc' => array( |
|
| 367 | - 'description' => __( 'A comma separated list of other emails that should receive communications for this invoice.', 'invoicing' ), |
|
| 368 | - 'type' => 'string ', |
|
| 369 | - 'context' => array( 'view', 'edit' ), |
|
| 370 | - ), |
|
| 371 | - |
|
| 372 | - 'subscription_id' => array( |
|
| 373 | - 'description' => __( 'The ID of the subscription associated with this invoice.', 'invoicing' ), |
|
| 374 | - 'type' => 'string ', |
|
| 375 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 376 | - 'readonly' => true, |
|
| 377 | - ), |
|
| 378 | - |
|
| 379 | - 'subscription_name' => array( |
|
| 380 | - 'description' => __( 'The name of the subscription associated with this invoice.', 'invoicing' ), |
|
| 381 | - 'type' => 'string ', |
|
| 382 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 383 | - 'readonly' => true, |
|
| 384 | - ), |
|
| 385 | - |
|
| 386 | - 'subscription_name' => array( |
|
| 387 | - 'description' => __( 'The name of the subscription associated with this invoice.', 'invoicing' ), |
|
| 388 | - 'type' => 'string ', |
|
| 389 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 390 | - 'readonly' => true, |
|
| 391 | - ), |
|
| 392 | - |
|
| 393 | - 'is_parent' => array( |
|
| 394 | - 'description' => __( 'Whether or not this is a parent invoice.', 'invoicing' ), |
|
| 395 | - 'type' => 'boolean', |
|
| 396 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 397 | - 'readonly' => true, |
|
| 398 | - ), |
|
| 399 | - |
|
| 400 | - 'is_renewal' => array( |
|
| 401 | - 'description' => __( 'Whether or not this is a renewal invoice.', 'invoicing' ), |
|
| 402 | - 'type' => 'boolean', |
|
| 403 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 404 | - 'readonly' => true, |
|
| 405 | - ), |
|
| 406 | - |
|
| 407 | - 'is_recurring' => array( |
|
| 408 | - 'description' => __( 'Whether or not this is a recurring invoice.', 'invoicing' ), |
|
| 409 | - 'type' => 'boolean', |
|
| 410 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 411 | - 'readonly' => true, |
|
| 412 | - ), |
|
| 413 | - |
|
| 414 | - 'is_free' => array( |
|
| 415 | - 'description' => __( 'Whether or not this invoice is free.', 'invoicing' ), |
|
| 416 | - 'type' => 'boolean', |
|
| 417 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 418 | - 'readonly' => true, |
|
| 419 | - ), |
|
| 420 | - |
|
| 421 | - 'is_paid' => array( |
|
| 422 | - 'description' => __( 'Whether or not this invoice has been paid.', 'invoicing' ), |
|
| 423 | - 'type' => 'boolean', |
|
| 424 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 425 | - 'readonly' => true, |
|
| 426 | - ), |
|
| 427 | - |
|
| 428 | - 'needs_payment' => array( |
|
| 429 | - 'description' => __( 'Whether or not this invoice needs payment.', 'invoicing' ), |
|
| 430 | - 'type' => 'boolean', |
|
| 431 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 432 | - 'readonly' => true, |
|
| 433 | - ), |
|
| 434 | - |
|
| 435 | - 'is_refunded' => array( |
|
| 436 | - 'description' => __( 'Whether or not this invoice was refunded.', 'invoicing' ), |
|
| 437 | - 'type' => 'boolean', |
|
| 438 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 439 | - 'readonly' => true, |
|
| 440 | - ), |
|
| 441 | - |
|
| 442 | - 'is_due' => array( |
|
| 443 | - 'description' => __( 'Whether or not this invoice is due.', 'invoicing' ), |
|
| 444 | - 'type' => 'boolean', |
|
| 445 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 446 | - 'readonly' => true, |
|
| 447 | - ), |
|
| 448 | - |
|
| 449 | - 'is_held' => array( |
|
| 450 | - 'description' => __( 'Whether or not this invoice has been held for payment confirmation.', 'invoicing' ), |
|
| 451 | - 'type' => 'boolean', |
|
| 452 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 453 | - 'readonly' => true, |
|
| 454 | - ), |
|
| 455 | - |
|
| 456 | - 'is_draft' => array( |
|
| 457 | - 'description' => __( 'Whether or not this invoice is marked as draft (cannot be viewed on the frontend).', 'invoicing' ), |
|
| 458 | - 'type' => 'boolean', |
|
| 459 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 460 | - 'readonly' => true, |
|
| 461 | - ), |
|
| 462 | - |
|
| 463 | - 'path' => array( |
|
| 464 | - 'description' => __( 'The invoice path/slug/name.', 'invoicing' ), |
|
| 465 | - 'type' => 'string', |
|
| 466 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 467 | - 'readonly' => true, |
|
| 468 | - ), |
|
| 469 | - |
|
| 470 | - 'description' => array( |
|
| 471 | - 'description' => __( 'The invoice description.', 'invoicing' ), |
|
| 472 | - 'type' => 'string', |
|
| 473 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 474 | - ), |
|
| 475 | - |
|
| 476 | - 'payment_form' => array( |
|
| 477 | - 'description' => __( 'The id of the payment form used to pay for this invoice.', 'invoicing' ), |
|
| 478 | - 'type' => 'integer', |
|
| 479 | - 'context' => array( 'view', 'edit' ), |
|
| 480 | - 'readonly' => true, |
|
| 481 | - ), |
|
| 482 | - |
|
| 483 | - 'submission_id' => array( |
|
| 484 | - 'description' => __( 'A uniques ID of the submission details used to pay for this invoice.', 'invoicing' ), |
|
| 485 | - 'type' => 'string', |
|
| 486 | - 'context' => array( 'view', 'edit' ), |
|
| 487 | - 'readonly' => true, |
|
| 488 | - ), |
|
| 489 | - |
|
| 490 | - 'customer_id' => array( |
|
| 491 | - 'description' => __( 'The customer id.', 'invoicing' ), |
|
| 492 | - 'type' => 'integer', |
|
| 493 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 494 | - ), |
|
| 495 | - |
|
| 496 | - 'customer_ip' => array( |
|
| 497 | - 'description' => __( "The customer's ip address.", 'invoicing' ), |
|
| 498 | - 'type' => 'string', |
|
| 499 | - 'format' => 'ip', |
|
| 500 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 501 | - ), |
|
| 502 | - |
|
| 503 | - 'first_name' => array( |
|
| 504 | - 'description' => __( "The customer's first name.", 'invoicing' ), |
|
| 505 | - 'type' => 'string', |
|
| 506 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 507 | - ), |
|
| 508 | - |
|
| 509 | - 'last_name' => array( |
|
| 510 | - 'description' => __( "The customer's last name.", 'invoicing' ), |
|
| 511 | - 'type' => 'string', |
|
| 512 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 513 | - ), |
|
| 353 | + 'disable_taxes' => array( |
|
| 354 | + 'description' => __( 'Whether or not taxes should be disabled for this invoice.', 'invoicing' ), |
|
| 355 | + 'type' => 'boolean ', |
|
| 356 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 357 | + ), |
|
| 358 | + |
|
| 359 | + 'is_viewed' => array( |
|
| 360 | + 'description' => __( 'Whether or not this invoice has been viewed by the user.', 'invoicing' ), |
|
| 361 | + 'type' => 'boolean ', |
|
| 362 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 363 | + 'readonly' => true, |
|
| 364 | + ), |
|
| 365 | + |
|
| 366 | + 'email_cc' => array( |
|
| 367 | + 'description' => __( 'A comma separated list of other emails that should receive communications for this invoice.', 'invoicing' ), |
|
| 368 | + 'type' => 'string ', |
|
| 369 | + 'context' => array( 'view', 'edit' ), |
|
| 370 | + ), |
|
| 371 | + |
|
| 372 | + 'subscription_id' => array( |
|
| 373 | + 'description' => __( 'The ID of the subscription associated with this invoice.', 'invoicing' ), |
|
| 374 | + 'type' => 'string ', |
|
| 375 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 376 | + 'readonly' => true, |
|
| 377 | + ), |
|
| 378 | + |
|
| 379 | + 'subscription_name' => array( |
|
| 380 | + 'description' => __( 'The name of the subscription associated with this invoice.', 'invoicing' ), |
|
| 381 | + 'type' => 'string ', |
|
| 382 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 383 | + 'readonly' => true, |
|
| 384 | + ), |
|
| 385 | + |
|
| 386 | + 'subscription_name' => array( |
|
| 387 | + 'description' => __( 'The name of the subscription associated with this invoice.', 'invoicing' ), |
|
| 388 | + 'type' => 'string ', |
|
| 389 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 390 | + 'readonly' => true, |
|
| 391 | + ), |
|
| 392 | + |
|
| 393 | + 'is_parent' => array( |
|
| 394 | + 'description' => __( 'Whether or not this is a parent invoice.', 'invoicing' ), |
|
| 395 | + 'type' => 'boolean', |
|
| 396 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 397 | + 'readonly' => true, |
|
| 398 | + ), |
|
| 399 | + |
|
| 400 | + 'is_renewal' => array( |
|
| 401 | + 'description' => __( 'Whether or not this is a renewal invoice.', 'invoicing' ), |
|
| 402 | + 'type' => 'boolean', |
|
| 403 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 404 | + 'readonly' => true, |
|
| 405 | + ), |
|
| 406 | + |
|
| 407 | + 'is_recurring' => array( |
|
| 408 | + 'description' => __( 'Whether or not this is a recurring invoice.', 'invoicing' ), |
|
| 409 | + 'type' => 'boolean', |
|
| 410 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 411 | + 'readonly' => true, |
|
| 412 | + ), |
|
| 413 | + |
|
| 414 | + 'is_free' => array( |
|
| 415 | + 'description' => __( 'Whether or not this invoice is free.', 'invoicing' ), |
|
| 416 | + 'type' => 'boolean', |
|
| 417 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 418 | + 'readonly' => true, |
|
| 419 | + ), |
|
| 420 | + |
|
| 421 | + 'is_paid' => array( |
|
| 422 | + 'description' => __( 'Whether or not this invoice has been paid.', 'invoicing' ), |
|
| 423 | + 'type' => 'boolean', |
|
| 424 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 425 | + 'readonly' => true, |
|
| 426 | + ), |
|
| 427 | + |
|
| 428 | + 'needs_payment' => array( |
|
| 429 | + 'description' => __( 'Whether or not this invoice needs payment.', 'invoicing' ), |
|
| 430 | + 'type' => 'boolean', |
|
| 431 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 432 | + 'readonly' => true, |
|
| 433 | + ), |
|
| 434 | + |
|
| 435 | + 'is_refunded' => array( |
|
| 436 | + 'description' => __( 'Whether or not this invoice was refunded.', 'invoicing' ), |
|
| 437 | + 'type' => 'boolean', |
|
| 438 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 439 | + 'readonly' => true, |
|
| 440 | + ), |
|
| 441 | + |
|
| 442 | + 'is_due' => array( |
|
| 443 | + 'description' => __( 'Whether or not this invoice is due.', 'invoicing' ), |
|
| 444 | + 'type' => 'boolean', |
|
| 445 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 446 | + 'readonly' => true, |
|
| 447 | + ), |
|
| 448 | + |
|
| 449 | + 'is_held' => array( |
|
| 450 | + 'description' => __( 'Whether or not this invoice has been held for payment confirmation.', 'invoicing' ), |
|
| 451 | + 'type' => 'boolean', |
|
| 452 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 453 | + 'readonly' => true, |
|
| 454 | + ), |
|
| 455 | + |
|
| 456 | + 'is_draft' => array( |
|
| 457 | + 'description' => __( 'Whether or not this invoice is marked as draft (cannot be viewed on the frontend).', 'invoicing' ), |
|
| 458 | + 'type' => 'boolean', |
|
| 459 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 460 | + 'readonly' => true, |
|
| 461 | + ), |
|
| 462 | + |
|
| 463 | + 'path' => array( |
|
| 464 | + 'description' => __( 'The invoice path/slug/name.', 'invoicing' ), |
|
| 465 | + 'type' => 'string', |
|
| 466 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 467 | + 'readonly' => true, |
|
| 468 | + ), |
|
| 469 | + |
|
| 470 | + 'description' => array( |
|
| 471 | + 'description' => __( 'The invoice description.', 'invoicing' ), |
|
| 472 | + 'type' => 'string', |
|
| 473 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 474 | + ), |
|
| 475 | + |
|
| 476 | + 'payment_form' => array( |
|
| 477 | + 'description' => __( 'The id of the payment form used to pay for this invoice.', 'invoicing' ), |
|
| 478 | + 'type' => 'integer', |
|
| 479 | + 'context' => array( 'view', 'edit' ), |
|
| 480 | + 'readonly' => true, |
|
| 481 | + ), |
|
| 482 | + |
|
| 483 | + 'submission_id' => array( |
|
| 484 | + 'description' => __( 'A uniques ID of the submission details used to pay for this invoice.', 'invoicing' ), |
|
| 485 | + 'type' => 'string', |
|
| 486 | + 'context' => array( 'view', 'edit' ), |
|
| 487 | + 'readonly' => true, |
|
| 488 | + ), |
|
| 489 | + |
|
| 490 | + 'customer_id' => array( |
|
| 491 | + 'description' => __( 'The customer id.', 'invoicing' ), |
|
| 492 | + 'type' => 'integer', |
|
| 493 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 494 | + ), |
|
| 495 | + |
|
| 496 | + 'customer_ip' => array( |
|
| 497 | + 'description' => __( "The customer's ip address.", 'invoicing' ), |
|
| 498 | + 'type' => 'string', |
|
| 499 | + 'format' => 'ip', |
|
| 500 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 501 | + ), |
|
| 502 | + |
|
| 503 | + 'first_name' => array( |
|
| 504 | + 'description' => __( "The customer's first name.", 'invoicing' ), |
|
| 505 | + 'type' => 'string', |
|
| 506 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 507 | + ), |
|
| 508 | + |
|
| 509 | + 'last_name' => array( |
|
| 510 | + 'description' => __( "The customer's last name.", 'invoicing' ), |
|
| 511 | + 'type' => 'string', |
|
| 512 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 513 | + ), |
|
| 514 | 514 | |
| 515 | - 'full_name' => array( |
|
| 516 | - 'description' => __( "The customer's full name.", 'invoicing' ), |
|
| 517 | - 'type' => 'string', |
|
| 518 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 519 | - 'readonly' => true, |
|
| 520 | - ), |
|
| 521 | - |
|
| 522 | - 'phone_number' => array( |
|
| 523 | - 'description' => __( "The customer's phone number.", 'invoicing' ), |
|
| 524 | - 'type' => 'string', |
|
| 525 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 526 | - ), |
|
| 527 | - |
|
| 528 | - 'email_address' => array( |
|
| 529 | - 'description' => __( "The customer's email address.", 'invoicing' ), |
|
| 530 | - 'type' => 'string', |
|
| 531 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 532 | - 'readonly' => true, |
|
| 533 | - ), |
|
| 534 | - |
|
| 535 | - 'customer_country' => array( |
|
| 536 | - 'description' => __( "The customer's country.", 'invoicing' ), |
|
| 537 | - 'type' => 'string', |
|
| 538 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 539 | - 'default' => wpinv_get_default_country(), |
|
| 540 | - ), |
|
| 541 | - |
|
| 542 | - 'customer_state' => array( |
|
| 543 | - 'description' => __( "The customer's state.", 'invoicing' ), |
|
| 544 | - 'type' => 'string', |
|
| 545 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 546 | - ), |
|
| 547 | - |
|
| 548 | - 'customer_city' => array( |
|
| 549 | - 'description' => __( "The customer's city.", 'invoicing' ), |
|
| 550 | - 'type' => 'string', |
|
| 551 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 552 | - ), |
|
| 553 | - |
|
| 554 | - 'customer_zip' => array( |
|
| 555 | - 'description' => __( "The customer's zip/postal code.", 'invoicing' ), |
|
| 556 | - 'type' => 'string', |
|
| 557 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 558 | - ), |
|
| 559 | - |
|
| 560 | - 'customer_company' => array( |
|
| 561 | - 'description' => __( "The customer's company name.", 'invoicing' ), |
|
| 562 | - 'type' => 'string', |
|
| 563 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 564 | - ), |
|
| 565 | - |
|
| 566 | - 'vat_number' => array( |
|
| 567 | - 'description' => __( "The customer's VAT number.", 'invoicing' ), |
|
| 568 | - 'type' => 'string', |
|
| 569 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 570 | - ), |
|
| 571 | - |
|
| 572 | - 'vat_rate' => array( |
|
| 573 | - 'description' => __( "The customer's VAT rate.", 'invoicing' ), |
|
| 574 | - 'type' => 'number', |
|
| 575 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 576 | - 'readonly' => true, |
|
| 577 | - ), |
|
| 578 | - |
|
| 579 | - 'customer_address' => array( |
|
| 580 | - 'description' => __( "The customer's address.", 'invoicing' ), |
|
| 581 | - 'type' => 'string', |
|
| 582 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 583 | - ), |
|
| 584 | - |
|
| 585 | - 'address_confirmed' => array( |
|
| 586 | - 'description' => __( "Whether or not the customer's address is confirmed.", 'invoicing' ), |
|
| 587 | - 'type' => 'boolean', |
|
| 588 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 589 | - ), |
|
| 590 | - |
|
| 591 | - 'meta_data' => array( |
|
| 592 | - 'description' => __( 'Invoice meta data.', 'invoicing' ), |
|
| 593 | - 'type' => 'array', |
|
| 594 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 595 | - 'items' => array( |
|
| 596 | - 'type' => 'object', |
|
| 597 | - 'properties' => array( |
|
| 598 | - 'id' => array( |
|
| 599 | - 'description' => __( 'Meta ID.', 'invoicing' ), |
|
| 600 | - 'type' => 'string', |
|
| 601 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 602 | - ), |
|
| 603 | - 'key' => array( |
|
| 604 | - 'description' => __( 'Meta key.', 'invoicing' ), |
|
| 605 | - 'type' => 'string', |
|
| 606 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 607 | - ), |
|
| 608 | - 'value' => array( |
|
| 609 | - 'description' => __( 'Meta Value.', 'invoicing' ), |
|
| 610 | - 'type' => array( 'string', 'array', 'object', 'integer', 'null' ), |
|
| 611 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 612 | - ), |
|
| 613 | - ), |
|
| 614 | - ), |
|
| 615 | - ), |
|
| 616 | - |
|
| 617 | - 'view_url' => array( |
|
| 618 | - 'description' => __( 'URL to the invoice.', 'invoicing' ), |
|
| 619 | - 'type' => 'string', |
|
| 620 | - 'format' => 'uri', |
|
| 621 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 622 | - 'readonly' => true, |
|
| 623 | - ), |
|
| 624 | - |
|
| 625 | - 'checkout_payment_url' => array( |
|
| 626 | - 'description' => __( 'URL to the invoice checkout page.', 'invoicing' ), |
|
| 627 | - 'type' => 'string', |
|
| 628 | - 'format' => 'uri', |
|
| 629 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 630 | - 'readonly' => true, |
|
| 631 | - ), |
|
| 632 | - |
|
| 633 | - 'receipt_url' => array( |
|
| 634 | - 'description' => __( 'URL to the invoice receipt page.', 'invoicing' ), |
|
| 635 | - 'type' => 'string', |
|
| 636 | - 'format' => 'uri', |
|
| 637 | - 'context' => array( 'view', 'edit', 'embed' ), |
|
| 638 | - 'readonly' => true, |
|
| 639 | - ), |
|
| 515 | + 'full_name' => array( |
|
| 516 | + 'description' => __( "The customer's full name.", 'invoicing' ), |
|
| 517 | + 'type' => 'string', |
|
| 518 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 519 | + 'readonly' => true, |
|
| 520 | + ), |
|
| 521 | + |
|
| 522 | + 'phone_number' => array( |
|
| 523 | + 'description' => __( "The customer's phone number.", 'invoicing' ), |
|
| 524 | + 'type' => 'string', |
|
| 525 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 526 | + ), |
|
| 527 | + |
|
| 528 | + 'email_address' => array( |
|
| 529 | + 'description' => __( "The customer's email address.", 'invoicing' ), |
|
| 530 | + 'type' => 'string', |
|
| 531 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 532 | + 'readonly' => true, |
|
| 533 | + ), |
|
| 534 | + |
|
| 535 | + 'customer_country' => array( |
|
| 536 | + 'description' => __( "The customer's country.", 'invoicing' ), |
|
| 537 | + 'type' => 'string', |
|
| 538 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 539 | + 'default' => wpinv_get_default_country(), |
|
| 540 | + ), |
|
| 541 | + |
|
| 542 | + 'customer_state' => array( |
|
| 543 | + 'description' => __( "The customer's state.", 'invoicing' ), |
|
| 544 | + 'type' => 'string', |
|
| 545 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 546 | + ), |
|
| 547 | + |
|
| 548 | + 'customer_city' => array( |
|
| 549 | + 'description' => __( "The customer's city.", 'invoicing' ), |
|
| 550 | + 'type' => 'string', |
|
| 551 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 552 | + ), |
|
| 553 | + |
|
| 554 | + 'customer_zip' => array( |
|
| 555 | + 'description' => __( "The customer's zip/postal code.", 'invoicing' ), |
|
| 556 | + 'type' => 'string', |
|
| 557 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 558 | + ), |
|
| 559 | + |
|
| 560 | + 'customer_company' => array( |
|
| 561 | + 'description' => __( "The customer's company name.", 'invoicing' ), |
|
| 562 | + 'type' => 'string', |
|
| 563 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 564 | + ), |
|
| 565 | + |
|
| 566 | + 'vat_number' => array( |
|
| 567 | + 'description' => __( "The customer's VAT number.", 'invoicing' ), |
|
| 568 | + 'type' => 'string', |
|
| 569 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 570 | + ), |
|
| 571 | + |
|
| 572 | + 'vat_rate' => array( |
|
| 573 | + 'description' => __( "The customer's VAT rate.", 'invoicing' ), |
|
| 574 | + 'type' => 'number', |
|
| 575 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 576 | + 'readonly' => true, |
|
| 577 | + ), |
|
| 578 | + |
|
| 579 | + 'customer_address' => array( |
|
| 580 | + 'description' => __( "The customer's address.", 'invoicing' ), |
|
| 581 | + 'type' => 'string', |
|
| 582 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 583 | + ), |
|
| 584 | + |
|
| 585 | + 'address_confirmed' => array( |
|
| 586 | + 'description' => __( "Whether or not the customer's address is confirmed.", 'invoicing' ), |
|
| 587 | + 'type' => 'boolean', |
|
| 588 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 589 | + ), |
|
| 590 | + |
|
| 591 | + 'meta_data' => array( |
|
| 592 | + 'description' => __( 'Invoice meta data.', 'invoicing' ), |
|
| 593 | + 'type' => 'array', |
|
| 594 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 595 | + 'items' => array( |
|
| 596 | + 'type' => 'object', |
|
| 597 | + 'properties' => array( |
|
| 598 | + 'id' => array( |
|
| 599 | + 'description' => __( 'Meta ID.', 'invoicing' ), |
|
| 600 | + 'type' => 'string', |
|
| 601 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 602 | + ), |
|
| 603 | + 'key' => array( |
|
| 604 | + 'description' => __( 'Meta key.', 'invoicing' ), |
|
| 605 | + 'type' => 'string', |
|
| 606 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 607 | + ), |
|
| 608 | + 'value' => array( |
|
| 609 | + 'description' => __( 'Meta Value.', 'invoicing' ), |
|
| 610 | + 'type' => array( 'string', 'array', 'object', 'integer', 'null' ), |
|
| 611 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 612 | + ), |
|
| 613 | + ), |
|
| 614 | + ), |
|
| 615 | + ), |
|
| 616 | + |
|
| 617 | + 'view_url' => array( |
|
| 618 | + 'description' => __( 'URL to the invoice.', 'invoicing' ), |
|
| 619 | + 'type' => 'string', |
|
| 620 | + 'format' => 'uri', |
|
| 621 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 622 | + 'readonly' => true, |
|
| 623 | + ), |
|
| 624 | + |
|
| 625 | + 'checkout_payment_url' => array( |
|
| 626 | + 'description' => __( 'URL to the invoice checkout page.', 'invoicing' ), |
|
| 627 | + 'type' => 'string', |
|
| 628 | + 'format' => 'uri', |
|
| 629 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 630 | + 'readonly' => true, |
|
| 631 | + ), |
|
| 632 | + |
|
| 633 | + 'receipt_url' => array( |
|
| 634 | + 'description' => __( 'URL to the invoice receipt page.', 'invoicing' ), |
|
| 635 | + 'type' => 'string', |
|
| 636 | + 'format' => 'uri', |
|
| 637 | + 'context' => array( 'view', 'edit', 'embed' ), |
|
| 638 | + 'readonly' => true, |
|
| 639 | + ), |
|
| 640 | 640 | |
| 641 | 641 | ); |
@@ -4,7 +4,7 @@ discard block |
||
| 4 | 4 | * |
| 5 | 5 | */ |
| 6 | 6 | if ( ! defined( 'ABSPATH' ) ) { |
| 7 | - exit; |
|
| 7 | + exit; |
|
| 8 | 8 | } |
| 9 | 9 | |
| 10 | 10 | /** |
@@ -14,228 +14,228 @@ discard block |
||
| 14 | 14 | */ |
| 15 | 15 | class GetPaid_Item_Data_Store extends GetPaid_Data_Store_WP { |
| 16 | 16 | |
| 17 | - /** |
|
| 18 | - * Data stored in meta keys, but not considered "meta" for an item. |
|
| 19 | - * |
|
| 20 | - * @since 1.0.19 |
|
| 21 | - * @var array |
|
| 22 | - */ |
|
| 23 | - protected $internal_meta_keys = array( |
|
| 24 | - '_wpinv_price', |
|
| 25 | - '_wpinv_vat_rule', |
|
| 26 | - '_wpinv_vat_class', |
|
| 27 | - '_wpinv_type', |
|
| 28 | - '_wpinv_custom_id', |
|
| 29 | - '_wpinv_custom_name', |
|
| 30 | - '_wpinv_custom_singular_name', |
|
| 31 | - '_wpinv_editable', |
|
| 32 | - '_wpinv_dynamic_pricing', |
|
| 33 | - '_minimum_price', |
|
| 34 | - '_wpinv_is_recurring', |
|
| 35 | - '_wpinv_recurring_period', |
|
| 36 | - '_wpinv_recurring_interval', |
|
| 37 | - '_wpinv_recurring_limit', |
|
| 38 | - '_wpinv_free_trial', |
|
| 39 | - '_wpinv_trial_period', |
|
| 40 | - '_wpinv_trial_interval' |
|
| 41 | - ); |
|
| 42 | - |
|
| 43 | - /** |
|
| 44 | - * A map of meta keys to data props. |
|
| 45 | - * |
|
| 46 | - * @since 1.0.19 |
|
| 47 | - * |
|
| 48 | - * @var array |
|
| 49 | - */ |
|
| 50 | - protected $meta_key_to_props = array( |
|
| 51 | - '_wpinv_price' => 'price', |
|
| 52 | - '_wpinv_vat_rule' => 'vat_rule', |
|
| 53 | - '_wpinv_vat_class' => 'vat_class', |
|
| 54 | - '_wpinv_type' => 'type', |
|
| 55 | - '_wpinv_custom_id' => 'custom_id', |
|
| 56 | - '_wpinv_custom_name' => 'custom_name', |
|
| 57 | - '_wpinv_custom_singular_name' => 'custom_singular_name', |
|
| 58 | - '_wpinv_editable' => 'is_editable', |
|
| 59 | - '_wpinv_dynamic_pricing' => 'is_dynamic_pricing', |
|
| 60 | - '_minimum_price' => 'minimum_price', |
|
| 61 | - '_wpinv_custom_name' => 'custom_name', |
|
| 62 | - '_wpinv_is_recurring' => 'is_recurring', |
|
| 63 | - '_wpinv_recurring_period' => 'recurring_period', |
|
| 64 | - '_wpinv_recurring_interval' => 'recurring_interval', |
|
| 65 | - '_wpinv_recurring_limit' => 'recurring_limit', |
|
| 66 | - '_wpinv_free_trial' => 'is_free_trial', |
|
| 67 | - '_wpinv_trial_period' => 'trial_period', |
|
| 68 | - '_wpinv_trial_interval' => 'trial_interval', |
|
| 69 | - '_wpinv_version' => 'version', |
|
| 70 | - ); |
|
| 71 | - |
|
| 72 | - /* |
|
| 17 | + /** |
|
| 18 | + * Data stored in meta keys, but not considered "meta" for an item. |
|
| 19 | + * |
|
| 20 | + * @since 1.0.19 |
|
| 21 | + * @var array |
|
| 22 | + */ |
|
| 23 | + protected $internal_meta_keys = array( |
|
| 24 | + '_wpinv_price', |
|
| 25 | + '_wpinv_vat_rule', |
|
| 26 | + '_wpinv_vat_class', |
|
| 27 | + '_wpinv_type', |
|
| 28 | + '_wpinv_custom_id', |
|
| 29 | + '_wpinv_custom_name', |
|
| 30 | + '_wpinv_custom_singular_name', |
|
| 31 | + '_wpinv_editable', |
|
| 32 | + '_wpinv_dynamic_pricing', |
|
| 33 | + '_minimum_price', |
|
| 34 | + '_wpinv_is_recurring', |
|
| 35 | + '_wpinv_recurring_period', |
|
| 36 | + '_wpinv_recurring_interval', |
|
| 37 | + '_wpinv_recurring_limit', |
|
| 38 | + '_wpinv_free_trial', |
|
| 39 | + '_wpinv_trial_period', |
|
| 40 | + '_wpinv_trial_interval' |
|
| 41 | + ); |
|
| 42 | + |
|
| 43 | + /** |
|
| 44 | + * A map of meta keys to data props. |
|
| 45 | + * |
|
| 46 | + * @since 1.0.19 |
|
| 47 | + * |
|
| 48 | + * @var array |
|
| 49 | + */ |
|
| 50 | + protected $meta_key_to_props = array( |
|
| 51 | + '_wpinv_price' => 'price', |
|
| 52 | + '_wpinv_vat_rule' => 'vat_rule', |
|
| 53 | + '_wpinv_vat_class' => 'vat_class', |
|
| 54 | + '_wpinv_type' => 'type', |
|
| 55 | + '_wpinv_custom_id' => 'custom_id', |
|
| 56 | + '_wpinv_custom_name' => 'custom_name', |
|
| 57 | + '_wpinv_custom_singular_name' => 'custom_singular_name', |
|
| 58 | + '_wpinv_editable' => 'is_editable', |
|
| 59 | + '_wpinv_dynamic_pricing' => 'is_dynamic_pricing', |
|
| 60 | + '_minimum_price' => 'minimum_price', |
|
| 61 | + '_wpinv_custom_name' => 'custom_name', |
|
| 62 | + '_wpinv_is_recurring' => 'is_recurring', |
|
| 63 | + '_wpinv_recurring_period' => 'recurring_period', |
|
| 64 | + '_wpinv_recurring_interval' => 'recurring_interval', |
|
| 65 | + '_wpinv_recurring_limit' => 'recurring_limit', |
|
| 66 | + '_wpinv_free_trial' => 'is_free_trial', |
|
| 67 | + '_wpinv_trial_period' => 'trial_period', |
|
| 68 | + '_wpinv_trial_interval' => 'trial_interval', |
|
| 69 | + '_wpinv_version' => 'version', |
|
| 70 | + ); |
|
| 71 | + |
|
| 72 | + /* |
|
| 73 | 73 | |-------------------------------------------------------------------------- |
| 74 | 74 | | CRUD Methods |
| 75 | 75 | |-------------------------------------------------------------------------- |
| 76 | 76 | */ |
| 77 | 77 | |
| 78 | - /** |
|
| 79 | - * Method to create a new item in the database. |
|
| 80 | - * |
|
| 81 | - * @param WPInv_Item $item Item object. |
|
| 82 | - */ |
|
| 83 | - public function create( &$item ) { |
|
| 84 | - $item->set_version( WPINV_VERSION ); |
|
| 85 | - $item->set_date_created( current_time('mysql') ); |
|
| 86 | - |
|
| 87 | - // Create a new post. |
|
| 88 | - $id = wp_insert_post( |
|
| 89 | - apply_filters( |
|
| 90 | - 'getpaid_new_item_data', |
|
| 91 | - array( |
|
| 92 | - 'post_date' => $item->get_date_created( 'edit' ), |
|
| 93 | - 'post_type' => 'wpi_item', |
|
| 94 | - 'post_status' => $this->get_post_status( $item ), |
|
| 95 | - 'ping_status' => 'closed', |
|
| 96 | - 'post_author' => $item->get_author( 'edit' ), |
|
| 97 | - 'post_title' => $item->get_name( 'edit' ), |
|
| 98 | - 'post_parent' => 0, |
|
| 99 | - 'post_excerpt' => $item->get_description( 'edit' ), |
|
| 100 | - ) |
|
| 101 | - ), |
|
| 102 | - true |
|
| 103 | - ); |
|
| 104 | - |
|
| 105 | - if ( $id && ! is_wp_error( $id ) ) { |
|
| 106 | - $item->set_id( $id ); |
|
| 107 | - $this->update_post_meta( $item ); |
|
| 108 | - $item->save_meta_data(); |
|
| 109 | - $item->apply_changes(); |
|
| 110 | - $this->clear_caches( $item ); |
|
| 111 | - do_action( 'getpaid_new_item', $item ); |
|
| 112 | - return true; |
|
| 113 | - } |
|
| 114 | - |
|
| 115 | - if ( is_wp_error( $id ) ) { |
|
| 116 | - $item->last_error = $id->get_error_message(); |
|
| 117 | - } |
|
| 78 | + /** |
|
| 79 | + * Method to create a new item in the database. |
|
| 80 | + * |
|
| 81 | + * @param WPInv_Item $item Item object. |
|
| 82 | + */ |
|
| 83 | + public function create( &$item ) { |
|
| 84 | + $item->set_version( WPINV_VERSION ); |
|
| 85 | + $item->set_date_created( current_time('mysql') ); |
|
| 86 | + |
|
| 87 | + // Create a new post. |
|
| 88 | + $id = wp_insert_post( |
|
| 89 | + apply_filters( |
|
| 90 | + 'getpaid_new_item_data', |
|
| 91 | + array( |
|
| 92 | + 'post_date' => $item->get_date_created( 'edit' ), |
|
| 93 | + 'post_type' => 'wpi_item', |
|
| 94 | + 'post_status' => $this->get_post_status( $item ), |
|
| 95 | + 'ping_status' => 'closed', |
|
| 96 | + 'post_author' => $item->get_author( 'edit' ), |
|
| 97 | + 'post_title' => $item->get_name( 'edit' ), |
|
| 98 | + 'post_parent' => 0, |
|
| 99 | + 'post_excerpt' => $item->get_description( 'edit' ), |
|
| 100 | + ) |
|
| 101 | + ), |
|
| 102 | + true |
|
| 103 | + ); |
|
| 104 | + |
|
| 105 | + if ( $id && ! is_wp_error( $id ) ) { |
|
| 106 | + $item->set_id( $id ); |
|
| 107 | + $this->update_post_meta( $item ); |
|
| 108 | + $item->save_meta_data(); |
|
| 109 | + $item->apply_changes(); |
|
| 110 | + $this->clear_caches( $item ); |
|
| 111 | + do_action( 'getpaid_new_item', $item ); |
|
| 112 | + return true; |
|
| 113 | + } |
|
| 114 | + |
|
| 115 | + if ( is_wp_error( $id ) ) { |
|
| 116 | + $item->last_error = $id->get_error_message(); |
|
| 117 | + } |
|
| 118 | 118 | |
| 119 | - return false; |
|
| 120 | - } |
|
| 121 | - |
|
| 122 | - /** |
|
| 123 | - * Method to read an item from the database. |
|
| 124 | - * |
|
| 125 | - * @param WPInv_Item $item Item object. |
|
| 126 | - * |
|
| 127 | - */ |
|
| 128 | - public function read( &$item ) { |
|
| 129 | - |
|
| 130 | - $item->set_defaults(); |
|
| 131 | - $item_object = get_post( $item->get_id() ); |
|
| 132 | - |
|
| 133 | - if ( ! $item->get_id() || ! $item_object || $item_object->post_type != 'wpi_item' ) { |
|
| 134 | - $item->last_error = __( 'Invalid item.', 'invoicing' ); |
|
| 135 | - $item->set_id( 0 ); |
|
| 136 | - return false; |
|
| 137 | - } |
|
| 138 | - |
|
| 139 | - $item->set_props( |
|
| 140 | - array( |
|
| 141 | - 'parent_id' => $item_object->post_parent, |
|
| 142 | - 'date_created' => 0 < $item_object->post_date ? $item_object->post_date : null, |
|
| 143 | - 'date_modified' => 0 < $item_object->post_modified ? $item_object->post_modified : null, |
|
| 144 | - 'status' => $item_object->post_status, |
|
| 145 | - 'name' => $item_object->post_title, |
|
| 146 | - 'description' => $item_object->post_excerpt, |
|
| 147 | - 'author' => $item_object->post_author, |
|
| 148 | - ) |
|
| 149 | - ); |
|
| 150 | - |
|
| 151 | - $this->read_object_data( $item, $item_object ); |
|
| 152 | - $item->read_meta_data(); |
|
| 153 | - $item->set_object_read( true ); |
|
| 154 | - do_action( 'getpaid_read_item', $item ); |
|
| 155 | - |
|
| 156 | - } |
|
| 157 | - |
|
| 158 | - /** |
|
| 159 | - * Method to update an item in the database. |
|
| 160 | - * |
|
| 161 | - * @param WPInv_Item $item Item object. |
|
| 162 | - */ |
|
| 163 | - public function update( &$item ) { |
|
| 164 | - $item->save_meta_data(); |
|
| 165 | - $item->set_version( WPINV_VERSION ); |
|
| 166 | - |
|
| 167 | - if ( null === $item->get_date_created( 'edit' ) ) { |
|
| 168 | - $item->set_date_created( current_time('mysql') ); |
|
| 169 | - } |
|
| 170 | - |
|
| 171 | - // Grab the current status so we can compare. |
|
| 172 | - $previous_status = get_post_status( $item->get_id() ); |
|
| 173 | - |
|
| 174 | - $changes = $item->get_changes(); |
|
| 175 | - |
|
| 176 | - // Only update the post when the post data changes. |
|
| 177 | - if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'parent_id', 'description', 'name', 'author' ), array_keys( $changes ) ) ) { |
|
| 178 | - $post_data = array( |
|
| 179 | - 'post_date' => $item->get_date_created( 'edit' ), |
|
| 180 | - 'post_status' => $item->get_status( 'edit' ), |
|
| 181 | - 'post_parent' => $item->get_parent_id( 'edit' ), |
|
| 182 | - 'post_excerpt' => $item->get_description( 'edit' ), |
|
| 183 | - 'post_modified' => $item->get_date_modified( 'edit' ), |
|
| 184 | - 'post_title' => $item->get_name( 'edit' ), |
|
| 185 | - 'post_author' => $item->get_author( 'edit' ), |
|
| 186 | - ); |
|
| 187 | - |
|
| 188 | - /** |
|
| 189 | - * When updating this object, to prevent infinite loops, use $wpdb |
|
| 190 | - * to update data, since wp_update_post spawns more calls to the |
|
| 191 | - * save_post action. |
|
| 192 | - * |
|
| 193 | - * This ensures hooks are fired by either WP itself (admin screen save), |
|
| 194 | - * or an update purely from CRUD. |
|
| 195 | - */ |
|
| 196 | - if ( doing_action( 'save_post' ) ) { |
|
| 197 | - $GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $item->get_id() ) ); |
|
| 198 | - clean_post_cache( $item->get_id() ); |
|
| 199 | - } else { |
|
| 200 | - wp_update_post( array_merge( array( 'ID' => $item->get_id() ), $post_data ) ); |
|
| 201 | - } |
|
| 202 | - $item->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook. |
|
| 203 | - } |
|
| 204 | - $this->update_post_meta( $item ); |
|
| 205 | - $item->apply_changes(); |
|
| 206 | - $this->clear_caches( $item ); |
|
| 207 | - |
|
| 208 | - // Fire a hook depending on the status - this should be considered a creation if it was previously draft status. |
|
| 209 | - $new_status = $item->get_status( 'edit' ); |
|
| 210 | - |
|
| 211 | - if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) { |
|
| 212 | - do_action( 'getpaid_new_item', $item ); |
|
| 213 | - } else { |
|
| 214 | - do_action( 'getpaid_update_item', $item ); |
|
| 215 | - } |
|
| 216 | - |
|
| 217 | - } |
|
| 218 | - |
|
| 219 | - /* |
|
| 119 | + return false; |
|
| 120 | + } |
|
| 121 | + |
|
| 122 | + /** |
|
| 123 | + * Method to read an item from the database. |
|
| 124 | + * |
|
| 125 | + * @param WPInv_Item $item Item object. |
|
| 126 | + * |
|
| 127 | + */ |
|
| 128 | + public function read( &$item ) { |
|
| 129 | + |
|
| 130 | + $item->set_defaults(); |
|
| 131 | + $item_object = get_post( $item->get_id() ); |
|
| 132 | + |
|
| 133 | + if ( ! $item->get_id() || ! $item_object || $item_object->post_type != 'wpi_item' ) { |
|
| 134 | + $item->last_error = __( 'Invalid item.', 'invoicing' ); |
|
| 135 | + $item->set_id( 0 ); |
|
| 136 | + return false; |
|
| 137 | + } |
|
| 138 | + |
|
| 139 | + $item->set_props( |
|
| 140 | + array( |
|
| 141 | + 'parent_id' => $item_object->post_parent, |
|
| 142 | + 'date_created' => 0 < $item_object->post_date ? $item_object->post_date : null, |
|
| 143 | + 'date_modified' => 0 < $item_object->post_modified ? $item_object->post_modified : null, |
|
| 144 | + 'status' => $item_object->post_status, |
|
| 145 | + 'name' => $item_object->post_title, |
|
| 146 | + 'description' => $item_object->post_excerpt, |
|
| 147 | + 'author' => $item_object->post_author, |
|
| 148 | + ) |
|
| 149 | + ); |
|
| 150 | + |
|
| 151 | + $this->read_object_data( $item, $item_object ); |
|
| 152 | + $item->read_meta_data(); |
|
| 153 | + $item->set_object_read( true ); |
|
| 154 | + do_action( 'getpaid_read_item', $item ); |
|
| 155 | + |
|
| 156 | + } |
|
| 157 | + |
|
| 158 | + /** |
|
| 159 | + * Method to update an item in the database. |
|
| 160 | + * |
|
| 161 | + * @param WPInv_Item $item Item object. |
|
| 162 | + */ |
|
| 163 | + public function update( &$item ) { |
|
| 164 | + $item->save_meta_data(); |
|
| 165 | + $item->set_version( WPINV_VERSION ); |
|
| 166 | + |
|
| 167 | + if ( null === $item->get_date_created( 'edit' ) ) { |
|
| 168 | + $item->set_date_created( current_time('mysql') ); |
|
| 169 | + } |
|
| 170 | + |
|
| 171 | + // Grab the current status so we can compare. |
|
| 172 | + $previous_status = get_post_status( $item->get_id() ); |
|
| 173 | + |
|
| 174 | + $changes = $item->get_changes(); |
|
| 175 | + |
|
| 176 | + // Only update the post when the post data changes. |
|
| 177 | + if ( array_intersect( array( 'date_created', 'date_modified', 'status', 'parent_id', 'description', 'name', 'author' ), array_keys( $changes ) ) ) { |
|
| 178 | + $post_data = array( |
|
| 179 | + 'post_date' => $item->get_date_created( 'edit' ), |
|
| 180 | + 'post_status' => $item->get_status( 'edit' ), |
|
| 181 | + 'post_parent' => $item->get_parent_id( 'edit' ), |
|
| 182 | + 'post_excerpt' => $item->get_description( 'edit' ), |
|
| 183 | + 'post_modified' => $item->get_date_modified( 'edit' ), |
|
| 184 | + 'post_title' => $item->get_name( 'edit' ), |
|
| 185 | + 'post_author' => $item->get_author( 'edit' ), |
|
| 186 | + ); |
|
| 187 | + |
|
| 188 | + /** |
|
| 189 | + * When updating this object, to prevent infinite loops, use $wpdb |
|
| 190 | + * to update data, since wp_update_post spawns more calls to the |
|
| 191 | + * save_post action. |
|
| 192 | + * |
|
| 193 | + * This ensures hooks are fired by either WP itself (admin screen save), |
|
| 194 | + * or an update purely from CRUD. |
|
| 195 | + */ |
|
| 196 | + if ( doing_action( 'save_post' ) ) { |
|
| 197 | + $GLOBALS['wpdb']->update( $GLOBALS['wpdb']->posts, $post_data, array( 'ID' => $item->get_id() ) ); |
|
| 198 | + clean_post_cache( $item->get_id() ); |
|
| 199 | + } else { |
|
| 200 | + wp_update_post( array_merge( array( 'ID' => $item->get_id() ), $post_data ) ); |
|
| 201 | + } |
|
| 202 | + $item->read_meta_data( true ); // Refresh internal meta data, in case things were hooked into `save_post` or another WP hook. |
|
| 203 | + } |
|
| 204 | + $this->update_post_meta( $item ); |
|
| 205 | + $item->apply_changes(); |
|
| 206 | + $this->clear_caches( $item ); |
|
| 207 | + |
|
| 208 | + // Fire a hook depending on the status - this should be considered a creation if it was previously draft status. |
|
| 209 | + $new_status = $item->get_status( 'edit' ); |
|
| 210 | + |
|
| 211 | + if ( $new_status !== $previous_status && in_array( $previous_status, array( 'new', 'auto-draft', 'draft' ), true ) ) { |
|
| 212 | + do_action( 'getpaid_new_item', $item ); |
|
| 213 | + } else { |
|
| 214 | + do_action( 'getpaid_update_item', $item ); |
|
| 215 | + } |
|
| 216 | + |
|
| 217 | + } |
|
| 218 | + |
|
| 219 | + /* |
|
| 220 | 220 | |-------------------------------------------------------------------------- |
| 221 | 221 | | Additional Methods |
| 222 | 222 | |-------------------------------------------------------------------------- |
| 223 | 223 | */ |
| 224 | 224 | |
| 225 | - /** |
|
| 226 | - * Helper method that updates all the post meta for an item based on it's settings in the WPInv_Item class. |
|
| 227 | - * |
|
| 228 | - * @param WPInv_Item $item WPInv_Item object. |
|
| 229 | - * @since 1.0.19 |
|
| 230 | - */ |
|
| 231 | - protected function update_post_meta( &$item ) { |
|
| 225 | + /** |
|
| 226 | + * Helper method that updates all the post meta for an item based on it's settings in the WPInv_Item class. |
|
| 227 | + * |
|
| 228 | + * @param WPInv_Item $item WPInv_Item object. |
|
| 229 | + * @since 1.0.19 |
|
| 230 | + */ |
|
| 231 | + protected function update_post_meta( &$item ) { |
|
| 232 | 232 | |
| 233 | - // Ensure that we have a custom id. |
|
| 233 | + // Ensure that we have a custom id. |
|
| 234 | 234 | if ( ! $item->get_custom_id() ) { |
| 235 | 235 | $item->set_custom_id( $item->get_id() ); |
| 236 | - } |
|
| 236 | + } |
|
| 237 | 237 | |
| 238 | - parent::update_post_meta( $item ); |
|
| 239 | - } |
|
| 238 | + parent::update_post_meta( $item ); |
|
| 239 | + } |
|
| 240 | 240 | |
| 241 | 241 | } |
