@@ -12,43 +12,43 @@ discard block |
||
| 12 | 12 | */ |
| 13 | 13 | class GetPaid_Reports_Report_Earnings extends GetPaid_Reports_Abstract_Report { |
| 14 | 14 | |
| 15 | - /** |
|
| 16 | - * Retrieves the earning graphs. |
|
| 17 | - * |
|
| 18 | - */ |
|
| 19 | - public function get_graphs() { |
|
| 15 | + /** |
|
| 16 | + * Retrieves the earning graphs. |
|
| 17 | + * |
|
| 18 | + */ |
|
| 19 | + public function get_graphs() { |
|
| 20 | 20 | |
| 21 | - $graphs = array( |
|
| 21 | + $graphs = array( |
|
| 22 | 22 | |
| 23 | 23 | 'total' => __( 'Earnings', 'invoicing' ), |
| 24 | 24 | 'discount' => __( 'Discount', 'invoicing' ), |
| 25 | - 'fees_total' => __( 'Fees', 'invoicing' ), |
|
| 26 | - 'tax' => __( 'Tax', 'invoicing' ), |
|
| 25 | + 'fees_total' => __( 'Fees', 'invoicing' ), |
|
| 26 | + 'tax' => __( 'Tax', 'invoicing' ), |
|
| 27 | 27 | |
| 28 | - ); |
|
| 28 | + ); |
|
| 29 | 29 | |
| 30 | - return apply_filters( 'getpaid_earning_graphs', $graphs ); |
|
| 30 | + return apply_filters( 'getpaid_earning_graphs', $graphs ); |
|
| 31 | 31 | |
| 32 | - } |
|
| 32 | + } |
|
| 33 | 33 | |
| 34 | - /** |
|
| 35 | - * Retrieves the earning sql. |
|
| 36 | - * |
|
| 37 | - */ |
|
| 38 | - public function get_sql( $range ) { |
|
| 39 | - global $wpdb; |
|
| 34 | + /** |
|
| 35 | + * Retrieves the earning sql. |
|
| 36 | + * |
|
| 37 | + */ |
|
| 38 | + public function get_sql( $range ) { |
|
| 39 | + global $wpdb; |
|
| 40 | 40 | |
| 41 | - $table = $wpdb->prefix . 'getpaid_invoices'; |
|
| 42 | - $clauses = $this->get_range_sql( $range ); |
|
| 43 | - $graphs = array_keys( $this->get_graphs() ); |
|
| 44 | - $graphs_sql = array(); |
|
| 41 | + $table = $wpdb->prefix . 'getpaid_invoices'; |
|
| 42 | + $clauses = $this->get_range_sql( $range ); |
|
| 43 | + $graphs = array_keys( $this->get_graphs() ); |
|
| 44 | + $graphs_sql = array(); |
|
| 45 | 45 | |
| 46 | - foreach ( $graphs as $graph ) { |
|
| 47 | - $graphs_sql[] = "SUM( meta.$graph ) AS $graph"; |
|
| 48 | - } |
|
| 46 | + foreach ( $graphs as $graph ) { |
|
| 47 | + $graphs_sql[] = "SUM( meta.$graph ) AS $graph"; |
|
| 48 | + } |
|
| 49 | 49 | |
| 50 | - $graphs_sql = implode( ', ', $graphs_sql ); |
|
| 51 | - $sql = "SELECT {$clauses[0]} AS completed_date, $graphs_sql |
|
| 50 | + $graphs_sql = implode( ', ', $graphs_sql ); |
|
| 51 | + $sql = "SELECT {$clauses[0]} AS completed_date, $graphs_sql |
|
| 52 | 52 | FROM $wpdb->posts |
| 53 | 53 | LEFT JOIN $table as meta ON meta.post_id = $wpdb->posts.ID |
| 54 | 54 | WHERE meta.post_id IS NOT NULL |
@@ -58,94 +58,94 @@ discard block |
||
| 58 | 58 | GROUP BY {$clauses[0]} |
| 59 | 59 | "; |
| 60 | 60 | |
| 61 | - return apply_filters( 'getpaid_earning_graphs_get_sql', $sql, $range ); |
|
| 62 | - |
|
| 63 | - } |
|
| 64 | - |
|
| 65 | - /** |
|
| 66 | - * Prepares the report stats. |
|
| 67 | - * |
|
| 68 | - */ |
|
| 69 | - public function prepare_stats() { |
|
| 70 | - global $wpdb; |
|
| 71 | - $this->stats = $wpdb->get_results( $this->get_sql( $this->get_range() ) ); |
|
| 72 | - } |
|
| 73 | - |
|
| 74 | - /** |
|
| 75 | - * Retrieves report labels. |
|
| 76 | - * |
|
| 77 | - */ |
|
| 78 | - public function get_labels( $range ) { |
|
| 79 | - |
|
| 80 | - $labels = array( |
|
| 81 | - 'today' => $this->get_hours_in_a_day(), |
|
| 82 | - 'yesterday' => $this->get_hours_in_a_day(), |
|
| 83 | - '7_days' => $this->get_days_in_period( 7 ), |
|
| 84 | - '30_days' => $this->get_days_in_period( 30 ), |
|
| 85 | - '60_days' => $this->get_days_in_period( 60 ), |
|
| 86 | - '90_days' => $this->get_weeks_in_period( 90 ), |
|
| 87 | - '180_days' => $this->get_weeks_in_period( 180 ), |
|
| 88 | - '360_days' => $this->get_weeks_in_period( 360 ), |
|
| 89 | - ); |
|
| 90 | - |
|
| 91 | - $label = isset( $labels[ $range ] ) ? $labels[ $range ] : $labels[ '7_days' ]; |
|
| 92 | - return apply_filters( 'getpaid_earning_graphs_get_labels', $label, $range ); |
|
| 93 | - } |
|
| 94 | - |
|
| 95 | - /** |
|
| 96 | - * Retrieves report datasets. |
|
| 97 | - * |
|
| 98 | - */ |
|
| 99 | - public function get_datasets( $labels ) { |
|
| 100 | - |
|
| 101 | - $datasets = array(); |
|
| 102 | - |
|
| 103 | - foreach ( $this->get_graphs() as $key => $label ) { |
|
| 104 | - $datasets[ $key ] = array( |
|
| 105 | - 'label' => $label, |
|
| 106 | - 'data' => $this->get_data( $key, $labels ) |
|
| 107 | - ); |
|
| 108 | - } |
|
| 109 | - |
|
| 110 | - return apply_filters( 'getpaid_earning_graphs_get_datasets', $datasets, $labels ); |
|
| 111 | - } |
|
| 112 | - |
|
| 113 | - /** |
|
| 114 | - * Retrieves report data. |
|
| 115 | - * |
|
| 116 | - */ |
|
| 117 | - public function get_data( $key, $labels ) { |
|
| 118 | - |
|
| 119 | - $data = wp_list_pluck( $this->stats, $key, 'completed_date' ); |
|
| 120 | - $prepared = array(); |
|
| 121 | - |
|
| 122 | - foreach ( $labels as $label ) { |
|
| 123 | - |
|
| 124 | - $value = 0; |
|
| 125 | - if ( isset( $data[ $label ] ) ) { |
|
| 126 | - $value = wpinv_round_amount( wpinv_sanitize_amount( $data[ $label ] ) ); |
|
| 127 | - } |
|
| 128 | - |
|
| 129 | - $prepared[] = $value; |
|
| 130 | - } |
|
| 131 | - |
|
| 132 | - return apply_filters( 'getpaid_earning_graphs_get_data', $prepared, $key, $labels ); |
|
| 133 | - |
|
| 134 | - } |
|
| 135 | - |
|
| 136 | - /** |
|
| 137 | - * Displays the report card. |
|
| 138 | - * |
|
| 139 | - */ |
|
| 140 | - public function display() { |
|
| 141 | - |
|
| 142 | - $labels = $this->get_labels( $this->get_range() ); |
|
| 143 | - $chart_data = array( |
|
| 144 | - 'labels' => array_values( $labels ), |
|
| 145 | - 'datasets' => $this->get_datasets( array_keys( $labels ) ), |
|
| 146 | - ); |
|
| 147 | - |
|
| 148 | - ?> |
|
| 61 | + return apply_filters( 'getpaid_earning_graphs_get_sql', $sql, $range ); |
|
| 62 | + |
|
| 63 | + } |
|
| 64 | + |
|
| 65 | + /** |
|
| 66 | + * Prepares the report stats. |
|
| 67 | + * |
|
| 68 | + */ |
|
| 69 | + public function prepare_stats() { |
|
| 70 | + global $wpdb; |
|
| 71 | + $this->stats = $wpdb->get_results( $this->get_sql( $this->get_range() ) ); |
|
| 72 | + } |
|
| 73 | + |
|
| 74 | + /** |
|
| 75 | + * Retrieves report labels. |
|
| 76 | + * |
|
| 77 | + */ |
|
| 78 | + public function get_labels( $range ) { |
|
| 79 | + |
|
| 80 | + $labels = array( |
|
| 81 | + 'today' => $this->get_hours_in_a_day(), |
|
| 82 | + 'yesterday' => $this->get_hours_in_a_day(), |
|
| 83 | + '7_days' => $this->get_days_in_period( 7 ), |
|
| 84 | + '30_days' => $this->get_days_in_period( 30 ), |
|
| 85 | + '60_days' => $this->get_days_in_period( 60 ), |
|
| 86 | + '90_days' => $this->get_weeks_in_period( 90 ), |
|
| 87 | + '180_days' => $this->get_weeks_in_period( 180 ), |
|
| 88 | + '360_days' => $this->get_weeks_in_period( 360 ), |
|
| 89 | + ); |
|
| 90 | + |
|
| 91 | + $label = isset( $labels[ $range ] ) ? $labels[ $range ] : $labels[ '7_days' ]; |
|
| 92 | + return apply_filters( 'getpaid_earning_graphs_get_labels', $label, $range ); |
|
| 93 | + } |
|
| 94 | + |
|
| 95 | + /** |
|
| 96 | + * Retrieves report datasets. |
|
| 97 | + * |
|
| 98 | + */ |
|
| 99 | + public function get_datasets( $labels ) { |
|
| 100 | + |
|
| 101 | + $datasets = array(); |
|
| 102 | + |
|
| 103 | + foreach ( $this->get_graphs() as $key => $label ) { |
|
| 104 | + $datasets[ $key ] = array( |
|
| 105 | + 'label' => $label, |
|
| 106 | + 'data' => $this->get_data( $key, $labels ) |
|
| 107 | + ); |
|
| 108 | + } |
|
| 109 | + |
|
| 110 | + return apply_filters( 'getpaid_earning_graphs_get_datasets', $datasets, $labels ); |
|
| 111 | + } |
|
| 112 | + |
|
| 113 | + /** |
|
| 114 | + * Retrieves report data. |
|
| 115 | + * |
|
| 116 | + */ |
|
| 117 | + public function get_data( $key, $labels ) { |
|
| 118 | + |
|
| 119 | + $data = wp_list_pluck( $this->stats, $key, 'completed_date' ); |
|
| 120 | + $prepared = array(); |
|
| 121 | + |
|
| 122 | + foreach ( $labels as $label ) { |
|
| 123 | + |
|
| 124 | + $value = 0; |
|
| 125 | + if ( isset( $data[ $label ] ) ) { |
|
| 126 | + $value = wpinv_round_amount( wpinv_sanitize_amount( $data[ $label ] ) ); |
|
| 127 | + } |
|
| 128 | + |
|
| 129 | + $prepared[] = $value; |
|
| 130 | + } |
|
| 131 | + |
|
| 132 | + return apply_filters( 'getpaid_earning_graphs_get_data', $prepared, $key, $labels ); |
|
| 133 | + |
|
| 134 | + } |
|
| 135 | + |
|
| 136 | + /** |
|
| 137 | + * Displays the report card. |
|
| 138 | + * |
|
| 139 | + */ |
|
| 140 | + public function display() { |
|
| 141 | + |
|
| 142 | + $labels = $this->get_labels( $this->get_range() ); |
|
| 143 | + $chart_data = array( |
|
| 144 | + 'labels' => array_values( $labels ), |
|
| 145 | + 'datasets' => $this->get_datasets( array_keys( $labels ) ), |
|
| 146 | + ); |
|
| 147 | + |
|
| 148 | + ?> |
|
| 149 | 149 | |
| 150 | 150 | <?php foreach ( $chart_data['datasets'] as $key => $dataset ) : ?> |
| 151 | 151 | <div class="row mb-4"> |
@@ -165,15 +165,15 @@ discard block |
||
| 165 | 165 | |
| 166 | 166 | <?php |
| 167 | 167 | |
| 168 | - } |
|
| 168 | + } |
|
| 169 | 169 | |
| 170 | - /** |
|
| 171 | - * Displays the actual report. |
|
| 172 | - * |
|
| 173 | - */ |
|
| 174 | - public function display_graph( $key, $dataset, $labels ) { |
|
| 170 | + /** |
|
| 171 | + * Displays the actual report. |
|
| 172 | + * |
|
| 173 | + */ |
|
| 174 | + public function display_graph( $key, $dataset, $labels ) { |
|
| 175 | 175 | |
| 176 | - ?> |
|
| 176 | + ?> |
|
| 177 | 177 | |
| 178 | 178 | <canvas id="getpaid-chartjs-earnings-<?php echo sanitize_key( $key ); ?>"></canvas> |
| 179 | 179 | |
@@ -223,20 +223,20 @@ discard block |
||
| 223 | 223 | </script> |
| 224 | 224 | |
| 225 | 225 | <?php |
| 226 | - } |
|
| 226 | + } |
|
| 227 | 227 | |
| 228 | - /** |
|
| 229 | - * Displays the actual report. |
|
| 230 | - * |
|
| 231 | - */ |
|
| 232 | - public function display_stats() {} |
|
| 228 | + /** |
|
| 229 | + * Displays the actual report. |
|
| 230 | + * |
|
| 231 | + */ |
|
| 232 | + public function display_stats() {} |
|
| 233 | 233 | |
| 234 | - /** |
|
| 235 | - * Displays the range selector. |
|
| 236 | - * |
|
| 237 | - */ |
|
| 238 | - public function display_range_selector() { |
|
| 234 | + /** |
|
| 235 | + * Displays the range selector. |
|
| 236 | + * |
|
| 237 | + */ |
|
| 238 | + public function display_range_selector() { |
|
| 239 | 239 | |
| 240 | - } |
|
| 240 | + } |
|
| 241 | 241 | |
| 242 | 242 | } |
@@ -18,664 +18,664 @@ |
||
| 18 | 18 | */ |
| 19 | 19 | class GetPaid_REST_Report_Sales_Controller extends GetPaid_REST_Date_Based_Controller { |
| 20 | 20 | |
| 21 | - /** |
|
| 22 | - * Route base. |
|
| 23 | - * |
|
| 24 | - * @var string |
|
| 25 | - */ |
|
| 26 | - protected $rest_base = 'reports/sales'; |
|
| 27 | - |
|
| 28 | - /** |
|
| 29 | - * The report data. |
|
| 30 | - * |
|
| 31 | - * @var stdClass |
|
| 32 | - */ |
|
| 33 | - protected $report_data; |
|
| 34 | - |
|
| 35 | - /** |
|
| 36 | - * The report range. |
|
| 37 | - * |
|
| 38 | - * @var array |
|
| 39 | - */ |
|
| 40 | - protected $report_range; |
|
| 41 | - |
|
| 42 | - /** |
|
| 43 | - * Registers the routes for the objects of the controller. |
|
| 44 | - * |
|
| 45 | - * @since 2.0.0 |
|
| 46 | - * |
|
| 47 | - * @see register_rest_route() |
|
| 48 | - */ |
|
| 49 | - public function register_namespace_routes( $namespace ) { |
|
| 50 | - |
|
| 51 | - // Get sales report. |
|
| 52 | - register_rest_route( |
|
| 53 | - $namespace, |
|
| 54 | - $this->rest_base, |
|
| 55 | - array( |
|
| 56 | - array( |
|
| 57 | - 'methods' => WP_REST_Server::READABLE, |
|
| 58 | - 'callback' => array( $this, 'get_items' ), |
|
| 59 | - 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 60 | - 'args' => $this->get_collection_params(), |
|
| 61 | - ), |
|
| 62 | - 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 63 | - ) |
|
| 64 | - ); |
|
| 65 | - |
|
| 66 | - } |
|
| 67 | - |
|
| 68 | - /** |
|
| 69 | - * Makes sure the current user has access to READ the report APIs. |
|
| 70 | - * |
|
| 71 | - * @since 2.0.0 |
|
| 72 | - * @param WP_REST_Request $request Full data about the request. |
|
| 73 | - * @return WP_Error|boolean |
|
| 74 | - */ |
|
| 75 | - public function get_items_permissions_check( $request ) { |
|
| 76 | - |
|
| 77 | - if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 78 | - return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 79 | - } |
|
| 80 | - |
|
| 81 | - return true; |
|
| 82 | - } |
|
| 83 | - |
|
| 84 | - /** |
|
| 85 | - * Get sales reports. |
|
| 86 | - * |
|
| 87 | - * @param WP_REST_Request $request |
|
| 88 | - * @return array|WP_Error |
|
| 89 | - */ |
|
| 90 | - public function get_items( $request ) { |
|
| 91 | - $data = array(); |
|
| 92 | - $item = $this->prepare_item_for_response( null, $request ); |
|
| 93 | - $data[] = $this->prepare_response_for_collection( $item ); |
|
| 94 | - |
|
| 95 | - return rest_ensure_response( $data ); |
|
| 96 | - } |
|
| 97 | - |
|
| 98 | - /** |
|
| 99 | - * Prepare a report sales object for serialization. |
|
| 100 | - * |
|
| 101 | - * @param null $_ |
|
| 102 | - * @param WP_REST_Request $request Request object. |
|
| 103 | - * @return WP_REST_Response $response Response data. |
|
| 104 | - */ |
|
| 105 | - public function prepare_item_for_response( $_, $request ) { |
|
| 106 | - |
|
| 107 | - // Set report range. |
|
| 108 | - $this->report_range = $this->get_date_range( $request ); |
|
| 109 | - |
|
| 110 | - $report_data = $this->get_report_data(); |
|
| 111 | - $period_totals = array(); |
|
| 112 | - |
|
| 113 | - // Setup period totals by ensuring each period in the interval has data. |
|
| 114 | - $start_date = strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS; |
|
| 115 | - |
|
| 116 | - if ( 'month' === $this->groupby ) { |
|
| 117 | - $start_date = strtotime( date( 'Y-m-01', $start_date ) ); |
|
| 118 | - } |
|
| 119 | - |
|
| 120 | - for ( $i = 0; $i < $this->interval; $i++ ) { |
|
| 121 | - |
|
| 122 | - switch ( $this->groupby ) { |
|
| 123 | - case 'day' : |
|
| 124 | - $time = date( 'Y-m-d', strtotime( "+{$i} DAY", $start_date ) ); |
|
| 125 | - break; |
|
| 126 | - default : |
|
| 127 | - $time = date( 'Y-m', strtotime( "+{$i} MONTH", $start_date ) ); |
|
| 128 | - break; |
|
| 129 | - } |
|
| 130 | - |
|
| 131 | - // Set the defaults for each period. |
|
| 132 | - $period_totals[ $time ] = array( |
|
| 133 | - 'sales' => wpinv_round_amount( 0.00 ), |
|
| 134 | - 'invoices' => 0, |
|
| 135 | - 'refunds' => wpinv_round_amount( 0.00 ), |
|
| 136 | - 'items' => 0, |
|
| 137 | - 'refunded_items' => 0, |
|
| 138 | - 'tax' => wpinv_round_amount( 0.00 ), |
|
| 139 | - 'refunded_tax' => wpinv_round_amount( 0.00 ), |
|
| 140 | - 'subtotal' => wpinv_round_amount( 0.00 ), |
|
| 141 | - 'refunded_subtotal' => wpinv_round_amount( 0.00 ), |
|
| 142 | - 'fees' => wpinv_round_amount( 0.00 ), |
|
| 143 | - 'refunded_fees' => wpinv_round_amount( 0.00 ), |
|
| 144 | - 'discount' => wpinv_round_amount( 0.00 ), |
|
| 145 | - ); |
|
| 146 | - |
|
| 147 | - } |
|
| 148 | - |
|
| 149 | - // add total sales, total invoice count, total tax for each period |
|
| 150 | - $date_format = ( 'day' === $this->groupby ) ? 'Y-m-d' : 'Y-m'; |
|
| 151 | - foreach ( $report_data->invoices as $invoice ) { |
|
| 152 | - $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
| 153 | - |
|
| 154 | - if ( ! isset( $period_totals[ $time ] ) ) { |
|
| 155 | - continue; |
|
| 156 | - } |
|
| 157 | - |
|
| 158 | - $period_totals[ $time ]['sales'] = wpinv_round_amount( $invoice->total_sales ); |
|
| 159 | - $period_totals[ $time ]['tax'] = wpinv_round_amount( $invoice->total_tax ); |
|
| 160 | - $period_totals[ $time ]['subtotal'] = wpinv_round_amount( $invoice->subtotal ); |
|
| 161 | - $period_totals[ $time ]['fees'] = wpinv_round_amount( $invoice->total_fees ); |
|
| 162 | - |
|
| 163 | - } |
|
| 164 | - |
|
| 165 | - foreach ( $report_data->refunds as $invoice ) { |
|
| 166 | - $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
| 167 | - |
|
| 168 | - if ( ! isset( $period_totals[ $time ] ) ) { |
|
| 169 | - continue; |
|
| 170 | - } |
|
| 171 | - |
|
| 172 | - $period_totals[ $time ]['refunds'] = wpinv_round_amount( $invoice->total_sales ); |
|
| 173 | - $period_totals[ $time ]['refunded_tax'] = wpinv_round_amount( $invoice->total_tax ); |
|
| 174 | - $period_totals[ $time ]['refunded_subtotal'] = wpinv_round_amount( $invoice->subtotal ); |
|
| 175 | - $period_totals[ $time ]['refunded_fees'] = wpinv_round_amount( $invoice->total_fees ); |
|
| 176 | - |
|
| 177 | - } |
|
| 178 | - |
|
| 179 | - foreach ( $report_data->invoice_counts as $invoice ) { |
|
| 180 | - $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
| 181 | - |
|
| 182 | - if ( isset( $period_totals[ $time ] ) ) { |
|
| 183 | - $period_totals[ $time ]['invoices'] = (int) $invoice->count; |
|
| 184 | - } |
|
| 185 | - |
|
| 186 | - } |
|
| 187 | - |
|
| 188 | - // Add total invoice items for each period. |
|
| 189 | - foreach ( $report_data->invoice_items as $invoice_item ) { |
|
| 190 | - $time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $invoice_item->post_date ) ) : date( 'Y-m', strtotime( $invoice_item->post_date ) ); |
|
| 191 | - |
|
| 192 | - if ( isset( $period_totals[ $time ] ) ) { |
|
| 193 | - $period_totals[ $time ]['items'] = (int) $invoice_item->invoice_item_count; |
|
| 194 | - } |
|
| 195 | - |
|
| 196 | - } |
|
| 197 | - |
|
| 198 | - // Add total discount for each period. |
|
| 199 | - foreach ( $report_data->coupons as $discount ) { |
|
| 200 | - $time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $discount->post_date ) ) : date( 'Y-m', strtotime( $discount->post_date ) ); |
|
| 201 | - |
|
| 202 | - if ( isset( $period_totals[ $time ] ) ) { |
|
| 203 | - $period_totals[ $time ]['discount'] = wpinv_round_amount( $discount->discount_amount ); |
|
| 204 | - } |
|
| 205 | - |
|
| 206 | - } |
|
| 207 | - |
|
| 208 | - $report_data->totals = $period_totals; |
|
| 209 | - $report_data->grouped_by = $this->groupby; |
|
| 210 | - $report_data->interval = max( $this->interval, 1 ); |
|
| 211 | - $report_data->currency = wpinv_get_currency(); |
|
| 212 | - $report_data->currency_symbol = wpinv_currency_symbol(); |
|
| 213 | - $report_data->currency_position = wpinv_currency_position(); |
|
| 214 | - $report_data->decimal_places = wpinv_decimals(); |
|
| 215 | - $report_data->thousands_sep = wpinv_thousands_separator(); |
|
| 216 | - $report_data->decimals_sep = wpinv_decimal_separator(); |
|
| 217 | - $report_data->start_date = date( 'Y-m-d', strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS ); |
|
| 218 | - $report_data->end_date = date( 'Y-m-d', strtotime( $this->report_range['before'] ) - DAY_IN_SECONDS ); |
|
| 219 | - $report_data->start_date_locale = getpaid_format_date( date( 'Y-m-d', strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS ) ); |
|
| 220 | - $report_data->end_date_locale = getpaid_format_date( date( 'Y-m-d', strtotime( $this->report_range['before'] ) - DAY_IN_SECONDS ) ); |
|
| 221 | - $report_data->decimals_sep = wpinv_decimal_separator(); |
|
| 222 | - |
|
| 223 | - $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
| 224 | - $data = $report_data; |
|
| 225 | - unset( $data->invoice_counts, $data->invoices, $data->coupons, $data->refunds, $data->invoice_items ); |
|
| 226 | - $data = $this->add_additional_fields_to_object( (array) $data, $request ); |
|
| 227 | - $data = $this->filter_response_by_context( $data, $context ); |
|
| 228 | - |
|
| 229 | - // Wrap the data in a response object. |
|
| 230 | - $response = rest_ensure_response( $data ); |
|
| 231 | - $response->add_links( array( |
|
| 232 | - 'about' => array( |
|
| 233 | - 'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ), |
|
| 234 | - ), |
|
| 235 | - ) ); |
|
| 236 | - |
|
| 237 | - return apply_filters( 'getpaid_rest_prepare_report_sales', $response, $report_data, $request ); |
|
| 238 | - } |
|
| 239 | - |
|
| 240 | - /** |
|
| 241 | - * Get report data. |
|
| 242 | - * |
|
| 243 | - * @return stdClass |
|
| 244 | - */ |
|
| 245 | - public function get_report_data() { |
|
| 246 | - if ( empty( $this->report_data ) ) { |
|
| 247 | - $this->query_report_data(); |
|
| 248 | - } |
|
| 249 | - return $this->report_data; |
|
| 250 | - } |
|
| 251 | - |
|
| 252 | - /** |
|
| 253 | - * Get all data needed for this report and store in the class. |
|
| 254 | - */ |
|
| 255 | - protected function query_report_data() { |
|
| 256 | - |
|
| 257 | - // Prepare reports. |
|
| 258 | - $this->report_data = (object) array( |
|
| 259 | - 'invoice_counts' => $this->query_invoice_counts(),//count, post_date |
|
| 260 | - 'coupons' => $this->query_coupon_counts(), // discount_amount, post_date |
|
| 261 | - 'invoice_items' => $this->query_item_counts(), // invoice_item_count, post_date |
|
| 262 | - 'refunded_items' => $this->count_refunded_items(), // invoice_item_count, post_date |
|
| 263 | - 'invoices' => $this->query_invoice_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date |
|
| 264 | - 'refunds' => $this->query_refunded_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date |
|
| 265 | - 'previous_range' => $this->previous_range, |
|
| 266 | - ); |
|
| 267 | - |
|
| 268 | - // Calculated totals. |
|
| 269 | - $this->report_data->total_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_tax' ) ) ); |
|
| 270 | - $this->report_data->total_sales = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_sales' ) ) ); |
|
| 271 | - $this->report_data->total_discount = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_discount' ) ) ); |
|
| 272 | - $this->report_data->total_fees = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_fees' ) ) ); |
|
| 273 | - $this->report_data->subtotal = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'subtotal' ) ) ); |
|
| 274 | - $this->report_data->net_sales = wpinv_round_amount( $this->report_data->total_sales - max( 0, $this->report_data->total_tax ) ); |
|
| 275 | - $this->report_data->total_refunded_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_tax' ) ) ); |
|
| 276 | - $this->report_data->total_refunds = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_sales' ) ) ); |
|
| 277 | - $this->report_data->refunded_discount = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_discount' ) ) ); |
|
| 278 | - $this->report_data->refunded_fees = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_fees' ) ) ); |
|
| 279 | - $this->report_data->refunded_subtotal = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'subtotal' ) ) ); |
|
| 280 | - $this->report_data->net_refunds = wpinv_round_amount( $this->report_data->total_refunds + max( 0, $this->report_data->total_refunded_tax ) ); |
|
| 281 | - |
|
| 282 | - |
|
| 283 | - // Calculate average based on net. |
|
| 284 | - $this->report_data->average_sales = wpinv_round_amount( $this->report_data->net_sales / max( $this->interval, 1 ), 2 ); |
|
| 285 | - $this->report_data->average_total_sales = wpinv_round_amount( $this->report_data->total_sales / max( $this->interval, 1 ), 2 ); |
|
| 286 | - |
|
| 287 | - // Total invoices in this period, even if refunded. |
|
| 288 | - $this->report_data->total_invoices = absint( array_sum( wp_list_pluck( $this->report_data->invoice_counts, 'count' ) ) ); |
|
| 289 | - |
|
| 290 | - // Items invoiced in this period, even if refunded. |
|
| 291 | - $this->report_data->total_items = absint( array_sum( wp_list_pluck( $this->report_data->invoice_items, 'invoice_item_count' ) ) ); |
|
| 292 | - |
|
| 293 | - // 3rd party filtering of report data |
|
| 294 | - $this->report_data = apply_filters( 'getpaid_rest_api_filter_report_data', $this->report_data ); |
|
| 295 | - } |
|
| 296 | - |
|
| 297 | - /** |
|
| 298 | - * Prepares invoice counts. |
|
| 299 | - * |
|
| 300 | - * @return array. |
|
| 301 | - */ |
|
| 302 | - protected function query_invoice_counts() { |
|
| 303 | - |
|
| 304 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 305 | - array( |
|
| 306 | - 'data' => array( |
|
| 307 | - 'ID' => array( |
|
| 308 | - 'type' => 'post_data', |
|
| 309 | - 'function' => 'COUNT', |
|
| 310 | - 'name' => 'count', |
|
| 311 | - 'distinct' => true, |
|
| 312 | - ), |
|
| 313 | - 'post_date' => array( |
|
| 314 | - 'type' => 'post_data', |
|
| 315 | - 'function' => '', |
|
| 316 | - 'name' => 'post_date', |
|
| 317 | - ), |
|
| 318 | - ), |
|
| 319 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 320 | - 'order_by' => 'post_date ASC', |
|
| 321 | - 'query_type' => 'get_results', |
|
| 322 | - 'filter_range' => $this->report_range, |
|
| 323 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
| 324 | - ) |
|
| 325 | - ); |
|
| 326 | - |
|
| 327 | - } |
|
| 328 | - |
|
| 329 | - /** |
|
| 330 | - * Prepares coupon counts. |
|
| 331 | - * |
|
| 332 | - * @return array. |
|
| 333 | - */ |
|
| 334 | - protected function query_coupon_counts() { |
|
| 335 | - |
|
| 336 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 337 | - array( |
|
| 338 | - 'data' => array( |
|
| 339 | - 'discount' => array( |
|
| 340 | - 'type' => 'invoice_data', |
|
| 341 | - 'function' => 'SUM', |
|
| 342 | - 'name' => 'discount_amount', |
|
| 343 | - ), |
|
| 344 | - 'post_date' => array( |
|
| 345 | - 'type' => 'post_data', |
|
| 346 | - 'function' => '', |
|
| 347 | - 'name' => 'post_date', |
|
| 348 | - ), |
|
| 349 | - ), |
|
| 350 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 351 | - 'order_by' => 'post_date ASC', |
|
| 352 | - 'query_type' => 'get_results', |
|
| 353 | - 'filter_range' => $this->report_range, |
|
| 354 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
| 355 | - ) |
|
| 356 | - ); |
|
| 357 | - |
|
| 358 | - } |
|
| 359 | - |
|
| 360 | - /** |
|
| 361 | - * Prepares item counts. |
|
| 362 | - * |
|
| 363 | - * @return array. |
|
| 364 | - */ |
|
| 365 | - protected function query_item_counts() { |
|
| 366 | - |
|
| 367 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 368 | - array( |
|
| 369 | - 'data' => array( |
|
| 370 | - 'quantity' => array( |
|
| 371 | - 'type' => 'invoice_item', |
|
| 372 | - 'function' => 'SUM', |
|
| 373 | - 'name' => 'invoice_item_count', |
|
| 374 | - ), |
|
| 375 | - 'post_date' => array( |
|
| 376 | - 'type' => 'post_data', |
|
| 377 | - 'function' => '', |
|
| 378 | - 'name' => 'post_date', |
|
| 379 | - ), |
|
| 380 | - ), |
|
| 381 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 382 | - 'order_by' => 'post_date ASC', |
|
| 383 | - 'query_type' => 'get_results', |
|
| 384 | - 'filter_range' => $this->report_range, |
|
| 385 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
| 386 | - ) |
|
| 387 | - ); |
|
| 388 | - |
|
| 389 | - } |
|
| 390 | - |
|
| 391 | - /** |
|
| 392 | - * Prepares refunded item counts. |
|
| 393 | - * |
|
| 394 | - * @return array. |
|
| 395 | - */ |
|
| 396 | - protected function count_refunded_items() { |
|
| 397 | - |
|
| 398 | - return (int) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 399 | - array( |
|
| 400 | - 'data' => array( |
|
| 401 | - 'quantity' => array( |
|
| 402 | - 'type' => 'invoice_item', |
|
| 403 | - 'function' => 'SUM', |
|
| 404 | - 'name' => 'invoice_item_count', |
|
| 405 | - ), |
|
| 406 | - ), |
|
| 407 | - 'query_type' => 'get_var', |
|
| 408 | - 'filter_range' => $this->report_range, |
|
| 409 | - 'invoice_status' => array( 'wpi-refunded' ), |
|
| 410 | - ) |
|
| 411 | - ); |
|
| 412 | - |
|
| 413 | - } |
|
| 414 | - |
|
| 415 | - /** |
|
| 416 | - * Prepares daily invoice totals. |
|
| 417 | - * |
|
| 418 | - * @return array. |
|
| 419 | - */ |
|
| 420 | - protected function query_invoice_totals() { |
|
| 421 | - |
|
| 422 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 423 | - array( |
|
| 424 | - 'data' => array( |
|
| 425 | - 'total' => array( |
|
| 426 | - 'type' => 'invoice_data', |
|
| 427 | - 'function' => 'SUM', |
|
| 428 | - 'name' => 'total_sales', |
|
| 429 | - ), |
|
| 430 | - 'tax' => array( |
|
| 431 | - 'type' => 'invoice_data', |
|
| 432 | - 'function' => 'SUM', |
|
| 433 | - 'name' => 'total_tax', |
|
| 434 | - ), |
|
| 435 | - 'discount' => array( |
|
| 436 | - 'type' => 'invoice_data', |
|
| 437 | - 'function' => 'SUM', |
|
| 438 | - 'name' => 'total_discount', |
|
| 439 | - ), |
|
| 440 | - 'fees_total' => array( |
|
| 441 | - 'type' => 'invoice_data', |
|
| 442 | - 'function' => 'SUM', |
|
| 443 | - 'name' => 'total_fees', |
|
| 444 | - ), |
|
| 445 | - 'subtotal' => array( |
|
| 446 | - 'type' => 'invoice_data', |
|
| 447 | - 'function' => 'SUM', |
|
| 448 | - 'name' => 'subtotal', |
|
| 449 | - ), |
|
| 450 | - 'post_date' => array( |
|
| 451 | - 'type' => 'post_data', |
|
| 452 | - 'function' => '', |
|
| 453 | - 'name' => 'post_date', |
|
| 454 | - ), |
|
| 455 | - ), |
|
| 456 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 457 | - 'order_by' => 'post_date ASC', |
|
| 458 | - 'query_type' => 'get_results', |
|
| 459 | - 'filter_range' => $this->report_range, |
|
| 460 | - 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-renewal' ), |
|
| 461 | - ) |
|
| 462 | - ); |
|
| 463 | - |
|
| 464 | - } |
|
| 465 | - |
|
| 466 | - /** |
|
| 467 | - * Prepares daily invoice totals. |
|
| 468 | - * |
|
| 469 | - * @return array. |
|
| 470 | - */ |
|
| 471 | - protected function query_refunded_totals() { |
|
| 472 | - |
|
| 473 | - return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 474 | - array( |
|
| 475 | - 'data' => array( |
|
| 476 | - 'total' => array( |
|
| 477 | - 'type' => 'invoice_data', |
|
| 478 | - 'function' => 'SUM', |
|
| 479 | - 'name' => 'total_sales', |
|
| 480 | - ), |
|
| 481 | - 'tax' => array( |
|
| 482 | - 'type' => 'invoice_data', |
|
| 483 | - 'function' => 'SUM', |
|
| 484 | - 'name' => 'total_tax', |
|
| 485 | - ), |
|
| 486 | - 'discount' => array( |
|
| 487 | - 'type' => 'invoice_data', |
|
| 488 | - 'function' => 'SUM', |
|
| 489 | - 'name' => 'total_discount', |
|
| 490 | - ), |
|
| 491 | - 'fees_total' => array( |
|
| 492 | - 'type' => 'invoice_data', |
|
| 493 | - 'function' => 'SUM', |
|
| 494 | - 'name' => 'total_fees', |
|
| 495 | - ), |
|
| 496 | - 'subtotal' => array( |
|
| 497 | - 'type' => 'invoice_data', |
|
| 498 | - 'function' => 'SUM', |
|
| 499 | - 'name' => 'subtotal', |
|
| 500 | - ), |
|
| 501 | - 'post_date' => array( |
|
| 502 | - 'type' => 'post_data', |
|
| 503 | - 'function' => '', |
|
| 504 | - 'name' => 'post_date', |
|
| 505 | - ), |
|
| 506 | - ), |
|
| 507 | - 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 508 | - 'order_by' => 'post_date ASC', |
|
| 509 | - 'query_type' => 'get_results', |
|
| 510 | - 'filter_range' => $this->report_range, |
|
| 511 | - 'invoice_status' => array( 'wpi-refunded' ), |
|
| 512 | - ) |
|
| 513 | - ); |
|
| 514 | - |
|
| 515 | - } |
|
| 516 | - |
|
| 517 | - /** |
|
| 518 | - * Get the Report's schema, conforming to JSON Schema. |
|
| 519 | - * |
|
| 520 | - * @return array |
|
| 521 | - */ |
|
| 522 | - public function get_item_schema() { |
|
| 523 | - |
|
| 524 | - $schema = array( |
|
| 525 | - '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
| 526 | - 'title' => 'sales_report', |
|
| 527 | - 'type' => 'object', |
|
| 528 | - 'properties' => array( |
|
| 529 | - 'total_sales' => array( |
|
| 530 | - 'description' => __( 'Gross sales in the period.', 'invoicing' ), |
|
| 531 | - 'type' => 'string', |
|
| 532 | - 'context' => array( 'view' ), |
|
| 533 | - 'readonly' => true, |
|
| 534 | - ), |
|
| 535 | - 'net_sales' => array( |
|
| 536 | - 'description' => __( 'Net sales in the period.', 'invoicing' ), |
|
| 537 | - 'type' => 'string', |
|
| 538 | - 'context' => array( 'view' ), |
|
| 539 | - 'readonly' => true, |
|
| 540 | - ), |
|
| 541 | - 'average_sales' => array( |
|
| 542 | - 'description' => __( 'Average net daily sales.', 'invoicing' ), |
|
| 543 | - 'type' => 'string', |
|
| 544 | - 'context' => array( 'view' ), |
|
| 545 | - 'readonly' => true, |
|
| 546 | - ), |
|
| 547 | - 'average_total_sales' => array( |
|
| 548 | - 'description' => __( 'Average gross daily sales.', 'invoicing' ), |
|
| 549 | - 'type' => 'string', |
|
| 550 | - 'context' => array( 'view' ), |
|
| 551 | - 'readonly' => true, |
|
| 552 | - ), |
|
| 553 | - 'total_invoices' => array( |
|
| 554 | - 'description' => __( 'Number of paid invoices.', 'invoicing' ), |
|
| 555 | - 'type' => 'integer', |
|
| 556 | - 'context' => array( 'view' ), |
|
| 557 | - 'readonly' => true, |
|
| 558 | - ), |
|
| 559 | - 'total_items' => array( |
|
| 560 | - 'description' => __( 'Number of items purchased.', 'invoicing' ), |
|
| 561 | - 'type' => 'integer', |
|
| 562 | - 'context' => array( 'view' ), |
|
| 563 | - 'readonly' => true, |
|
| 564 | - ), |
|
| 565 | - 'refunded_items' => array( |
|
| 566 | - 'description' => __( 'Number of items refunded.', 'invoicing' ), |
|
| 567 | - 'type' => 'integer', |
|
| 568 | - 'context' => array( 'view' ), |
|
| 569 | - 'readonly' => true, |
|
| 570 | - ), |
|
| 571 | - 'total_tax' => array( |
|
| 572 | - 'description' => __( 'Total charged for taxes.', 'invoicing' ), |
|
| 573 | - 'type' => 'string', |
|
| 574 | - 'context' => array( 'view' ), |
|
| 575 | - 'readonly' => true, |
|
| 576 | - ), |
|
| 577 | - 'total_refunded_tax' => array( |
|
| 578 | - 'description' => __( 'Total refunded for taxes.', 'invoicing' ), |
|
| 579 | - 'type' => 'string', |
|
| 580 | - 'context' => array( 'view' ), |
|
| 581 | - 'readonly' => true, |
|
| 582 | - ), |
|
| 583 | - 'total_fees' => array( |
|
| 584 | - 'description' => __( 'Total fees charged.', 'invoicing' ), |
|
| 585 | - 'type' => 'string', |
|
| 586 | - 'context' => array( 'view' ), |
|
| 587 | - 'readonly' => true, |
|
| 588 | - ), |
|
| 589 | - 'total_refunds' => array( |
|
| 590 | - 'description' => __( 'Total of refunded invoices.', 'invoicing' ), |
|
| 591 | - 'type' => 'integer', |
|
| 592 | - 'context' => array( 'view' ), |
|
| 593 | - 'readonly' => true, |
|
| 594 | - ), |
|
| 595 | - 'net_refunds' => array( |
|
| 596 | - 'description' => __( 'Net of refunded invoices.', 'invoicing' ), |
|
| 597 | - 'type' => 'integer', |
|
| 598 | - 'context' => array( 'view' ), |
|
| 599 | - 'readonly' => true, |
|
| 600 | - ), |
|
| 601 | - 'total_discount' => array( |
|
| 602 | - 'description' => __( 'Total of discounts used.', 'invoicing' ), |
|
| 603 | - 'type' => 'integer', |
|
| 604 | - 'context' => array( 'view' ), |
|
| 605 | - 'readonly' => true, |
|
| 606 | - ), |
|
| 607 | - 'totals' => array( |
|
| 608 | - 'description' => __( 'Totals.', 'invoicing' ), |
|
| 609 | - 'type' => 'array', |
|
| 610 | - 'items' => array( |
|
| 611 | - 'type' => 'array', |
|
| 612 | - ), |
|
| 613 | - 'context' => array( 'view' ), |
|
| 614 | - 'readonly' => true, |
|
| 615 | - ), |
|
| 616 | - 'interval' => array( |
|
| 617 | - 'description' => __( 'Number of months/days in the report period.', 'invoicing' ), |
|
| 618 | - 'type' => 'integer', |
|
| 619 | - 'context' => array( 'view' ), |
|
| 620 | - 'readonly' => true, |
|
| 621 | - ), |
|
| 622 | - 'previous_range' => array( |
|
| 623 | - 'description' => __( 'The previous report period.', 'invoicing' ), |
|
| 624 | - 'type' => 'array', |
|
| 625 | - 'items' => array( |
|
| 626 | - 'type' => 'string', |
|
| 627 | - ), |
|
| 628 | - 'context' => array( 'view' ), |
|
| 629 | - 'readonly' => true, |
|
| 630 | - ), |
|
| 631 | - 'grouped_by' => array( |
|
| 632 | - 'description' => __( 'The period used to group the totals.', 'invoicing' ), |
|
| 633 | - 'type' => 'string', |
|
| 634 | - 'context' => array( 'view' ), |
|
| 635 | - 'enum' => array( 'day', 'month' ), |
|
| 636 | - 'readonly' => true, |
|
| 637 | - ), |
|
| 638 | - 'currency' => array( |
|
| 639 | - 'description' => __( 'The default store currency.', 'invoicing' ), |
|
| 640 | - 'type' => 'string', |
|
| 641 | - 'context' => array( 'view' ), |
|
| 642 | - 'readonly' => true, |
|
| 643 | - ), |
|
| 644 | - 'currency_symbol' => array( |
|
| 645 | - 'description' => __( 'The default store currency symbol.', 'invoicing' ), |
|
| 646 | - 'type' => 'string', |
|
| 647 | - 'context' => array( 'view' ), |
|
| 648 | - 'readonly' => true, |
|
| 649 | - ), |
|
| 650 | - 'currency_position' => array( |
|
| 651 | - 'description' => __( 'The default store currency position.', 'invoicing' ), |
|
| 652 | - 'type' => 'string', |
|
| 653 | - 'context' => array( 'view' ), |
|
| 654 | - 'readonly' => true, |
|
| 655 | - ), |
|
| 656 | - 'decimal_places' => array( |
|
| 657 | - 'description' => __( 'The default store decimal places.', 'invoicing' ), |
|
| 658 | - 'type' => 'string', |
|
| 659 | - 'context' => array( 'view' ), |
|
| 660 | - 'readonly' => true, |
|
| 661 | - ), |
|
| 662 | - 'thousands_sep' => array( |
|
| 663 | - 'description' => __( 'The default store thousands separator.', 'invoicing' ), |
|
| 664 | - 'type' => 'string', |
|
| 665 | - 'context' => array( 'view' ), |
|
| 666 | - 'readonly' => true, |
|
| 667 | - ), |
|
| 668 | - 'decimals_sep' => array( |
|
| 669 | - 'description' => __( 'The default store decimals separator.', 'invoicing' ), |
|
| 670 | - 'type' => 'string', |
|
| 671 | - 'context' => array( 'view' ), |
|
| 672 | - 'readonly' => true, |
|
| 673 | - ), |
|
| 674 | - ), |
|
| 675 | - ); |
|
| 676 | - |
|
| 677 | - return $this->add_additional_fields_schema( $schema ); |
|
| 678 | - |
|
| 679 | - } |
|
| 21 | + /** |
|
| 22 | + * Route base. |
|
| 23 | + * |
|
| 24 | + * @var string |
|
| 25 | + */ |
|
| 26 | + protected $rest_base = 'reports/sales'; |
|
| 27 | + |
|
| 28 | + /** |
|
| 29 | + * The report data. |
|
| 30 | + * |
|
| 31 | + * @var stdClass |
|
| 32 | + */ |
|
| 33 | + protected $report_data; |
|
| 34 | + |
|
| 35 | + /** |
|
| 36 | + * The report range. |
|
| 37 | + * |
|
| 38 | + * @var array |
|
| 39 | + */ |
|
| 40 | + protected $report_range; |
|
| 41 | + |
|
| 42 | + /** |
|
| 43 | + * Registers the routes for the objects of the controller. |
|
| 44 | + * |
|
| 45 | + * @since 2.0.0 |
|
| 46 | + * |
|
| 47 | + * @see register_rest_route() |
|
| 48 | + */ |
|
| 49 | + public function register_namespace_routes( $namespace ) { |
|
| 50 | + |
|
| 51 | + // Get sales report. |
|
| 52 | + register_rest_route( |
|
| 53 | + $namespace, |
|
| 54 | + $this->rest_base, |
|
| 55 | + array( |
|
| 56 | + array( |
|
| 57 | + 'methods' => WP_REST_Server::READABLE, |
|
| 58 | + 'callback' => array( $this, 'get_items' ), |
|
| 59 | + 'permission_callback' => array( $this, 'get_items_permissions_check' ), |
|
| 60 | + 'args' => $this->get_collection_params(), |
|
| 61 | + ), |
|
| 62 | + 'schema' => array( $this, 'get_public_item_schema' ), |
|
| 63 | + ) |
|
| 64 | + ); |
|
| 65 | + |
|
| 66 | + } |
|
| 67 | + |
|
| 68 | + /** |
|
| 69 | + * Makes sure the current user has access to READ the report APIs. |
|
| 70 | + * |
|
| 71 | + * @since 2.0.0 |
|
| 72 | + * @param WP_REST_Request $request Full data about the request. |
|
| 73 | + * @return WP_Error|boolean |
|
| 74 | + */ |
|
| 75 | + public function get_items_permissions_check( $request ) { |
|
| 76 | + |
|
| 77 | + if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 78 | + return new WP_Error( 'rest_cannot_view', __( 'Sorry, you cannot list resources.', 'invoicing' ), array( 'status' => rest_authorization_required_code() ) ); |
|
| 79 | + } |
|
| 80 | + |
|
| 81 | + return true; |
|
| 82 | + } |
|
| 83 | + |
|
| 84 | + /** |
|
| 85 | + * Get sales reports. |
|
| 86 | + * |
|
| 87 | + * @param WP_REST_Request $request |
|
| 88 | + * @return array|WP_Error |
|
| 89 | + */ |
|
| 90 | + public function get_items( $request ) { |
|
| 91 | + $data = array(); |
|
| 92 | + $item = $this->prepare_item_for_response( null, $request ); |
|
| 93 | + $data[] = $this->prepare_response_for_collection( $item ); |
|
| 94 | + |
|
| 95 | + return rest_ensure_response( $data ); |
|
| 96 | + } |
|
| 97 | + |
|
| 98 | + /** |
|
| 99 | + * Prepare a report sales object for serialization. |
|
| 100 | + * |
|
| 101 | + * @param null $_ |
|
| 102 | + * @param WP_REST_Request $request Request object. |
|
| 103 | + * @return WP_REST_Response $response Response data. |
|
| 104 | + */ |
|
| 105 | + public function prepare_item_for_response( $_, $request ) { |
|
| 106 | + |
|
| 107 | + // Set report range. |
|
| 108 | + $this->report_range = $this->get_date_range( $request ); |
|
| 109 | + |
|
| 110 | + $report_data = $this->get_report_data(); |
|
| 111 | + $period_totals = array(); |
|
| 112 | + |
|
| 113 | + // Setup period totals by ensuring each period in the interval has data. |
|
| 114 | + $start_date = strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS; |
|
| 115 | + |
|
| 116 | + if ( 'month' === $this->groupby ) { |
|
| 117 | + $start_date = strtotime( date( 'Y-m-01', $start_date ) ); |
|
| 118 | + } |
|
| 119 | + |
|
| 120 | + for ( $i = 0; $i < $this->interval; $i++ ) { |
|
| 121 | + |
|
| 122 | + switch ( $this->groupby ) { |
|
| 123 | + case 'day' : |
|
| 124 | + $time = date( 'Y-m-d', strtotime( "+{$i} DAY", $start_date ) ); |
|
| 125 | + break; |
|
| 126 | + default : |
|
| 127 | + $time = date( 'Y-m', strtotime( "+{$i} MONTH", $start_date ) ); |
|
| 128 | + break; |
|
| 129 | + } |
|
| 130 | + |
|
| 131 | + // Set the defaults for each period. |
|
| 132 | + $period_totals[ $time ] = array( |
|
| 133 | + 'sales' => wpinv_round_amount( 0.00 ), |
|
| 134 | + 'invoices' => 0, |
|
| 135 | + 'refunds' => wpinv_round_amount( 0.00 ), |
|
| 136 | + 'items' => 0, |
|
| 137 | + 'refunded_items' => 0, |
|
| 138 | + 'tax' => wpinv_round_amount( 0.00 ), |
|
| 139 | + 'refunded_tax' => wpinv_round_amount( 0.00 ), |
|
| 140 | + 'subtotal' => wpinv_round_amount( 0.00 ), |
|
| 141 | + 'refunded_subtotal' => wpinv_round_amount( 0.00 ), |
|
| 142 | + 'fees' => wpinv_round_amount( 0.00 ), |
|
| 143 | + 'refunded_fees' => wpinv_round_amount( 0.00 ), |
|
| 144 | + 'discount' => wpinv_round_amount( 0.00 ), |
|
| 145 | + ); |
|
| 146 | + |
|
| 147 | + } |
|
| 148 | + |
|
| 149 | + // add total sales, total invoice count, total tax for each period |
|
| 150 | + $date_format = ( 'day' === $this->groupby ) ? 'Y-m-d' : 'Y-m'; |
|
| 151 | + foreach ( $report_data->invoices as $invoice ) { |
|
| 152 | + $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
| 153 | + |
|
| 154 | + if ( ! isset( $period_totals[ $time ] ) ) { |
|
| 155 | + continue; |
|
| 156 | + } |
|
| 157 | + |
|
| 158 | + $period_totals[ $time ]['sales'] = wpinv_round_amount( $invoice->total_sales ); |
|
| 159 | + $period_totals[ $time ]['tax'] = wpinv_round_amount( $invoice->total_tax ); |
|
| 160 | + $period_totals[ $time ]['subtotal'] = wpinv_round_amount( $invoice->subtotal ); |
|
| 161 | + $period_totals[ $time ]['fees'] = wpinv_round_amount( $invoice->total_fees ); |
|
| 162 | + |
|
| 163 | + } |
|
| 164 | + |
|
| 165 | + foreach ( $report_data->refunds as $invoice ) { |
|
| 166 | + $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
| 167 | + |
|
| 168 | + if ( ! isset( $period_totals[ $time ] ) ) { |
|
| 169 | + continue; |
|
| 170 | + } |
|
| 171 | + |
|
| 172 | + $period_totals[ $time ]['refunds'] = wpinv_round_amount( $invoice->total_sales ); |
|
| 173 | + $period_totals[ $time ]['refunded_tax'] = wpinv_round_amount( $invoice->total_tax ); |
|
| 174 | + $period_totals[ $time ]['refunded_subtotal'] = wpinv_round_amount( $invoice->subtotal ); |
|
| 175 | + $period_totals[ $time ]['refunded_fees'] = wpinv_round_amount( $invoice->total_fees ); |
|
| 176 | + |
|
| 177 | + } |
|
| 178 | + |
|
| 179 | + foreach ( $report_data->invoice_counts as $invoice ) { |
|
| 180 | + $time = date( $date_format, strtotime( $invoice->post_date ) ); |
|
| 181 | + |
|
| 182 | + if ( isset( $period_totals[ $time ] ) ) { |
|
| 183 | + $period_totals[ $time ]['invoices'] = (int) $invoice->count; |
|
| 184 | + } |
|
| 185 | + |
|
| 186 | + } |
|
| 187 | + |
|
| 188 | + // Add total invoice items for each period. |
|
| 189 | + foreach ( $report_data->invoice_items as $invoice_item ) { |
|
| 190 | + $time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $invoice_item->post_date ) ) : date( 'Y-m', strtotime( $invoice_item->post_date ) ); |
|
| 191 | + |
|
| 192 | + if ( isset( $period_totals[ $time ] ) ) { |
|
| 193 | + $period_totals[ $time ]['items'] = (int) $invoice_item->invoice_item_count; |
|
| 194 | + } |
|
| 195 | + |
|
| 196 | + } |
|
| 197 | + |
|
| 198 | + // Add total discount for each period. |
|
| 199 | + foreach ( $report_data->coupons as $discount ) { |
|
| 200 | + $time = ( 'day' === $this->groupby ) ? date( 'Y-m-d', strtotime( $discount->post_date ) ) : date( 'Y-m', strtotime( $discount->post_date ) ); |
|
| 201 | + |
|
| 202 | + if ( isset( $period_totals[ $time ] ) ) { |
|
| 203 | + $period_totals[ $time ]['discount'] = wpinv_round_amount( $discount->discount_amount ); |
|
| 204 | + } |
|
| 205 | + |
|
| 206 | + } |
|
| 207 | + |
|
| 208 | + $report_data->totals = $period_totals; |
|
| 209 | + $report_data->grouped_by = $this->groupby; |
|
| 210 | + $report_data->interval = max( $this->interval, 1 ); |
|
| 211 | + $report_data->currency = wpinv_get_currency(); |
|
| 212 | + $report_data->currency_symbol = wpinv_currency_symbol(); |
|
| 213 | + $report_data->currency_position = wpinv_currency_position(); |
|
| 214 | + $report_data->decimal_places = wpinv_decimals(); |
|
| 215 | + $report_data->thousands_sep = wpinv_thousands_separator(); |
|
| 216 | + $report_data->decimals_sep = wpinv_decimal_separator(); |
|
| 217 | + $report_data->start_date = date( 'Y-m-d', strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS ); |
|
| 218 | + $report_data->end_date = date( 'Y-m-d', strtotime( $this->report_range['before'] ) - DAY_IN_SECONDS ); |
|
| 219 | + $report_data->start_date_locale = getpaid_format_date( date( 'Y-m-d', strtotime( $this->report_range['after'] ) + DAY_IN_SECONDS ) ); |
|
| 220 | + $report_data->end_date_locale = getpaid_format_date( date( 'Y-m-d', strtotime( $this->report_range['before'] ) - DAY_IN_SECONDS ) ); |
|
| 221 | + $report_data->decimals_sep = wpinv_decimal_separator(); |
|
| 222 | + |
|
| 223 | + $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; |
|
| 224 | + $data = $report_data; |
|
| 225 | + unset( $data->invoice_counts, $data->invoices, $data->coupons, $data->refunds, $data->invoice_items ); |
|
| 226 | + $data = $this->add_additional_fields_to_object( (array) $data, $request ); |
|
| 227 | + $data = $this->filter_response_by_context( $data, $context ); |
|
| 228 | + |
|
| 229 | + // Wrap the data in a response object. |
|
| 230 | + $response = rest_ensure_response( $data ); |
|
| 231 | + $response->add_links( array( |
|
| 232 | + 'about' => array( |
|
| 233 | + 'href' => rest_url( sprintf( '%s/reports', $this->namespace ) ), |
|
| 234 | + ), |
|
| 235 | + ) ); |
|
| 236 | + |
|
| 237 | + return apply_filters( 'getpaid_rest_prepare_report_sales', $response, $report_data, $request ); |
|
| 238 | + } |
|
| 239 | + |
|
| 240 | + /** |
|
| 241 | + * Get report data. |
|
| 242 | + * |
|
| 243 | + * @return stdClass |
|
| 244 | + */ |
|
| 245 | + public function get_report_data() { |
|
| 246 | + if ( empty( $this->report_data ) ) { |
|
| 247 | + $this->query_report_data(); |
|
| 248 | + } |
|
| 249 | + return $this->report_data; |
|
| 250 | + } |
|
| 251 | + |
|
| 252 | + /** |
|
| 253 | + * Get all data needed for this report and store in the class. |
|
| 254 | + */ |
|
| 255 | + protected function query_report_data() { |
|
| 256 | + |
|
| 257 | + // Prepare reports. |
|
| 258 | + $this->report_data = (object) array( |
|
| 259 | + 'invoice_counts' => $this->query_invoice_counts(),//count, post_date |
|
| 260 | + 'coupons' => $this->query_coupon_counts(), // discount_amount, post_date |
|
| 261 | + 'invoice_items' => $this->query_item_counts(), // invoice_item_count, post_date |
|
| 262 | + 'refunded_items' => $this->count_refunded_items(), // invoice_item_count, post_date |
|
| 263 | + 'invoices' => $this->query_invoice_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date |
|
| 264 | + 'refunds' => $this->query_refunded_totals(), // total_sales, total_tax, total_discount, total_fees, subtotal, post_date |
|
| 265 | + 'previous_range' => $this->previous_range, |
|
| 266 | + ); |
|
| 267 | + |
|
| 268 | + // Calculated totals. |
|
| 269 | + $this->report_data->total_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_tax' ) ) ); |
|
| 270 | + $this->report_data->total_sales = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_sales' ) ) ); |
|
| 271 | + $this->report_data->total_discount = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_discount' ) ) ); |
|
| 272 | + $this->report_data->total_fees = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'total_fees' ) ) ); |
|
| 273 | + $this->report_data->subtotal = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->invoices, 'subtotal' ) ) ); |
|
| 274 | + $this->report_data->net_sales = wpinv_round_amount( $this->report_data->total_sales - max( 0, $this->report_data->total_tax ) ); |
|
| 275 | + $this->report_data->total_refunded_tax = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_tax' ) ) ); |
|
| 276 | + $this->report_data->total_refunds = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_sales' ) ) ); |
|
| 277 | + $this->report_data->refunded_discount = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_discount' ) ) ); |
|
| 278 | + $this->report_data->refunded_fees = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'total_fees' ) ) ); |
|
| 279 | + $this->report_data->refunded_subtotal = wpinv_round_amount( array_sum( wp_list_pluck( $this->report_data->refunds, 'subtotal' ) ) ); |
|
| 280 | + $this->report_data->net_refunds = wpinv_round_amount( $this->report_data->total_refunds + max( 0, $this->report_data->total_refunded_tax ) ); |
|
| 281 | + |
|
| 282 | + |
|
| 283 | + // Calculate average based on net. |
|
| 284 | + $this->report_data->average_sales = wpinv_round_amount( $this->report_data->net_sales / max( $this->interval, 1 ), 2 ); |
|
| 285 | + $this->report_data->average_total_sales = wpinv_round_amount( $this->report_data->total_sales / max( $this->interval, 1 ), 2 ); |
|
| 286 | + |
|
| 287 | + // Total invoices in this period, even if refunded. |
|
| 288 | + $this->report_data->total_invoices = absint( array_sum( wp_list_pluck( $this->report_data->invoice_counts, 'count' ) ) ); |
|
| 289 | + |
|
| 290 | + // Items invoiced in this period, even if refunded. |
|
| 291 | + $this->report_data->total_items = absint( array_sum( wp_list_pluck( $this->report_data->invoice_items, 'invoice_item_count' ) ) ); |
|
| 292 | + |
|
| 293 | + // 3rd party filtering of report data |
|
| 294 | + $this->report_data = apply_filters( 'getpaid_rest_api_filter_report_data', $this->report_data ); |
|
| 295 | + } |
|
| 296 | + |
|
| 297 | + /** |
|
| 298 | + * Prepares invoice counts. |
|
| 299 | + * |
|
| 300 | + * @return array. |
|
| 301 | + */ |
|
| 302 | + protected function query_invoice_counts() { |
|
| 303 | + |
|
| 304 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 305 | + array( |
|
| 306 | + 'data' => array( |
|
| 307 | + 'ID' => array( |
|
| 308 | + 'type' => 'post_data', |
|
| 309 | + 'function' => 'COUNT', |
|
| 310 | + 'name' => 'count', |
|
| 311 | + 'distinct' => true, |
|
| 312 | + ), |
|
| 313 | + 'post_date' => array( |
|
| 314 | + 'type' => 'post_data', |
|
| 315 | + 'function' => '', |
|
| 316 | + 'name' => 'post_date', |
|
| 317 | + ), |
|
| 318 | + ), |
|
| 319 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 320 | + 'order_by' => 'post_date ASC', |
|
| 321 | + 'query_type' => 'get_results', |
|
| 322 | + 'filter_range' => $this->report_range, |
|
| 323 | + 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
| 324 | + ) |
|
| 325 | + ); |
|
| 326 | + |
|
| 327 | + } |
|
| 328 | + |
|
| 329 | + /** |
|
| 330 | + * Prepares coupon counts. |
|
| 331 | + * |
|
| 332 | + * @return array. |
|
| 333 | + */ |
|
| 334 | + protected function query_coupon_counts() { |
|
| 335 | + |
|
| 336 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 337 | + array( |
|
| 338 | + 'data' => array( |
|
| 339 | + 'discount' => array( |
|
| 340 | + 'type' => 'invoice_data', |
|
| 341 | + 'function' => 'SUM', |
|
| 342 | + 'name' => 'discount_amount', |
|
| 343 | + ), |
|
| 344 | + 'post_date' => array( |
|
| 345 | + 'type' => 'post_data', |
|
| 346 | + 'function' => '', |
|
| 347 | + 'name' => 'post_date', |
|
| 348 | + ), |
|
| 349 | + ), |
|
| 350 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 351 | + 'order_by' => 'post_date ASC', |
|
| 352 | + 'query_type' => 'get_results', |
|
| 353 | + 'filter_range' => $this->report_range, |
|
| 354 | + 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
| 355 | + ) |
|
| 356 | + ); |
|
| 357 | + |
|
| 358 | + } |
|
| 359 | + |
|
| 360 | + /** |
|
| 361 | + * Prepares item counts. |
|
| 362 | + * |
|
| 363 | + * @return array. |
|
| 364 | + */ |
|
| 365 | + protected function query_item_counts() { |
|
| 366 | + |
|
| 367 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 368 | + array( |
|
| 369 | + 'data' => array( |
|
| 370 | + 'quantity' => array( |
|
| 371 | + 'type' => 'invoice_item', |
|
| 372 | + 'function' => 'SUM', |
|
| 373 | + 'name' => 'invoice_item_count', |
|
| 374 | + ), |
|
| 375 | + 'post_date' => array( |
|
| 376 | + 'type' => 'post_data', |
|
| 377 | + 'function' => '', |
|
| 378 | + 'name' => 'post_date', |
|
| 379 | + ), |
|
| 380 | + ), |
|
| 381 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 382 | + 'order_by' => 'post_date ASC', |
|
| 383 | + 'query_type' => 'get_results', |
|
| 384 | + 'filter_range' => $this->report_range, |
|
| 385 | + 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-refunded', 'wpi-renewal' ), |
|
| 386 | + ) |
|
| 387 | + ); |
|
| 388 | + |
|
| 389 | + } |
|
| 390 | + |
|
| 391 | + /** |
|
| 392 | + * Prepares refunded item counts. |
|
| 393 | + * |
|
| 394 | + * @return array. |
|
| 395 | + */ |
|
| 396 | + protected function count_refunded_items() { |
|
| 397 | + |
|
| 398 | + return (int) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 399 | + array( |
|
| 400 | + 'data' => array( |
|
| 401 | + 'quantity' => array( |
|
| 402 | + 'type' => 'invoice_item', |
|
| 403 | + 'function' => 'SUM', |
|
| 404 | + 'name' => 'invoice_item_count', |
|
| 405 | + ), |
|
| 406 | + ), |
|
| 407 | + 'query_type' => 'get_var', |
|
| 408 | + 'filter_range' => $this->report_range, |
|
| 409 | + 'invoice_status' => array( 'wpi-refunded' ), |
|
| 410 | + ) |
|
| 411 | + ); |
|
| 412 | + |
|
| 413 | + } |
|
| 414 | + |
|
| 415 | + /** |
|
| 416 | + * Prepares daily invoice totals. |
|
| 417 | + * |
|
| 418 | + * @return array. |
|
| 419 | + */ |
|
| 420 | + protected function query_invoice_totals() { |
|
| 421 | + |
|
| 422 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 423 | + array( |
|
| 424 | + 'data' => array( |
|
| 425 | + 'total' => array( |
|
| 426 | + 'type' => 'invoice_data', |
|
| 427 | + 'function' => 'SUM', |
|
| 428 | + 'name' => 'total_sales', |
|
| 429 | + ), |
|
| 430 | + 'tax' => array( |
|
| 431 | + 'type' => 'invoice_data', |
|
| 432 | + 'function' => 'SUM', |
|
| 433 | + 'name' => 'total_tax', |
|
| 434 | + ), |
|
| 435 | + 'discount' => array( |
|
| 436 | + 'type' => 'invoice_data', |
|
| 437 | + 'function' => 'SUM', |
|
| 438 | + 'name' => 'total_discount', |
|
| 439 | + ), |
|
| 440 | + 'fees_total' => array( |
|
| 441 | + 'type' => 'invoice_data', |
|
| 442 | + 'function' => 'SUM', |
|
| 443 | + 'name' => 'total_fees', |
|
| 444 | + ), |
|
| 445 | + 'subtotal' => array( |
|
| 446 | + 'type' => 'invoice_data', |
|
| 447 | + 'function' => 'SUM', |
|
| 448 | + 'name' => 'subtotal', |
|
| 449 | + ), |
|
| 450 | + 'post_date' => array( |
|
| 451 | + 'type' => 'post_data', |
|
| 452 | + 'function' => '', |
|
| 453 | + 'name' => 'post_date', |
|
| 454 | + ), |
|
| 455 | + ), |
|
| 456 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 457 | + 'order_by' => 'post_date ASC', |
|
| 458 | + 'query_type' => 'get_results', |
|
| 459 | + 'filter_range' => $this->report_range, |
|
| 460 | + 'invoice_status' => array( 'publish', 'wpi-processing', 'wpi-onhold', 'wpi-renewal' ), |
|
| 461 | + ) |
|
| 462 | + ); |
|
| 463 | + |
|
| 464 | + } |
|
| 465 | + |
|
| 466 | + /** |
|
| 467 | + * Prepares daily invoice totals. |
|
| 468 | + * |
|
| 469 | + * @return array. |
|
| 470 | + */ |
|
| 471 | + protected function query_refunded_totals() { |
|
| 472 | + |
|
| 473 | + return (array) GetPaid_Reports_Helper::get_invoice_report_data( |
|
| 474 | + array( |
|
| 475 | + 'data' => array( |
|
| 476 | + 'total' => array( |
|
| 477 | + 'type' => 'invoice_data', |
|
| 478 | + 'function' => 'SUM', |
|
| 479 | + 'name' => 'total_sales', |
|
| 480 | + ), |
|
| 481 | + 'tax' => array( |
|
| 482 | + 'type' => 'invoice_data', |
|
| 483 | + 'function' => 'SUM', |
|
| 484 | + 'name' => 'total_tax', |
|
| 485 | + ), |
|
| 486 | + 'discount' => array( |
|
| 487 | + 'type' => 'invoice_data', |
|
| 488 | + 'function' => 'SUM', |
|
| 489 | + 'name' => 'total_discount', |
|
| 490 | + ), |
|
| 491 | + 'fees_total' => array( |
|
| 492 | + 'type' => 'invoice_data', |
|
| 493 | + 'function' => 'SUM', |
|
| 494 | + 'name' => 'total_fees', |
|
| 495 | + ), |
|
| 496 | + 'subtotal' => array( |
|
| 497 | + 'type' => 'invoice_data', |
|
| 498 | + 'function' => 'SUM', |
|
| 499 | + 'name' => 'subtotal', |
|
| 500 | + ), |
|
| 501 | + 'post_date' => array( |
|
| 502 | + 'type' => 'post_data', |
|
| 503 | + 'function' => '', |
|
| 504 | + 'name' => 'post_date', |
|
| 505 | + ), |
|
| 506 | + ), |
|
| 507 | + 'group_by' => $this->get_group_by_sql( 'posts.post_date' ), |
|
| 508 | + 'order_by' => 'post_date ASC', |
|
| 509 | + 'query_type' => 'get_results', |
|
| 510 | + 'filter_range' => $this->report_range, |
|
| 511 | + 'invoice_status' => array( 'wpi-refunded' ), |
|
| 512 | + ) |
|
| 513 | + ); |
|
| 514 | + |
|
| 515 | + } |
|
| 516 | + |
|
| 517 | + /** |
|
| 518 | + * Get the Report's schema, conforming to JSON Schema. |
|
| 519 | + * |
|
| 520 | + * @return array |
|
| 521 | + */ |
|
| 522 | + public function get_item_schema() { |
|
| 523 | + |
|
| 524 | + $schema = array( |
|
| 525 | + '$schema' => 'http://json-schema.org/draft-04/schema#', |
|
| 526 | + 'title' => 'sales_report', |
|
| 527 | + 'type' => 'object', |
|
| 528 | + 'properties' => array( |
|
| 529 | + 'total_sales' => array( |
|
| 530 | + 'description' => __( 'Gross sales in the period.', 'invoicing' ), |
|
| 531 | + 'type' => 'string', |
|
| 532 | + 'context' => array( 'view' ), |
|
| 533 | + 'readonly' => true, |
|
| 534 | + ), |
|
| 535 | + 'net_sales' => array( |
|
| 536 | + 'description' => __( 'Net sales in the period.', 'invoicing' ), |
|
| 537 | + 'type' => 'string', |
|
| 538 | + 'context' => array( 'view' ), |
|
| 539 | + 'readonly' => true, |
|
| 540 | + ), |
|
| 541 | + 'average_sales' => array( |
|
| 542 | + 'description' => __( 'Average net daily sales.', 'invoicing' ), |
|
| 543 | + 'type' => 'string', |
|
| 544 | + 'context' => array( 'view' ), |
|
| 545 | + 'readonly' => true, |
|
| 546 | + ), |
|
| 547 | + 'average_total_sales' => array( |
|
| 548 | + 'description' => __( 'Average gross daily sales.', 'invoicing' ), |
|
| 549 | + 'type' => 'string', |
|
| 550 | + 'context' => array( 'view' ), |
|
| 551 | + 'readonly' => true, |
|
| 552 | + ), |
|
| 553 | + 'total_invoices' => array( |
|
| 554 | + 'description' => __( 'Number of paid invoices.', 'invoicing' ), |
|
| 555 | + 'type' => 'integer', |
|
| 556 | + 'context' => array( 'view' ), |
|
| 557 | + 'readonly' => true, |
|
| 558 | + ), |
|
| 559 | + 'total_items' => array( |
|
| 560 | + 'description' => __( 'Number of items purchased.', 'invoicing' ), |
|
| 561 | + 'type' => 'integer', |
|
| 562 | + 'context' => array( 'view' ), |
|
| 563 | + 'readonly' => true, |
|
| 564 | + ), |
|
| 565 | + 'refunded_items' => array( |
|
| 566 | + 'description' => __( 'Number of items refunded.', 'invoicing' ), |
|
| 567 | + 'type' => 'integer', |
|
| 568 | + 'context' => array( 'view' ), |
|
| 569 | + 'readonly' => true, |
|
| 570 | + ), |
|
| 571 | + 'total_tax' => array( |
|
| 572 | + 'description' => __( 'Total charged for taxes.', 'invoicing' ), |
|
| 573 | + 'type' => 'string', |
|
| 574 | + 'context' => array( 'view' ), |
|
| 575 | + 'readonly' => true, |
|
| 576 | + ), |
|
| 577 | + 'total_refunded_tax' => array( |
|
| 578 | + 'description' => __( 'Total refunded for taxes.', 'invoicing' ), |
|
| 579 | + 'type' => 'string', |
|
| 580 | + 'context' => array( 'view' ), |
|
| 581 | + 'readonly' => true, |
|
| 582 | + ), |
|
| 583 | + 'total_fees' => array( |
|
| 584 | + 'description' => __( 'Total fees charged.', 'invoicing' ), |
|
| 585 | + 'type' => 'string', |
|
| 586 | + 'context' => array( 'view' ), |
|
| 587 | + 'readonly' => true, |
|
| 588 | + ), |
|
| 589 | + 'total_refunds' => array( |
|
| 590 | + 'description' => __( 'Total of refunded invoices.', 'invoicing' ), |
|
| 591 | + 'type' => 'integer', |
|
| 592 | + 'context' => array( 'view' ), |
|
| 593 | + 'readonly' => true, |
|
| 594 | + ), |
|
| 595 | + 'net_refunds' => array( |
|
| 596 | + 'description' => __( 'Net of refunded invoices.', 'invoicing' ), |
|
| 597 | + 'type' => 'integer', |
|
| 598 | + 'context' => array( 'view' ), |
|
| 599 | + 'readonly' => true, |
|
| 600 | + ), |
|
| 601 | + 'total_discount' => array( |
|
| 602 | + 'description' => __( 'Total of discounts used.', 'invoicing' ), |
|
| 603 | + 'type' => 'integer', |
|
| 604 | + 'context' => array( 'view' ), |
|
| 605 | + 'readonly' => true, |
|
| 606 | + ), |
|
| 607 | + 'totals' => array( |
|
| 608 | + 'description' => __( 'Totals.', 'invoicing' ), |
|
| 609 | + 'type' => 'array', |
|
| 610 | + 'items' => array( |
|
| 611 | + 'type' => 'array', |
|
| 612 | + ), |
|
| 613 | + 'context' => array( 'view' ), |
|
| 614 | + 'readonly' => true, |
|
| 615 | + ), |
|
| 616 | + 'interval' => array( |
|
| 617 | + 'description' => __( 'Number of months/days in the report period.', 'invoicing' ), |
|
| 618 | + 'type' => 'integer', |
|
| 619 | + 'context' => array( 'view' ), |
|
| 620 | + 'readonly' => true, |
|
| 621 | + ), |
|
| 622 | + 'previous_range' => array( |
|
| 623 | + 'description' => __( 'The previous report period.', 'invoicing' ), |
|
| 624 | + 'type' => 'array', |
|
| 625 | + 'items' => array( |
|
| 626 | + 'type' => 'string', |
|
| 627 | + ), |
|
| 628 | + 'context' => array( 'view' ), |
|
| 629 | + 'readonly' => true, |
|
| 630 | + ), |
|
| 631 | + 'grouped_by' => array( |
|
| 632 | + 'description' => __( 'The period used to group the totals.', 'invoicing' ), |
|
| 633 | + 'type' => 'string', |
|
| 634 | + 'context' => array( 'view' ), |
|
| 635 | + 'enum' => array( 'day', 'month' ), |
|
| 636 | + 'readonly' => true, |
|
| 637 | + ), |
|
| 638 | + 'currency' => array( |
|
| 639 | + 'description' => __( 'The default store currency.', 'invoicing' ), |
|
| 640 | + 'type' => 'string', |
|
| 641 | + 'context' => array( 'view' ), |
|
| 642 | + 'readonly' => true, |
|
| 643 | + ), |
|
| 644 | + 'currency_symbol' => array( |
|
| 645 | + 'description' => __( 'The default store currency symbol.', 'invoicing' ), |
|
| 646 | + 'type' => 'string', |
|
| 647 | + 'context' => array( 'view' ), |
|
| 648 | + 'readonly' => true, |
|
| 649 | + ), |
|
| 650 | + 'currency_position' => array( |
|
| 651 | + 'description' => __( 'The default store currency position.', 'invoicing' ), |
|
| 652 | + 'type' => 'string', |
|
| 653 | + 'context' => array( 'view' ), |
|
| 654 | + 'readonly' => true, |
|
| 655 | + ), |
|
| 656 | + 'decimal_places' => array( |
|
| 657 | + 'description' => __( 'The default store decimal places.', 'invoicing' ), |
|
| 658 | + 'type' => 'string', |
|
| 659 | + 'context' => array( 'view' ), |
|
| 660 | + 'readonly' => true, |
|
| 661 | + ), |
|
| 662 | + 'thousands_sep' => array( |
|
| 663 | + 'description' => __( 'The default store thousands separator.', 'invoicing' ), |
|
| 664 | + 'type' => 'string', |
|
| 665 | + 'context' => array( 'view' ), |
|
| 666 | + 'readonly' => true, |
|
| 667 | + ), |
|
| 668 | + 'decimals_sep' => array( |
|
| 669 | + 'description' => __( 'The default store decimals separator.', 'invoicing' ), |
|
| 670 | + 'type' => 'string', |
|
| 671 | + 'context' => array( 'view' ), |
|
| 672 | + 'readonly' => true, |
|
| 673 | + ), |
|
| 674 | + ), |
|
| 675 | + ); |
|
| 676 | + |
|
| 677 | + return $this->add_additional_fields_schema( $schema ); |
|
| 678 | + |
|
| 679 | + } |
|
| 680 | 680 | |
| 681 | 681 | } |
@@ -16,577 +16,577 @@ |
||
| 16 | 16 | */ |
| 17 | 17 | class GetPaid_REST_Date_Based_Controller extends GetPaid_REST_Controller { |
| 18 | 18 | |
| 19 | - /** |
|
| 20 | - * Group response items by day or month. |
|
| 21 | - * |
|
| 22 | - * @var string |
|
| 23 | - */ |
|
| 24 | - public $groupby = 'day'; |
|
| 25 | - |
|
| 26 | - /** |
|
| 27 | - * Returns an array with arguments to request the previous report. |
|
| 28 | - * |
|
| 29 | - * @var array |
|
| 30 | - */ |
|
| 31 | - public $previous_range = array(); |
|
| 32 | - |
|
| 33 | - /** |
|
| 34 | - * The period interval. |
|
| 35 | - * |
|
| 36 | - * @var int |
|
| 37 | - */ |
|
| 38 | - public $interval; |
|
| 39 | - |
|
| 40 | - /** |
|
| 41 | - * Retrieves the before and after dates. |
|
| 42 | - * |
|
| 43 | - * @param WP_REST_Request $request Request object. |
|
| 44 | - * @return array The appropriate date range. |
|
| 45 | - */ |
|
| 46 | - public function get_date_range( $request ) { |
|
| 47 | - |
|
| 48 | - // If not supported, assume all time. |
|
| 49 | - if ( ! in_array( $request['period'], array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days', '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year' ) ) ) { |
|
| 50 | - $request['period'] = '7_days'; |
|
| 51 | - } |
|
| 52 | - |
|
| 53 | - $date_range = call_user_func( array( $this, 'get_' . $request['period'] . '_date_range' ), $request ); |
|
| 54 | - $this->prepare_interval( $date_range ); |
|
| 55 | - |
|
| 56 | - return $date_range; |
|
| 57 | - |
|
| 58 | - } |
|
| 59 | - |
|
| 60 | - /** |
|
| 61 | - * Groups by month or days. |
|
| 62 | - * |
|
| 63 | - * @param array $range Date range. |
|
| 64 | - * @return array The appropriate date range. |
|
| 65 | - */ |
|
| 66 | - public function prepare_interval( $range ) { |
|
| 67 | - |
|
| 68 | - $before = strtotime( $range['before'] ) - DAY_IN_SECONDS; |
|
| 69 | - $after = strtotime( $range['after'] ) + DAY_IN_SECONDS; |
|
| 70 | - if ( 'day' === $this->groupby ) { |
|
| 71 | - $difference = max( DAY_IN_SECONDS, ( DAY_IN_SECONDS + $before - $after ) ); // Prevent division by 0; |
|
| 72 | - $this->interval = absint( ceil( max( 1, $difference / DAY_IN_SECONDS ) ) ); |
|
| 73 | - return; |
|
| 74 | - } |
|
| 75 | - |
|
| 76 | - $this->interval = 0; |
|
| 77 | - $min_date = strtotime( date( 'Y-m-01', $after ) ); |
|
| 78 | - |
|
| 79 | - while ( $min_date <= $before ) { |
|
| 80 | - $this->interval ++; |
|
| 81 | - $min_date = strtotime( '+1 MONTH', $min_date ); |
|
| 82 | - } |
|
| 83 | - |
|
| 84 | - $this->interval = max( 1, $this->interval ); |
|
| 85 | - |
|
| 86 | - } |
|
| 87 | - |
|
| 88 | - /** |
|
| 89 | - * Retrieves a custom date range. |
|
| 90 | - * |
|
| 91 | - * @param WP_REST_Request $request Request object. |
|
| 92 | - * @return array The appropriate date range. |
|
| 93 | - */ |
|
| 94 | - public function get_custom_date_range( $request ) { |
|
| 95 | - |
|
| 96 | - $after = max( strtotime( '-20 years' ), strtotime( sanitize_text_field( $request['after'] ) ) ); |
|
| 97 | - $before = strtotime( '+1 day', current_time( 'timestamp' ) ); |
|
| 98 | - |
|
| 99 | - if ( ! empty( $request['before'] ) ) { |
|
| 100 | - $before = min( $before, strtotime( sanitize_text_field( $request['before'] ) ) ); |
|
| 101 | - } |
|
| 102 | - |
|
| 103 | - // 3 months max for day view |
|
| 104 | - if ( floor( ( $before - $after ) / MONTH_IN_SECONDS ) > 3 ) { |
|
| 105 | - $this->groupby = 'month'; |
|
| 106 | - } |
|
| 107 | - |
|
| 108 | - // Set the previous date range. |
|
| 109 | - $difference = $before - $after; |
|
| 110 | - $this->previous_range = array( |
|
| 111 | - 'period' => 'custom', |
|
| 112 | - 'before' => date( 'Y-m-d', $before - $difference ), |
|
| 113 | - 'after' => date( 'Y-m-d', $after - $difference ), |
|
| 114 | - ); |
|
| 115 | - |
|
| 116 | - // Generate the report. |
|
| 117 | - return array( |
|
| 118 | - 'before' => date( 'Y-m-d', $before ), |
|
| 119 | - 'after' => date( 'Y-m-d', $after ), |
|
| 120 | - ); |
|
| 121 | - |
|
| 122 | - } |
|
| 123 | - |
|
| 124 | - /** |
|
| 125 | - * Retrieves todays date range. |
|
| 126 | - * |
|
| 127 | - * @return array The appropriate date range. |
|
| 128 | - */ |
|
| 129 | - public function get_today_date_range() { |
|
| 130 | - |
|
| 131 | - // Set the previous date range. |
|
| 132 | - $this->previous_range = array( |
|
| 133 | - 'period' => 'yesterday', |
|
| 134 | - ); |
|
| 135 | - |
|
| 136 | - // Generate the report. |
|
| 137 | - return array( |
|
| 138 | - 'before' => date( 'Y-m-d', strtotime( '+1 day', current_time( 'timestamp' ) ) ), |
|
| 139 | - 'after' => date( 'Y-m-d', strtotime( '-1 day', current_time( 'timestamp' ) ) ), |
|
| 140 | - ); |
|
| 141 | - |
|
| 142 | - } |
|
| 143 | - |
|
| 144 | - /** |
|
| 145 | - * Retrieves yesterdays date range. |
|
| 146 | - * |
|
| 147 | - * @return array The appropriate date range. |
|
| 148 | - */ |
|
| 149 | - public function get_yesterday_date_range() { |
|
| 150 | - |
|
| 151 | - // Set the previous date range. |
|
| 152 | - $this->previous_range = array( |
|
| 153 | - 'period' => 'custom', |
|
| 154 | - 'before' => date( 'Y-m-d', strtotime( '-1 day', current_time( 'timestamp' ) ) ), |
|
| 155 | - 'after' => date( 'Y-m-d', strtotime( '-3 days', current_time( 'timestamp' ) ) ), |
|
| 156 | - ); |
|
| 157 | - |
|
| 158 | - // Generate the report. |
|
| 159 | - return array( |
|
| 160 | - 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 161 | - 'after' => date( 'Y-m-d', strtotime( '-2 days', current_time( 'timestamp' ) ) ), |
|
| 162 | - ); |
|
| 163 | - |
|
| 164 | - } |
|
| 165 | - |
|
| 166 | - /** |
|
| 167 | - * Retrieves this week's date range. |
|
| 168 | - * |
|
| 169 | - * @return array The appropriate date range. |
|
| 170 | - */ |
|
| 171 | - public function get_week_date_range() { |
|
| 172 | - |
|
| 173 | - // Set the previous date range. |
|
| 174 | - $this->previous_range = array( |
|
| 175 | - 'period' => 'last_week', |
|
| 176 | - ); |
|
| 177 | - |
|
| 178 | - // Generate the report. |
|
| 179 | - return array( |
|
| 180 | - 'before' => date( 'Y-m-d', strtotime( 'sunday last week', current_time( 'timestamp' ) ) + 8 * DAY_IN_SECONDS ), |
|
| 181 | - 'after' => date( 'Y-m-d', strtotime( 'sunday last week', current_time( 'timestamp' ) ) ), |
|
| 182 | - ); |
|
| 183 | - |
|
| 184 | - } |
|
| 185 | - |
|
| 186 | - /** |
|
| 187 | - * Retrieves last week's date range. |
|
| 188 | - * |
|
| 189 | - * @return array The appropriate date range. |
|
| 190 | - */ |
|
| 191 | - public function get_last_week_date_range() { |
|
| 192 | - |
|
| 193 | - // Set the previous date range. |
|
| 194 | - $this->previous_range = array( |
|
| 195 | - 'period' => 'custom', |
|
| 196 | - 'before' => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' ) ) ), |
|
| 197 | - 'after' => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' ) ) - 8 * DAY_IN_SECONDS ), |
|
| 198 | - ); |
|
| 199 | - |
|
| 200 | - // Generate the report. |
|
| 201 | - return array( |
|
| 202 | - 'before' => date( 'Y-m-d', strtotime( 'monday this week', current_time( 'timestamp' ) ) ), |
|
| 203 | - 'after' => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' ) ) - DAY_IN_SECONDS ), |
|
| 204 | - ); |
|
| 205 | - |
|
| 206 | - } |
|
| 207 | - |
|
| 208 | - /** |
|
| 209 | - * Retrieves last 7 days date range. |
|
| 210 | - * |
|
| 211 | - * @return array The appropriate date range. |
|
| 212 | - */ |
|
| 213 | - public function get_7_days_date_range() { |
|
| 214 | - |
|
| 215 | - // Set the previous date range. |
|
| 216 | - $this->previous_range = array( |
|
| 217 | - 'period' => 'custom', |
|
| 218 | - 'before' => date( 'Y-m-d', strtotime( '-7 days', current_time( 'timestamp' ) ) ), |
|
| 219 | - 'after' => date( 'Y-m-d', strtotime( '-15 days', current_time( 'timestamp' ) ) ), |
|
| 220 | - ); |
|
| 221 | - |
|
| 222 | - // Generate the report. |
|
| 223 | - return array( |
|
| 224 | - 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 225 | - 'after' => date( 'Y-m-d', strtotime( '-8 days', current_time( 'timestamp' ) ) ), |
|
| 226 | - ); |
|
| 227 | - |
|
| 228 | - } |
|
| 229 | - |
|
| 230 | - /** |
|
| 231 | - * Retrieves last 30 days date range. |
|
| 232 | - * |
|
| 233 | - * @return array The appropriate date range. |
|
| 234 | - */ |
|
| 235 | - public function get_30_days_date_range() { |
|
| 236 | - |
|
| 237 | - // Set the previous date range. |
|
| 238 | - $this->previous_range = array( |
|
| 239 | - 'period' => 'custom', |
|
| 240 | - 'before' => date( 'Y-m-d', strtotime( '-30 days', current_time( 'timestamp' ) ) ), |
|
| 241 | - 'after' => date( 'Y-m-d', strtotime( '-61 days', current_time( 'timestamp' ) ) ), |
|
| 242 | - ); |
|
| 243 | - |
|
| 244 | - // Generate the report. |
|
| 245 | - return array( |
|
| 246 | - 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 247 | - 'after' => date( 'Y-m-d', strtotime( '-31 days', current_time( 'timestamp' ) ) ), |
|
| 248 | - ); |
|
| 249 | - |
|
| 250 | - } |
|
| 251 | - |
|
| 252 | - /** |
|
| 253 | - * Retrieves last 90 days date range. |
|
| 254 | - * |
|
| 255 | - * @return array The appropriate date range. |
|
| 256 | - */ |
|
| 257 | - public function get_90_days_date_range() { |
|
| 258 | - |
|
| 259 | - $this->groupby = 'month'; |
|
| 260 | - |
|
| 261 | - // Set the previous date range. |
|
| 262 | - $this->previous_range = array( |
|
| 263 | - 'period' => 'custom', |
|
| 264 | - 'before' => date( 'Y-m-d', strtotime( '-90 days', current_time( 'timestamp' ) ) ), |
|
| 265 | - 'after' => date( 'Y-m-d', strtotime( '-181 days', current_time( 'timestamp' ) ) ), |
|
| 266 | - ); |
|
| 267 | - |
|
| 268 | - // Generate the report. |
|
| 269 | - return array( |
|
| 270 | - 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 271 | - 'after' => date( 'Y-m-d', strtotime( '-91 days', current_time( 'timestamp' ) ) ), |
|
| 272 | - ); |
|
| 273 | - |
|
| 274 | - } |
|
| 275 | - |
|
| 276 | - /** |
|
| 277 | - * Retrieves last 180 days date range. |
|
| 278 | - * |
|
| 279 | - * @return array The appropriate date range. |
|
| 280 | - */ |
|
| 281 | - public function get_180_days_date_range() { |
|
| 282 | - |
|
| 283 | - $this->groupby = 'month'; |
|
| 284 | - |
|
| 285 | - // Set the previous date range. |
|
| 286 | - $this->previous_range = array( |
|
| 287 | - 'period' => 'custom', |
|
| 288 | - 'before' => date( 'Y-m-d', strtotime( '-180 days', current_time( 'timestamp' ) ) ), |
|
| 289 | - 'after' => date( 'Y-m-d', strtotime( '-361 days', current_time( 'timestamp' ) ) ), |
|
| 290 | - ); |
|
| 291 | - |
|
| 292 | - // Generate the report. |
|
| 293 | - return array( |
|
| 294 | - 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 295 | - 'after' => date( 'Y-m-d', strtotime( '-181 days', current_time( 'timestamp' ) ) ), |
|
| 296 | - ); |
|
| 297 | - |
|
| 298 | - } |
|
| 299 | - |
|
| 300 | - /** |
|
| 301 | - * Retrieves last 60 days date range. |
|
| 302 | - * |
|
| 303 | - * @return array The appropriate date range. |
|
| 304 | - */ |
|
| 305 | - public function get_60_days_date_range() { |
|
| 306 | - |
|
| 307 | - // Set the previous date range. |
|
| 308 | - $this->previous_range = array( |
|
| 309 | - 'period' => 'custom', |
|
| 310 | - 'before' => date( 'Y-m-d', strtotime( '-60 days', current_time( 'timestamp' ) ) ), |
|
| 311 | - 'after' => date( 'Y-m-d', strtotime( '-121 days', current_time( 'timestamp' ) ) ), |
|
| 312 | - ); |
|
| 313 | - |
|
| 314 | - // Generate the report. |
|
| 315 | - return array( |
|
| 316 | - 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 317 | - 'after' => date( 'Y-m-d', strtotime( '-61 days', current_time( 'timestamp' ) ) ), |
|
| 318 | - ); |
|
| 319 | - |
|
| 320 | - } |
|
| 321 | - |
|
| 322 | - /** |
|
| 323 | - * Retrieves this month date range. |
|
| 324 | - * |
|
| 325 | - * @return array The appropriate date range. |
|
| 326 | - */ |
|
| 327 | - public function get_month_date_range() { |
|
| 328 | - |
|
| 329 | - // Set the previous date range. |
|
| 330 | - $this->previous_range = array( |
|
| 331 | - 'period' => 'last_month', |
|
| 332 | - ); |
|
| 333 | - |
|
| 334 | - // Generate the report. |
|
| 335 | - return array( |
|
| 336 | - 'before' => date( 'Y-m-01', strtotime( 'next month', current_time( 'timestamp' ) ) ), |
|
| 337 | - 'after' => date( 'Y-m-t', strtotime( 'last month', current_time( 'timestamp' ) ) ), |
|
| 338 | - ); |
|
| 339 | - |
|
| 340 | - } |
|
| 341 | - |
|
| 342 | - /** |
|
| 343 | - * Retrieves last month's date range. |
|
| 344 | - * |
|
| 345 | - * @return array The appropriate date range. |
|
| 346 | - */ |
|
| 347 | - public function get_last_month_date_range() { |
|
| 348 | - |
|
| 349 | - // Set the previous date range. |
|
| 350 | - $this->previous_range = array( |
|
| 351 | - 'period' => 'custom', |
|
| 352 | - 'before' => date( 'Y-m-1', strtotime( 'last month', current_time( 'timestamp' ) ) ), |
|
| 353 | - 'after' => date( 'Y-m-t', strtotime( "-3 months", current_time( 'timestamp' ) ) ), |
|
| 354 | - ); |
|
| 355 | - |
|
| 356 | - // Generate the report. |
|
| 357 | - return array( |
|
| 358 | - 'before' => date( 'Y-m-1', current_time( 'timestamp' ) ), |
|
| 359 | - 'after' => date( 'Y-m-t', strtotime( "-2 months", current_time( 'timestamp' ) ) ), |
|
| 360 | - ); |
|
| 361 | - |
|
| 362 | - } |
|
| 363 | - |
|
| 364 | - /** |
|
| 365 | - * Retrieves this quarter date range. |
|
| 366 | - * |
|
| 367 | - * @return array The available quarters. |
|
| 368 | - */ |
|
| 369 | - public function get_quarters() { |
|
| 370 | - |
|
| 371 | - $last_year = (int) date('Y') - 1; |
|
| 372 | - $next_year = (int) date('Y') + 1; |
|
| 373 | - $year = (int) date('Y'); |
|
| 374 | - return array( |
|
| 375 | - |
|
| 376 | - array( |
|
| 377 | - 'after' => "$last_year-06-30", |
|
| 378 | - 'before' => "$last_year-10-01", |
|
| 379 | - ), |
|
| 380 | - |
|
| 381 | - array( |
|
| 382 | - 'before' => "$year-01-01", |
|
| 383 | - 'after' => "$last_year-09-30", |
|
| 384 | - ), |
|
| 385 | - |
|
| 386 | - array( |
|
| 387 | - 'before' => "$year-04-01", |
|
| 388 | - 'after' => "$last_year-12-31", |
|
| 389 | - ), |
|
| 390 | - |
|
| 391 | - array( |
|
| 392 | - 'before' => "$year-07-01", |
|
| 393 | - 'after' => "$year-03-31", |
|
| 394 | - ), |
|
| 395 | - |
|
| 396 | - array( |
|
| 397 | - 'after' => "$year-06-30", |
|
| 398 | - 'before' => "$year-10-01", |
|
| 399 | - ), |
|
| 400 | - |
|
| 401 | - array( |
|
| 402 | - 'before' => "$next_year-01-01", |
|
| 403 | - 'after' => "$year-09-30", |
|
| 404 | - ) |
|
| 405 | - |
|
| 406 | - ); |
|
| 407 | - |
|
| 408 | - } |
|
| 409 | - |
|
| 410 | - /** |
|
| 411 | - * Retrieves the current quater. |
|
| 412 | - * |
|
| 413 | - * @return int The current quarter. |
|
| 414 | - */ |
|
| 415 | - public function get_quarter() { |
|
| 416 | - |
|
| 417 | - $month = (int) date( 'n', current_time( 'timestamp' ) ); |
|
| 418 | - $quarters = array( 1, 1, 1, 2, 2, 2, 3, 3, 3, 4, 4, 4 ); |
|
| 419 | - return $quarters[ $month - 1 ]; |
|
| 420 | - |
|
| 421 | - } |
|
| 422 | - |
|
| 423 | - /** |
|
| 424 | - * Retrieves this quarter date range. |
|
| 425 | - * |
|
| 426 | - * @return array The appropriate date range. |
|
| 427 | - */ |
|
| 428 | - public function get_quarter_date_range() { |
|
| 429 | - |
|
| 430 | - // Set the previous date range. |
|
| 431 | - $this->previous_range = array( |
|
| 432 | - 'period' => 'last_quarter', |
|
| 433 | - ); |
|
| 434 | - |
|
| 435 | - // Generate the report. |
|
| 436 | - $quarters = $this->get_quarters(); |
|
| 437 | - return $quarters[ $this->get_quarter() + 1 ]; |
|
| 438 | - |
|
| 439 | - } |
|
| 440 | - |
|
| 441 | - /** |
|
| 442 | - * Retrieves last quarter's date range. |
|
| 443 | - * |
|
| 444 | - * @return array The appropriate date range. |
|
| 445 | - */ |
|
| 446 | - public function get_last_quarter_date_range() { |
|
| 447 | - |
|
| 448 | - $quarters = $this->get_quarters(); |
|
| 449 | - $quarter = $this->get_quarter(); |
|
| 450 | - |
|
| 451 | - // Set the previous date range. |
|
| 452 | - $this->previous_range = array_merge( |
|
| 453 | - $quarters[ $quarter - 1 ], |
|
| 454 | - array( 'period' => 'custom' ) |
|
| 455 | - ); |
|
| 456 | - |
|
| 457 | - // Generate the report. |
|
| 458 | - return $quarters[ $quarter ]; |
|
| 459 | - |
|
| 460 | - } |
|
| 461 | - |
|
| 462 | - /** |
|
| 463 | - * Retrieves this year date range. |
|
| 464 | - * |
|
| 465 | - * @return array The appropriate date range. |
|
| 466 | - */ |
|
| 467 | - public function get_year_date_range() { |
|
| 468 | - |
|
| 469 | - $this->groupby = 'month'; |
|
| 470 | - |
|
| 471 | - // Set the previous date range. |
|
| 472 | - $this->previous_range = array( |
|
| 473 | - 'period' => 'last_year', |
|
| 474 | - ); |
|
| 475 | - |
|
| 476 | - // Generate the report. |
|
| 477 | - return array( |
|
| 478 | - 'before' => date( 'Y-m-d', strtotime( 'next year January 1st', current_time( 'timestamp' ) ) ), |
|
| 479 | - 'after' => date( 'Y-m-d', strtotime( 'last year December 31st', current_time( 'timestamp' ) ) ), |
|
| 480 | - ); |
|
| 481 | - |
|
| 482 | - } |
|
| 483 | - |
|
| 484 | - /** |
|
| 485 | - * Retrieves last year date range. |
|
| 486 | - * |
|
| 487 | - * @return array The appropriate date range. |
|
| 488 | - */ |
|
| 489 | - public function get_last_year_date_range() { |
|
| 490 | - |
|
| 491 | - $this->groupby = 'month'; |
|
| 492 | - |
|
| 493 | - // Set the previous date range. |
|
| 494 | - $year = (int) date('Y') - 3; |
|
| 495 | - $this->previous_range = array( |
|
| 496 | - 'period' => 'custom', |
|
| 497 | - 'before' => date( 'Y-m-d', strtotime( 'first day of january last year', current_time( 'timestamp' ) ) ), |
|
| 498 | - 'after' => "$year-12-31", |
|
| 499 | - ); |
|
| 500 | - |
|
| 501 | - // Generate the report. |
|
| 502 | - $year = (int) date('Y') - 2; |
|
| 503 | - return array( |
|
| 504 | - 'after' => "$year-12-31", |
|
| 505 | - 'before' => date( 'Y-m-d', strtotime( 'first day of january this year', current_time( 'timestamp' ) ) ), |
|
| 506 | - ); |
|
| 507 | - |
|
| 508 | - } |
|
| 509 | - |
|
| 510 | - /** |
|
| 511 | - * Prepare a the request date for SQL usage. |
|
| 512 | - * |
|
| 513 | - * @param WP_REST_Request $request Request object. |
|
| 514 | - * @param string $date_field The date field. |
|
| 515 | - * @return string The appropriate SQL. |
|
| 516 | - */ |
|
| 517 | - public function get_date_range_sql( $request, $date_field ) { |
|
| 518 | - global $wpdb; |
|
| 519 | - |
|
| 520 | - $sql = '1=1'; |
|
| 521 | - $range = $this->get_date_range( $request ); |
|
| 522 | - |
|
| 523 | - if ( ! empty( $range['after'] ) ) { |
|
| 524 | - $sql .= ' AND ' . $wpdb->prepare( |
|
| 525 | - "$date_field > %s", |
|
| 526 | - $range['after'] |
|
| 527 | - ); |
|
| 528 | - } |
|
| 529 | - |
|
| 530 | - if ( ! empty( $range['before'] ) ) { |
|
| 531 | - $sql .= ' AND ' . $wpdb->prepare( |
|
| 532 | - "$date_field < %s", |
|
| 533 | - $range['before'] |
|
| 534 | - ); |
|
| 535 | - } |
|
| 536 | - |
|
| 537 | - return $sql; |
|
| 538 | - |
|
| 539 | - } |
|
| 540 | - |
|
| 541 | - /** |
|
| 542 | - * Prepares a group by query. |
|
| 543 | - * |
|
| 544 | - * @param string $date_field The date field. |
|
| 545 | - * @return string The appropriate SQL. |
|
| 546 | - */ |
|
| 547 | - public function get_group_by_sql( $date_field ) { |
|
| 548 | - |
|
| 549 | - if ( 'day' === $this->groupby ) { |
|
| 550 | - return "YEAR($date_field), MONTH($date_field), DAY($date_field)"; |
|
| 551 | - } |
|
| 552 | - |
|
| 553 | - return "YEAR($date_field), MONTH($date_field)"; |
|
| 554 | - } |
|
| 555 | - |
|
| 556 | - /** |
|
| 557 | - * Get the query params for collections. |
|
| 558 | - * |
|
| 559 | - * @return array |
|
| 560 | - */ |
|
| 561 | - public function get_collection_params() { |
|
| 562 | - return array( |
|
| 563 | - 'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
| 564 | - 'period' => array( |
|
| 565 | - 'description' => __( 'Limit to results of a specific period.', 'invoicing' ), |
|
| 566 | - 'type' => 'string', |
|
| 567 | - 'enum' => array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days' , '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year', 'quarter', 'last_quarter' ), |
|
| 568 | - 'validate_callback' => 'rest_validate_request_arg', |
|
| 569 | - 'sanitize_callback' => 'sanitize_text_field', |
|
| 570 | - 'default' => '7_days', |
|
| 571 | - ), |
|
| 572 | - 'after' => array( |
|
| 573 | - /* translators: %s: date format */ |
|
| 574 | - 'description' => sprintf( __( 'Limit to results after a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ), |
|
| 575 | - 'type' => 'string', |
|
| 576 | - 'format' => 'date', |
|
| 577 | - 'validate_callback' => 'rest_validate_request_arg', |
|
| 578 | - 'sanitize_callback' => 'sanitize_text_field', |
|
| 579 | - 'default' => date( 'Y-m-d', strtotime( '-8 days', current_time( 'timestamp' ) ) ), |
|
| 580 | - ), |
|
| 581 | - 'before' => array( |
|
| 582 | - /* translators: %s: date format */ |
|
| 583 | - 'description' => sprintf( __( 'Limit to results before a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ), |
|
| 584 | - 'type' => 'string', |
|
| 585 | - 'format' => 'date', |
|
| 586 | - 'validate_callback' => 'rest_validate_request_arg', |
|
| 587 | - 'sanitize_callback' => 'sanitize_text_field', |
|
| 588 | - 'default' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 589 | - ), |
|
| 590 | - ); |
|
| 591 | - } |
|
| 19 | + /** |
|
| 20 | + * Group response items by day or month. |
|
| 21 | + * |
|
| 22 | + * @var string |
|
| 23 | + */ |
|
| 24 | + public $groupby = 'day'; |
|
| 25 | + |
|
| 26 | + /** |
|
| 27 | + * Returns an array with arguments to request the previous report. |
|
| 28 | + * |
|
| 29 | + * @var array |
|
| 30 | + */ |
|
| 31 | + public $previous_range = array(); |
|
| 32 | + |
|
| 33 | + /** |
|
| 34 | + * The period interval. |
|
| 35 | + * |
|
| 36 | + * @var int |
|
| 37 | + */ |
|
| 38 | + public $interval; |
|
| 39 | + |
|
| 40 | + /** |
|
| 41 | + * Retrieves the before and after dates. |
|
| 42 | + * |
|
| 43 | + * @param WP_REST_Request $request Request object. |
|
| 44 | + * @return array The appropriate date range. |
|
| 45 | + */ |
|
| 46 | + public function get_date_range( $request ) { |
|
| 47 | + |
|
| 48 | + // If not supported, assume all time. |
|
| 49 | + if ( ! in_array( $request['period'], array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days', '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year' ) ) ) { |
|
| 50 | + $request['period'] = '7_days'; |
|
| 51 | + } |
|
| 52 | + |
|
| 53 | + $date_range = call_user_func( array( $this, 'get_' . $request['period'] . '_date_range' ), $request ); |
|
| 54 | + $this->prepare_interval( $date_range ); |
|
| 55 | + |
|
| 56 | + return $date_range; |
|
| 57 | + |
|
| 58 | + } |
|
| 59 | + |
|
| 60 | + /** |
|
| 61 | + * Groups by month or days. |
|
| 62 | + * |
|
| 63 | + * @param array $range Date range. |
|
| 64 | + * @return array The appropriate date range. |
|
| 65 | + */ |
|
| 66 | + public function prepare_interval( $range ) { |
|
| 67 | + |
|
| 68 | + $before = strtotime( $range['before'] ) - DAY_IN_SECONDS; |
|
| 69 | + $after = strtotime( $range['after'] ) + DAY_IN_SECONDS; |
|
| 70 | + if ( 'day' === $this->groupby ) { |
|
| 71 | + $difference = max( DAY_IN_SECONDS, ( DAY_IN_SECONDS + $before - $after ) ); // Prevent division by 0; |
|
| 72 | + $this->interval = absint( ceil( max( 1, $difference / DAY_IN_SECONDS ) ) ); |
|
| 73 | + return; |
|
| 74 | + } |
|
| 75 | + |
|
| 76 | + $this->interval = 0; |
|
| 77 | + $min_date = strtotime( date( 'Y-m-01', $after ) ); |
|
| 78 | + |
|
| 79 | + while ( $min_date <= $before ) { |
|
| 80 | + $this->interval ++; |
|
| 81 | + $min_date = strtotime( '+1 MONTH', $min_date ); |
|
| 82 | + } |
|
| 83 | + |
|
| 84 | + $this->interval = max( 1, $this->interval ); |
|
| 85 | + |
|
| 86 | + } |
|
| 87 | + |
|
| 88 | + /** |
|
| 89 | + * Retrieves a custom date range. |
|
| 90 | + * |
|
| 91 | + * @param WP_REST_Request $request Request object. |
|
| 92 | + * @return array The appropriate date range. |
|
| 93 | + */ |
|
| 94 | + public function get_custom_date_range( $request ) { |
|
| 95 | + |
|
| 96 | + $after = max( strtotime( '-20 years' ), strtotime( sanitize_text_field( $request['after'] ) ) ); |
|
| 97 | + $before = strtotime( '+1 day', current_time( 'timestamp' ) ); |
|
| 98 | + |
|
| 99 | + if ( ! empty( $request['before'] ) ) { |
|
| 100 | + $before = min( $before, strtotime( sanitize_text_field( $request['before'] ) ) ); |
|
| 101 | + } |
|
| 102 | + |
|
| 103 | + // 3 months max for day view |
|
| 104 | + if ( floor( ( $before - $after ) / MONTH_IN_SECONDS ) > 3 ) { |
|
| 105 | + $this->groupby = 'month'; |
|
| 106 | + } |
|
| 107 | + |
|
| 108 | + // Set the previous date range. |
|
| 109 | + $difference = $before - $after; |
|
| 110 | + $this->previous_range = array( |
|
| 111 | + 'period' => 'custom', |
|
| 112 | + 'before' => date( 'Y-m-d', $before - $difference ), |
|
| 113 | + 'after' => date( 'Y-m-d', $after - $difference ), |
|
| 114 | + ); |
|
| 115 | + |
|
| 116 | + // Generate the report. |
|
| 117 | + return array( |
|
| 118 | + 'before' => date( 'Y-m-d', $before ), |
|
| 119 | + 'after' => date( 'Y-m-d', $after ), |
|
| 120 | + ); |
|
| 121 | + |
|
| 122 | + } |
|
| 123 | + |
|
| 124 | + /** |
|
| 125 | + * Retrieves todays date range. |
|
| 126 | + * |
|
| 127 | + * @return array The appropriate date range. |
|
| 128 | + */ |
|
| 129 | + public function get_today_date_range() { |
|
| 130 | + |
|
| 131 | + // Set the previous date range. |
|
| 132 | + $this->previous_range = array( |
|
| 133 | + 'period' => 'yesterday', |
|
| 134 | + ); |
|
| 135 | + |
|
| 136 | + // Generate the report. |
|
| 137 | + return array( |
|
| 138 | + 'before' => date( 'Y-m-d', strtotime( '+1 day', current_time( 'timestamp' ) ) ), |
|
| 139 | + 'after' => date( 'Y-m-d', strtotime( '-1 day', current_time( 'timestamp' ) ) ), |
|
| 140 | + ); |
|
| 141 | + |
|
| 142 | + } |
|
| 143 | + |
|
| 144 | + /** |
|
| 145 | + * Retrieves yesterdays date range. |
|
| 146 | + * |
|
| 147 | + * @return array The appropriate date range. |
|
| 148 | + */ |
|
| 149 | + public function get_yesterday_date_range() { |
|
| 150 | + |
|
| 151 | + // Set the previous date range. |
|
| 152 | + $this->previous_range = array( |
|
| 153 | + 'period' => 'custom', |
|
| 154 | + 'before' => date( 'Y-m-d', strtotime( '-1 day', current_time( 'timestamp' ) ) ), |
|
| 155 | + 'after' => date( 'Y-m-d', strtotime( '-3 days', current_time( 'timestamp' ) ) ), |
|
| 156 | + ); |
|
| 157 | + |
|
| 158 | + // Generate the report. |
|
| 159 | + return array( |
|
| 160 | + 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 161 | + 'after' => date( 'Y-m-d', strtotime( '-2 days', current_time( 'timestamp' ) ) ), |
|
| 162 | + ); |
|
| 163 | + |
|
| 164 | + } |
|
| 165 | + |
|
| 166 | + /** |
|
| 167 | + * Retrieves this week's date range. |
|
| 168 | + * |
|
| 169 | + * @return array The appropriate date range. |
|
| 170 | + */ |
|
| 171 | + public function get_week_date_range() { |
|
| 172 | + |
|
| 173 | + // Set the previous date range. |
|
| 174 | + $this->previous_range = array( |
|
| 175 | + 'period' => 'last_week', |
|
| 176 | + ); |
|
| 177 | + |
|
| 178 | + // Generate the report. |
|
| 179 | + return array( |
|
| 180 | + 'before' => date( 'Y-m-d', strtotime( 'sunday last week', current_time( 'timestamp' ) ) + 8 * DAY_IN_SECONDS ), |
|
| 181 | + 'after' => date( 'Y-m-d', strtotime( 'sunday last week', current_time( 'timestamp' ) ) ), |
|
| 182 | + ); |
|
| 183 | + |
|
| 184 | + } |
|
| 185 | + |
|
| 186 | + /** |
|
| 187 | + * Retrieves last week's date range. |
|
| 188 | + * |
|
| 189 | + * @return array The appropriate date range. |
|
| 190 | + */ |
|
| 191 | + public function get_last_week_date_range() { |
|
| 192 | + |
|
| 193 | + // Set the previous date range. |
|
| 194 | + $this->previous_range = array( |
|
| 195 | + 'period' => 'custom', |
|
| 196 | + 'before' => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' ) ) ), |
|
| 197 | + 'after' => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' ) ) - 8 * DAY_IN_SECONDS ), |
|
| 198 | + ); |
|
| 199 | + |
|
| 200 | + // Generate the report. |
|
| 201 | + return array( |
|
| 202 | + 'before' => date( 'Y-m-d', strtotime( 'monday this week', current_time( 'timestamp' ) ) ), |
|
| 203 | + 'after' => date( 'Y-m-d', strtotime( 'monday last week', current_time( 'timestamp' ) ) - DAY_IN_SECONDS ), |
|
| 204 | + ); |
|
| 205 | + |
|
| 206 | + } |
|
| 207 | + |
|
| 208 | + /** |
|
| 209 | + * Retrieves last 7 days date range. |
|
| 210 | + * |
|
| 211 | + * @return array The appropriate date range. |
|
| 212 | + */ |
|
| 213 | + public function get_7_days_date_range() { |
|
| 214 | + |
|
| 215 | + // Set the previous date range. |
|
| 216 | + $this->previous_range = array( |
|
| 217 | + 'period' => 'custom', |
|
| 218 | + 'before' => date( 'Y-m-d', strtotime( '-7 days', current_time( 'timestamp' ) ) ), |
|
| 219 | + 'after' => date( 'Y-m-d', strtotime( '-15 days', current_time( 'timestamp' ) ) ), |
|
| 220 | + ); |
|
| 221 | + |
|
| 222 | + // Generate the report. |
|
| 223 | + return array( |
|
| 224 | + 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 225 | + 'after' => date( 'Y-m-d', strtotime( '-8 days', current_time( 'timestamp' ) ) ), |
|
| 226 | + ); |
|
| 227 | + |
|
| 228 | + } |
|
| 229 | + |
|
| 230 | + /** |
|
| 231 | + * Retrieves last 30 days date range. |
|
| 232 | + * |
|
| 233 | + * @return array The appropriate date range. |
|
| 234 | + */ |
|
| 235 | + public function get_30_days_date_range() { |
|
| 236 | + |
|
| 237 | + // Set the previous date range. |
|
| 238 | + $this->previous_range = array( |
|
| 239 | + 'period' => 'custom', |
|
| 240 | + 'before' => date( 'Y-m-d', strtotime( '-30 days', current_time( 'timestamp' ) ) ), |
|
| 241 | + 'after' => date( 'Y-m-d', strtotime( '-61 days', current_time( 'timestamp' ) ) ), |
|
| 242 | + ); |
|
| 243 | + |
|
| 244 | + // Generate the report. |
|
| 245 | + return array( |
|
| 246 | + 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 247 | + 'after' => date( 'Y-m-d', strtotime( '-31 days', current_time( 'timestamp' ) ) ), |
|
| 248 | + ); |
|
| 249 | + |
|
| 250 | + } |
|
| 251 | + |
|
| 252 | + /** |
|
| 253 | + * Retrieves last 90 days date range. |
|
| 254 | + * |
|
| 255 | + * @return array The appropriate date range. |
|
| 256 | + */ |
|
| 257 | + public function get_90_days_date_range() { |
|
| 258 | + |
|
| 259 | + $this->groupby = 'month'; |
|
| 260 | + |
|
| 261 | + // Set the previous date range. |
|
| 262 | + $this->previous_range = array( |
|
| 263 | + 'period' => 'custom', |
|
| 264 | + 'before' => date( 'Y-m-d', strtotime( '-90 days', current_time( 'timestamp' ) ) ), |
|
| 265 | + 'after' => date( 'Y-m-d', strtotime( '-181 days', current_time( 'timestamp' ) ) ), |
|
| 266 | + ); |
|
| 267 | + |
|
| 268 | + // Generate the report. |
|
| 269 | + return array( |
|
| 270 | + 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 271 | + 'after' => date( 'Y-m-d', strtotime( '-91 days', current_time( 'timestamp' ) ) ), |
|
| 272 | + ); |
|
| 273 | + |
|
| 274 | + } |
|
| 275 | + |
|
| 276 | + /** |
|
| 277 | + * Retrieves last 180 days date range. |
|
| 278 | + * |
|
| 279 | + * @return array The appropriate date range. |
|
| 280 | + */ |
|
| 281 | + public function get_180_days_date_range() { |
|
| 282 | + |
|
| 283 | + $this->groupby = 'month'; |
|
| 284 | + |
|
| 285 | + // Set the previous date range. |
|
| 286 | + $this->previous_range = array( |
|
| 287 | + 'period' => 'custom', |
|
| 288 | + 'before' => date( 'Y-m-d', strtotime( '-180 days', current_time( 'timestamp' ) ) ), |
|
| 289 | + 'after' => date( 'Y-m-d', strtotime( '-361 days', current_time( 'timestamp' ) ) ), |
|
| 290 | + ); |
|
| 291 | + |
|
| 292 | + // Generate the report. |
|
| 293 | + return array( |
|
| 294 | + 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 295 | + 'after' => date( 'Y-m-d', strtotime( '-181 days', current_time( 'timestamp' ) ) ), |
|
| 296 | + ); |
|
| 297 | + |
|
| 298 | + } |
|
| 299 | + |
|
| 300 | + /** |
|
| 301 | + * Retrieves last 60 days date range. |
|
| 302 | + * |
|
| 303 | + * @return array The appropriate date range. |
|
| 304 | + */ |
|
| 305 | + public function get_60_days_date_range() { |
|
| 306 | + |
|
| 307 | + // Set the previous date range. |
|
| 308 | + $this->previous_range = array( |
|
| 309 | + 'period' => 'custom', |
|
| 310 | + 'before' => date( 'Y-m-d', strtotime( '-60 days', current_time( 'timestamp' ) ) ), |
|
| 311 | + 'after' => date( 'Y-m-d', strtotime( '-121 days', current_time( 'timestamp' ) ) ), |
|
| 312 | + ); |
|
| 313 | + |
|
| 314 | + // Generate the report. |
|
| 315 | + return array( |
|
| 316 | + 'before' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 317 | + 'after' => date( 'Y-m-d', strtotime( '-61 days', current_time( 'timestamp' ) ) ), |
|
| 318 | + ); |
|
| 319 | + |
|
| 320 | + } |
|
| 321 | + |
|
| 322 | + /** |
|
| 323 | + * Retrieves this month date range. |
|
| 324 | + * |
|
| 325 | + * @return array The appropriate date range. |
|
| 326 | + */ |
|
| 327 | + public function get_month_date_range() { |
|
| 328 | + |
|
| 329 | + // Set the previous date range. |
|
| 330 | + $this->previous_range = array( |
|
| 331 | + 'period' => 'last_month', |
|
| 332 | + ); |
|
| 333 | + |
|
| 334 | + // Generate the report. |
|
| 335 | + return array( |
|
| 336 | + 'before' => date( 'Y-m-01', strtotime( 'next month', current_time( 'timestamp' ) ) ), |
|
| 337 | + 'after' => date( 'Y-m-t', strtotime( 'last month', current_time( 'timestamp' ) ) ), |
|
| 338 | + ); |
|
| 339 | + |
|
| 340 | + } |
|
| 341 | + |
|
| 342 | + /** |
|
| 343 | + * Retrieves last month's date range. |
|
| 344 | + * |
|
| 345 | + * @return array The appropriate date range. |
|
| 346 | + */ |
|
| 347 | + public function get_last_month_date_range() { |
|
| 348 | + |
|
| 349 | + // Set the previous date range. |
|
| 350 | + $this->previous_range = array( |
|
| 351 | + 'period' => 'custom', |
|
| 352 | + 'before' => date( 'Y-m-1', strtotime( 'last month', current_time( 'timestamp' ) ) ), |
|
| 353 | + 'after' => date( 'Y-m-t', strtotime( "-3 months", current_time( 'timestamp' ) ) ), |
|
| 354 | + ); |
|
| 355 | + |
|
| 356 | + // Generate the report. |
|
| 357 | + return array( |
|
| 358 | + 'before' => date( 'Y-m-1', current_time( 'timestamp' ) ), |
|
| 359 | + 'after' => date( 'Y-m-t', strtotime( "-2 months", current_time( 'timestamp' ) ) ), |
|
| 360 | + ); |
|
| 361 | + |
|
| 362 | + } |
|
| 363 | + |
|
| 364 | + /** |
|
| 365 | + * Retrieves this quarter date range. |
|
| 366 | + * |
|
| 367 | + * @return array The available quarters. |
|
| 368 | + */ |
|
| 369 | + public function get_quarters() { |
|
| 370 | + |
|
| 371 | + $last_year = (int) date('Y') - 1; |
|
| 372 | + $next_year = (int) date('Y') + 1; |
|
| 373 | + $year = (int) date('Y'); |
|
| 374 | + return array( |
|
| 375 | + |
|
| 376 | + array( |
|
| 377 | + 'after' => "$last_year-06-30", |
|
| 378 | + 'before' => "$last_year-10-01", |
|
| 379 | + ), |
|
| 380 | + |
|
| 381 | + array( |
|
| 382 | + 'before' => "$year-01-01", |
|
| 383 | + 'after' => "$last_year-09-30", |
|
| 384 | + ), |
|
| 385 | + |
|
| 386 | + array( |
|
| 387 | + 'before' => "$year-04-01", |
|
| 388 | + 'after' => "$last_year-12-31", |
|
| 389 | + ), |
|
| 390 | + |
|
| 391 | + array( |
|
| 392 | + 'before' => "$year-07-01", |
|
| 393 | + 'after' => "$year-03-31", |
|
| 394 | + ), |
|
| 395 | + |
|
| 396 | + array( |
|
| 397 | + 'after' => "$year-06-30", |
|
| 398 | + 'before' => "$year-10-01", |
|
| 399 | + ), |
|
| 400 | + |
|
| 401 | + array( |
|
| 402 | + 'before' => "$next_year-01-01", |
|
| 403 | + 'after' => "$year-09-30", |
|
| 404 | + ) |
|
| 405 | + |
|
| 406 | + ); |
|
| 407 | + |
|
| 408 | + } |
|
| 409 | + |
|
| 410 | + /** |
|
| 411 | + * Retrieves the current quater. |
|
| 412 | + * |
|
| 413 | + * @return int The current quarter. |
|
| 414 | + */ |
|
| 415 | + public function get_quarter() { |
|
| 416 | + |
|
| 417 | + $month = (int) date( 'n', current_time( 'timestamp' ) ); |
|
| 418 | + $quarters = array( 1, 1, 1, 2, 2, 2, 3, 3, 3, 4, 4, 4 ); |
|
| 419 | + return $quarters[ $month - 1 ]; |
|
| 420 | + |
|
| 421 | + } |
|
| 422 | + |
|
| 423 | + /** |
|
| 424 | + * Retrieves this quarter date range. |
|
| 425 | + * |
|
| 426 | + * @return array The appropriate date range. |
|
| 427 | + */ |
|
| 428 | + public function get_quarter_date_range() { |
|
| 429 | + |
|
| 430 | + // Set the previous date range. |
|
| 431 | + $this->previous_range = array( |
|
| 432 | + 'period' => 'last_quarter', |
|
| 433 | + ); |
|
| 434 | + |
|
| 435 | + // Generate the report. |
|
| 436 | + $quarters = $this->get_quarters(); |
|
| 437 | + return $quarters[ $this->get_quarter() + 1 ]; |
|
| 438 | + |
|
| 439 | + } |
|
| 440 | + |
|
| 441 | + /** |
|
| 442 | + * Retrieves last quarter's date range. |
|
| 443 | + * |
|
| 444 | + * @return array The appropriate date range. |
|
| 445 | + */ |
|
| 446 | + public function get_last_quarter_date_range() { |
|
| 447 | + |
|
| 448 | + $quarters = $this->get_quarters(); |
|
| 449 | + $quarter = $this->get_quarter(); |
|
| 450 | + |
|
| 451 | + // Set the previous date range. |
|
| 452 | + $this->previous_range = array_merge( |
|
| 453 | + $quarters[ $quarter - 1 ], |
|
| 454 | + array( 'period' => 'custom' ) |
|
| 455 | + ); |
|
| 456 | + |
|
| 457 | + // Generate the report. |
|
| 458 | + return $quarters[ $quarter ]; |
|
| 459 | + |
|
| 460 | + } |
|
| 461 | + |
|
| 462 | + /** |
|
| 463 | + * Retrieves this year date range. |
|
| 464 | + * |
|
| 465 | + * @return array The appropriate date range. |
|
| 466 | + */ |
|
| 467 | + public function get_year_date_range() { |
|
| 468 | + |
|
| 469 | + $this->groupby = 'month'; |
|
| 470 | + |
|
| 471 | + // Set the previous date range. |
|
| 472 | + $this->previous_range = array( |
|
| 473 | + 'period' => 'last_year', |
|
| 474 | + ); |
|
| 475 | + |
|
| 476 | + // Generate the report. |
|
| 477 | + return array( |
|
| 478 | + 'before' => date( 'Y-m-d', strtotime( 'next year January 1st', current_time( 'timestamp' ) ) ), |
|
| 479 | + 'after' => date( 'Y-m-d', strtotime( 'last year December 31st', current_time( 'timestamp' ) ) ), |
|
| 480 | + ); |
|
| 481 | + |
|
| 482 | + } |
|
| 483 | + |
|
| 484 | + /** |
|
| 485 | + * Retrieves last year date range. |
|
| 486 | + * |
|
| 487 | + * @return array The appropriate date range. |
|
| 488 | + */ |
|
| 489 | + public function get_last_year_date_range() { |
|
| 490 | + |
|
| 491 | + $this->groupby = 'month'; |
|
| 492 | + |
|
| 493 | + // Set the previous date range. |
|
| 494 | + $year = (int) date('Y') - 3; |
|
| 495 | + $this->previous_range = array( |
|
| 496 | + 'period' => 'custom', |
|
| 497 | + 'before' => date( 'Y-m-d', strtotime( 'first day of january last year', current_time( 'timestamp' ) ) ), |
|
| 498 | + 'after' => "$year-12-31", |
|
| 499 | + ); |
|
| 500 | + |
|
| 501 | + // Generate the report. |
|
| 502 | + $year = (int) date('Y') - 2; |
|
| 503 | + return array( |
|
| 504 | + 'after' => "$year-12-31", |
|
| 505 | + 'before' => date( 'Y-m-d', strtotime( 'first day of january this year', current_time( 'timestamp' ) ) ), |
|
| 506 | + ); |
|
| 507 | + |
|
| 508 | + } |
|
| 509 | + |
|
| 510 | + /** |
|
| 511 | + * Prepare a the request date for SQL usage. |
|
| 512 | + * |
|
| 513 | + * @param WP_REST_Request $request Request object. |
|
| 514 | + * @param string $date_field The date field. |
|
| 515 | + * @return string The appropriate SQL. |
|
| 516 | + */ |
|
| 517 | + public function get_date_range_sql( $request, $date_field ) { |
|
| 518 | + global $wpdb; |
|
| 519 | + |
|
| 520 | + $sql = '1=1'; |
|
| 521 | + $range = $this->get_date_range( $request ); |
|
| 522 | + |
|
| 523 | + if ( ! empty( $range['after'] ) ) { |
|
| 524 | + $sql .= ' AND ' . $wpdb->prepare( |
|
| 525 | + "$date_field > %s", |
|
| 526 | + $range['after'] |
|
| 527 | + ); |
|
| 528 | + } |
|
| 529 | + |
|
| 530 | + if ( ! empty( $range['before'] ) ) { |
|
| 531 | + $sql .= ' AND ' . $wpdb->prepare( |
|
| 532 | + "$date_field < %s", |
|
| 533 | + $range['before'] |
|
| 534 | + ); |
|
| 535 | + } |
|
| 536 | + |
|
| 537 | + return $sql; |
|
| 538 | + |
|
| 539 | + } |
|
| 540 | + |
|
| 541 | + /** |
|
| 542 | + * Prepares a group by query. |
|
| 543 | + * |
|
| 544 | + * @param string $date_field The date field. |
|
| 545 | + * @return string The appropriate SQL. |
|
| 546 | + */ |
|
| 547 | + public function get_group_by_sql( $date_field ) { |
|
| 548 | + |
|
| 549 | + if ( 'day' === $this->groupby ) { |
|
| 550 | + return "YEAR($date_field), MONTH($date_field), DAY($date_field)"; |
|
| 551 | + } |
|
| 552 | + |
|
| 553 | + return "YEAR($date_field), MONTH($date_field)"; |
|
| 554 | + } |
|
| 555 | + |
|
| 556 | + /** |
|
| 557 | + * Get the query params for collections. |
|
| 558 | + * |
|
| 559 | + * @return array |
|
| 560 | + */ |
|
| 561 | + public function get_collection_params() { |
|
| 562 | + return array( |
|
| 563 | + 'context' => $this->get_context_param( array( 'default' => 'view' ) ), |
|
| 564 | + 'period' => array( |
|
| 565 | + 'description' => __( 'Limit to results of a specific period.', 'invoicing' ), |
|
| 566 | + 'type' => 'string', |
|
| 567 | + 'enum' => array( 'custom', 'today', 'yesterday', 'week', 'last_week', '7_days', '30_days', '60_days' , '90_days', '180_days', 'month', 'last_month', 'quarter', 'last_quarter', 'year', 'last_year', 'quarter', 'last_quarter' ), |
|
| 568 | + 'validate_callback' => 'rest_validate_request_arg', |
|
| 569 | + 'sanitize_callback' => 'sanitize_text_field', |
|
| 570 | + 'default' => '7_days', |
|
| 571 | + ), |
|
| 572 | + 'after' => array( |
|
| 573 | + /* translators: %s: date format */ |
|
| 574 | + 'description' => sprintf( __( 'Limit to results after a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ), |
|
| 575 | + 'type' => 'string', |
|
| 576 | + 'format' => 'date', |
|
| 577 | + 'validate_callback' => 'rest_validate_request_arg', |
|
| 578 | + 'sanitize_callback' => 'sanitize_text_field', |
|
| 579 | + 'default' => date( 'Y-m-d', strtotime( '-8 days', current_time( 'timestamp' ) ) ), |
|
| 580 | + ), |
|
| 581 | + 'before' => array( |
|
| 582 | + /* translators: %s: date format */ |
|
| 583 | + 'description' => sprintf( __( 'Limit to results before a specific date, the date needs to be in the %s format.', 'invoicing' ), 'YYYY-MM-DD' ), |
|
| 584 | + 'type' => 'string', |
|
| 585 | + 'format' => 'date', |
|
| 586 | + 'validate_callback' => 'rest_validate_request_arg', |
|
| 587 | + 'sanitize_callback' => 'sanitize_text_field', |
|
| 588 | + 'default' => date( 'Y-m-d', current_time( 'timestamp' ) ), |
|
| 589 | + ), |
|
| 590 | + ); |
|
| 591 | + } |
|
| 592 | 592 | } |
@@ -12,88 +12,88 @@ discard block |
||
| 12 | 12 | */ |
| 13 | 13 | class GetPaid_Reports_Report { |
| 14 | 14 | |
| 15 | - /** |
|
| 16 | - * @var array |
|
| 17 | - */ |
|
| 18 | - public $views; |
|
| 15 | + /** |
|
| 16 | + * @var array |
|
| 17 | + */ |
|
| 18 | + public $views; |
|
| 19 | 19 | |
| 20 | - /** |
|
| 21 | - * Class constructor. |
|
| 22 | - * |
|
| 23 | - */ |
|
| 24 | - public function __construct() { |
|
| 20 | + /** |
|
| 21 | + * Class constructor. |
|
| 22 | + * |
|
| 23 | + */ |
|
| 24 | + public function __construct() { |
|
| 25 | 25 | |
| 26 | - $this->views = array( |
|
| 26 | + $this->views = array( |
|
| 27 | 27 | |
| 28 | 28 | 'items' => array( |
| 29 | - 'label' => __( 'Items', 'invoicing' ), |
|
| 30 | - 'class' => 'GetPaid_Reports_Report_Items', |
|
| 31 | - ), |
|
| 29 | + 'label' => __( 'Items', 'invoicing' ), |
|
| 30 | + 'class' => 'GetPaid_Reports_Report_Items', |
|
| 31 | + ), |
|
| 32 | 32 | |
| 33 | - 'gateways' => array( |
|
| 34 | - 'label' => __( 'Payment Methods', 'invoicing' ), |
|
| 35 | - 'class' => 'GetPaid_Reports_Report_Gateways', |
|
| 36 | - ), |
|
| 33 | + 'gateways' => array( |
|
| 34 | + 'label' => __( 'Payment Methods', 'invoicing' ), |
|
| 35 | + 'class' => 'GetPaid_Reports_Report_Gateways', |
|
| 36 | + ), |
|
| 37 | 37 | |
| 38 | - 'discounts' => array( |
|
| 39 | - 'label' => __( 'Discount Codes', 'invoicing' ), |
|
| 40 | - 'class' => 'GetPaid_Reports_Report_Discounts', |
|
| 41 | - ), |
|
| 38 | + 'discounts' => array( |
|
| 39 | + 'label' => __( 'Discount Codes', 'invoicing' ), |
|
| 40 | + 'class' => 'GetPaid_Reports_Report_Discounts', |
|
| 41 | + ), |
|
| 42 | 42 | |
| 43 | 43 | ); |
| 44 | 44 | |
| 45 | - $this->views = apply_filters( 'wpinv_report_views', $this->views ); |
|
| 46 | - |
|
| 47 | - } |
|
| 48 | - |
|
| 49 | - /** |
|
| 50 | - * Retrieves the current range. |
|
| 51 | - * |
|
| 52 | - */ |
|
| 53 | - public function get_range() { |
|
| 54 | - $valid_ranges = $this->get_periods(); |
|
| 55 | - |
|
| 56 | - if ( isset( $_GET['date_range'] ) && array_key_exists( $_GET['date_range'], $valid_ranges ) ) { |
|
| 57 | - return sanitize_key( $_GET['date_range'] ); |
|
| 58 | - } |
|
| 59 | - |
|
| 60 | - return '7_days'; |
|
| 61 | - } |
|
| 62 | - |
|
| 63 | - /** |
|
| 64 | - * Returns an array of date ranges. |
|
| 65 | - * |
|
| 66 | - * @return array |
|
| 67 | - */ |
|
| 68 | - public function get_periods() { |
|
| 69 | - |
|
| 70 | - $periods = array( |
|
| 71 | - 'today' => __( 'Today', 'invoicing' ), |
|
| 72 | - 'yesterday' => __( 'Yesterday', 'invoicing' ), |
|
| 73 | - 'week' => __( 'This week', 'invoicing' ), |
|
| 74 | - 'last_week' => __( 'Last week', 'invoicing' ), |
|
| 75 | - '7_days' => __( 'Last 7 days', 'invoicing' ), |
|
| 76 | - 'month' => __( 'This month', 'invoicing' ), |
|
| 77 | - 'last_month' => __( 'Last month', 'invoicing' ), |
|
| 78 | - '30_days' => __( 'Last 30 days', 'invoicing' ), |
|
| 79 | - 'quarter' => __( 'This Quarter', 'invoicing' ), |
|
| 80 | - 'last_quarter' => __( 'Last Quarter', 'invoicing' ), |
|
| 81 | - 'year' => __( 'This year', 'invoicing' ), |
|
| 82 | - 'last_year' => __( 'Last Year', 'invoicing' ), |
|
| 83 | - 'custom' => __( 'Custom Date Range', 'invoicing' ), |
|
| 84 | - ); |
|
| 85 | - |
|
| 86 | - return apply_filters( 'getpaid_earning_periods', $periods ); |
|
| 87 | - } |
|
| 88 | - |
|
| 89 | - /** |
|
| 90 | - * Displays the range selector. |
|
| 91 | - * |
|
| 92 | - */ |
|
| 93 | - public function display_range_selector() { |
|
| 94 | - |
|
| 95 | - $range = $this->get_range(); |
|
| 96 | - ?> |
|
| 45 | + $this->views = apply_filters( 'wpinv_report_views', $this->views ); |
|
| 46 | + |
|
| 47 | + } |
|
| 48 | + |
|
| 49 | + /** |
|
| 50 | + * Retrieves the current range. |
|
| 51 | + * |
|
| 52 | + */ |
|
| 53 | + public function get_range() { |
|
| 54 | + $valid_ranges = $this->get_periods(); |
|
| 55 | + |
|
| 56 | + if ( isset( $_GET['date_range'] ) && array_key_exists( $_GET['date_range'], $valid_ranges ) ) { |
|
| 57 | + return sanitize_key( $_GET['date_range'] ); |
|
| 58 | + } |
|
| 59 | + |
|
| 60 | + return '7_days'; |
|
| 61 | + } |
|
| 62 | + |
|
| 63 | + /** |
|
| 64 | + * Returns an array of date ranges. |
|
| 65 | + * |
|
| 66 | + * @return array |
|
| 67 | + */ |
|
| 68 | + public function get_periods() { |
|
| 69 | + |
|
| 70 | + $periods = array( |
|
| 71 | + 'today' => __( 'Today', 'invoicing' ), |
|
| 72 | + 'yesterday' => __( 'Yesterday', 'invoicing' ), |
|
| 73 | + 'week' => __( 'This week', 'invoicing' ), |
|
| 74 | + 'last_week' => __( 'Last week', 'invoicing' ), |
|
| 75 | + '7_days' => __( 'Last 7 days', 'invoicing' ), |
|
| 76 | + 'month' => __( 'This month', 'invoicing' ), |
|
| 77 | + 'last_month' => __( 'Last month', 'invoicing' ), |
|
| 78 | + '30_days' => __( 'Last 30 days', 'invoicing' ), |
|
| 79 | + 'quarter' => __( 'This Quarter', 'invoicing' ), |
|
| 80 | + 'last_quarter' => __( 'Last Quarter', 'invoicing' ), |
|
| 81 | + 'year' => __( 'This year', 'invoicing' ), |
|
| 82 | + 'last_year' => __( 'Last Year', 'invoicing' ), |
|
| 83 | + 'custom' => __( 'Custom Date Range', 'invoicing' ), |
|
| 84 | + ); |
|
| 85 | + |
|
| 86 | + return apply_filters( 'getpaid_earning_periods', $periods ); |
|
| 87 | + } |
|
| 88 | + |
|
| 89 | + /** |
|
| 90 | + * Displays the range selector. |
|
| 91 | + * |
|
| 92 | + */ |
|
| 93 | + public function display_range_selector() { |
|
| 94 | + |
|
| 95 | + $range = $this->get_range(); |
|
| 96 | + ?> |
|
| 97 | 97 | |
| 98 | 98 | <form method="get" class="getpaid-filter-earnings float-right"> |
| 99 | 99 | <?php getpaid_hidden_field( 'page', 'wpinv-reports' ); ?> |
@@ -115,14 +115,14 @@ discard block |
||
| 115 | 115 | </form> |
| 116 | 116 | |
| 117 | 117 | <?php |
| 118 | - } |
|
| 118 | + } |
|
| 119 | 119 | |
| 120 | - /** |
|
| 121 | - * Displays the reports tab. |
|
| 122 | - * |
|
| 123 | - */ |
|
| 124 | - public function display() { |
|
| 125 | - ?> |
|
| 120 | + /** |
|
| 121 | + * Displays the reports tab. |
|
| 122 | + * |
|
| 123 | + */ |
|
| 124 | + public function display() { |
|
| 125 | + ?> |
|
| 126 | 126 | |
| 127 | 127 | <div class="mt-4" style="max-width: 1200px;"> |
| 128 | 128 | |
@@ -202,24 +202,24 @@ discard block |
||
| 202 | 202 | |
| 203 | 203 | <?php |
| 204 | 204 | |
| 205 | - } |
|
| 206 | - |
|
| 207 | - /** |
|
| 208 | - * Displays the left side. |
|
| 209 | - * |
|
| 210 | - */ |
|
| 211 | - public function display_left() { |
|
| 212 | - $graphs = array( |
|
| 213 | - 'sales' => __( 'Earnings', 'invoicing' ), |
|
| 214 | - 'refunds' => __( 'Refunds', 'invoicing' ), |
|
| 215 | - 'tax' => __( 'Taxes', 'invoicing' ), |
|
| 216 | - 'fees' => __( 'Fees', 'invoicing' ), |
|
| 217 | - 'discount' => __( 'Discounts', 'invoicing' ), |
|
| 218 | - 'invoices' => __( 'Invoices', 'invoicing' ), |
|
| 219 | - 'items' => __( 'Purchased Items', 'invoicing' ), |
|
| 220 | - ); |
|
| 221 | - |
|
| 222 | - ?> |
|
| 205 | + } |
|
| 206 | + |
|
| 207 | + /** |
|
| 208 | + * Displays the left side. |
|
| 209 | + * |
|
| 210 | + */ |
|
| 211 | + public function display_left() { |
|
| 212 | + $graphs = array( |
|
| 213 | + 'sales' => __( 'Earnings', 'invoicing' ), |
|
| 214 | + 'refunds' => __( 'Refunds', 'invoicing' ), |
|
| 215 | + 'tax' => __( 'Taxes', 'invoicing' ), |
|
| 216 | + 'fees' => __( 'Fees', 'invoicing' ), |
|
| 217 | + 'discount' => __( 'Discounts', 'invoicing' ), |
|
| 218 | + 'invoices' => __( 'Invoices', 'invoicing' ), |
|
| 219 | + 'items' => __( 'Purchased Items', 'invoicing' ), |
|
| 220 | + ); |
|
| 221 | + |
|
| 222 | + ?> |
|
| 223 | 223 | |
| 224 | 224 | <?php foreach ( $graphs as $key => $graph ) : ?> |
| 225 | 225 | <div class="row mb-4"> |
@@ -238,35 +238,35 @@ discard block |
||
| 238 | 238 | |
| 239 | 239 | <?php |
| 240 | 240 | |
| 241 | - } |
|
| 242 | - |
|
| 243 | - /** |
|
| 244 | - * Retrieves the download url. |
|
| 245 | - * |
|
| 246 | - */ |
|
| 247 | - public function get_download_url( $graph, $file_type ) { |
|
| 248 | - |
|
| 249 | - return wp_nonce_url( |
|
| 250 | - add_query_arg( |
|
| 251 | - array( |
|
| 252 | - 'getpaid-admin-action' => 'download_graph', |
|
| 253 | - 'file_type' => urlencode( $file_type ), |
|
| 254 | - 'graph' => urlencode( $graph ), |
|
| 255 | - ) |
|
| 256 | - ), |
|
| 257 | - 'getpaid-nonce', |
|
| 258 | - 'getpaid-nonce' |
|
| 259 | - ); |
|
| 241 | + } |
|
| 242 | + |
|
| 243 | + /** |
|
| 244 | + * Retrieves the download url. |
|
| 245 | + * |
|
| 246 | + */ |
|
| 247 | + public function get_download_url( $graph, $file_type ) { |
|
| 248 | + |
|
| 249 | + return wp_nonce_url( |
|
| 250 | + add_query_arg( |
|
| 251 | + array( |
|
| 252 | + 'getpaid-admin-action' => 'download_graph', |
|
| 253 | + 'file_type' => urlencode( $file_type ), |
|
| 254 | + 'graph' => urlencode( $graph ), |
|
| 255 | + ) |
|
| 256 | + ), |
|
| 257 | + 'getpaid-nonce', |
|
| 258 | + 'getpaid-nonce' |
|
| 259 | + ); |
|
| 260 | 260 | |
| 261 | - } |
|
| 261 | + } |
|
| 262 | 262 | |
| 263 | - /** |
|
| 264 | - * Displays the right side. |
|
| 265 | - * |
|
| 266 | - */ |
|
| 267 | - public function display_right() { |
|
| 263 | + /** |
|
| 264 | + * Displays the right side. |
|
| 265 | + * |
|
| 266 | + */ |
|
| 267 | + public function display_right() { |
|
| 268 | 268 | |
| 269 | - ?> |
|
| 269 | + ?> |
|
| 270 | 270 | |
| 271 | 271 | <?php foreach ( $this->views as $key => $view ) : ?> |
| 272 | 272 | <div class="row mb-4"> |
@@ -295,10 +295,10 @@ discard block |
||
| 295 | 295 | </div> |
| 296 | 296 | <div class="card-body"> |
| 297 | 297 | <?php |
| 298 | - $class = $view['class']; |
|
| 299 | - $class = new $class(); |
|
| 300 | - $class->display_stats(); |
|
| 301 | - ?> |
|
| 298 | + $class = $view['class']; |
|
| 299 | + $class = new $class(); |
|
| 300 | + $class->display_stats(); |
|
| 301 | + ?> |
|
| 302 | 302 | </div> |
| 303 | 303 | </div> |
| 304 | 304 | </div> |
@@ -307,67 +307,67 @@ discard block |
||
| 307 | 307 | |
| 308 | 308 | <?php |
| 309 | 309 | |
| 310 | - } |
|
| 311 | - |
|
| 312 | - /** |
|
| 313 | - * Returns a list of report cards. |
|
| 314 | - * |
|
| 315 | - */ |
|
| 316 | - public function get_cards() { |
|
| 317 | - |
|
| 318 | - $cards = array( |
|
| 319 | - 'total_sales' => array( |
|
| 320 | - 'description' => __( 'Gross sales in the period.', 'invoicing' ), |
|
| 321 | - 'label' => __( 'Gross Revenue', 'invoicing' ), |
|
| 322 | - ), |
|
| 323 | - 'net_sales' => array( |
|
| 324 | - 'description' => __( 'Net sales in the period.', 'invoicing' ), |
|
| 325 | - 'label' => __( 'Net Revenue', 'invoicing' ), |
|
| 326 | - ), |
|
| 327 | - 'average_sales' => array( |
|
| 328 | - 'description' => __( 'Average net daily/monthly sales.', 'invoicing' ), |
|
| 329 | - 'label' => __( 'Avg. Net Sales', 'invoicing' ), |
|
| 330 | - ), |
|
| 331 | - 'average_total_sales' => array( |
|
| 332 | - 'description' => __( 'Average gross daily/monthly sales.', 'invoicing' ), |
|
| 333 | - 'label' => __( 'Avg. Gross Sales', 'invoicing' ), |
|
| 334 | - ), |
|
| 335 | - 'total_invoices' => array( |
|
| 336 | - 'description' => __( 'Number of paid invoices.', 'invoicing' ), |
|
| 337 | - 'label' => __( 'Paid Invoices', 'invoicing' ), |
|
| 338 | - ), |
|
| 339 | - 'total_items' => array( |
|
| 340 | - 'description' => __( 'Number of items purchased.', 'invoicing' ), |
|
| 341 | - 'label' => __( 'Purchased Items', 'invoicing' ), |
|
| 342 | - ), |
|
| 343 | - 'refunded_items' => array( |
|
| 344 | - 'description' => __( 'Number of items refunded.', 'invoicing' ), |
|
| 345 | - 'label' => __( 'Refunded Items', 'invoicing' ), |
|
| 346 | - ), |
|
| 347 | - 'total_tax' => array( |
|
| 348 | - 'description' => __( 'Total charged for taxes.', 'invoicing' ), |
|
| 349 | - 'label' => __( 'Tax', 'invoicing' ), |
|
| 350 | - ), |
|
| 351 | - 'total_refunded_tax' => array( |
|
| 352 | - 'description' => __( 'Total refunded for taxes.', 'invoicing' ), |
|
| 353 | - 'label' => __( 'Refunded Tax', 'invoicing' ), |
|
| 354 | - ), |
|
| 355 | - 'total_fees' => array( |
|
| 356 | - 'description' => __( 'Total fees charged.', 'invoicing' ), |
|
| 357 | - 'label' => __( 'Fees', 'invoicing' ), |
|
| 358 | - ), |
|
| 359 | - 'total_refunds' => array( |
|
| 360 | - 'description' => __( 'Total of refunded invoices.', 'invoicing' ), |
|
| 361 | - 'label' => __( 'Refunded', 'invoicing' ), |
|
| 362 | - ), |
|
| 363 | - 'total_discount' => array( |
|
| 364 | - 'description' => __( 'Total of discounts used.', 'invoicing' ), |
|
| 365 | - 'label' => __( 'Discounted', 'invoicing' ), |
|
| 366 | - ), |
|
| 367 | - ); |
|
| 368 | - |
|
| 369 | - return apply_filters( 'wpinv_report_cards', $cards ); |
|
| 370 | - } |
|
| 310 | + } |
|
| 311 | + |
|
| 312 | + /** |
|
| 313 | + * Returns a list of report cards. |
|
| 314 | + * |
|
| 315 | + */ |
|
| 316 | + public function get_cards() { |
|
| 317 | + |
|
| 318 | + $cards = array( |
|
| 319 | + 'total_sales' => array( |
|
| 320 | + 'description' => __( 'Gross sales in the period.', 'invoicing' ), |
|
| 321 | + 'label' => __( 'Gross Revenue', 'invoicing' ), |
|
| 322 | + ), |
|
| 323 | + 'net_sales' => array( |
|
| 324 | + 'description' => __( 'Net sales in the period.', 'invoicing' ), |
|
| 325 | + 'label' => __( 'Net Revenue', 'invoicing' ), |
|
| 326 | + ), |
|
| 327 | + 'average_sales' => array( |
|
| 328 | + 'description' => __( 'Average net daily/monthly sales.', 'invoicing' ), |
|
| 329 | + 'label' => __( 'Avg. Net Sales', 'invoicing' ), |
|
| 330 | + ), |
|
| 331 | + 'average_total_sales' => array( |
|
| 332 | + 'description' => __( 'Average gross daily/monthly sales.', 'invoicing' ), |
|
| 333 | + 'label' => __( 'Avg. Gross Sales', 'invoicing' ), |
|
| 334 | + ), |
|
| 335 | + 'total_invoices' => array( |
|
| 336 | + 'description' => __( 'Number of paid invoices.', 'invoicing' ), |
|
| 337 | + 'label' => __( 'Paid Invoices', 'invoicing' ), |
|
| 338 | + ), |
|
| 339 | + 'total_items' => array( |
|
| 340 | + 'description' => __( 'Number of items purchased.', 'invoicing' ), |
|
| 341 | + 'label' => __( 'Purchased Items', 'invoicing' ), |
|
| 342 | + ), |
|
| 343 | + 'refunded_items' => array( |
|
| 344 | + 'description' => __( 'Number of items refunded.', 'invoicing' ), |
|
| 345 | + 'label' => __( 'Refunded Items', 'invoicing' ), |
|
| 346 | + ), |
|
| 347 | + 'total_tax' => array( |
|
| 348 | + 'description' => __( 'Total charged for taxes.', 'invoicing' ), |
|
| 349 | + 'label' => __( 'Tax', 'invoicing' ), |
|
| 350 | + ), |
|
| 351 | + 'total_refunded_tax' => array( |
|
| 352 | + 'description' => __( 'Total refunded for taxes.', 'invoicing' ), |
|
| 353 | + 'label' => __( 'Refunded Tax', 'invoicing' ), |
|
| 354 | + ), |
|
| 355 | + 'total_fees' => array( |
|
| 356 | + 'description' => __( 'Total fees charged.', 'invoicing' ), |
|
| 357 | + 'label' => __( 'Fees', 'invoicing' ), |
|
| 358 | + ), |
|
| 359 | + 'total_refunds' => array( |
|
| 360 | + 'description' => __( 'Total of refunded invoices.', 'invoicing' ), |
|
| 361 | + 'label' => __( 'Refunded', 'invoicing' ), |
|
| 362 | + ), |
|
| 363 | + 'total_discount' => array( |
|
| 364 | + 'description' => __( 'Total of discounts used.', 'invoicing' ), |
|
| 365 | + 'label' => __( 'Discounted', 'invoicing' ), |
|
| 366 | + ), |
|
| 367 | + ); |
|
| 368 | + |
|
| 369 | + return apply_filters( 'wpinv_report_cards', $cards ); |
|
| 370 | + } |
|
| 371 | 371 | |
| 372 | 372 | |
| 373 | 373 | |
@@ -15,30 +15,30 @@ discard block |
||
| 15 | 15 | */ |
| 16 | 16 | class WPInv_Discount extends GetPaid_Data { |
| 17 | 17 | |
| 18 | - /** |
|
| 19 | - * Which data store to load. |
|
| 20 | - * |
|
| 21 | - * @var string |
|
| 22 | - */ |
|
| 18 | + /** |
|
| 19 | + * Which data store to load. |
|
| 20 | + * |
|
| 21 | + * @var string |
|
| 22 | + */ |
|
| 23 | 23 | protected $data_store_name = 'discount'; |
| 24 | 24 | |
| 25 | 25 | /** |
| 26 | - * This is the name of this object type. |
|
| 27 | - * |
|
| 28 | - * @var string |
|
| 29 | - */ |
|
| 30 | - protected $object_type = 'discount'; |
|
| 31 | - |
|
| 32 | - /** |
|
| 33 | - * Discount Data array. This is the core item data exposed in APIs. |
|
| 34 | - * |
|
| 35 | - * @since 1.0.19 |
|
| 36 | - * @var array |
|
| 37 | - */ |
|
| 38 | - protected $data = array( |
|
| 39 | - 'status' => 'draft', |
|
| 40 | - 'version' => '', |
|
| 41 | - 'date_created' => null, |
|
| 26 | + * This is the name of this object type. |
|
| 27 | + * |
|
| 28 | + * @var string |
|
| 29 | + */ |
|
| 30 | + protected $object_type = 'discount'; |
|
| 31 | + |
|
| 32 | + /** |
|
| 33 | + * Discount Data array. This is the core item data exposed in APIs. |
|
| 34 | + * |
|
| 35 | + * @since 1.0.19 |
|
| 36 | + * @var array |
|
| 37 | + */ |
|
| 38 | + protected $data = array( |
|
| 39 | + 'status' => 'draft', |
|
| 40 | + 'version' => '', |
|
| 41 | + 'date_created' => null, |
|
| 42 | 42 | 'date_modified' => null, |
| 43 | 43 | 'name' => 'no-name', |
| 44 | 44 | 'description' => '', |
@@ -58,144 +58,144 @@ discard block |
||
| 58 | 58 | 'amount' => null, |
| 59 | 59 | ); |
| 60 | 60 | |
| 61 | - /** |
|
| 62 | - * Stores meta in cache for future reads. |
|
| 63 | - * |
|
| 64 | - * A group must be set to to enable caching. |
|
| 65 | - * |
|
| 66 | - * @var string |
|
| 67 | - */ |
|
| 68 | - protected $cache_group = 'getpaid_discounts'; |
|
| 61 | + /** |
|
| 62 | + * Stores meta in cache for future reads. |
|
| 63 | + * |
|
| 64 | + * A group must be set to to enable caching. |
|
| 65 | + * |
|
| 66 | + * @var string |
|
| 67 | + */ |
|
| 68 | + protected $cache_group = 'getpaid_discounts'; |
|
| 69 | 69 | |
| 70 | 70 | /** |
| 71 | 71 | * Stores a reference to the original WP_Post object |
| 72 | 72 | * |
| 73 | 73 | * @var WP_Post |
| 74 | 74 | */ |
| 75 | - protected $post = null; |
|
| 76 | - |
|
| 77 | - /** |
|
| 78 | - * Get the discount if ID is passed, otherwise the discount is new and empty. |
|
| 79 | - * |
|
| 80 | - * @param int|array|string|WPInv_Discount|WP_Post $discount discount data, object, ID or code. |
|
| 81 | - */ |
|
| 82 | - public function __construct( $discount = 0 ) { |
|
| 83 | - parent::__construct( $discount ); |
|
| 84 | - |
|
| 85 | - if ( is_numeric( $discount ) && 'wpi_discount' === get_post_type( $discount ) ) { |
|
| 86 | - $this->set_id( $discount ); |
|
| 87 | - } elseif ( $discount instanceof self ) { |
|
| 88 | - $this->set_id( $discount->get_id() ); |
|
| 89 | - } elseif ( ! empty( $discount->ID ) ) { |
|
| 90 | - $this->set_id( $discount->ID ); |
|
| 91 | - } elseif ( is_array( $discount ) ) { |
|
| 92 | - $this->set_props( $discount ); |
|
| 93 | - |
|
| 94 | - if ( isset( $discount['ID'] ) ) { |
|
| 95 | - $this->set_id( $discount['ID'] ); |
|
| 96 | - } |
|
| 97 | - |
|
| 98 | - } elseif ( is_scalar( $discount ) && $discount = self::get_discount_id_by_code( $discount ) ) { |
|
| 99 | - $this->set_id( $discount ); |
|
| 100 | - } else { |
|
| 101 | - $this->set_object_read( true ); |
|
| 102 | - } |
|
| 75 | + protected $post = null; |
|
| 76 | + |
|
| 77 | + /** |
|
| 78 | + * Get the discount if ID is passed, otherwise the discount is new and empty. |
|
| 79 | + * |
|
| 80 | + * @param int|array|string|WPInv_Discount|WP_Post $discount discount data, object, ID or code. |
|
| 81 | + */ |
|
| 82 | + public function __construct( $discount = 0 ) { |
|
| 83 | + parent::__construct( $discount ); |
|
| 84 | + |
|
| 85 | + if ( is_numeric( $discount ) && 'wpi_discount' === get_post_type( $discount ) ) { |
|
| 86 | + $this->set_id( $discount ); |
|
| 87 | + } elseif ( $discount instanceof self ) { |
|
| 88 | + $this->set_id( $discount->get_id() ); |
|
| 89 | + } elseif ( ! empty( $discount->ID ) ) { |
|
| 90 | + $this->set_id( $discount->ID ); |
|
| 91 | + } elseif ( is_array( $discount ) ) { |
|
| 92 | + $this->set_props( $discount ); |
|
| 93 | + |
|
| 94 | + if ( isset( $discount['ID'] ) ) { |
|
| 95 | + $this->set_id( $discount['ID'] ); |
|
| 96 | + } |
|
| 97 | + |
|
| 98 | + } elseif ( is_scalar( $discount ) && $discount = self::get_discount_id_by_code( $discount ) ) { |
|
| 99 | + $this->set_id( $discount ); |
|
| 100 | + } else { |
|
| 101 | + $this->set_object_read( true ); |
|
| 102 | + } |
|
| 103 | 103 | |
| 104 | 104 | // Load the datastore. |
| 105 | - $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
| 105 | + $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
| 106 | 106 | |
| 107 | - if ( $this->get_id() > 0 ) { |
|
| 107 | + if ( $this->get_id() > 0 ) { |
|
| 108 | 108 | $this->post = get_post( $this->get_id() ); |
| 109 | 109 | $this->ID = $this->get_id(); |
| 110 | - $this->data_store->read( $this ); |
|
| 110 | + $this->data_store->read( $this ); |
|
| 111 | + } |
|
| 112 | + |
|
| 113 | + } |
|
| 114 | + |
|
| 115 | + /** |
|
| 116 | + * Fetch a discount from the db/cache |
|
| 117 | + * |
|
| 118 | + * |
|
| 119 | + * @static |
|
| 120 | + * @param string $field The field to query against: 'ID', 'discount_code' |
|
| 121 | + * @param string|int $value The field value |
|
| 122 | + * @deprecated |
|
| 123 | + * @since 1.0.15 |
|
| 124 | + * @return array|bool array of discount details on success. False otherwise. |
|
| 125 | + */ |
|
| 126 | + public static function get_data_by( $field, $value ) { |
|
| 127 | + |
|
| 128 | + if ( 'id' == strtolower( $field ) ) { |
|
| 129 | + // Make sure the value is numeric to avoid casting objects, for example, |
|
| 130 | + // to int 1. |
|
| 131 | + if ( ! is_numeric( $value ) ) |
|
| 132 | + return false; |
|
| 133 | + $value = intval( $value ); |
|
| 134 | + if ( $value < 1 ) |
|
| 135 | + return false; |
|
| 136 | + } |
|
| 137 | + |
|
| 138 | + if ( ! $value || ! is_string( $field ) ) { |
|
| 139 | + return false; |
|
| 140 | + } |
|
| 141 | + |
|
| 142 | + $field = trim( $field ); |
|
| 143 | + |
|
| 144 | + // prepare query args |
|
| 145 | + switch ( strtolower( $field ) ) { |
|
| 146 | + case 'id': |
|
| 147 | + $discount_id = $value; |
|
| 148 | + $args = array( 'include' => array( $value ) ); |
|
| 149 | + break; |
|
| 150 | + case 'discount_code': |
|
| 151 | + case 'code': |
|
| 152 | + $value = trim( $value ); |
|
| 153 | + $discount_id = wp_cache_get( $value, 'WPInv_Discount_Codes' ); |
|
| 154 | + $args = array( 'meta_key' => '_wpi_discount_code', 'meta_value' => $value ); |
|
| 155 | + break; |
|
| 156 | + case 'name': |
|
| 157 | + $discount_id = 0; |
|
| 158 | + $args = array( 'name' => trim( $value ) ); |
|
| 159 | + break; |
|
| 160 | + default: |
|
| 161 | + $args = apply_filters( "wpinv_discount_get_data_by_{$field}_args", null, $value ); |
|
| 162 | + if ( ! is_array( $args ) ) { |
|
| 163 | + return apply_filters( "wpinv_discount_get_data_by_$field", false, $value ); |
|
| 164 | + } |
|
| 165 | + |
|
| 166 | + } |
|
| 167 | + |
|
| 168 | + // Check if there is a cached value. |
|
| 169 | + if ( ! empty( $discount_id ) && $discount = wp_cache_get( (int) $discount_id, 'WPInv_Discounts' ) ) { |
|
| 170 | + return $discount; |
|
| 171 | + } |
|
| 172 | + |
|
| 173 | + $args = array_merge( |
|
| 174 | + $args, |
|
| 175 | + array( |
|
| 176 | + 'post_type' => 'wpi_discount', |
|
| 177 | + 'posts_per_page' => 1, |
|
| 178 | + 'post_status' => array( 'publish', 'pending', 'draft', 'expired' ) |
|
| 179 | + ) |
|
| 180 | + ); |
|
| 181 | + |
|
| 182 | + $discount = get_posts( $args ); |
|
| 183 | + |
|
| 184 | + if( empty( $discount ) ) { |
|
| 185 | + return false; |
|
| 111 | 186 | } |
| 112 | 187 | |
| 113 | - } |
|
| 114 | - |
|
| 115 | - /** |
|
| 116 | - * Fetch a discount from the db/cache |
|
| 117 | - * |
|
| 118 | - * |
|
| 119 | - * @static |
|
| 120 | - * @param string $field The field to query against: 'ID', 'discount_code' |
|
| 121 | - * @param string|int $value The field value |
|
| 122 | - * @deprecated |
|
| 123 | - * @since 1.0.15 |
|
| 124 | - * @return array|bool array of discount details on success. False otherwise. |
|
| 125 | - */ |
|
| 126 | - public static function get_data_by( $field, $value ) { |
|
| 127 | - |
|
| 128 | - if ( 'id' == strtolower( $field ) ) { |
|
| 129 | - // Make sure the value is numeric to avoid casting objects, for example, |
|
| 130 | - // to int 1. |
|
| 131 | - if ( ! is_numeric( $value ) ) |
|
| 132 | - return false; |
|
| 133 | - $value = intval( $value ); |
|
| 134 | - if ( $value < 1 ) |
|
| 135 | - return false; |
|
| 136 | - } |
|
| 137 | - |
|
| 138 | - if ( ! $value || ! is_string( $field ) ) { |
|
| 139 | - return false; |
|
| 140 | - } |
|
| 141 | - |
|
| 142 | - $field = trim( $field ); |
|
| 143 | - |
|
| 144 | - // prepare query args |
|
| 145 | - switch ( strtolower( $field ) ) { |
|
| 146 | - case 'id': |
|
| 147 | - $discount_id = $value; |
|
| 148 | - $args = array( 'include' => array( $value ) ); |
|
| 149 | - break; |
|
| 150 | - case 'discount_code': |
|
| 151 | - case 'code': |
|
| 152 | - $value = trim( $value ); |
|
| 153 | - $discount_id = wp_cache_get( $value, 'WPInv_Discount_Codes' ); |
|
| 154 | - $args = array( 'meta_key' => '_wpi_discount_code', 'meta_value' => $value ); |
|
| 155 | - break; |
|
| 156 | - case 'name': |
|
| 157 | - $discount_id = 0; |
|
| 158 | - $args = array( 'name' => trim( $value ) ); |
|
| 159 | - break; |
|
| 160 | - default: |
|
| 161 | - $args = apply_filters( "wpinv_discount_get_data_by_{$field}_args", null, $value ); |
|
| 162 | - if ( ! is_array( $args ) ) { |
|
| 163 | - return apply_filters( "wpinv_discount_get_data_by_$field", false, $value ); |
|
| 164 | - } |
|
| 165 | - |
|
| 166 | - } |
|
| 167 | - |
|
| 168 | - // Check if there is a cached value. |
|
| 169 | - if ( ! empty( $discount_id ) && $discount = wp_cache_get( (int) $discount_id, 'WPInv_Discounts' ) ) { |
|
| 170 | - return $discount; |
|
| 171 | - } |
|
| 172 | - |
|
| 173 | - $args = array_merge( |
|
| 174 | - $args, |
|
| 175 | - array( |
|
| 176 | - 'post_type' => 'wpi_discount', |
|
| 177 | - 'posts_per_page' => 1, |
|
| 178 | - 'post_status' => array( 'publish', 'pending', 'draft', 'expired' ) |
|
| 179 | - ) |
|
| 180 | - ); |
|
| 181 | - |
|
| 182 | - $discount = get_posts( $args ); |
|
| 183 | - |
|
| 184 | - if( empty( $discount ) ) { |
|
| 185 | - return false; |
|
| 186 | - } |
|
| 187 | - |
|
| 188 | - $discount = $discount[0]; |
|
| 189 | - |
|
| 190 | - // Prepare the return data. |
|
| 191 | - $return = array( |
|
| 188 | + $discount = $discount[0]; |
|
| 189 | + |
|
| 190 | + // Prepare the return data. |
|
| 191 | + $return = array( |
|
| 192 | 192 | 'ID' => $discount->ID, |
| 193 | 193 | 'code' => get_post_meta( $discount->ID, '_wpi_discount_code', true ), |
| 194 | 194 | 'amount' => get_post_meta( $discount->ID, '_wpi_discount_amount', true ), |
| 195 | 195 | 'date_created' => $discount->post_date, |
| 196 | - 'date_modified' => $discount->post_modified, |
|
| 197 | - 'status' => $discount->post_status, |
|
| 198 | - 'start' => get_post_meta( $discount->ID, '_wpi_discount_start', true ), |
|
| 196 | + 'date_modified' => $discount->post_modified, |
|
| 197 | + 'status' => $discount->post_status, |
|
| 198 | + 'start' => get_post_meta( $discount->ID, '_wpi_discount_start', true ), |
|
| 199 | 199 | 'expiration' => get_post_meta( $discount->ID, '_wpi_discount_expiration', true ), |
| 200 | 200 | 'type' => get_post_meta( $discount->ID, '_wpi_discount_type', true ), |
| 201 | 201 | 'description' => $discount->post_excerpt, |
@@ -209,77 +209,77 @@ discard block |
||
| 209 | 209 | 'max_total' => get_post_meta( $discount->ID, '_wpi_discount_max_total', true ), |
| 210 | 210 | ); |
| 211 | 211 | |
| 212 | - $return = apply_filters( 'wpinv_discount_properties', $return ); |
|
| 213 | - |
|
| 214 | - // Update the cache with our data |
|
| 215 | - wp_cache_add( $discount->ID, $return, 'WPInv_Discounts' ); |
|
| 216 | - wp_cache_add( $return['code'], $discount->ID, 'WPInv_Discount_Codes' ); |
|
| 217 | - |
|
| 218 | - return $return; |
|
| 219 | - } |
|
| 220 | - |
|
| 221 | - /** |
|
| 222 | - * Given a discount code, it returns a discount id. |
|
| 223 | - * |
|
| 224 | - * |
|
| 225 | - * @static |
|
| 226 | - * @param string $discount_code |
|
| 227 | - * @since 1.0.15 |
|
| 228 | - * @return int |
|
| 229 | - */ |
|
| 230 | - public static function get_discount_id_by_code( $discount_code ) { |
|
| 231 | - |
|
| 232 | - // Trim the code. |
|
| 233 | - $discount_code = trim( $discount_code ); |
|
| 234 | - |
|
| 235 | - // Ensure a value has been passed. |
|
| 236 | - if ( empty( $discount_code ) ) { |
|
| 237 | - return 0; |
|
| 238 | - } |
|
| 239 | - |
|
| 240 | - // Maybe retrieve from the cache. |
|
| 241 | - $discount_id = wp_cache_get( $discount_code, 'getpaid_discount_codes' ); |
|
| 242 | - if ( ! empty( $discount_id ) ) { |
|
| 243 | - return $discount_id; |
|
| 244 | - } |
|
| 245 | - |
|
| 246 | - // Fetch the first discount codes. |
|
| 247 | - $discounts = get_posts( |
|
| 248 | - array( |
|
| 249 | - 'meta_key' => '_wpi_discount_code', |
|
| 250 | - 'meta_value' => $discount_code, |
|
| 251 | - 'post_type' => 'wpi_discount', |
|
| 252 | - 'posts_per_page' => 1, |
|
| 253 | - 'post_status' => array( 'publish', 'pending', 'draft', 'expired' ), |
|
| 254 | - 'fields' => 'ids', |
|
| 255 | - ) |
|
| 256 | - ); |
|
| 257 | - |
|
| 258 | - if ( empty( $discounts ) ) { |
|
| 259 | - return 0; |
|
| 260 | - } |
|
| 261 | - |
|
| 262 | - $discount_id = $discounts[0]; |
|
| 263 | - |
|
| 264 | - // Update the cache with our data |
|
| 265 | - wp_cache_add( get_post_meta( $discount_id, '_wpi_discount_code', true ), $discount_id, 'getpaid_discount_codes' ); |
|
| 266 | - |
|
| 267 | - return $discount_id; |
|
| 268 | - } |
|
| 269 | - |
|
| 270 | - /** |
|
| 271 | - * Magic method for checking the existence of a certain custom field. |
|
| 272 | - * |
|
| 273 | - * @since 1.0.15 |
|
| 274 | - * @access public |
|
| 275 | - * |
|
| 276 | - * @return bool Whether the given discount field is set. |
|
| 277 | - */ |
|
| 278 | - public function __isset( $key ){ |
|
| 279 | - return isset( $this->data[$key] ) || method_exists( $this, "get_$key"); |
|
| 280 | - } |
|
| 281 | - |
|
| 282 | - /* |
|
| 212 | + $return = apply_filters( 'wpinv_discount_properties', $return ); |
|
| 213 | + |
|
| 214 | + // Update the cache with our data |
|
| 215 | + wp_cache_add( $discount->ID, $return, 'WPInv_Discounts' ); |
|
| 216 | + wp_cache_add( $return['code'], $discount->ID, 'WPInv_Discount_Codes' ); |
|
| 217 | + |
|
| 218 | + return $return; |
|
| 219 | + } |
|
| 220 | + |
|
| 221 | + /** |
|
| 222 | + * Given a discount code, it returns a discount id. |
|
| 223 | + * |
|
| 224 | + * |
|
| 225 | + * @static |
|
| 226 | + * @param string $discount_code |
|
| 227 | + * @since 1.0.15 |
|
| 228 | + * @return int |
|
| 229 | + */ |
|
| 230 | + public static function get_discount_id_by_code( $discount_code ) { |
|
| 231 | + |
|
| 232 | + // Trim the code. |
|
| 233 | + $discount_code = trim( $discount_code ); |
|
| 234 | + |
|
| 235 | + // Ensure a value has been passed. |
|
| 236 | + if ( empty( $discount_code ) ) { |
|
| 237 | + return 0; |
|
| 238 | + } |
|
| 239 | + |
|
| 240 | + // Maybe retrieve from the cache. |
|
| 241 | + $discount_id = wp_cache_get( $discount_code, 'getpaid_discount_codes' ); |
|
| 242 | + if ( ! empty( $discount_id ) ) { |
|
| 243 | + return $discount_id; |
|
| 244 | + } |
|
| 245 | + |
|
| 246 | + // Fetch the first discount codes. |
|
| 247 | + $discounts = get_posts( |
|
| 248 | + array( |
|
| 249 | + 'meta_key' => '_wpi_discount_code', |
|
| 250 | + 'meta_value' => $discount_code, |
|
| 251 | + 'post_type' => 'wpi_discount', |
|
| 252 | + 'posts_per_page' => 1, |
|
| 253 | + 'post_status' => array( 'publish', 'pending', 'draft', 'expired' ), |
|
| 254 | + 'fields' => 'ids', |
|
| 255 | + ) |
|
| 256 | + ); |
|
| 257 | + |
|
| 258 | + if ( empty( $discounts ) ) { |
|
| 259 | + return 0; |
|
| 260 | + } |
|
| 261 | + |
|
| 262 | + $discount_id = $discounts[0]; |
|
| 263 | + |
|
| 264 | + // Update the cache with our data |
|
| 265 | + wp_cache_add( get_post_meta( $discount_id, '_wpi_discount_code', true ), $discount_id, 'getpaid_discount_codes' ); |
|
| 266 | + |
|
| 267 | + return $discount_id; |
|
| 268 | + } |
|
| 269 | + |
|
| 270 | + /** |
|
| 271 | + * Magic method for checking the existence of a certain custom field. |
|
| 272 | + * |
|
| 273 | + * @since 1.0.15 |
|
| 274 | + * @access public |
|
| 275 | + * |
|
| 276 | + * @return bool Whether the given discount field is set. |
|
| 277 | + */ |
|
| 278 | + public function __isset( $key ){ |
|
| 279 | + return isset( $this->data[$key] ) || method_exists( $this, "get_$key"); |
|
| 280 | + } |
|
| 281 | + |
|
| 282 | + /* |
|
| 283 | 283 | |-------------------------------------------------------------------------- |
| 284 | 284 | | CRUD methods |
| 285 | 285 | |-------------------------------------------------------------------------- |
@@ -294,430 +294,430 @@ discard block |
||
| 294 | 294 | |-------------------------------------------------------------------------- |
| 295 | 295 | */ |
| 296 | 296 | |
| 297 | - /** |
|
| 298 | - * Get discount status. |
|
| 299 | - * |
|
| 300 | - * @since 1.0.19 |
|
| 301 | - * @param string $context View or edit context. |
|
| 302 | - * @return string |
|
| 303 | - */ |
|
| 304 | - public function get_status( $context = 'view' ) { |
|
| 305 | - return $this->get_prop( 'status', $context ); |
|
| 297 | + /** |
|
| 298 | + * Get discount status. |
|
| 299 | + * |
|
| 300 | + * @since 1.0.19 |
|
| 301 | + * @param string $context View or edit context. |
|
| 302 | + * @return string |
|
| 303 | + */ |
|
| 304 | + public function get_status( $context = 'view' ) { |
|
| 305 | + return $this->get_prop( 'status', $context ); |
|
| 306 | 306 | } |
| 307 | 307 | |
| 308 | 308 | /** |
| 309 | - * Get plugin version when the discount was created. |
|
| 310 | - * |
|
| 311 | - * @since 1.0.19 |
|
| 312 | - * @param string $context View or edit context. |
|
| 313 | - * @return string |
|
| 314 | - */ |
|
| 315 | - public function get_version( $context = 'view' ) { |
|
| 316 | - return $this->get_prop( 'version', $context ); |
|
| 309 | + * Get plugin version when the discount was created. |
|
| 310 | + * |
|
| 311 | + * @since 1.0.19 |
|
| 312 | + * @param string $context View or edit context. |
|
| 313 | + * @return string |
|
| 314 | + */ |
|
| 315 | + public function get_version( $context = 'view' ) { |
|
| 316 | + return $this->get_prop( 'version', $context ); |
|
| 317 | 317 | } |
| 318 | 318 | |
| 319 | 319 | /** |
| 320 | - * Get date when the discount was created. |
|
| 321 | - * |
|
| 322 | - * @since 1.0.19 |
|
| 323 | - * @param string $context View or edit context. |
|
| 324 | - * @return string |
|
| 325 | - */ |
|
| 326 | - public function get_date_created( $context = 'view' ) { |
|
| 327 | - return $this->get_prop( 'date_created', $context ); |
|
| 320 | + * Get date when the discount was created. |
|
| 321 | + * |
|
| 322 | + * @since 1.0.19 |
|
| 323 | + * @param string $context View or edit context. |
|
| 324 | + * @return string |
|
| 325 | + */ |
|
| 326 | + public function get_date_created( $context = 'view' ) { |
|
| 327 | + return $this->get_prop( 'date_created', $context ); |
|
| 328 | 328 | } |
| 329 | 329 | |
| 330 | 330 | /** |
| 331 | - * Get GMT date when the discount was created. |
|
| 332 | - * |
|
| 333 | - * @since 1.0.19 |
|
| 334 | - * @param string $context View or edit context. |
|
| 335 | - * @return string |
|
| 336 | - */ |
|
| 337 | - public function get_date_created_gmt( $context = 'view' ) { |
|
| 331 | + * Get GMT date when the discount was created. |
|
| 332 | + * |
|
| 333 | + * @since 1.0.19 |
|
| 334 | + * @param string $context View or edit context. |
|
| 335 | + * @return string |
|
| 336 | + */ |
|
| 337 | + public function get_date_created_gmt( $context = 'view' ) { |
|
| 338 | 338 | $date = $this->get_date_created( $context ); |
| 339 | 339 | |
| 340 | 340 | if ( $date ) { |
| 341 | 341 | $date = get_gmt_from_date( $date ); |
| 342 | 342 | } |
| 343 | - return $date; |
|
| 343 | + return $date; |
|
| 344 | 344 | } |
| 345 | 345 | |
| 346 | 346 | /** |
| 347 | - * Get date when the discount was last modified. |
|
| 348 | - * |
|
| 349 | - * @since 1.0.19 |
|
| 350 | - * @param string $context View or edit context. |
|
| 351 | - * @return string |
|
| 352 | - */ |
|
| 353 | - public function get_date_modified( $context = 'view' ) { |
|
| 354 | - return $this->get_prop( 'date_modified', $context ); |
|
| 347 | + * Get date when the discount was last modified. |
|
| 348 | + * |
|
| 349 | + * @since 1.0.19 |
|
| 350 | + * @param string $context View or edit context. |
|
| 351 | + * @return string |
|
| 352 | + */ |
|
| 353 | + public function get_date_modified( $context = 'view' ) { |
|
| 354 | + return $this->get_prop( 'date_modified', $context ); |
|
| 355 | 355 | } |
| 356 | 356 | |
| 357 | 357 | /** |
| 358 | - * Get GMT date when the discount was last modified. |
|
| 359 | - * |
|
| 360 | - * @since 1.0.19 |
|
| 361 | - * @param string $context View or edit context. |
|
| 362 | - * @return string |
|
| 363 | - */ |
|
| 364 | - public function get_date_modified_gmt( $context = 'view' ) { |
|
| 358 | + * Get GMT date when the discount was last modified. |
|
| 359 | + * |
|
| 360 | + * @since 1.0.19 |
|
| 361 | + * @param string $context View or edit context. |
|
| 362 | + * @return string |
|
| 363 | + */ |
|
| 364 | + public function get_date_modified_gmt( $context = 'view' ) { |
|
| 365 | 365 | $date = $this->get_date_modified( $context ); |
| 366 | 366 | |
| 367 | 367 | if ( $date ) { |
| 368 | 368 | $date = get_gmt_from_date( $date ); |
| 369 | 369 | } |
| 370 | - return $date; |
|
| 370 | + return $date; |
|
| 371 | 371 | } |
| 372 | 372 | |
| 373 | 373 | /** |
| 374 | - * Get the discount name. |
|
| 375 | - * |
|
| 376 | - * @since 1.0.19 |
|
| 377 | - * @param string $context View or edit context. |
|
| 378 | - * @return string |
|
| 379 | - */ |
|
| 380 | - public function get_name( $context = 'view' ) { |
|
| 381 | - return $this->get_prop( 'name', $context ); |
|
| 374 | + * Get the discount name. |
|
| 375 | + * |
|
| 376 | + * @since 1.0.19 |
|
| 377 | + * @param string $context View or edit context. |
|
| 378 | + * @return string |
|
| 379 | + */ |
|
| 380 | + public function get_name( $context = 'view' ) { |
|
| 381 | + return $this->get_prop( 'name', $context ); |
|
| 382 | 382 | } |
| 383 | 383 | |
| 384 | 384 | /** |
| 385 | - * Alias of self::get_name(). |
|
| 386 | - * |
|
| 387 | - * @since 1.0.19 |
|
| 388 | - * @param string $context View or edit context. |
|
| 389 | - * @return string |
|
| 390 | - */ |
|
| 391 | - public function get_title( $context = 'view' ) { |
|
| 392 | - return $this->get_name( $context ); |
|
| 385 | + * Alias of self::get_name(). |
|
| 386 | + * |
|
| 387 | + * @since 1.0.19 |
|
| 388 | + * @param string $context View or edit context. |
|
| 389 | + * @return string |
|
| 390 | + */ |
|
| 391 | + public function get_title( $context = 'view' ) { |
|
| 392 | + return $this->get_name( $context ); |
|
| 393 | 393 | } |
| 394 | 394 | |
| 395 | 395 | /** |
| 396 | - * Get the discount description. |
|
| 397 | - * |
|
| 398 | - * @since 1.0.19 |
|
| 399 | - * @param string $context View or edit context. |
|
| 400 | - * @return string |
|
| 401 | - */ |
|
| 402 | - public function get_description( $context = 'view' ) { |
|
| 403 | - return $this->get_prop( 'description', $context ); |
|
| 396 | + * Get the discount description. |
|
| 397 | + * |
|
| 398 | + * @since 1.0.19 |
|
| 399 | + * @param string $context View or edit context. |
|
| 400 | + * @return string |
|
| 401 | + */ |
|
| 402 | + public function get_description( $context = 'view' ) { |
|
| 403 | + return $this->get_prop( 'description', $context ); |
|
| 404 | 404 | } |
| 405 | 405 | |
| 406 | 406 | /** |
| 407 | - * Alias of self::get_description(). |
|
| 408 | - * |
|
| 409 | - * @since 1.0.19 |
|
| 410 | - * @param string $context View or edit context. |
|
| 411 | - * @return string |
|
| 412 | - */ |
|
| 413 | - public function get_excerpt( $context = 'view' ) { |
|
| 414 | - return $this->get_description( $context ); |
|
| 407 | + * Alias of self::get_description(). |
|
| 408 | + * |
|
| 409 | + * @since 1.0.19 |
|
| 410 | + * @param string $context View or edit context. |
|
| 411 | + * @return string |
|
| 412 | + */ |
|
| 413 | + public function get_excerpt( $context = 'view' ) { |
|
| 414 | + return $this->get_description( $context ); |
|
| 415 | 415 | } |
| 416 | 416 | |
| 417 | 417 | /** |
| 418 | - * Alias of self::get_description(). |
|
| 419 | - * |
|
| 420 | - * @since 1.0.19 |
|
| 421 | - * @param string $context View or edit context. |
|
| 422 | - * @return string |
|
| 423 | - */ |
|
| 424 | - public function get_summary( $context = 'view' ) { |
|
| 425 | - return $this->get_description( $context ); |
|
| 418 | + * Alias of self::get_description(). |
|
| 419 | + * |
|
| 420 | + * @since 1.0.19 |
|
| 421 | + * @param string $context View or edit context. |
|
| 422 | + * @return string |
|
| 423 | + */ |
|
| 424 | + public function get_summary( $context = 'view' ) { |
|
| 425 | + return $this->get_description( $context ); |
|
| 426 | 426 | } |
| 427 | 427 | |
| 428 | 428 | /** |
| 429 | - * Get the owner of the discount. |
|
| 430 | - * |
|
| 431 | - * @since 1.0.19 |
|
| 432 | - * @param string $context View or edit context. |
|
| 433 | - * @return string |
|
| 434 | - */ |
|
| 435 | - public function get_author( $context = 'view' ) { |
|
| 436 | - return (int) $this->get_prop( 'author', $context ); |
|
| 437 | - } |
|
| 429 | + * Get the owner of the discount. |
|
| 430 | + * |
|
| 431 | + * @since 1.0.19 |
|
| 432 | + * @param string $context View or edit context. |
|
| 433 | + * @return string |
|
| 434 | + */ |
|
| 435 | + public function get_author( $context = 'view' ) { |
|
| 436 | + return (int) $this->get_prop( 'author', $context ); |
|
| 437 | + } |
|
| 438 | 438 | |
| 439 | - /** |
|
| 440 | - * Get the discount code. |
|
| 441 | - * |
|
| 442 | - * @since 1.0.19 |
|
| 443 | - * @param string $context View or edit context. |
|
| 444 | - * @return string |
|
| 445 | - */ |
|
| 446 | - public function get_code( $context = 'view' ) { |
|
| 447 | - return $this->get_prop( 'code', $context ); |
|
| 448 | - } |
|
| 439 | + /** |
|
| 440 | + * Get the discount code. |
|
| 441 | + * |
|
| 442 | + * @since 1.0.19 |
|
| 443 | + * @param string $context View or edit context. |
|
| 444 | + * @return string |
|
| 445 | + */ |
|
| 446 | + public function get_code( $context = 'view' ) { |
|
| 447 | + return $this->get_prop( 'code', $context ); |
|
| 448 | + } |
|
| 449 | 449 | |
| 450 | - /** |
|
| 451 | - * Alias for self::get_code(). |
|
| 452 | - * |
|
| 453 | - * @since 1.0.19 |
|
| 454 | - * @param string $context View or edit context. |
|
| 455 | - * @return string |
|
| 456 | - */ |
|
| 457 | - public function get_coupon_code( $context = 'view' ) { |
|
| 458 | - return $this->get_code( $context ); |
|
| 459 | - } |
|
| 450 | + /** |
|
| 451 | + * Alias for self::get_code(). |
|
| 452 | + * |
|
| 453 | + * @since 1.0.19 |
|
| 454 | + * @param string $context View or edit context. |
|
| 455 | + * @return string |
|
| 456 | + */ |
|
| 457 | + public function get_coupon_code( $context = 'view' ) { |
|
| 458 | + return $this->get_code( $context ); |
|
| 459 | + } |
|
| 460 | 460 | |
| 461 | - /** |
|
| 462 | - * Alias for self::get_code(). |
|
| 463 | - * |
|
| 464 | - * @since 1.0.19 |
|
| 465 | - * @param string $context View or edit context. |
|
| 466 | - * @return string |
|
| 467 | - */ |
|
| 468 | - public function get_discount_code( $context = 'view' ) { |
|
| 469 | - return $this->get_code( $context ); |
|
| 470 | - } |
|
| 461 | + /** |
|
| 462 | + * Alias for self::get_code(). |
|
| 463 | + * |
|
| 464 | + * @since 1.0.19 |
|
| 465 | + * @param string $context View or edit context. |
|
| 466 | + * @return string |
|
| 467 | + */ |
|
| 468 | + public function get_discount_code( $context = 'view' ) { |
|
| 469 | + return $this->get_code( $context ); |
|
| 470 | + } |
|
| 471 | 471 | |
| 472 | - /** |
|
| 473 | - * Get the discount's amount. |
|
| 474 | - * |
|
| 475 | - * @since 1.0.19 |
|
| 476 | - * @param string $context View or edit context. |
|
| 477 | - * @return float |
|
| 478 | - */ |
|
| 479 | - public function get_amount( $context = 'view' ) { |
|
| 480 | - return $this->get_prop( 'amount', $context ); |
|
| 481 | - } |
|
| 482 | - |
|
| 483 | - /** |
|
| 484 | - * Get the discount's formated amount/rate. |
|
| 485 | - * |
|
| 486 | - * @since 1.0.19 |
|
| 487 | - * @return string |
|
| 488 | - */ |
|
| 489 | - public function get_formatted_amount() { |
|
| 490 | - |
|
| 491 | - if ( $this->is_type( 'flat' ) ) { |
|
| 492 | - $rate = wpinv_price( $this->get_amount() ); |
|
| 493 | - } else { |
|
| 494 | - $rate = $this->get_amount() . '%'; |
|
| 495 | - } |
|
| 496 | - |
|
| 497 | - return apply_filters( 'wpinv_format_discount_rate', $rate, $this->get_type(), $this->get_amount() ); |
|
| 498 | - } |
|
| 472 | + /** |
|
| 473 | + * Get the discount's amount. |
|
| 474 | + * |
|
| 475 | + * @since 1.0.19 |
|
| 476 | + * @param string $context View or edit context. |
|
| 477 | + * @return float |
|
| 478 | + */ |
|
| 479 | + public function get_amount( $context = 'view' ) { |
|
| 480 | + return $this->get_prop( 'amount', $context ); |
|
| 481 | + } |
|
| 482 | + |
|
| 483 | + /** |
|
| 484 | + * Get the discount's formated amount/rate. |
|
| 485 | + * |
|
| 486 | + * @since 1.0.19 |
|
| 487 | + * @return string |
|
| 488 | + */ |
|
| 489 | + public function get_formatted_amount() { |
|
| 490 | + |
|
| 491 | + if ( $this->is_type( 'flat' ) ) { |
|
| 492 | + $rate = wpinv_price( $this->get_amount() ); |
|
| 493 | + } else { |
|
| 494 | + $rate = $this->get_amount() . '%'; |
|
| 495 | + } |
|
| 496 | + |
|
| 497 | + return apply_filters( 'wpinv_format_discount_rate', $rate, $this->get_type(), $this->get_amount() ); |
|
| 498 | + } |
|
| 499 | 499 | |
| 500 | - /** |
|
| 501 | - * Get the discount's start date. |
|
| 502 | - * |
|
| 503 | - * @since 1.0.19 |
|
| 504 | - * @param string $context View or edit context. |
|
| 505 | - * @return string |
|
| 506 | - */ |
|
| 507 | - public function get_start( $context = 'view' ) { |
|
| 508 | - return $this->get_prop( 'start', $context ); |
|
| 509 | - } |
|
| 500 | + /** |
|
| 501 | + * Get the discount's start date. |
|
| 502 | + * |
|
| 503 | + * @since 1.0.19 |
|
| 504 | + * @param string $context View or edit context. |
|
| 505 | + * @return string |
|
| 506 | + */ |
|
| 507 | + public function get_start( $context = 'view' ) { |
|
| 508 | + return $this->get_prop( 'start', $context ); |
|
| 509 | + } |
|
| 510 | 510 | |
| 511 | - /** |
|
| 512 | - * Alias for self::get_start(). |
|
| 513 | - * |
|
| 514 | - * @since 1.0.19 |
|
| 515 | - * @param string $context View or edit context. |
|
| 516 | - * @return string |
|
| 517 | - */ |
|
| 518 | - public function get_start_date( $context = 'view' ) { |
|
| 519 | - return $this->get_start( $context ); |
|
| 520 | - } |
|
| 511 | + /** |
|
| 512 | + * Alias for self::get_start(). |
|
| 513 | + * |
|
| 514 | + * @since 1.0.19 |
|
| 515 | + * @param string $context View or edit context. |
|
| 516 | + * @return string |
|
| 517 | + */ |
|
| 518 | + public function get_start_date( $context = 'view' ) { |
|
| 519 | + return $this->get_start( $context ); |
|
| 520 | + } |
|
| 521 | 521 | |
| 522 | - /** |
|
| 523 | - * Get the discount's expiration date. |
|
| 524 | - * |
|
| 525 | - * @since 1.0.19 |
|
| 526 | - * @param string $context View or edit context. |
|
| 527 | - * @return string |
|
| 528 | - */ |
|
| 529 | - public function get_expiration( $context = 'view' ) { |
|
| 530 | - return $this->get_prop( 'expiration', $context ); |
|
| 531 | - } |
|
| 522 | + /** |
|
| 523 | + * Get the discount's expiration date. |
|
| 524 | + * |
|
| 525 | + * @since 1.0.19 |
|
| 526 | + * @param string $context View or edit context. |
|
| 527 | + * @return string |
|
| 528 | + */ |
|
| 529 | + public function get_expiration( $context = 'view' ) { |
|
| 530 | + return $this->get_prop( 'expiration', $context ); |
|
| 531 | + } |
|
| 532 | 532 | |
| 533 | - /** |
|
| 534 | - * Alias for self::get_expiration(). |
|
| 535 | - * |
|
| 536 | - * @since 1.0.19 |
|
| 537 | - * @param string $context View or edit context. |
|
| 538 | - * @return string |
|
| 539 | - */ |
|
| 540 | - public function get_expiration_date( $context = 'view' ) { |
|
| 541 | - return $this->get_expiration( $context ); |
|
| 542 | - } |
|
| 543 | - |
|
| 544 | - /** |
|
| 545 | - * Alias for self::get_expiration(). |
|
| 546 | - * |
|
| 547 | - * @since 1.0.19 |
|
| 548 | - * @param string $context View or edit context. |
|
| 549 | - * @return string |
|
| 550 | - */ |
|
| 551 | - public function get_end_date( $context = 'view' ) { |
|
| 552 | - return $this->get_expiration( $context ); |
|
| 553 | - } |
|
| 533 | + /** |
|
| 534 | + * Alias for self::get_expiration(). |
|
| 535 | + * |
|
| 536 | + * @since 1.0.19 |
|
| 537 | + * @param string $context View or edit context. |
|
| 538 | + * @return string |
|
| 539 | + */ |
|
| 540 | + public function get_expiration_date( $context = 'view' ) { |
|
| 541 | + return $this->get_expiration( $context ); |
|
| 542 | + } |
|
| 543 | + |
|
| 544 | + /** |
|
| 545 | + * Alias for self::get_expiration(). |
|
| 546 | + * |
|
| 547 | + * @since 1.0.19 |
|
| 548 | + * @param string $context View or edit context. |
|
| 549 | + * @return string |
|
| 550 | + */ |
|
| 551 | + public function get_end_date( $context = 'view' ) { |
|
| 552 | + return $this->get_expiration( $context ); |
|
| 553 | + } |
|
| 554 | 554 | |
| 555 | - /** |
|
| 556 | - * Get the discount's type. |
|
| 557 | - * |
|
| 558 | - * @since 1.0.19 |
|
| 559 | - * @param string $context View or edit context. |
|
| 560 | - * @return string |
|
| 561 | - */ |
|
| 562 | - public function get_type( $context = 'view' ) { |
|
| 563 | - return $this->get_prop( 'type', $context ); |
|
| 564 | - } |
|
| 565 | - |
|
| 566 | - /** |
|
| 567 | - * Get the number of times a discount has been used. |
|
| 568 | - * |
|
| 569 | - * @since 1.0.19 |
|
| 570 | - * @param string $context View or edit context. |
|
| 571 | - * @return int |
|
| 572 | - */ |
|
| 573 | - public function get_uses( $context = 'view' ) { |
|
| 574 | - return (int) $this->get_prop( 'uses', $context ); |
|
| 575 | - } |
|
| 576 | - |
|
| 577 | - /** |
|
| 578 | - * Get the discount's usage, i.e uses / max uses. |
|
| 579 | - * |
|
| 580 | - * @since 1.0.19 |
|
| 581 | - * @return string |
|
| 582 | - */ |
|
| 583 | - public function get_usage() { |
|
| 584 | - |
|
| 585 | - if ( ! $this->has_limit() ) { |
|
| 586 | - return $this->get_uses() . ' / ' . ' ∞'; |
|
| 587 | - } |
|
| 588 | - |
|
| 589 | - return $this->get_uses() . ' / ' . (int) $this->get_max_uses(); |
|
| 590 | - |
|
| 591 | - } |
|
| 592 | - |
|
| 593 | - /** |
|
| 594 | - * Get the maximum number of time a discount can be used. |
|
| 595 | - * |
|
| 596 | - * @since 1.0.19 |
|
| 597 | - * @param string $context View or edit context. |
|
| 598 | - * @return int |
|
| 599 | - */ |
|
| 600 | - public function get_max_uses( $context = 'view' ) { |
|
| 601 | - $max_uses = $this->get_prop( 'max_uses', $context ); |
|
| 602 | - return empty( $max_uses ) ? null : $max_uses; |
|
| 603 | - } |
|
| 604 | - |
|
| 605 | - /** |
|
| 606 | - * Checks if this is a single use discount or not. |
|
| 607 | - * |
|
| 608 | - * @since 1.0.19 |
|
| 609 | - * @param string $context View or edit context. |
|
| 610 | - * @return bool |
|
| 611 | - */ |
|
| 612 | - public function get_is_single_use( $context = 'view' ) { |
|
| 613 | - return $this->get_prop( 'is_single_use', $context ); |
|
| 614 | - } |
|
| 615 | - |
|
| 616 | - /** |
|
| 617 | - * Get the items that can be used with this discount. |
|
| 618 | - * |
|
| 619 | - * @since 1.0.19 |
|
| 620 | - * @param string $context View or edit context. |
|
| 621 | - * @return array |
|
| 622 | - */ |
|
| 623 | - public function get_items( $context = 'view' ) { |
|
| 624 | - return wpinv_parse_list( $this->get_prop( 'items', $context ) ); |
|
| 625 | - } |
|
| 626 | - |
|
| 627 | - /** |
|
| 628 | - * Alias for self::get_items(). |
|
| 629 | - * |
|
| 630 | - * @since 1.0.19 |
|
| 631 | - * @param string $context View or edit context. |
|
| 632 | - * @return array |
|
| 633 | - */ |
|
| 634 | - public function get_allowed_items( $context = 'view' ) { |
|
| 635 | - return $this->get_items( $context ); |
|
| 636 | - } |
|
| 637 | - |
|
| 638 | - /** |
|
| 639 | - * Get the items that are not allowed to use this discount. |
|
| 640 | - * |
|
| 641 | - * @since 1.0.19 |
|
| 642 | - * @param string $context View or edit context. |
|
| 643 | - * @return array |
|
| 644 | - */ |
|
| 645 | - public function get_excluded_items( $context = 'view' ) { |
|
| 646 | - return wpinv_parse_list( $this->get_prop( 'excluded_items', $context ) ); |
|
| 647 | - } |
|
| 648 | - |
|
| 649 | - /** |
|
| 650 | - * Checks if this is a recurring discount or not. |
|
| 651 | - * |
|
| 652 | - * @since 1.0.19 |
|
| 653 | - * @param string $context View or edit context. |
|
| 654 | - * @return int|string|bool |
|
| 655 | - */ |
|
| 656 | - public function get_is_recurring( $context = 'view' ) { |
|
| 657 | - return $this->get_prop( 'is_recurring', $context ); |
|
| 658 | - } |
|
| 659 | - |
|
| 660 | - /** |
|
| 661 | - * Get's the minimum total amount allowed for this discount. |
|
| 662 | - * |
|
| 663 | - * @since 1.0.19 |
|
| 664 | - * @param string $context View or edit context. |
|
| 665 | - * @return float |
|
| 666 | - */ |
|
| 667 | - public function get_min_total( $context = 'view' ) { |
|
| 668 | - $minimum = $this->get_prop( 'min_total', $context ); |
|
| 669 | - return empty( $minimum ) ? null : $minimum; |
|
| 670 | - } |
|
| 671 | - |
|
| 672 | - /** |
|
| 673 | - * Alias for self::get_min_total(). |
|
| 674 | - * |
|
| 675 | - * @since 1.0.19 |
|
| 676 | - * @param string $context View or edit context. |
|
| 677 | - * @return float |
|
| 678 | - */ |
|
| 679 | - public function get_minimum_total( $context = 'view' ) { |
|
| 680 | - return $this->get_min_total( $context ); |
|
| 681 | - } |
|
| 682 | - |
|
| 683 | - /** |
|
| 684 | - * Get's the maximum total amount allowed for this discount. |
|
| 685 | - * |
|
| 686 | - * @since 1.0.19 |
|
| 687 | - * @param string $context View or edit context. |
|
| 688 | - * @return float |
|
| 689 | - */ |
|
| 690 | - public function get_max_total( $context = 'view' ) { |
|
| 691 | - $maximum = $this->get_prop( 'max_total', $context ); |
|
| 692 | - return empty( $maximum ) ? null : $maximum; |
|
| 693 | - } |
|
| 694 | - |
|
| 695 | - /** |
|
| 696 | - * Alias for self::get_max_total(). |
|
| 697 | - * |
|
| 698 | - * @since 1.0.19 |
|
| 699 | - * @param string $context View or edit context. |
|
| 700 | - * @return float |
|
| 701 | - */ |
|
| 702 | - public function get_maximum_total( $context = 'view' ) { |
|
| 703 | - return $this->get_max_total( $context ); |
|
| 704 | - } |
|
| 705 | - |
|
| 706 | - /** |
|
| 707 | - * Magic method for accessing discount properties. |
|
| 708 | - * |
|
| 709 | - * @since 1.0.15 |
|
| 710 | - * @access public |
|
| 711 | - * |
|
| 712 | - * @param string $key Discount data to retrieve |
|
| 713 | - * @param string $context View or edit context. |
|
| 714 | - * @return mixed Value of the given discount property (if set). |
|
| 715 | - */ |
|
| 716 | - public function get( $key, $context = 'view' ) { |
|
| 555 | + /** |
|
| 556 | + * Get the discount's type. |
|
| 557 | + * |
|
| 558 | + * @since 1.0.19 |
|
| 559 | + * @param string $context View or edit context. |
|
| 560 | + * @return string |
|
| 561 | + */ |
|
| 562 | + public function get_type( $context = 'view' ) { |
|
| 563 | + return $this->get_prop( 'type', $context ); |
|
| 564 | + } |
|
| 565 | + |
|
| 566 | + /** |
|
| 567 | + * Get the number of times a discount has been used. |
|
| 568 | + * |
|
| 569 | + * @since 1.0.19 |
|
| 570 | + * @param string $context View or edit context. |
|
| 571 | + * @return int |
|
| 572 | + */ |
|
| 573 | + public function get_uses( $context = 'view' ) { |
|
| 574 | + return (int) $this->get_prop( 'uses', $context ); |
|
| 575 | + } |
|
| 576 | + |
|
| 577 | + /** |
|
| 578 | + * Get the discount's usage, i.e uses / max uses. |
|
| 579 | + * |
|
| 580 | + * @since 1.0.19 |
|
| 581 | + * @return string |
|
| 582 | + */ |
|
| 583 | + public function get_usage() { |
|
| 584 | + |
|
| 585 | + if ( ! $this->has_limit() ) { |
|
| 586 | + return $this->get_uses() . ' / ' . ' ∞'; |
|
| 587 | + } |
|
| 588 | + |
|
| 589 | + return $this->get_uses() . ' / ' . (int) $this->get_max_uses(); |
|
| 590 | + |
|
| 591 | + } |
|
| 592 | + |
|
| 593 | + /** |
|
| 594 | + * Get the maximum number of time a discount can be used. |
|
| 595 | + * |
|
| 596 | + * @since 1.0.19 |
|
| 597 | + * @param string $context View or edit context. |
|
| 598 | + * @return int |
|
| 599 | + */ |
|
| 600 | + public function get_max_uses( $context = 'view' ) { |
|
| 601 | + $max_uses = $this->get_prop( 'max_uses', $context ); |
|
| 602 | + return empty( $max_uses ) ? null : $max_uses; |
|
| 603 | + } |
|
| 604 | + |
|
| 605 | + /** |
|
| 606 | + * Checks if this is a single use discount or not. |
|
| 607 | + * |
|
| 608 | + * @since 1.0.19 |
|
| 609 | + * @param string $context View or edit context. |
|
| 610 | + * @return bool |
|
| 611 | + */ |
|
| 612 | + public function get_is_single_use( $context = 'view' ) { |
|
| 613 | + return $this->get_prop( 'is_single_use', $context ); |
|
| 614 | + } |
|
| 615 | + |
|
| 616 | + /** |
|
| 617 | + * Get the items that can be used with this discount. |
|
| 618 | + * |
|
| 619 | + * @since 1.0.19 |
|
| 620 | + * @param string $context View or edit context. |
|
| 621 | + * @return array |
|
| 622 | + */ |
|
| 623 | + public function get_items( $context = 'view' ) { |
|
| 624 | + return wpinv_parse_list( $this->get_prop( 'items', $context ) ); |
|
| 625 | + } |
|
| 626 | + |
|
| 627 | + /** |
|
| 628 | + * Alias for self::get_items(). |
|
| 629 | + * |
|
| 630 | + * @since 1.0.19 |
|
| 631 | + * @param string $context View or edit context. |
|
| 632 | + * @return array |
|
| 633 | + */ |
|
| 634 | + public function get_allowed_items( $context = 'view' ) { |
|
| 635 | + return $this->get_items( $context ); |
|
| 636 | + } |
|
| 637 | + |
|
| 638 | + /** |
|
| 639 | + * Get the items that are not allowed to use this discount. |
|
| 640 | + * |
|
| 641 | + * @since 1.0.19 |
|
| 642 | + * @param string $context View or edit context. |
|
| 643 | + * @return array |
|
| 644 | + */ |
|
| 645 | + public function get_excluded_items( $context = 'view' ) { |
|
| 646 | + return wpinv_parse_list( $this->get_prop( 'excluded_items', $context ) ); |
|
| 647 | + } |
|
| 648 | + |
|
| 649 | + /** |
|
| 650 | + * Checks if this is a recurring discount or not. |
|
| 651 | + * |
|
| 652 | + * @since 1.0.19 |
|
| 653 | + * @param string $context View or edit context. |
|
| 654 | + * @return int|string|bool |
|
| 655 | + */ |
|
| 656 | + public function get_is_recurring( $context = 'view' ) { |
|
| 657 | + return $this->get_prop( 'is_recurring', $context ); |
|
| 658 | + } |
|
| 659 | + |
|
| 660 | + /** |
|
| 661 | + * Get's the minimum total amount allowed for this discount. |
|
| 662 | + * |
|
| 663 | + * @since 1.0.19 |
|
| 664 | + * @param string $context View or edit context. |
|
| 665 | + * @return float |
|
| 666 | + */ |
|
| 667 | + public function get_min_total( $context = 'view' ) { |
|
| 668 | + $minimum = $this->get_prop( 'min_total', $context ); |
|
| 669 | + return empty( $minimum ) ? null : $minimum; |
|
| 670 | + } |
|
| 671 | + |
|
| 672 | + /** |
|
| 673 | + * Alias for self::get_min_total(). |
|
| 674 | + * |
|
| 675 | + * @since 1.0.19 |
|
| 676 | + * @param string $context View or edit context. |
|
| 677 | + * @return float |
|
| 678 | + */ |
|
| 679 | + public function get_minimum_total( $context = 'view' ) { |
|
| 680 | + return $this->get_min_total( $context ); |
|
| 681 | + } |
|
| 682 | + |
|
| 683 | + /** |
|
| 684 | + * Get's the maximum total amount allowed for this discount. |
|
| 685 | + * |
|
| 686 | + * @since 1.0.19 |
|
| 687 | + * @param string $context View or edit context. |
|
| 688 | + * @return float |
|
| 689 | + */ |
|
| 690 | + public function get_max_total( $context = 'view' ) { |
|
| 691 | + $maximum = $this->get_prop( 'max_total', $context ); |
|
| 692 | + return empty( $maximum ) ? null : $maximum; |
|
| 693 | + } |
|
| 694 | + |
|
| 695 | + /** |
|
| 696 | + * Alias for self::get_max_total(). |
|
| 697 | + * |
|
| 698 | + * @since 1.0.19 |
|
| 699 | + * @param string $context View or edit context. |
|
| 700 | + * @return float |
|
| 701 | + */ |
|
| 702 | + public function get_maximum_total( $context = 'view' ) { |
|
| 703 | + return $this->get_max_total( $context ); |
|
| 704 | + } |
|
| 705 | + |
|
| 706 | + /** |
|
| 707 | + * Magic method for accessing discount properties. |
|
| 708 | + * |
|
| 709 | + * @since 1.0.15 |
|
| 710 | + * @access public |
|
| 711 | + * |
|
| 712 | + * @param string $key Discount data to retrieve |
|
| 713 | + * @param string $context View or edit context. |
|
| 714 | + * @return mixed Value of the given discount property (if set). |
|
| 715 | + */ |
|
| 716 | + public function get( $key, $context = 'view' ) { |
|
| 717 | 717 | return $this->get_prop( $key, $context ); |
| 718 | - } |
|
| 718 | + } |
|
| 719 | 719 | |
| 720 | - /* |
|
| 720 | + /* |
|
| 721 | 721 | |-------------------------------------------------------------------------- |
| 722 | 722 | | Setters |
| 723 | 723 | |-------------------------------------------------------------------------- |
@@ -727,41 +727,41 @@ discard block |
||
| 727 | 727 | | object. |
| 728 | 728 | */ |
| 729 | 729 | |
| 730 | - /** |
|
| 731 | - * Sets discount status. |
|
| 732 | - * |
|
| 733 | - * @since 1.0.19 |
|
| 734 | - * @param string $status New status. |
|
| 735 | - * @return array details of change. |
|
| 736 | - */ |
|
| 737 | - public function set_status( $status ) { |
|
| 730 | + /** |
|
| 731 | + * Sets discount status. |
|
| 732 | + * |
|
| 733 | + * @since 1.0.19 |
|
| 734 | + * @param string $status New status. |
|
| 735 | + * @return array details of change. |
|
| 736 | + */ |
|
| 737 | + public function set_status( $status ) { |
|
| 738 | 738 | $old_status = $this->get_status(); |
| 739 | 739 | |
| 740 | 740 | $this->set_prop( 'status', $status ); |
| 741 | 741 | |
| 742 | - return array( |
|
| 743 | - 'from' => $old_status, |
|
| 744 | - 'to' => $status, |
|
| 745 | - ); |
|
| 742 | + return array( |
|
| 743 | + 'from' => $old_status, |
|
| 744 | + 'to' => $status, |
|
| 745 | + ); |
|
| 746 | 746 | } |
| 747 | 747 | |
| 748 | 748 | /** |
| 749 | - * Set plugin version when the discount was created. |
|
| 750 | - * |
|
| 751 | - * @since 1.0.19 |
|
| 752 | - */ |
|
| 753 | - public function set_version( $value ) { |
|
| 754 | - $this->set_prop( 'version', $value ); |
|
| 749 | + * Set plugin version when the discount was created. |
|
| 750 | + * |
|
| 751 | + * @since 1.0.19 |
|
| 752 | + */ |
|
| 753 | + public function set_version( $value ) { |
|
| 754 | + $this->set_prop( 'version', $value ); |
|
| 755 | 755 | } |
| 756 | 756 | |
| 757 | 757 | /** |
| 758 | - * Set date when the discount was created. |
|
| 759 | - * |
|
| 760 | - * @since 1.0.19 |
|
| 761 | - * @param string $value Value to set. |
|
| 758 | + * Set date when the discount was created. |
|
| 759 | + * |
|
| 760 | + * @since 1.0.19 |
|
| 761 | + * @param string $value Value to set. |
|
| 762 | 762 | * @return bool Whether or not the date was set. |
| 763 | - */ |
|
| 764 | - public function set_date_created( $value ) { |
|
| 763 | + */ |
|
| 764 | + public function set_date_created( $value ) { |
|
| 765 | 765 | $date = strtotime( $value ); |
| 766 | 766 | |
| 767 | 767 | if ( $date ) { |
@@ -774,13 +774,13 @@ discard block |
||
| 774 | 774 | } |
| 775 | 775 | |
| 776 | 776 | /** |
| 777 | - * Set date when the discount was last modified. |
|
| 778 | - * |
|
| 779 | - * @since 1.0.19 |
|
| 780 | - * @param string $value Value to set. |
|
| 777 | + * Set date when the discount was last modified. |
|
| 778 | + * |
|
| 779 | + * @since 1.0.19 |
|
| 780 | + * @param string $value Value to set. |
|
| 781 | 781 | * @return bool Whether or not the date was set. |
| 782 | - */ |
|
| 783 | - public function set_date_modified( $value ) { |
|
| 782 | + */ |
|
| 783 | + public function set_date_modified( $value ) { |
|
| 784 | 784 | $date = strtotime( $value ); |
| 785 | 785 | |
| 786 | 786 | if ( $date ) { |
@@ -793,324 +793,324 @@ discard block |
||
| 793 | 793 | } |
| 794 | 794 | |
| 795 | 795 | /** |
| 796 | - * Set the discount name. |
|
| 797 | - * |
|
| 798 | - * @since 1.0.19 |
|
| 799 | - * @param string $value New name. |
|
| 800 | - */ |
|
| 801 | - public function set_name( $value ) { |
|
| 796 | + * Set the discount name. |
|
| 797 | + * |
|
| 798 | + * @since 1.0.19 |
|
| 799 | + * @param string $value New name. |
|
| 800 | + */ |
|
| 801 | + public function set_name( $value ) { |
|
| 802 | 802 | $name = sanitize_text_field( $value ); |
| 803 | - $this->set_prop( 'name', $name ); |
|
| 803 | + $this->set_prop( 'name', $name ); |
|
| 804 | 804 | } |
| 805 | 805 | |
| 806 | 806 | /** |
| 807 | - * Alias of self::set_name(). |
|
| 808 | - * |
|
| 809 | - * @since 1.0.19 |
|
| 810 | - * @param string $value New name. |
|
| 811 | - */ |
|
| 812 | - public function set_title( $value ) { |
|
| 813 | - $this->set_name( $value ); |
|
| 807 | + * Alias of self::set_name(). |
|
| 808 | + * |
|
| 809 | + * @since 1.0.19 |
|
| 810 | + * @param string $value New name. |
|
| 811 | + */ |
|
| 812 | + public function set_title( $value ) { |
|
| 813 | + $this->set_name( $value ); |
|
| 814 | 814 | } |
| 815 | 815 | |
| 816 | 816 | /** |
| 817 | - * Set the discount description. |
|
| 818 | - * |
|
| 819 | - * @since 1.0.19 |
|
| 820 | - * @param string $value New description. |
|
| 821 | - */ |
|
| 822 | - public function set_description( $value ) { |
|
| 817 | + * Set the discount description. |
|
| 818 | + * |
|
| 819 | + * @since 1.0.19 |
|
| 820 | + * @param string $value New description. |
|
| 821 | + */ |
|
| 822 | + public function set_description( $value ) { |
|
| 823 | 823 | $description = wp_kses_post( $value ); |
| 824 | - return $this->set_prop( 'description', $description ); |
|
| 824 | + return $this->set_prop( 'description', $description ); |
|
| 825 | 825 | } |
| 826 | 826 | |
| 827 | 827 | /** |
| 828 | - * Alias of self::set_description(). |
|
| 829 | - * |
|
| 830 | - * @since 1.0.19 |
|
| 831 | - * @param string $value New description. |
|
| 832 | - */ |
|
| 833 | - public function set_excerpt( $value ) { |
|
| 834 | - $this->set_description( $value ); |
|
| 828 | + * Alias of self::set_description(). |
|
| 829 | + * |
|
| 830 | + * @since 1.0.19 |
|
| 831 | + * @param string $value New description. |
|
| 832 | + */ |
|
| 833 | + public function set_excerpt( $value ) { |
|
| 834 | + $this->set_description( $value ); |
|
| 835 | 835 | } |
| 836 | 836 | |
| 837 | 837 | /** |
| 838 | - * Alias of self::set_description(). |
|
| 839 | - * |
|
| 840 | - * @since 1.0.19 |
|
| 841 | - * @param string $value New description. |
|
| 842 | - */ |
|
| 843 | - public function set_summary( $value ) { |
|
| 844 | - $this->set_description( $value ); |
|
| 838 | + * Alias of self::set_description(). |
|
| 839 | + * |
|
| 840 | + * @since 1.0.19 |
|
| 841 | + * @param string $value New description. |
|
| 842 | + */ |
|
| 843 | + public function set_summary( $value ) { |
|
| 844 | + $this->set_description( $value ); |
|
| 845 | 845 | } |
| 846 | 846 | |
| 847 | 847 | /** |
| 848 | - * Set the owner of the discount. |
|
| 849 | - * |
|
| 850 | - * @since 1.0.19 |
|
| 851 | - * @param int $value New author. |
|
| 852 | - */ |
|
| 853 | - public function set_author( $value ) { |
|
| 854 | - $this->set_prop( 'author', (int) $value ); |
|
| 855 | - } |
|
| 848 | + * Set the owner of the discount. |
|
| 849 | + * |
|
| 850 | + * @since 1.0.19 |
|
| 851 | + * @param int $value New author. |
|
| 852 | + */ |
|
| 853 | + public function set_author( $value ) { |
|
| 854 | + $this->set_prop( 'author', (int) $value ); |
|
| 855 | + } |
|
| 856 | 856 | |
| 857 | - /** |
|
| 858 | - * Sets the discount code. |
|
| 859 | - * |
|
| 860 | - * @since 1.0.19 |
|
| 861 | - * @param string $value New discount code. |
|
| 862 | - */ |
|
| 863 | - public function set_code( $value ) { |
|
| 864 | - $code = sanitize_text_field( $value ); |
|
| 865 | - $this->set_prop( 'code', $code ); |
|
| 866 | - } |
|
| 857 | + /** |
|
| 858 | + * Sets the discount code. |
|
| 859 | + * |
|
| 860 | + * @since 1.0.19 |
|
| 861 | + * @param string $value New discount code. |
|
| 862 | + */ |
|
| 863 | + public function set_code( $value ) { |
|
| 864 | + $code = sanitize_text_field( $value ); |
|
| 865 | + $this->set_prop( 'code', $code ); |
|
| 866 | + } |
|
| 867 | 867 | |
| 868 | - /** |
|
| 869 | - * Alias of self::set_code(). |
|
| 870 | - * |
|
| 871 | - * @since 1.0.19 |
|
| 872 | - * @param string $value New discount code. |
|
| 873 | - */ |
|
| 874 | - public function set_coupon_code( $value ) { |
|
| 875 | - $this->set_code( $value ); |
|
| 876 | - } |
|
| 868 | + /** |
|
| 869 | + * Alias of self::set_code(). |
|
| 870 | + * |
|
| 871 | + * @since 1.0.19 |
|
| 872 | + * @param string $value New discount code. |
|
| 873 | + */ |
|
| 874 | + public function set_coupon_code( $value ) { |
|
| 875 | + $this->set_code( $value ); |
|
| 876 | + } |
|
| 877 | 877 | |
| 878 | - /** |
|
| 879 | - * Alias of self::set_code(). |
|
| 880 | - * |
|
| 881 | - * @since 1.0.19 |
|
| 882 | - * @param string $value New discount code. |
|
| 883 | - */ |
|
| 884 | - public function set_discount_code( $value ) { |
|
| 885 | - $this->set_code( $value ); |
|
| 886 | - } |
|
| 878 | + /** |
|
| 879 | + * Alias of self::set_code(). |
|
| 880 | + * |
|
| 881 | + * @since 1.0.19 |
|
| 882 | + * @param string $value New discount code. |
|
| 883 | + */ |
|
| 884 | + public function set_discount_code( $value ) { |
|
| 885 | + $this->set_code( $value ); |
|
| 886 | + } |
|
| 887 | 887 | |
| 888 | - /** |
|
| 889 | - * Sets the discount amount. |
|
| 890 | - * |
|
| 891 | - * @since 1.0.19 |
|
| 892 | - * @param float $value New discount code. |
|
| 893 | - */ |
|
| 894 | - public function set_amount( $value ) { |
|
| 895 | - $amount = floatval( wpinv_sanitize_amount( $value ) ); |
|
| 896 | - $this->set_prop( 'amount', $amount ); |
|
| 897 | - } |
|
| 898 | - |
|
| 899 | - /** |
|
| 900 | - * Sets the discount's start date. |
|
| 901 | - * |
|
| 902 | - * @since 1.0.19 |
|
| 903 | - * @param float $value New start date. |
|
| 904 | - */ |
|
| 905 | - public function set_start( $value ) { |
|
| 906 | - $date = strtotime( $value ); |
|
| 888 | + /** |
|
| 889 | + * Sets the discount amount. |
|
| 890 | + * |
|
| 891 | + * @since 1.0.19 |
|
| 892 | + * @param float $value New discount code. |
|
| 893 | + */ |
|
| 894 | + public function set_amount( $value ) { |
|
| 895 | + $amount = floatval( wpinv_sanitize_amount( $value ) ); |
|
| 896 | + $this->set_prop( 'amount', $amount ); |
|
| 897 | + } |
|
| 907 | 898 | |
| 908 | - if ( $date ) { |
|
| 909 | - $this->set_prop( 'start', date( 'Y-m-d H:i', $date ) ); |
|
| 910 | - return true; |
|
| 911 | - } |
|
| 899 | + /** |
|
| 900 | + * Sets the discount's start date. |
|
| 901 | + * |
|
| 902 | + * @since 1.0.19 |
|
| 903 | + * @param float $value New start date. |
|
| 904 | + */ |
|
| 905 | + public function set_start( $value ) { |
|
| 906 | + $date = strtotime( $value ); |
|
| 907 | + |
|
| 908 | + if ( $date ) { |
|
| 909 | + $this->set_prop( 'start', date( 'Y-m-d H:i', $date ) ); |
|
| 910 | + return true; |
|
| 911 | + } |
|
| 912 | 912 | |
| 913 | - $this->set_prop( 'start', '' ); |
|
| 913 | + $this->set_prop( 'start', '' ); |
|
| 914 | 914 | |
| 915 | 915 | return false; |
| 916 | - } |
|
| 917 | - |
|
| 918 | - /** |
|
| 919 | - * Alias of self::set_start(). |
|
| 920 | - * |
|
| 921 | - * @since 1.0.19 |
|
| 922 | - * @param string $value New start date. |
|
| 923 | - */ |
|
| 924 | - public function set_start_date( $value ) { |
|
| 925 | - $this->set_start( $value ); |
|
| 926 | - } |
|
| 927 | - |
|
| 928 | - /** |
|
| 929 | - * Sets the discount's expiration date. |
|
| 930 | - * |
|
| 931 | - * @since 1.0.19 |
|
| 932 | - * @param float $value New expiration date. |
|
| 933 | - */ |
|
| 934 | - public function set_expiration( $value ) { |
|
| 935 | - $date = strtotime( $value ); |
|
| 916 | + } |
|
| 917 | + |
|
| 918 | + /** |
|
| 919 | + * Alias of self::set_start(). |
|
| 920 | + * |
|
| 921 | + * @since 1.0.19 |
|
| 922 | + * @param string $value New start date. |
|
| 923 | + */ |
|
| 924 | + public function set_start_date( $value ) { |
|
| 925 | + $this->set_start( $value ); |
|
| 926 | + } |
|
| 927 | + |
|
| 928 | + /** |
|
| 929 | + * Sets the discount's expiration date. |
|
| 930 | + * |
|
| 931 | + * @since 1.0.19 |
|
| 932 | + * @param float $value New expiration date. |
|
| 933 | + */ |
|
| 934 | + public function set_expiration( $value ) { |
|
| 935 | + $date = strtotime( $value ); |
|
| 936 | 936 | |
| 937 | 937 | if ( $date ) { |
| 938 | 938 | $this->set_prop( 'expiration', date( 'Y-m-d H:i', $date ) ); |
| 939 | 939 | return true; |
| 940 | 940 | } |
| 941 | 941 | |
| 942 | - $this->set_prop( 'expiration', '' ); |
|
| 942 | + $this->set_prop( 'expiration', '' ); |
|
| 943 | 943 | return false; |
| 944 | - } |
|
| 945 | - |
|
| 946 | - /** |
|
| 947 | - * Alias of self::set_expiration(). |
|
| 948 | - * |
|
| 949 | - * @since 1.0.19 |
|
| 950 | - * @param string $value New expiration date. |
|
| 951 | - */ |
|
| 952 | - public function set_expiration_date( $value ) { |
|
| 953 | - $this->set_expiration( $value ); |
|
| 954 | - } |
|
| 955 | - |
|
| 956 | - /** |
|
| 957 | - * Alias of self::set_expiration(). |
|
| 958 | - * |
|
| 959 | - * @since 1.0.19 |
|
| 960 | - * @param string $value New expiration date. |
|
| 961 | - */ |
|
| 962 | - public function set_end_date( $value ) { |
|
| 963 | - $this->set_expiration( $value ); |
|
| 964 | - } |
|
| 965 | - |
|
| 966 | - /** |
|
| 967 | - * Sets the discount type. |
|
| 968 | - * |
|
| 969 | - * @since 1.0.19 |
|
| 970 | - * @param string $value New discount type. |
|
| 971 | - */ |
|
| 972 | - public function set_type( $value ) { |
|
| 973 | - if ( $value && array_key_exists( sanitize_text_field( $value ), wpinv_get_discount_types() ) ) { |
|
| 974 | - $this->set_prop( 'type', sanitize_text_field( $value ) ); |
|
| 975 | - } |
|
| 976 | - } |
|
| 977 | - |
|
| 978 | - /** |
|
| 979 | - * Sets the number of times a discount has been used. |
|
| 980 | - * |
|
| 981 | - * @since 1.0.19 |
|
| 982 | - * @param int $value usage count. |
|
| 983 | - */ |
|
| 984 | - public function set_uses( $value ) { |
|
| 985 | - |
|
| 986 | - $value = (int) $value; |
|
| 987 | - |
|
| 988 | - if ( $value < 0 ) { |
|
| 989 | - $value = 0; |
|
| 990 | - } |
|
| 991 | - |
|
| 992 | - $this->set_prop( 'uses', (int) $value ); |
|
| 993 | - } |
|
| 994 | - |
|
| 995 | - /** |
|
| 996 | - * Sets the maximum number of times a discount can be used. |
|
| 997 | - * |
|
| 998 | - * @since 1.0.19 |
|
| 999 | - * @param int $value maximum usage count. |
|
| 1000 | - */ |
|
| 1001 | - public function set_max_uses( $value ) { |
|
| 1002 | - $this->set_prop( 'max_uses', absint( $value ) ); |
|
| 1003 | - } |
|
| 1004 | - |
|
| 1005 | - /** |
|
| 1006 | - * Sets if this is a single use discount or not. |
|
| 1007 | - * |
|
| 1008 | - * @since 1.0.19 |
|
| 1009 | - * @param int|bool $value is single use. |
|
| 1010 | - */ |
|
| 1011 | - public function set_is_single_use( $value ) { |
|
| 1012 | - $this->set_prop( 'is_single_use', (bool) $value ); |
|
| 1013 | - } |
|
| 1014 | - |
|
| 1015 | - /** |
|
| 1016 | - * Sets the items that can be used with this discount. |
|
| 1017 | - * |
|
| 1018 | - * @since 1.0.19 |
|
| 1019 | - * @param array $value items. |
|
| 1020 | - */ |
|
| 1021 | - public function set_items( $value ) { |
|
| 1022 | - $this->set_prop( 'items', wpinv_parse_list( $value ) ); |
|
| 1023 | - } |
|
| 1024 | - |
|
| 1025 | - /** |
|
| 1026 | - * Alias for self::set_items(). |
|
| 1027 | - * |
|
| 1028 | - * @since 1.0.19 |
|
| 1029 | - * @param array $value items. |
|
| 1030 | - */ |
|
| 1031 | - public function set_allowed_items( $value ) { |
|
| 1032 | - $this->set_items( $value ); |
|
| 1033 | - } |
|
| 1034 | - |
|
| 1035 | - /** |
|
| 1036 | - * Sets the items that can not be used with this discount. |
|
| 1037 | - * |
|
| 1038 | - * @since 1.0.19 |
|
| 1039 | - * @param array $value items. |
|
| 1040 | - */ |
|
| 1041 | - public function set_excluded_items( $value ) { |
|
| 1042 | - $this->set_prop( 'excluded_items', wpinv_parse_list( $value ) ); |
|
| 1043 | - } |
|
| 1044 | - |
|
| 1045 | - /** |
|
| 1046 | - * Sets if this is a recurring discounts or not. |
|
| 1047 | - * |
|
| 1048 | - * @since 1.0.19 |
|
| 1049 | - * @param int|bool $value is recurring. |
|
| 1050 | - */ |
|
| 1051 | - public function set_is_recurring( $value ) { |
|
| 1052 | - $this->set_prop( 'is_recurring', (bool) $value ); |
|
| 1053 | - } |
|
| 1054 | - |
|
| 1055 | - /** |
|
| 1056 | - * Sets the minimum total that can not be used with this discount. |
|
| 1057 | - * |
|
| 1058 | - * @since 1.0.19 |
|
| 1059 | - * @param float $value minimum total. |
|
| 1060 | - */ |
|
| 1061 | - public function set_min_total( $value ) { |
|
| 1062 | - $this->set_prop( 'min_total', (float) wpinv_sanitize_amount( $value ) ); |
|
| 1063 | - } |
|
| 1064 | - |
|
| 1065 | - /** |
|
| 1066 | - * Alias for self::set_min_total(). |
|
| 1067 | - * |
|
| 1068 | - * @since 1.0.19 |
|
| 1069 | - * @param float $value minimum total. |
|
| 1070 | - */ |
|
| 1071 | - public function set_minimum_total( $value ) { |
|
| 1072 | - $this->set_min_total( $value ); |
|
| 1073 | - } |
|
| 1074 | - |
|
| 1075 | - /** |
|
| 1076 | - * Sets the maximum total that can not be used with this discount. |
|
| 1077 | - * |
|
| 1078 | - * @since 1.0.19 |
|
| 1079 | - * @param float $value maximum total. |
|
| 1080 | - */ |
|
| 1081 | - public function set_max_total( $value ) { |
|
| 1082 | - $this->set_prop( 'max_total', (float) wpinv_sanitize_amount( $value ) ); |
|
| 1083 | - } |
|
| 1084 | - |
|
| 1085 | - /** |
|
| 1086 | - * Alias for self::set_max_total(). |
|
| 1087 | - * |
|
| 1088 | - * @since 1.0.19 |
|
| 1089 | - * @param float $value maximum total. |
|
| 1090 | - */ |
|
| 1091 | - public function set_maximum_total( $value ) { |
|
| 1092 | - $this->set_max_total( $value ); |
|
| 1093 | - } |
|
| 1094 | - |
|
| 1095 | - /** |
|
| 1096 | - * @deprecated |
|
| 1097 | - */ |
|
| 1098 | - public function refresh(){} |
|
| 1099 | - |
|
| 1100 | - /** |
|
| 1101 | - * @deprecated |
|
| 1102 | - * |
|
| 1103 | - */ |
|
| 1104 | - public function update_status( $status = 'publish' ){ |
|
| 1105 | - |
|
| 1106 | - if ( $this->exists() && $this->get_status() != $status ) { |
|
| 1107 | - $this->set_status( $status ); |
|
| 1108 | - $this->save(); |
|
| 1109 | - } |
|
| 1110 | - |
|
| 1111 | - } |
|
| 1112 | - |
|
| 1113 | - /* |
|
| 944 | + } |
|
| 945 | + |
|
| 946 | + /** |
|
| 947 | + * Alias of self::set_expiration(). |
|
| 948 | + * |
|
| 949 | + * @since 1.0.19 |
|
| 950 | + * @param string $value New expiration date. |
|
| 951 | + */ |
|
| 952 | + public function set_expiration_date( $value ) { |
|
| 953 | + $this->set_expiration( $value ); |
|
| 954 | + } |
|
| 955 | + |
|
| 956 | + /** |
|
| 957 | + * Alias of self::set_expiration(). |
|
| 958 | + * |
|
| 959 | + * @since 1.0.19 |
|
| 960 | + * @param string $value New expiration date. |
|
| 961 | + */ |
|
| 962 | + public function set_end_date( $value ) { |
|
| 963 | + $this->set_expiration( $value ); |
|
| 964 | + } |
|
| 965 | + |
|
| 966 | + /** |
|
| 967 | + * Sets the discount type. |
|
| 968 | + * |
|
| 969 | + * @since 1.0.19 |
|
| 970 | + * @param string $value New discount type. |
|
| 971 | + */ |
|
| 972 | + public function set_type( $value ) { |
|
| 973 | + if ( $value && array_key_exists( sanitize_text_field( $value ), wpinv_get_discount_types() ) ) { |
|
| 974 | + $this->set_prop( 'type', sanitize_text_field( $value ) ); |
|
| 975 | + } |
|
| 976 | + } |
|
| 977 | + |
|
| 978 | + /** |
|
| 979 | + * Sets the number of times a discount has been used. |
|
| 980 | + * |
|
| 981 | + * @since 1.0.19 |
|
| 982 | + * @param int $value usage count. |
|
| 983 | + */ |
|
| 984 | + public function set_uses( $value ) { |
|
| 985 | + |
|
| 986 | + $value = (int) $value; |
|
| 987 | + |
|
| 988 | + if ( $value < 0 ) { |
|
| 989 | + $value = 0; |
|
| 990 | + } |
|
| 991 | + |
|
| 992 | + $this->set_prop( 'uses', (int) $value ); |
|
| 993 | + } |
|
| 994 | + |
|
| 995 | + /** |
|
| 996 | + * Sets the maximum number of times a discount can be used. |
|
| 997 | + * |
|
| 998 | + * @since 1.0.19 |
|
| 999 | + * @param int $value maximum usage count. |
|
| 1000 | + */ |
|
| 1001 | + public function set_max_uses( $value ) { |
|
| 1002 | + $this->set_prop( 'max_uses', absint( $value ) ); |
|
| 1003 | + } |
|
| 1004 | + |
|
| 1005 | + /** |
|
| 1006 | + * Sets if this is a single use discount or not. |
|
| 1007 | + * |
|
| 1008 | + * @since 1.0.19 |
|
| 1009 | + * @param int|bool $value is single use. |
|
| 1010 | + */ |
|
| 1011 | + public function set_is_single_use( $value ) { |
|
| 1012 | + $this->set_prop( 'is_single_use', (bool) $value ); |
|
| 1013 | + } |
|
| 1014 | + |
|
| 1015 | + /** |
|
| 1016 | + * Sets the items that can be used with this discount. |
|
| 1017 | + * |
|
| 1018 | + * @since 1.0.19 |
|
| 1019 | + * @param array $value items. |
|
| 1020 | + */ |
|
| 1021 | + public function set_items( $value ) { |
|
| 1022 | + $this->set_prop( 'items', wpinv_parse_list( $value ) ); |
|
| 1023 | + } |
|
| 1024 | + |
|
| 1025 | + /** |
|
| 1026 | + * Alias for self::set_items(). |
|
| 1027 | + * |
|
| 1028 | + * @since 1.0.19 |
|
| 1029 | + * @param array $value items. |
|
| 1030 | + */ |
|
| 1031 | + public function set_allowed_items( $value ) { |
|
| 1032 | + $this->set_items( $value ); |
|
| 1033 | + } |
|
| 1034 | + |
|
| 1035 | + /** |
|
| 1036 | + * Sets the items that can not be used with this discount. |
|
| 1037 | + * |
|
| 1038 | + * @since 1.0.19 |
|
| 1039 | + * @param array $value items. |
|
| 1040 | + */ |
|
| 1041 | + public function set_excluded_items( $value ) { |
|
| 1042 | + $this->set_prop( 'excluded_items', wpinv_parse_list( $value ) ); |
|
| 1043 | + } |
|
| 1044 | + |
|
| 1045 | + /** |
|
| 1046 | + * Sets if this is a recurring discounts or not. |
|
| 1047 | + * |
|
| 1048 | + * @since 1.0.19 |
|
| 1049 | + * @param int|bool $value is recurring. |
|
| 1050 | + */ |
|
| 1051 | + public function set_is_recurring( $value ) { |
|
| 1052 | + $this->set_prop( 'is_recurring', (bool) $value ); |
|
| 1053 | + } |
|
| 1054 | + |
|
| 1055 | + /** |
|
| 1056 | + * Sets the minimum total that can not be used with this discount. |
|
| 1057 | + * |
|
| 1058 | + * @since 1.0.19 |
|
| 1059 | + * @param float $value minimum total. |
|
| 1060 | + */ |
|
| 1061 | + public function set_min_total( $value ) { |
|
| 1062 | + $this->set_prop( 'min_total', (float) wpinv_sanitize_amount( $value ) ); |
|
| 1063 | + } |
|
| 1064 | + |
|
| 1065 | + /** |
|
| 1066 | + * Alias for self::set_min_total(). |
|
| 1067 | + * |
|
| 1068 | + * @since 1.0.19 |
|
| 1069 | + * @param float $value minimum total. |
|
| 1070 | + */ |
|
| 1071 | + public function set_minimum_total( $value ) { |
|
| 1072 | + $this->set_min_total( $value ); |
|
| 1073 | + } |
|
| 1074 | + |
|
| 1075 | + /** |
|
| 1076 | + * Sets the maximum total that can not be used with this discount. |
|
| 1077 | + * |
|
| 1078 | + * @since 1.0.19 |
|
| 1079 | + * @param float $value maximum total. |
|
| 1080 | + */ |
|
| 1081 | + public function set_max_total( $value ) { |
|
| 1082 | + $this->set_prop( 'max_total', (float) wpinv_sanitize_amount( $value ) ); |
|
| 1083 | + } |
|
| 1084 | + |
|
| 1085 | + /** |
|
| 1086 | + * Alias for self::set_max_total(). |
|
| 1087 | + * |
|
| 1088 | + * @since 1.0.19 |
|
| 1089 | + * @param float $value maximum total. |
|
| 1090 | + */ |
|
| 1091 | + public function set_maximum_total( $value ) { |
|
| 1092 | + $this->set_max_total( $value ); |
|
| 1093 | + } |
|
| 1094 | + |
|
| 1095 | + /** |
|
| 1096 | + * @deprecated |
|
| 1097 | + */ |
|
| 1098 | + public function refresh(){} |
|
| 1099 | + |
|
| 1100 | + /** |
|
| 1101 | + * @deprecated |
|
| 1102 | + * |
|
| 1103 | + */ |
|
| 1104 | + public function update_status( $status = 'publish' ){ |
|
| 1105 | + |
|
| 1106 | + if ( $this->exists() && $this->get_status() != $status ) { |
|
| 1107 | + $this->set_status( $status ); |
|
| 1108 | + $this->save(); |
|
| 1109 | + } |
|
| 1110 | + |
|
| 1111 | + } |
|
| 1112 | + |
|
| 1113 | + /* |
|
| 1114 | 1114 | |-------------------------------------------------------------------------- |
| 1115 | 1115 | | Conditionals |
| 1116 | 1116 | |-------------------------------------------------------------------------- |
@@ -1119,263 +1119,263 @@ discard block |
||
| 1119 | 1119 | | |
| 1120 | 1120 | */ |
| 1121 | 1121 | |
| 1122 | - /** |
|
| 1123 | - * Checks whether a discount exists in the database or not |
|
| 1124 | - * |
|
| 1125 | - * @since 1.0.15 |
|
| 1126 | - */ |
|
| 1127 | - public function exists(){ |
|
| 1128 | - $id = $this->get_id(); |
|
| 1129 | - return ! empty( $id ); |
|
| 1130 | - } |
|
| 1131 | - |
|
| 1132 | - /** |
|
| 1133 | - * Checks the discount type. |
|
| 1134 | - * |
|
| 1135 | - * |
|
| 1136 | - * @param string $type the discount type to check against |
|
| 1137 | - * @since 1.0.15 |
|
| 1138 | - * @return bool |
|
| 1139 | - */ |
|
| 1140 | - public function is_type( $type ) { |
|
| 1141 | - return $this->get_type() == $type; |
|
| 1142 | - } |
|
| 1143 | - |
|
| 1144 | - /** |
|
| 1145 | - * Checks whether the discount is published or not |
|
| 1146 | - * |
|
| 1147 | - * @since 1.0.15 |
|
| 1148 | - * @return bool |
|
| 1149 | - */ |
|
| 1150 | - public function is_active() { |
|
| 1151 | - return $this->get_status() == 'publish'; |
|
| 1152 | - } |
|
| 1153 | - |
|
| 1154 | - /** |
|
| 1155 | - * Checks whether the discount has max uses |
|
| 1156 | - * |
|
| 1157 | - * @since 1.0.15 |
|
| 1158 | - * @return bool |
|
| 1159 | - */ |
|
| 1160 | - public function has_limit() { |
|
| 1161 | - $limit = $this->get_max_uses(); |
|
| 1162 | - return ! empty( $limit ); |
|
| 1163 | - } |
|
| 1164 | - |
|
| 1165 | - /** |
|
| 1166 | - * Checks whether the discount has ever been used. |
|
| 1167 | - * |
|
| 1168 | - * @since 1.0.15 |
|
| 1169 | - * @return bool |
|
| 1170 | - */ |
|
| 1171 | - public function has_uses() { |
|
| 1172 | - return $this->get_uses() > 0; |
|
| 1173 | - } |
|
| 1174 | - |
|
| 1175 | - /** |
|
| 1176 | - * Checks whether the discount is has exided the usage limit or not |
|
| 1177 | - * |
|
| 1178 | - * @since 1.0.15 |
|
| 1179 | - * @return bool |
|
| 1180 | - */ |
|
| 1181 | - public function has_exceeded_limit() { |
|
| 1182 | - |
|
| 1183 | - if ( ! $this->has_limit() || ! $this->has_uses() ) { |
|
| 1184 | - $exceeded = false ; |
|
| 1185 | - } else { |
|
| 1186 | - $exceeded = ! ( (int) $this->get_max_uses() < $this->get_uses() ); |
|
| 1187 | - } |
|
| 1188 | - |
|
| 1189 | - return apply_filters( 'wpinv_is_discount_maxed_out', $exceeded, $this->get_id(), $this, $this->get_code() ); |
|
| 1190 | - } |
|
| 1191 | - |
|
| 1192 | - /** |
|
| 1193 | - * Checks whether the discount has an expiration date. |
|
| 1194 | - * |
|
| 1195 | - * @since 1.0.15 |
|
| 1196 | - * @return bool |
|
| 1197 | - */ |
|
| 1198 | - public function has_expiration_date() { |
|
| 1199 | - $date = $this->get_expiration_date(); |
|
| 1200 | - return ! empty( $date ); |
|
| 1201 | - } |
|
| 1202 | - |
|
| 1203 | - /** |
|
| 1204 | - * Checks if the discount is expired |
|
| 1205 | - * |
|
| 1206 | - * @since 1.0.15 |
|
| 1207 | - * @return bool |
|
| 1208 | - */ |
|
| 1209 | - public function is_expired() { |
|
| 1210 | - $expired = $this->has_expiration_date() ? current_time( 'timestamp' ) > strtotime( $this->get_expiration_date() ) : false; |
|
| 1211 | - return apply_filters( 'wpinv_is_discount_expired', $expired, $this->get_id(), $this, $this->get_code() ); |
|
| 1212 | - } |
|
| 1213 | - |
|
| 1214 | - /** |
|
| 1215 | - * Checks whether the discount has a start date. |
|
| 1216 | - * |
|
| 1217 | - * @since 1.0.15 |
|
| 1218 | - * @return bool |
|
| 1219 | - */ |
|
| 1220 | - public function has_start_date() { |
|
| 1221 | - $date = $this->get_start_date(); |
|
| 1222 | - return ! empty( $date ); |
|
| 1223 | - } |
|
| 1224 | - |
|
| 1225 | - /** |
|
| 1226 | - * Checks the discount start date. |
|
| 1227 | - * |
|
| 1228 | - * @since 1.0.15 |
|
| 1229 | - * @return bool |
|
| 1230 | - */ |
|
| 1231 | - public function has_started() { |
|
| 1232 | - $started = $this->has_start_date() ? true : current_time( 'timestamp' ) > strtotime( $this->get_start_date() ); |
|
| 1233 | - return apply_filters( 'wpinv_is_discount_started', $started, $this->get_id(), $this, $this->get_code() ); |
|
| 1234 | - } |
|
| 1235 | - |
|
| 1236 | - /** |
|
| 1237 | - * Checks the discount has allowed items or not. |
|
| 1238 | - * |
|
| 1239 | - * @since 1.0.15 |
|
| 1240 | - * @return bool |
|
| 1241 | - */ |
|
| 1242 | - public function has_allowed_items() { |
|
| 1243 | - $allowed_items = $this->get_allowed_items(); |
|
| 1244 | - return ! empty( $allowed_items ); |
|
| 1245 | - } |
|
| 1246 | - |
|
| 1247 | - /** |
|
| 1248 | - * Checks the discount has excluded items or not. |
|
| 1249 | - * |
|
| 1250 | - * @since 1.0.15 |
|
| 1251 | - * @return bool |
|
| 1252 | - */ |
|
| 1253 | - public function has_excluded_items() { |
|
| 1254 | - $excluded_items = $this->get_excluded_items(); |
|
| 1255 | - return ! empty( $excluded_items ); |
|
| 1256 | - } |
|
| 1257 | - |
|
| 1258 | - /** |
|
| 1259 | - * Check if a discount is valid for a given item id. |
|
| 1260 | - * |
|
| 1261 | - * @param int|int[] $item_ids |
|
| 1262 | - * @since 1.0.15 |
|
| 1263 | - * @return boolean |
|
| 1264 | - */ |
|
| 1265 | - public function is_valid_for_items( $item_ids ) { |
|
| 1266 | - |
|
| 1267 | - $item_ids = wp_parse_id_list( $item_ids ); |
|
| 1268 | - $included = array_intersect( $item_ids, $this->get_allowed_items() ); |
|
| 1269 | - $excluded = array_intersect( $item_ids, $this->get_excluded_items() ); |
|
| 1270 | - |
|
| 1271 | - if ( $this->has_excluded_items() && ! empty( $excluded ) ) { |
|
| 1272 | - return false; |
|
| 1273 | - } |
|
| 1274 | - |
|
| 1275 | - if ( $this->has_allowed_items() && empty( $included ) ) { |
|
| 1276 | - return false; |
|
| 1277 | - } |
|
| 1278 | - |
|
| 1279 | - return true; |
|
| 1280 | - } |
|
| 1281 | - |
|
| 1282 | - /** |
|
| 1283 | - * Check if a discount is valid for the given amount |
|
| 1284 | - * |
|
| 1285 | - * @param float $amount The amount to check against |
|
| 1286 | - * @since 1.0.15 |
|
| 1287 | - * @return boolean |
|
| 1288 | - */ |
|
| 1289 | - public function is_valid_for_amount( $amount ) { |
|
| 1290 | - return $this->is_minimum_amount_met( $amount ) && $this->is_maximum_amount_met( $amount ); |
|
| 1291 | - } |
|
| 1292 | - |
|
| 1293 | - /** |
|
| 1294 | - * Checks if the minimum amount is set |
|
| 1295 | - * |
|
| 1296 | - * @since 1.0.15 |
|
| 1297 | - * @return boolean |
|
| 1298 | - */ |
|
| 1299 | - public function has_minimum_amount() { |
|
| 1300 | - $minimum = $this->get_minimum_total(); |
|
| 1301 | - return ! empty( $minimum ); |
|
| 1302 | - } |
|
| 1303 | - |
|
| 1304 | - /** |
|
| 1305 | - * Checks if the minimum amount is met |
|
| 1306 | - * |
|
| 1307 | - * @param float $amount The amount to check against |
|
| 1308 | - * @since 1.0.15 |
|
| 1309 | - * @return boolean |
|
| 1310 | - */ |
|
| 1311 | - public function is_minimum_amount_met( $amount ) { |
|
| 1312 | - $amount = floatval( wpinv_sanitize_amount( $amount ) ); |
|
| 1313 | - $min_met= ! ( $this->has_minimum_amount() && $amount < floatval( wpinv_sanitize_amount( $this->get_minimum_total() ) ) ); |
|
| 1314 | - return apply_filters( 'wpinv_is_discount_min_met', $min_met, $this->get_id(), $this, $this->get_code(), $amount ); |
|
| 1315 | - } |
|
| 1316 | - |
|
| 1317 | - /** |
|
| 1318 | - * Checks if the maximum amount is set |
|
| 1319 | - * |
|
| 1320 | - * @since 1.0.15 |
|
| 1321 | - * @return boolean |
|
| 1322 | - */ |
|
| 1323 | - public function has_maximum_amount() { |
|
| 1324 | - $maximum = $this->get_maximum_total(); |
|
| 1325 | - return ! empty( $maximum ); |
|
| 1326 | - } |
|
| 1327 | - |
|
| 1328 | - /** |
|
| 1329 | - * Checks if the maximum amount is met |
|
| 1330 | - * |
|
| 1331 | - * @param float $amount The amount to check against |
|
| 1332 | - * @since 1.0.15 |
|
| 1333 | - * @return boolean |
|
| 1334 | - */ |
|
| 1335 | - public function is_maximum_amount_met( $amount ) { |
|
| 1336 | - $amount = floatval( wpinv_sanitize_amount( $amount ) ); |
|
| 1337 | - $max_met= ! ( $this->has_maximum_amount() && $amount > floatval( wpinv_sanitize_amount( $this->get_maximum_total() ) ) ); |
|
| 1338 | - return apply_filters( 'wpinv_is_discount_max_met', $max_met, $this->get_id(), $this, $this->get_code(), $amount ); |
|
| 1339 | - } |
|
| 1340 | - |
|
| 1341 | - /** |
|
| 1342 | - * Checks if the discount is recurring. |
|
| 1343 | - * |
|
| 1344 | - * @since 1.0.15 |
|
| 1345 | - * @return boolean |
|
| 1346 | - */ |
|
| 1347 | - public function is_recurring() { |
|
| 1348 | - $recurring = $this->get_is_recurring(); |
|
| 1349 | - return ! empty( $recurring ); |
|
| 1350 | - } |
|
| 1351 | - |
|
| 1352 | - /** |
|
| 1353 | - * Checks if the discount is single use. |
|
| 1354 | - * |
|
| 1355 | - * @since 1.0.15 |
|
| 1356 | - * @return boolean |
|
| 1357 | - */ |
|
| 1358 | - public function is_single_use() { |
|
| 1359 | - $usage = $this->get_is_single_use(); |
|
| 1360 | - return ! empty( $usage ); |
|
| 1361 | - } |
|
| 1362 | - |
|
| 1363 | - /** |
|
| 1364 | - * Check if a discount is valid for the given user |
|
| 1365 | - * |
|
| 1366 | - * @param int|string $user |
|
| 1367 | - * @since 1.0.15 |
|
| 1368 | - * @return boolean |
|
| 1369 | - */ |
|
| 1370 | - public function is_valid_for_user( $user ) { |
|
| 1371 | - |
|
| 1372 | - // Ensure that the discount is single use. |
|
| 1373 | - if ( empty( $user ) || ! $this->is_single_use() ) { |
|
| 1374 | - return true; |
|
| 1375 | - } |
|
| 1376 | - |
|
| 1377 | - // Prepare the user id. |
|
| 1378 | - $user_id = 0; |
|
| 1122 | + /** |
|
| 1123 | + * Checks whether a discount exists in the database or not |
|
| 1124 | + * |
|
| 1125 | + * @since 1.0.15 |
|
| 1126 | + */ |
|
| 1127 | + public function exists(){ |
|
| 1128 | + $id = $this->get_id(); |
|
| 1129 | + return ! empty( $id ); |
|
| 1130 | + } |
|
| 1131 | + |
|
| 1132 | + /** |
|
| 1133 | + * Checks the discount type. |
|
| 1134 | + * |
|
| 1135 | + * |
|
| 1136 | + * @param string $type the discount type to check against |
|
| 1137 | + * @since 1.0.15 |
|
| 1138 | + * @return bool |
|
| 1139 | + */ |
|
| 1140 | + public function is_type( $type ) { |
|
| 1141 | + return $this->get_type() == $type; |
|
| 1142 | + } |
|
| 1143 | + |
|
| 1144 | + /** |
|
| 1145 | + * Checks whether the discount is published or not |
|
| 1146 | + * |
|
| 1147 | + * @since 1.0.15 |
|
| 1148 | + * @return bool |
|
| 1149 | + */ |
|
| 1150 | + public function is_active() { |
|
| 1151 | + return $this->get_status() == 'publish'; |
|
| 1152 | + } |
|
| 1153 | + |
|
| 1154 | + /** |
|
| 1155 | + * Checks whether the discount has max uses |
|
| 1156 | + * |
|
| 1157 | + * @since 1.0.15 |
|
| 1158 | + * @return bool |
|
| 1159 | + */ |
|
| 1160 | + public function has_limit() { |
|
| 1161 | + $limit = $this->get_max_uses(); |
|
| 1162 | + return ! empty( $limit ); |
|
| 1163 | + } |
|
| 1164 | + |
|
| 1165 | + /** |
|
| 1166 | + * Checks whether the discount has ever been used. |
|
| 1167 | + * |
|
| 1168 | + * @since 1.0.15 |
|
| 1169 | + * @return bool |
|
| 1170 | + */ |
|
| 1171 | + public function has_uses() { |
|
| 1172 | + return $this->get_uses() > 0; |
|
| 1173 | + } |
|
| 1174 | + |
|
| 1175 | + /** |
|
| 1176 | + * Checks whether the discount is has exided the usage limit or not |
|
| 1177 | + * |
|
| 1178 | + * @since 1.0.15 |
|
| 1179 | + * @return bool |
|
| 1180 | + */ |
|
| 1181 | + public function has_exceeded_limit() { |
|
| 1182 | + |
|
| 1183 | + if ( ! $this->has_limit() || ! $this->has_uses() ) { |
|
| 1184 | + $exceeded = false ; |
|
| 1185 | + } else { |
|
| 1186 | + $exceeded = ! ( (int) $this->get_max_uses() < $this->get_uses() ); |
|
| 1187 | + } |
|
| 1188 | + |
|
| 1189 | + return apply_filters( 'wpinv_is_discount_maxed_out', $exceeded, $this->get_id(), $this, $this->get_code() ); |
|
| 1190 | + } |
|
| 1191 | + |
|
| 1192 | + /** |
|
| 1193 | + * Checks whether the discount has an expiration date. |
|
| 1194 | + * |
|
| 1195 | + * @since 1.0.15 |
|
| 1196 | + * @return bool |
|
| 1197 | + */ |
|
| 1198 | + public function has_expiration_date() { |
|
| 1199 | + $date = $this->get_expiration_date(); |
|
| 1200 | + return ! empty( $date ); |
|
| 1201 | + } |
|
| 1202 | + |
|
| 1203 | + /** |
|
| 1204 | + * Checks if the discount is expired |
|
| 1205 | + * |
|
| 1206 | + * @since 1.0.15 |
|
| 1207 | + * @return bool |
|
| 1208 | + */ |
|
| 1209 | + public function is_expired() { |
|
| 1210 | + $expired = $this->has_expiration_date() ? current_time( 'timestamp' ) > strtotime( $this->get_expiration_date() ) : false; |
|
| 1211 | + return apply_filters( 'wpinv_is_discount_expired', $expired, $this->get_id(), $this, $this->get_code() ); |
|
| 1212 | + } |
|
| 1213 | + |
|
| 1214 | + /** |
|
| 1215 | + * Checks whether the discount has a start date. |
|
| 1216 | + * |
|
| 1217 | + * @since 1.0.15 |
|
| 1218 | + * @return bool |
|
| 1219 | + */ |
|
| 1220 | + public function has_start_date() { |
|
| 1221 | + $date = $this->get_start_date(); |
|
| 1222 | + return ! empty( $date ); |
|
| 1223 | + } |
|
| 1224 | + |
|
| 1225 | + /** |
|
| 1226 | + * Checks the discount start date. |
|
| 1227 | + * |
|
| 1228 | + * @since 1.0.15 |
|
| 1229 | + * @return bool |
|
| 1230 | + */ |
|
| 1231 | + public function has_started() { |
|
| 1232 | + $started = $this->has_start_date() ? true : current_time( 'timestamp' ) > strtotime( $this->get_start_date() ); |
|
| 1233 | + return apply_filters( 'wpinv_is_discount_started', $started, $this->get_id(), $this, $this->get_code() ); |
|
| 1234 | + } |
|
| 1235 | + |
|
| 1236 | + /** |
|
| 1237 | + * Checks the discount has allowed items or not. |
|
| 1238 | + * |
|
| 1239 | + * @since 1.0.15 |
|
| 1240 | + * @return bool |
|
| 1241 | + */ |
|
| 1242 | + public function has_allowed_items() { |
|
| 1243 | + $allowed_items = $this->get_allowed_items(); |
|
| 1244 | + return ! empty( $allowed_items ); |
|
| 1245 | + } |
|
| 1246 | + |
|
| 1247 | + /** |
|
| 1248 | + * Checks the discount has excluded items or not. |
|
| 1249 | + * |
|
| 1250 | + * @since 1.0.15 |
|
| 1251 | + * @return bool |
|
| 1252 | + */ |
|
| 1253 | + public function has_excluded_items() { |
|
| 1254 | + $excluded_items = $this->get_excluded_items(); |
|
| 1255 | + return ! empty( $excluded_items ); |
|
| 1256 | + } |
|
| 1257 | + |
|
| 1258 | + /** |
|
| 1259 | + * Check if a discount is valid for a given item id. |
|
| 1260 | + * |
|
| 1261 | + * @param int|int[] $item_ids |
|
| 1262 | + * @since 1.0.15 |
|
| 1263 | + * @return boolean |
|
| 1264 | + */ |
|
| 1265 | + public function is_valid_for_items( $item_ids ) { |
|
| 1266 | + |
|
| 1267 | + $item_ids = wp_parse_id_list( $item_ids ); |
|
| 1268 | + $included = array_intersect( $item_ids, $this->get_allowed_items() ); |
|
| 1269 | + $excluded = array_intersect( $item_ids, $this->get_excluded_items() ); |
|
| 1270 | + |
|
| 1271 | + if ( $this->has_excluded_items() && ! empty( $excluded ) ) { |
|
| 1272 | + return false; |
|
| 1273 | + } |
|
| 1274 | + |
|
| 1275 | + if ( $this->has_allowed_items() && empty( $included ) ) { |
|
| 1276 | + return false; |
|
| 1277 | + } |
|
| 1278 | + |
|
| 1279 | + return true; |
|
| 1280 | + } |
|
| 1281 | + |
|
| 1282 | + /** |
|
| 1283 | + * Check if a discount is valid for the given amount |
|
| 1284 | + * |
|
| 1285 | + * @param float $amount The amount to check against |
|
| 1286 | + * @since 1.0.15 |
|
| 1287 | + * @return boolean |
|
| 1288 | + */ |
|
| 1289 | + public function is_valid_for_amount( $amount ) { |
|
| 1290 | + return $this->is_minimum_amount_met( $amount ) && $this->is_maximum_amount_met( $amount ); |
|
| 1291 | + } |
|
| 1292 | + |
|
| 1293 | + /** |
|
| 1294 | + * Checks if the minimum amount is set |
|
| 1295 | + * |
|
| 1296 | + * @since 1.0.15 |
|
| 1297 | + * @return boolean |
|
| 1298 | + */ |
|
| 1299 | + public function has_minimum_amount() { |
|
| 1300 | + $minimum = $this->get_minimum_total(); |
|
| 1301 | + return ! empty( $minimum ); |
|
| 1302 | + } |
|
| 1303 | + |
|
| 1304 | + /** |
|
| 1305 | + * Checks if the minimum amount is met |
|
| 1306 | + * |
|
| 1307 | + * @param float $amount The amount to check against |
|
| 1308 | + * @since 1.0.15 |
|
| 1309 | + * @return boolean |
|
| 1310 | + */ |
|
| 1311 | + public function is_minimum_amount_met( $amount ) { |
|
| 1312 | + $amount = floatval( wpinv_sanitize_amount( $amount ) ); |
|
| 1313 | + $min_met= ! ( $this->has_minimum_amount() && $amount < floatval( wpinv_sanitize_amount( $this->get_minimum_total() ) ) ); |
|
| 1314 | + return apply_filters( 'wpinv_is_discount_min_met', $min_met, $this->get_id(), $this, $this->get_code(), $amount ); |
|
| 1315 | + } |
|
| 1316 | + |
|
| 1317 | + /** |
|
| 1318 | + * Checks if the maximum amount is set |
|
| 1319 | + * |
|
| 1320 | + * @since 1.0.15 |
|
| 1321 | + * @return boolean |
|
| 1322 | + */ |
|
| 1323 | + public function has_maximum_amount() { |
|
| 1324 | + $maximum = $this->get_maximum_total(); |
|
| 1325 | + return ! empty( $maximum ); |
|
| 1326 | + } |
|
| 1327 | + |
|
| 1328 | + /** |
|
| 1329 | + * Checks if the maximum amount is met |
|
| 1330 | + * |
|
| 1331 | + * @param float $amount The amount to check against |
|
| 1332 | + * @since 1.0.15 |
|
| 1333 | + * @return boolean |
|
| 1334 | + */ |
|
| 1335 | + public function is_maximum_amount_met( $amount ) { |
|
| 1336 | + $amount = floatval( wpinv_sanitize_amount( $amount ) ); |
|
| 1337 | + $max_met= ! ( $this->has_maximum_amount() && $amount > floatval( wpinv_sanitize_amount( $this->get_maximum_total() ) ) ); |
|
| 1338 | + return apply_filters( 'wpinv_is_discount_max_met', $max_met, $this->get_id(), $this, $this->get_code(), $amount ); |
|
| 1339 | + } |
|
| 1340 | + |
|
| 1341 | + /** |
|
| 1342 | + * Checks if the discount is recurring. |
|
| 1343 | + * |
|
| 1344 | + * @since 1.0.15 |
|
| 1345 | + * @return boolean |
|
| 1346 | + */ |
|
| 1347 | + public function is_recurring() { |
|
| 1348 | + $recurring = $this->get_is_recurring(); |
|
| 1349 | + return ! empty( $recurring ); |
|
| 1350 | + } |
|
| 1351 | + |
|
| 1352 | + /** |
|
| 1353 | + * Checks if the discount is single use. |
|
| 1354 | + * |
|
| 1355 | + * @since 1.0.15 |
|
| 1356 | + * @return boolean |
|
| 1357 | + */ |
|
| 1358 | + public function is_single_use() { |
|
| 1359 | + $usage = $this->get_is_single_use(); |
|
| 1360 | + return ! empty( $usage ); |
|
| 1361 | + } |
|
| 1362 | + |
|
| 1363 | + /** |
|
| 1364 | + * Check if a discount is valid for the given user |
|
| 1365 | + * |
|
| 1366 | + * @param int|string $user |
|
| 1367 | + * @since 1.0.15 |
|
| 1368 | + * @return boolean |
|
| 1369 | + */ |
|
| 1370 | + public function is_valid_for_user( $user ) { |
|
| 1371 | + |
|
| 1372 | + // Ensure that the discount is single use. |
|
| 1373 | + if ( empty( $user ) || ! $this->is_single_use() ) { |
|
| 1374 | + return true; |
|
| 1375 | + } |
|
| 1376 | + |
|
| 1377 | + // Prepare the user id. |
|
| 1378 | + $user_id = 0; |
|
| 1379 | 1379 | if ( is_numeric( $user ) ) { |
| 1380 | 1380 | $user_id = absint( $user ); |
| 1381 | 1381 | } else if ( is_email( $user ) && $user_data = get_user_by( 'email', $user ) ) { |
@@ -1384,117 +1384,117 @@ discard block |
||
| 1384 | 1384 | $user_id = $user_data->ID; |
| 1385 | 1385 | } |
| 1386 | 1386 | |
| 1387 | - // Ensure that we have a user. |
|
| 1388 | - if ( empty( $user_id ) ) { |
|
| 1389 | - return true; |
|
| 1390 | - } |
|
| 1387 | + // Ensure that we have a user. |
|
| 1388 | + if ( empty( $user_id ) ) { |
|
| 1389 | + return true; |
|
| 1390 | + } |
|
| 1391 | 1391 | |
| 1392 | - // Get all payments with matching user id. |
|
| 1392 | + // Get all payments with matching user id. |
|
| 1393 | 1393 | $payments = wpinv_get_invoices( array( 'user' => $user_id, 'limit' => false, 'paginate' => false ) ); |
| 1394 | - $code = strtolower( $this->get_code() ); |
|
| 1395 | - |
|
| 1396 | - // For each payment... |
|
| 1397 | - foreach ( $payments as $payment ) { |
|
| 1398 | - |
|
| 1399 | - // Only check for paid invoices. |
|
| 1400 | - if ( $payment->is_paid() && strtolower( $payment->get_discount_code() ) == $code ) { |
|
| 1401 | - return false; |
|
| 1402 | - } |
|
| 1403 | - |
|
| 1404 | - } |
|
| 1405 | - |
|
| 1406 | - return true; |
|
| 1407 | - } |
|
| 1408 | - |
|
| 1409 | - /** |
|
| 1410 | - * Deletes the discount from the database |
|
| 1411 | - * |
|
| 1412 | - * @since 1.0.15 |
|
| 1413 | - * @return boolean |
|
| 1414 | - */ |
|
| 1415 | - public function remove() { |
|
| 1416 | - return $this->delete(); |
|
| 1417 | - } |
|
| 1418 | - |
|
| 1419 | - /** |
|
| 1420 | - * Increases a discount's usage. |
|
| 1421 | - * |
|
| 1422 | - * @since 1.0.15 |
|
| 1423 | - * @param int $by The number of usages to increas by. |
|
| 1424 | - * @return int |
|
| 1425 | - */ |
|
| 1426 | - public function increase_usage( $by = 1 ) { |
|
| 1427 | - |
|
| 1428 | - // Abort if zero. |
|
| 1429 | - if ( empty( $by ) ) { |
|
| 1430 | - return; |
|
| 1431 | - } |
|
| 1432 | - |
|
| 1433 | - // Increase the usage. |
|
| 1434 | - $this->set_uses( $this->get_uses() + (int) $by ); |
|
| 1435 | - |
|
| 1436 | - // Save the discount. |
|
| 1437 | - $this->save(); |
|
| 1438 | - |
|
| 1439 | - // Fire relevant hooks. |
|
| 1440 | - if( (int) $by > 0 ) { |
|
| 1441 | - do_action( 'wpinv_discount_increase_use_count', $this->get_uses(), $this->get_id(), $this->get_code(), absint( $by ) ); |
|
| 1442 | - } else { |
|
| 1443 | - do_action( 'wpinv_discount_decrease_use_count', $this->get_uses(), $this->get_id(), $this->get_code(), absint( $by ) ); |
|
| 1444 | - } |
|
| 1445 | - |
|
| 1446 | - // Return the number of times the discount has been used. |
|
| 1447 | - return $this->get_uses(); |
|
| 1448 | - } |
|
| 1449 | - |
|
| 1450 | - /** |
|
| 1451 | - * Alias of self::__toString() |
|
| 1452 | - * |
|
| 1453 | - * @since 1.0.15 |
|
| 1454 | - * @return string|false |
|
| 1455 | - */ |
|
| 1456 | - public function get_data_as_json() { |
|
| 1457 | - return $this->__toString(); |
|
| 1458 | - } |
|
| 1459 | - |
|
| 1460 | - /** |
|
| 1461 | - * Returns a discount's discounted amount. |
|
| 1462 | - * |
|
| 1463 | - * @since 1.0.15 |
|
| 1464 | - * @param float $amount |
|
| 1465 | - * @return float |
|
| 1466 | - */ |
|
| 1467 | - public function get_discounted_amount( $amount ) { |
|
| 1468 | - |
|
| 1469 | - // Convert amount to float. |
|
| 1470 | - $amount = (float) $amount; |
|
| 1471 | - |
|
| 1472 | - // Get discount amount. |
|
| 1473 | - $discount_amount = $this->get_amount(); |
|
| 1474 | - |
|
| 1475 | - if ( empty( $discount_amount ) ) { |
|
| 1476 | - return 0; |
|
| 1477 | - } |
|
| 1478 | - |
|
| 1479 | - // Format the amount. |
|
| 1480 | - $discount_amount = floatval( wpinv_sanitize_amount( $discount_amount ) ); |
|
| 1394 | + $code = strtolower( $this->get_code() ); |
|
| 1395 | + |
|
| 1396 | + // For each payment... |
|
| 1397 | + foreach ( $payments as $payment ) { |
|
| 1398 | + |
|
| 1399 | + // Only check for paid invoices. |
|
| 1400 | + if ( $payment->is_paid() && strtolower( $payment->get_discount_code() ) == $code ) { |
|
| 1401 | + return false; |
|
| 1402 | + } |
|
| 1403 | + |
|
| 1404 | + } |
|
| 1405 | + |
|
| 1406 | + return true; |
|
| 1407 | + } |
|
| 1408 | + |
|
| 1409 | + /** |
|
| 1410 | + * Deletes the discount from the database |
|
| 1411 | + * |
|
| 1412 | + * @since 1.0.15 |
|
| 1413 | + * @return boolean |
|
| 1414 | + */ |
|
| 1415 | + public function remove() { |
|
| 1416 | + return $this->delete(); |
|
| 1417 | + } |
|
| 1418 | + |
|
| 1419 | + /** |
|
| 1420 | + * Increases a discount's usage. |
|
| 1421 | + * |
|
| 1422 | + * @since 1.0.15 |
|
| 1423 | + * @param int $by The number of usages to increas by. |
|
| 1424 | + * @return int |
|
| 1425 | + */ |
|
| 1426 | + public function increase_usage( $by = 1 ) { |
|
| 1427 | + |
|
| 1428 | + // Abort if zero. |
|
| 1429 | + if ( empty( $by ) ) { |
|
| 1430 | + return; |
|
| 1431 | + } |
|
| 1432 | + |
|
| 1433 | + // Increase the usage. |
|
| 1434 | + $this->set_uses( $this->get_uses() + (int) $by ); |
|
| 1435 | + |
|
| 1436 | + // Save the discount. |
|
| 1437 | + $this->save(); |
|
| 1438 | + |
|
| 1439 | + // Fire relevant hooks. |
|
| 1440 | + if( (int) $by > 0 ) { |
|
| 1441 | + do_action( 'wpinv_discount_increase_use_count', $this->get_uses(), $this->get_id(), $this->get_code(), absint( $by ) ); |
|
| 1442 | + } else { |
|
| 1443 | + do_action( 'wpinv_discount_decrease_use_count', $this->get_uses(), $this->get_id(), $this->get_code(), absint( $by ) ); |
|
| 1444 | + } |
|
| 1445 | + |
|
| 1446 | + // Return the number of times the discount has been used. |
|
| 1447 | + return $this->get_uses(); |
|
| 1448 | + } |
|
| 1449 | + |
|
| 1450 | + /** |
|
| 1451 | + * Alias of self::__toString() |
|
| 1452 | + * |
|
| 1453 | + * @since 1.0.15 |
|
| 1454 | + * @return string|false |
|
| 1455 | + */ |
|
| 1456 | + public function get_data_as_json() { |
|
| 1457 | + return $this->__toString(); |
|
| 1458 | + } |
|
| 1459 | + |
|
| 1460 | + /** |
|
| 1461 | + * Returns a discount's discounted amount. |
|
| 1462 | + * |
|
| 1463 | + * @since 1.0.15 |
|
| 1464 | + * @param float $amount |
|
| 1465 | + * @return float |
|
| 1466 | + */ |
|
| 1467 | + public function get_discounted_amount( $amount ) { |
|
| 1468 | + |
|
| 1469 | + // Convert amount to float. |
|
| 1470 | + $amount = (float) $amount; |
|
| 1471 | + |
|
| 1472 | + // Get discount amount. |
|
| 1473 | + $discount_amount = $this->get_amount(); |
|
| 1474 | + |
|
| 1475 | + if ( empty( $discount_amount ) ) { |
|
| 1476 | + return 0; |
|
| 1477 | + } |
|
| 1478 | + |
|
| 1479 | + // Format the amount. |
|
| 1480 | + $discount_amount = floatval( wpinv_sanitize_amount( $discount_amount ) ); |
|
| 1481 | 1481 | |
| 1482 | - // If this is a percentage discount. |
|
| 1483 | - if ( $this->is_type( 'percent' ) ) { |
|
| 1482 | + // If this is a percentage discount. |
|
| 1483 | + if ( $this->is_type( 'percent' ) ) { |
|
| 1484 | 1484 | $discount_amount = $amount * ( $discount_amount / 100 ); |
| 1485 | - } |
|
| 1485 | + } |
|
| 1486 | 1486 | |
| 1487 | - // Discount can not be less than zero... |
|
| 1488 | - if ( $discount_amount < 0 ) { |
|
| 1489 | - $discount_amount = 0; |
|
| 1490 | - } |
|
| 1487 | + // Discount can not be less than zero... |
|
| 1488 | + if ( $discount_amount < 0 ) { |
|
| 1489 | + $discount_amount = 0; |
|
| 1490 | + } |
|
| 1491 | 1491 | |
| 1492 | - // ... or more than the amount. |
|
| 1493 | - if ( $discount_amount > $amount ) { |
|
| 1494 | - $discount_amount = $amount; |
|
| 1495 | - } |
|
| 1492 | + // ... or more than the amount. |
|
| 1493 | + if ( $discount_amount > $amount ) { |
|
| 1494 | + $discount_amount = $amount; |
|
| 1495 | + } |
|
| 1496 | 1496 | |
| 1497 | - return apply_filters( 'wpinv_discount_total_discount_amount', $discount_amount, $amount, $this ); |
|
| 1498 | - } |
|
| 1497 | + return apply_filters( 'wpinv_discount_total_discount_amount', $discount_amount, $amount, $this ); |
|
| 1498 | + } |
|
| 1499 | 1499 | |
| 1500 | 1500 | } |
@@ -14,7 +14,7 @@ discard block |
||
| 14 | 14 | */ |
| 15 | 15 | function wpinv_subscriptions_page() { |
| 16 | 16 | |
| 17 | - ?> |
|
| 17 | + ?> |
|
| 18 | 18 | |
| 19 | 19 | <div class="wrap"> |
| 20 | 20 | <h1><?php echo esc_html( get_admin_page_title() ); ?></h1> |
@@ -22,27 +22,27 @@ discard block |
||
| 22 | 22 | |
| 23 | 23 | <?php |
| 24 | 24 | |
| 25 | - // Verify user permissions. |
|
| 26 | - if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 25 | + // Verify user permissions. |
|
| 26 | + if ( ! wpinv_current_user_can_manage_invoicing() ) { |
|
| 27 | 27 | |
| 28 | - echo aui()->alert( |
|
| 29 | - array( |
|
| 30 | - 'type' => 'danger', |
|
| 31 | - 'content' => __( 'You are not permitted to view this page.', 'invoicing' ), |
|
| 32 | - ) |
|
| 33 | - ); |
|
| 28 | + echo aui()->alert( |
|
| 29 | + array( |
|
| 30 | + 'type' => 'danger', |
|
| 31 | + 'content' => __( 'You are not permitted to view this page.', 'invoicing' ), |
|
| 32 | + ) |
|
| 33 | + ); |
|
| 34 | 34 | |
| 35 | - } else if ( ! empty( $_GET['id'] ) && is_numeric( $_GET['id'] ) ) { |
|
| 35 | + } else if ( ! empty( $_GET['id'] ) && is_numeric( $_GET['id'] ) ) { |
|
| 36 | 36 | |
| 37 | - // Display a single subscription. |
|
| 38 | - wpinv_recurring_subscription_details(); |
|
| 39 | - } else { |
|
| 37 | + // Display a single subscription. |
|
| 38 | + wpinv_recurring_subscription_details(); |
|
| 39 | + } else { |
|
| 40 | 40 | |
| 41 | - // Display a list of available subscriptions. |
|
| 42 | - getpaid_print_subscriptions_list(); |
|
| 43 | - } |
|
| 41 | + // Display a list of available subscriptions. |
|
| 42 | + getpaid_print_subscriptions_list(); |
|
| 43 | + } |
|
| 44 | 44 | |
| 45 | - ?> |
|
| 45 | + ?> |
|
| 46 | 46 | |
| 47 | 47 | </div> |
| 48 | 48 | </div> |
@@ -59,10 +59,10 @@ discard block |
||
| 59 | 59 | */ |
| 60 | 60 | function getpaid_print_subscriptions_list() { |
| 61 | 61 | |
| 62 | - $subscribers_table = new WPInv_Subscriptions_List_Table(); |
|
| 63 | - $subscribers_table->prepare_items(); |
|
| 62 | + $subscribers_table = new WPInv_Subscriptions_List_Table(); |
|
| 63 | + $subscribers_table->prepare_items(); |
|
| 64 | 64 | |
| 65 | - ?> |
|
| 65 | + ?> |
|
| 66 | 66 | <form id="subscribers-filter" class="bsui" method="get"> |
| 67 | 67 | <input type="hidden" name="page" value="wpinv-subscriptions" /> |
| 68 | 68 | <?php $subscribers_table->views(); ?> |
@@ -80,27 +80,27 @@ discard block |
||
| 80 | 80 | */ |
| 81 | 81 | function wpinv_recurring_subscription_details() { |
| 82 | 82 | |
| 83 | - // Fetch the subscription. |
|
| 84 | - $sub = new WPInv_Subscription( (int) $_GET['id'] ); |
|
| 85 | - if ( ! $sub->get_id() ) { |
|
| 83 | + // Fetch the subscription. |
|
| 84 | + $sub = new WPInv_Subscription( (int) $_GET['id'] ); |
|
| 85 | + if ( ! $sub->get_id() ) { |
|
| 86 | 86 | |
| 87 | - echo aui()->alert( |
|
| 88 | - array( |
|
| 89 | - 'type' => 'danger', |
|
| 90 | - 'content' => __( 'Subscription not found.', 'invoicing' ), |
|
| 91 | - ) |
|
| 92 | - ); |
|
| 87 | + echo aui()->alert( |
|
| 88 | + array( |
|
| 89 | + 'type' => 'danger', |
|
| 90 | + 'content' => __( 'Subscription not found.', 'invoicing' ), |
|
| 91 | + ) |
|
| 92 | + ); |
|
| 93 | 93 | |
| 94 | - return; |
|
| 95 | - } |
|
| 94 | + return; |
|
| 95 | + } |
|
| 96 | 96 | |
| 97 | - // Use metaboxes to display the subscription details. |
|
| 98 | - add_meta_box( 'getpaid_admin_subscription_details_metabox', __( 'Subscription Details', 'invoicing' ), 'getpaid_admin_subscription_details_metabox', get_current_screen(), 'normal' ); |
|
| 99 | - add_meta_box( 'getpaid_admin_subscription_update_metabox', __( 'Change Status', 'invoicing' ), 'getpaid_admin_subscription_update_metabox', get_current_screen(), 'side' ); |
|
| 100 | - add_meta_box( 'getpaid_admin_subscription_invoice_details_metabox', __( 'Invoices', 'invoicing' ), 'getpaid_admin_subscription_invoice_details_metabox', get_current_screen(), 'advanced' ); |
|
| 101 | - do_action( 'getpaid_admin_single_subscription_register_metabox', $sub ); |
|
| 97 | + // Use metaboxes to display the subscription details. |
|
| 98 | + add_meta_box( 'getpaid_admin_subscription_details_metabox', __( 'Subscription Details', 'invoicing' ), 'getpaid_admin_subscription_details_metabox', get_current_screen(), 'normal' ); |
|
| 99 | + add_meta_box( 'getpaid_admin_subscription_update_metabox', __( 'Change Status', 'invoicing' ), 'getpaid_admin_subscription_update_metabox', get_current_screen(), 'side' ); |
|
| 100 | + add_meta_box( 'getpaid_admin_subscription_invoice_details_metabox', __( 'Invoices', 'invoicing' ), 'getpaid_admin_subscription_invoice_details_metabox', get_current_screen(), 'advanced' ); |
|
| 101 | + do_action( 'getpaid_admin_single_subscription_register_metabox', $sub ); |
|
| 102 | 102 | |
| 103 | - ?> |
|
| 103 | + ?> |
|
| 104 | 104 | |
| 105 | 105 | <form method="post" action="<?php echo admin_url( 'admin.php?page=wpinv-subscriptions&id=' . absint( $sub->get_id() ) ); ?>"> |
| 106 | 106 | |
@@ -140,41 +140,41 @@ discard block |
||
| 140 | 140 | */ |
| 141 | 141 | function getpaid_admin_subscription_details_metabox( $sub ) { |
| 142 | 142 | |
| 143 | - // Prepare subscription detail columns. |
|
| 144 | - $fields = apply_filters( |
|
| 145 | - 'getpaid_subscription_admin_page_fields', |
|
| 146 | - array( |
|
| 147 | - 'subscription' => __( 'Subscription', 'invoicing' ), |
|
| 148 | - 'customer' => __( 'Customer', 'invoicing' ), |
|
| 149 | - 'amount' => __( 'Amount', 'invoicing' ), |
|
| 150 | - 'start_date' => __( 'Start Date', 'invoicing' ), |
|
| 151 | - 'renews_on' => __( 'Next Payment', 'invoicing' ), |
|
| 152 | - 'renewals' => __( 'Payments', 'invoicing' ), |
|
| 153 | - 'item' => __( 'Item', 'invoicing' ), |
|
| 154 | - 'gateway' => __( 'Payment Method', 'invoicing' ), |
|
| 155 | - 'profile_id' => __( 'Profile ID', 'invoicing' ), |
|
| 156 | - 'status' => __( 'Status', 'invoicing' ), |
|
| 157 | - ) |
|
| 158 | - ); |
|
| 159 | - |
|
| 160 | - if ( ! $sub->is_active() ) { |
|
| 161 | - |
|
| 162 | - if ( isset( $fields['renews_on'] ) ) { |
|
| 163 | - unset( $fields['renews_on'] ); |
|
| 164 | - } |
|
| 165 | - |
|
| 166 | - if ( isset( $fields['gateway'] ) ) { |
|
| 167 | - unset( $fields['gateway'] ); |
|
| 168 | - } |
|
| 143 | + // Prepare subscription detail columns. |
|
| 144 | + $fields = apply_filters( |
|
| 145 | + 'getpaid_subscription_admin_page_fields', |
|
| 146 | + array( |
|
| 147 | + 'subscription' => __( 'Subscription', 'invoicing' ), |
|
| 148 | + 'customer' => __( 'Customer', 'invoicing' ), |
|
| 149 | + 'amount' => __( 'Amount', 'invoicing' ), |
|
| 150 | + 'start_date' => __( 'Start Date', 'invoicing' ), |
|
| 151 | + 'renews_on' => __( 'Next Payment', 'invoicing' ), |
|
| 152 | + 'renewals' => __( 'Payments', 'invoicing' ), |
|
| 153 | + 'item' => __( 'Item', 'invoicing' ), |
|
| 154 | + 'gateway' => __( 'Payment Method', 'invoicing' ), |
|
| 155 | + 'profile_id' => __( 'Profile ID', 'invoicing' ), |
|
| 156 | + 'status' => __( 'Status', 'invoicing' ), |
|
| 157 | + ) |
|
| 158 | + ); |
|
| 159 | + |
|
| 160 | + if ( ! $sub->is_active() ) { |
|
| 161 | + |
|
| 162 | + if ( isset( $fields['renews_on'] ) ) { |
|
| 163 | + unset( $fields['renews_on'] ); |
|
| 164 | + } |
|
| 165 | + |
|
| 166 | + if ( isset( $fields['gateway'] ) ) { |
|
| 167 | + unset( $fields['gateway'] ); |
|
| 168 | + } |
|
| 169 | 169 | |
| 170 | - } |
|
| 170 | + } |
|
| 171 | 171 | |
| 172 | - $profile_id = $sub->get_profile_id(); |
|
| 173 | - if ( empty( $profile_id ) && isset( $fields['profile_id'] ) ) { |
|
| 174 | - unset( $fields['profile_id'] ); |
|
| 175 | - } |
|
| 172 | + $profile_id = $sub->get_profile_id(); |
|
| 173 | + if ( empty( $profile_id ) && isset( $fields['profile_id'] ) ) { |
|
| 174 | + unset( $fields['profile_id'] ); |
|
| 175 | + } |
|
| 176 | 176 | |
| 177 | - ?> |
|
| 177 | + ?> |
|
| 178 | 178 | |
| 179 | 179 | <table class="table table-borderless" style="font-size: 14px;"> |
| 180 | 180 | <tbody> |
@@ -208,20 +208,20 @@ discard block |
||
| 208 | 208 | */ |
| 209 | 209 | function getpaid_admin_subscription_metabox_display_customer( $subscription ) { |
| 210 | 210 | |
| 211 | - $username = __( '(Missing User)', 'invoicing' ); |
|
| 211 | + $username = __( '(Missing User)', 'invoicing' ); |
|
| 212 | 212 | |
| 213 | - $user = get_userdata( $subscription->get_customer_id() ); |
|
| 214 | - if ( $user ) { |
|
| 213 | + $user = get_userdata( $subscription->get_customer_id() ); |
|
| 214 | + if ( $user ) { |
|
| 215 | 215 | |
| 216 | - $username = sprintf( |
|
| 217 | - '<a href="user-edit.php?user_id=%s">%s</a>', |
|
| 218 | - absint( $user->ID ), |
|
| 219 | - ! empty( $user->display_name ) ? sanitize_text_field( $user->display_name ) : sanitize_email( $user->user_email ) |
|
| 220 | - ); |
|
| 216 | + $username = sprintf( |
|
| 217 | + '<a href="user-edit.php?user_id=%s">%s</a>', |
|
| 218 | + absint( $user->ID ), |
|
| 219 | + ! empty( $user->display_name ) ? sanitize_text_field( $user->display_name ) : sanitize_email( $user->user_email ) |
|
| 220 | + ); |
|
| 221 | 221 | |
| 222 | - } |
|
| 222 | + } |
|
| 223 | 223 | |
| 224 | - echo $username; |
|
| 224 | + echo $username; |
|
| 225 | 225 | } |
| 226 | 226 | add_action( 'getpaid_subscription_admin_display_customer', 'getpaid_admin_subscription_metabox_display_customer' ); |
| 227 | 227 | |
@@ -231,8 +231,8 @@ discard block |
||
| 231 | 231 | * @param WPInv_Subscription $subscription |
| 232 | 232 | */ |
| 233 | 233 | function getpaid_admin_subscription_metabox_display_amount( $subscription ) { |
| 234 | - $amount = sanitize_text_field( getpaid_get_formatted_subscription_amount( $subscription ) ); |
|
| 235 | - echo "<span>$amount</span>"; |
|
| 234 | + $amount = sanitize_text_field( getpaid_get_formatted_subscription_amount( $subscription ) ); |
|
| 235 | + echo "<span>$amount</span>"; |
|
| 236 | 236 | } |
| 237 | 237 | add_action( 'getpaid_subscription_admin_display_amount', 'getpaid_admin_subscription_metabox_display_amount' ); |
| 238 | 238 | |
@@ -242,7 +242,7 @@ discard block |
||
| 242 | 242 | * @param WPInv_Subscription $subscription |
| 243 | 243 | */ |
| 244 | 244 | function getpaid_admin_subscription_metabox_display_id( $subscription ) { |
| 245 | - echo '#' . absint( $subscription->get_id() ); |
|
| 245 | + echo '#' . absint( $subscription->get_id() ); |
|
| 246 | 246 | } |
| 247 | 247 | add_action( 'getpaid_subscription_admin_display_subscription', 'getpaid_admin_subscription_metabox_display_id' ); |
| 248 | 248 | |
@@ -252,7 +252,7 @@ discard block |
||
| 252 | 252 | * @param WPInv_Subscription $subscription |
| 253 | 253 | */ |
| 254 | 254 | function getpaid_admin_subscription_metabox_display_start_date( $subscription ) { |
| 255 | - echo getpaid_format_date_value( $subscription->get_date_created() ); |
|
| 255 | + echo getpaid_format_date_value( $subscription->get_date_created() ); |
|
| 256 | 256 | } |
| 257 | 257 | add_action( 'getpaid_subscription_admin_display_start_date', 'getpaid_admin_subscription_metabox_display_start_date' ); |
| 258 | 258 | |
@@ -262,7 +262,7 @@ discard block |
||
| 262 | 262 | * @param WPInv_Subscription $subscription |
| 263 | 263 | */ |
| 264 | 264 | function getpaid_admin_subscription_metabox_display_renews_on( $subscription ) { |
| 265 | - echo getpaid_format_date_value( $subscription->get_expiration() ); |
|
| 265 | + echo getpaid_format_date_value( $subscription->get_expiration() ); |
|
| 266 | 266 | } |
| 267 | 267 | add_action( 'getpaid_subscription_admin_display_renews_on', 'getpaid_admin_subscription_metabox_display_renews_on' ); |
| 268 | 268 | |
@@ -272,8 +272,8 @@ discard block |
||
| 272 | 272 | * @param WPInv_Subscription $subscription |
| 273 | 273 | */ |
| 274 | 274 | function getpaid_admin_subscription_metabox_display_renewals( $subscription ) { |
| 275 | - $max_bills = $subscription->get_bill_times(); |
|
| 276 | - echo $subscription->get_times_billed() . ' / ' . ( empty( $max_bills ) ? "∞" : $max_bills ); |
|
| 275 | + $max_bills = $subscription->get_bill_times(); |
|
| 276 | + echo $subscription->get_times_billed() . ' / ' . ( empty( $max_bills ) ? "∞" : $max_bills ); |
|
| 277 | 277 | } |
| 278 | 278 | add_action( 'getpaid_subscription_admin_display_renewals', 'getpaid_admin_subscription_metabox_display_renewals' ); |
| 279 | 279 | /** |
@@ -283,16 +283,16 @@ discard block |
||
| 283 | 283 | */ |
| 284 | 284 | function getpaid_admin_subscription_metabox_display_item( $subscription ) { |
| 285 | 285 | |
| 286 | - $item = get_post( $subscription->get_product_id() ); |
|
| 286 | + $item = get_post( $subscription->get_product_id() ); |
|
| 287 | 287 | |
| 288 | - if ( ! empty( $item ) ) { |
|
| 289 | - $link = get_edit_post_link( $item ); |
|
| 290 | - $link = esc_url( $link ); |
|
| 291 | - $name = esc_html( get_the_title( $item ) ); |
|
| 292 | - echo "<a href='$link'>$name</a>"; |
|
| 293 | - } else { |
|
| 294 | - echo sprintf( __( 'Item #%s', 'invoicing' ), $subscription->get_product_id() ); |
|
| 295 | - } |
|
| 288 | + if ( ! empty( $item ) ) { |
|
| 289 | + $link = get_edit_post_link( $item ); |
|
| 290 | + $link = esc_url( $link ); |
|
| 291 | + $name = esc_html( get_the_title( $item ) ); |
|
| 292 | + echo "<a href='$link'>$name</a>"; |
|
| 293 | + } else { |
|
| 294 | + echo sprintf( __( 'Item #%s', 'invoicing' ), $subscription->get_product_id() ); |
|
| 295 | + } |
|
| 296 | 296 | |
| 297 | 297 | } |
| 298 | 298 | add_action( 'getpaid_subscription_admin_display_item', 'getpaid_admin_subscription_metabox_display_item' ); |
@@ -304,13 +304,13 @@ discard block |
||
| 304 | 304 | */ |
| 305 | 305 | function getpaid_admin_subscription_metabox_display_gateway( $subscription ) { |
| 306 | 306 | |
| 307 | - $gateway = $subscription->get_gateway(); |
|
| 307 | + $gateway = $subscription->get_gateway(); |
|
| 308 | 308 | |
| 309 | - if ( ! empty( $gateway ) ) { |
|
| 310 | - echo sanitize_text_field( wpinv_get_gateway_admin_label( $gateway ) ); |
|
| 311 | - } else { |
|
| 312 | - echo "—"; |
|
| 313 | - } |
|
| 309 | + if ( ! empty( $gateway ) ) { |
|
| 310 | + echo sanitize_text_field( wpinv_get_gateway_admin_label( $gateway ) ); |
|
| 311 | + } else { |
|
| 312 | + echo "—"; |
|
| 313 | + } |
|
| 314 | 314 | |
| 315 | 315 | } |
| 316 | 316 | add_action( 'getpaid_subscription_admin_display_gateway', 'getpaid_admin_subscription_metabox_display_gateway' ); |
@@ -321,7 +321,7 @@ discard block |
||
| 321 | 321 | * @param WPInv_Subscription $subscription |
| 322 | 322 | */ |
| 323 | 323 | function getpaid_admin_subscription_metabox_display_status( $subscription ) { |
| 324 | - echo $subscription->get_status_label_html(); |
|
| 324 | + echo $subscription->get_status_label_html(); |
|
| 325 | 325 | } |
| 326 | 326 | add_action( 'getpaid_subscription_admin_display_status', 'getpaid_admin_subscription_metabox_display_status' ); |
| 327 | 327 | |
@@ -332,14 +332,14 @@ discard block |
||
| 332 | 332 | */ |
| 333 | 333 | function getpaid_admin_subscription_metabox_display_profile_id( $subscription ) { |
| 334 | 334 | |
| 335 | - $profile_id = $subscription->get_profile_id(); |
|
| 335 | + $profile_id = $subscription->get_profile_id(); |
|
| 336 | 336 | |
| 337 | - if ( ! empty( $profile_id ) ) { |
|
| 338 | - $profile_id = sanitize_text_field( $profile_id ); |
|
| 339 | - echo apply_filters( 'getpaid_subscription_profile_id_display', $profile_id, $subscription ); |
|
| 340 | - } else { |
|
| 341 | - echo "—"; |
|
| 342 | - } |
|
| 337 | + if ( ! empty( $profile_id ) ) { |
|
| 338 | + $profile_id = sanitize_text_field( $profile_id ); |
|
| 339 | + echo apply_filters( 'getpaid_subscription_profile_id_display', $profile_id, $subscription ); |
|
| 340 | + } else { |
|
| 341 | + echo "—"; |
|
| 342 | + } |
|
| 343 | 343 | |
| 344 | 344 | } |
| 345 | 345 | add_action( 'getpaid_subscription_admin_display_profile_id', 'getpaid_admin_subscription_metabox_display_profile_id' ); |
@@ -351,39 +351,39 @@ discard block |
||
| 351 | 351 | */ |
| 352 | 352 | function getpaid_admin_subscription_update_metabox( $subscription ) { |
| 353 | 353 | |
| 354 | - ?> |
|
| 354 | + ?> |
|
| 355 | 355 | <div class="mt-3"> |
| 356 | 356 | |
| 357 | 357 | <?php |
| 358 | - echo aui()->select( |
|
| 359 | - array( |
|
| 360 | - 'options' => getpaid_get_subscription_statuses(), |
|
| 361 | - 'name' => 'subscription_status', |
|
| 362 | - 'id' => 'subscription_status_update_select', |
|
| 363 | - 'required' => true, |
|
| 364 | - 'no_wrap' => false, |
|
| 365 | - 'label' => __( 'Subscription Status', 'invoicing' ), |
|
| 366 | - 'help_text' => __( 'Updating the status will trigger related actions and hooks', 'invoicing' ), |
|
| 367 | - 'select2' => true, |
|
| 368 | - 'value' => $subscription->get_status( 'edit' ), |
|
| 369 | - ) |
|
| 370 | - ); |
|
| 371 | - ?> |
|
| 358 | + echo aui()->select( |
|
| 359 | + array( |
|
| 360 | + 'options' => getpaid_get_subscription_statuses(), |
|
| 361 | + 'name' => 'subscription_status', |
|
| 362 | + 'id' => 'subscription_status_update_select', |
|
| 363 | + 'required' => true, |
|
| 364 | + 'no_wrap' => false, |
|
| 365 | + 'label' => __( 'Subscription Status', 'invoicing' ), |
|
| 366 | + 'help_text' => __( 'Updating the status will trigger related actions and hooks', 'invoicing' ), |
|
| 367 | + 'select2' => true, |
|
| 368 | + 'value' => $subscription->get_status( 'edit' ), |
|
| 369 | + ) |
|
| 370 | + ); |
|
| 371 | + ?> |
|
| 372 | 372 | |
| 373 | 373 | <div class="mt-2 px-3 py-2 bg-light border-top" style="margin: -12px;"> |
| 374 | 374 | |
| 375 | 375 | <?php |
| 376 | - submit_button( __( 'Update', 'invoicing' ), 'primary', 'submit', false ); |
|
| 376 | + submit_button( __( 'Update', 'invoicing' ), 'primary', 'submit', false ); |
|
| 377 | 377 | |
| 378 | - $url = esc_url( wp_nonce_url( add_query_arg( 'getpaid-admin-action', 'subscription_manual_renew' ), 'getpaid-nonce', 'getpaid-nonce' ) ); |
|
| 379 | - $anchor = __( 'Renew Subscription', 'invoicing' ); |
|
| 380 | - $title = esc_attr__( 'Are you sure you want to extend the subscription and generate a new invoice that will be automatically marked as paid?', 'invoicing' ); |
|
| 378 | + $url = esc_url( wp_nonce_url( add_query_arg( 'getpaid-admin-action', 'subscription_manual_renew' ), 'getpaid-nonce', 'getpaid-nonce' ) ); |
|
| 379 | + $anchor = __( 'Renew Subscription', 'invoicing' ); |
|
| 380 | + $title = esc_attr__( 'Are you sure you want to extend the subscription and generate a new invoice that will be automatically marked as paid?', 'invoicing' ); |
|
| 381 | 381 | |
| 382 | - if ( $subscription->is_active() ) { |
|
| 383 | - echo "<a href='$url' class='float-right text-muted' onclick='return confirm(\"$title\")'>$anchor</a>"; |
|
| 384 | - } |
|
| 382 | + if ( $subscription->is_active() ) { |
|
| 383 | + echo "<a href='$url' class='float-right text-muted' onclick='return confirm(\"$title\")'>$anchor</a>"; |
|
| 384 | + } |
|
| 385 | 385 | |
| 386 | - echo '</div></div>'; |
|
| 386 | + echo '</div></div>'; |
|
| 387 | 387 | } |
| 388 | 388 | |
| 389 | 389 | /** |
@@ -393,33 +393,33 @@ discard block |
||
| 393 | 393 | */ |
| 394 | 394 | function getpaid_admin_subscription_invoice_details_metabox( $subscription ) { |
| 395 | 395 | |
| 396 | - $columns = apply_filters( |
|
| 397 | - 'getpaid_subscription_related_invoices_columns', |
|
| 398 | - array( |
|
| 399 | - 'invoice' => __( 'Invoice', 'invoicing' ), |
|
| 400 | - 'relationship' => __( 'Relationship', 'invoicing' ), |
|
| 401 | - 'date' => __( 'Date', 'invoicing' ), |
|
| 402 | - 'status' => __( 'Status', 'invoicing' ), |
|
| 403 | - 'total' => __( 'Total', 'invoicing' ), |
|
| 404 | - ), |
|
| 405 | - $subscription |
|
| 406 | - ); |
|
| 407 | - |
|
| 408 | - // Prepare the invoices. |
|
| 409 | - $payments = $subscription->get_child_payments( ! is_admin() ); |
|
| 410 | - $parent = $subscription->get_parent_invoice(); |
|
| 411 | - |
|
| 412 | - if ( $parent->get_id() ) { |
|
| 413 | - $payments = array_merge( array( $parent ), $payments ); |
|
| 414 | - } |
|
| 396 | + $columns = apply_filters( |
|
| 397 | + 'getpaid_subscription_related_invoices_columns', |
|
| 398 | + array( |
|
| 399 | + 'invoice' => __( 'Invoice', 'invoicing' ), |
|
| 400 | + 'relationship' => __( 'Relationship', 'invoicing' ), |
|
| 401 | + 'date' => __( 'Date', 'invoicing' ), |
|
| 402 | + 'status' => __( 'Status', 'invoicing' ), |
|
| 403 | + 'total' => __( 'Total', 'invoicing' ), |
|
| 404 | + ), |
|
| 405 | + $subscription |
|
| 406 | + ); |
|
| 407 | + |
|
| 408 | + // Prepare the invoices. |
|
| 409 | + $payments = $subscription->get_child_payments( ! is_admin() ); |
|
| 410 | + $parent = $subscription->get_parent_invoice(); |
|
| 411 | + |
|
| 412 | + if ( $parent->get_id() ) { |
|
| 413 | + $payments = array_merge( array( $parent ), $payments ); |
|
| 414 | + } |
|
| 415 | 415 | |
| 416 | - $table_class = 'w-100 bg-white'; |
|
| 416 | + $table_class = 'w-100 bg-white'; |
|
| 417 | 417 | |
| 418 | - if ( ! is_admin() ) { |
|
| 419 | - $table_class = 'table table-bordered table-striped'; |
|
| 420 | - } |
|
| 418 | + if ( ! is_admin() ) { |
|
| 419 | + $table_class = 'table table-bordered table-striped'; |
|
| 420 | + } |
|
| 421 | 421 | |
| 422 | - ?> |
|
| 422 | + ?> |
|
| 423 | 423 | <div class="m-0" style="overflow: auto;"> |
| 424 | 424 | |
| 425 | 425 | <table class="<?php echo $table_class; ?>"> |
@@ -427,13 +427,13 @@ discard block |
||
| 427 | 427 | <thead> |
| 428 | 428 | <tr> |
| 429 | 429 | <?php |
| 430 | - foreach ( $columns as $key => $label ) { |
|
| 431 | - $key = esc_attr( $key ); |
|
| 432 | - $label = sanitize_text_field( $label ); |
|
| 430 | + foreach ( $columns as $key => $label ) { |
|
| 431 | + $key = esc_attr( $key ); |
|
| 432 | + $label = sanitize_text_field( $label ); |
|
| 433 | 433 | |
| 434 | - echo "<th class='subscription-invoice-field-$key bg-light p-2 text-left color-dark font-weight-bold'>$label</th>"; |
|
| 435 | - } |
|
| 436 | - ?> |
|
| 434 | + echo "<th class='subscription-invoice-field-$key bg-light p-2 text-left color-dark font-weight-bold'>$label</th>"; |
|
| 435 | + } |
|
| 436 | + ?> |
|
| 437 | 437 | </tr> |
| 438 | 438 | </thead> |
| 439 | 439 | |
@@ -449,66 +449,66 @@ discard block |
||
| 449 | 449 | |
| 450 | 450 | <?php |
| 451 | 451 | |
| 452 | - foreach( $payments as $payment ) : |
|
| 452 | + foreach( $payments as $payment ) : |
|
| 453 | 453 | |
| 454 | - // Ensure that we have an invoice. |
|
| 455 | - $payment = new WPInv_Invoice( $payment ); |
|
| 454 | + // Ensure that we have an invoice. |
|
| 455 | + $payment = new WPInv_Invoice( $payment ); |
|
| 456 | 456 | |
| 457 | - // Abort if the invoice is invalid. |
|
| 458 | - if ( ! $payment->get_id() ) { |
|
| 459 | - continue; |
|
| 460 | - } |
|
| 457 | + // Abort if the invoice is invalid. |
|
| 458 | + if ( ! $payment->get_id() ) { |
|
| 459 | + continue; |
|
| 460 | + } |
|
| 461 | 461 | |
| 462 | - echo '<tr>'; |
|
| 462 | + echo '<tr>'; |
|
| 463 | 463 | |
| 464 | - foreach ( array_keys( $columns ) as $key ) { |
|
| 464 | + foreach ( array_keys( $columns ) as $key ) { |
|
| 465 | 465 | |
| 466 | - echo '<td class="p-2 text-left">'; |
|
| 466 | + echo '<td class="p-2 text-left">'; |
|
| 467 | 467 | |
| 468 | - switch( $key ) { |
|
| 468 | + switch( $key ) { |
|
| 469 | 469 | |
| 470 | - case 'total': |
|
| 471 | - echo '<strong>' . wpinv_price( $payment->get_total(), $payment->get_currency() ) . '</strong>'; |
|
| 472 | - break; |
|
| 470 | + case 'total': |
|
| 471 | + echo '<strong>' . wpinv_price( $payment->get_total(), $payment->get_currency() ) . '</strong>'; |
|
| 472 | + break; |
|
| 473 | 473 | |
| 474 | - case 'relationship': |
|
| 475 | - echo $payment->is_renewal() ? __( 'Renewal Invoice', 'invoicing' ) : __( 'Initial Invoice', 'invoicing' ); |
|
| 476 | - break; |
|
| 474 | + case 'relationship': |
|
| 475 | + echo $payment->is_renewal() ? __( 'Renewal Invoice', 'invoicing' ) : __( 'Initial Invoice', 'invoicing' ); |
|
| 476 | + break; |
|
| 477 | 477 | |
| 478 | - case 'date': |
|
| 479 | - echo getpaid_format_date_value( $payment->get_date_created() ); |
|
| 480 | - break; |
|
| 478 | + case 'date': |
|
| 479 | + echo getpaid_format_date_value( $payment->get_date_created() ); |
|
| 480 | + break; |
|
| 481 | 481 | |
| 482 | - case 'status': |
|
| 482 | + case 'status': |
|
| 483 | 483 | |
| 484 | - $status = $payment->get_status_nicename(); |
|
| 485 | - if ( is_admin() ) { |
|
| 486 | - $status = $payment->get_status_label_html(); |
|
| 487 | - } |
|
| 484 | + $status = $payment->get_status_nicename(); |
|
| 485 | + if ( is_admin() ) { |
|
| 486 | + $status = $payment->get_status_label_html(); |
|
| 487 | + } |
|
| 488 | 488 | |
| 489 | - echo $status; |
|
| 490 | - break; |
|
| 489 | + echo $status; |
|
| 490 | + break; |
|
| 491 | 491 | |
| 492 | - case 'invoice': |
|
| 493 | - $link = esc_url( get_edit_post_link( $payment->get_id() ) ); |
|
| 492 | + case 'invoice': |
|
| 493 | + $link = esc_url( get_edit_post_link( $payment->get_id() ) ); |
|
| 494 | 494 | |
| 495 | - if ( ! is_admin() ) { |
|
| 496 | - $link = esc_url( $payment->get_view_url() ); |
|
| 497 | - } |
|
| 495 | + if ( ! is_admin() ) { |
|
| 496 | + $link = esc_url( $payment->get_view_url() ); |
|
| 497 | + } |
|
| 498 | 498 | |
| 499 | - $invoice = sanitize_text_field( $payment->get_number() ); |
|
| 500 | - echo "<a href='$link'>$invoice</a>"; |
|
| 501 | - break; |
|
| 502 | - } |
|
| 499 | + $invoice = sanitize_text_field( $payment->get_number() ); |
|
| 500 | + echo "<a href='$link'>$invoice</a>"; |
|
| 501 | + break; |
|
| 502 | + } |
|
| 503 | 503 | |
| 504 | - echo '</td>'; |
|
| 504 | + echo '</td>'; |
|
| 505 | 505 | |
| 506 | - } |
|
| 506 | + } |
|
| 507 | 507 | |
| 508 | - echo '</tr>'; |
|
| 508 | + echo '</tr>'; |
|
| 509 | 509 | |
| 510 | - endforeach; |
|
| 511 | - ?> |
|
| 510 | + endforeach; |
|
| 511 | + ?> |
|
| 512 | 512 | |
| 513 | 513 | </tbody> |
| 514 | 514 | |
@@ -1,6 +1,6 @@ discard block |
||
| 1 | 1 | <?php |
| 2 | 2 | if ( ! defined( 'ABSPATH' ) ) { |
| 3 | - exit; |
|
| 3 | + exit; |
|
| 4 | 4 | } |
| 5 | 5 | |
| 6 | 6 | /** |
@@ -10,30 +10,30 @@ discard block |
||
| 10 | 10 | class WPInv_Item extends GetPaid_Data { |
| 11 | 11 | |
| 12 | 12 | /** |
| 13 | - * Which data store to load. |
|
| 14 | - * |
|
| 15 | - * @var string |
|
| 16 | - */ |
|
| 13 | + * Which data store to load. |
|
| 14 | + * |
|
| 15 | + * @var string |
|
| 16 | + */ |
|
| 17 | 17 | protected $data_store_name = 'item'; |
| 18 | 18 | |
| 19 | 19 | /** |
| 20 | - * This is the name of this object type. |
|
| 21 | - * |
|
| 22 | - * @var string |
|
| 23 | - */ |
|
| 24 | - protected $object_type = 'item'; |
|
| 20 | + * This is the name of this object type. |
|
| 21 | + * |
|
| 22 | + * @var string |
|
| 23 | + */ |
|
| 24 | + protected $object_type = 'item'; |
|
| 25 | 25 | |
| 26 | 26 | /** |
| 27 | - * Item Data array. This is the core item data exposed in APIs. |
|
| 28 | - * |
|
| 29 | - * @since 1.0.19 |
|
| 30 | - * @var array |
|
| 31 | - */ |
|
| 32 | - protected $data = array( |
|
| 33 | - 'parent_id' => 0, |
|
| 34 | - 'status' => 'draft', |
|
| 35 | - 'version' => '', |
|
| 36 | - 'date_created' => null, |
|
| 27 | + * Item Data array. This is the core item data exposed in APIs. |
|
| 28 | + * |
|
| 29 | + * @since 1.0.19 |
|
| 30 | + * @var array |
|
| 31 | + */ |
|
| 32 | + protected $data = array( |
|
| 33 | + 'parent_id' => 0, |
|
| 34 | + 'status' => 'draft', |
|
| 35 | + 'version' => '', |
|
| 36 | + 'date_created' => null, |
|
| 37 | 37 | 'date_modified' => null, |
| 38 | 38 | 'name' => '', |
| 39 | 39 | 'description' => '', |
@@ -58,13 +58,13 @@ discard block |
||
| 58 | 58 | ); |
| 59 | 59 | |
| 60 | 60 | /** |
| 61 | - * Stores meta in cache for future reads. |
|
| 62 | - * |
|
| 63 | - * A group must be set to to enable caching. |
|
| 64 | - * |
|
| 65 | - * @var string |
|
| 66 | - */ |
|
| 67 | - protected $cache_group = 'getpaid_items'; |
|
| 61 | + * Stores meta in cache for future reads. |
|
| 62 | + * |
|
| 63 | + * A group must be set to to enable caching. |
|
| 64 | + * |
|
| 65 | + * @var string |
|
| 66 | + */ |
|
| 67 | + protected $cache_group = 'getpaid_items'; |
|
| 68 | 68 | |
| 69 | 69 | /** |
| 70 | 70 | * Stores a reference to the original WP_Post object |
@@ -74,37 +74,37 @@ discard block |
||
| 74 | 74 | protected $post = null; |
| 75 | 75 | |
| 76 | 76 | /** |
| 77 | - * Get the item if ID is passed, otherwise the item is new and empty. |
|
| 78 | - * |
|
| 79 | - * @param int|object|WPInv_Item|WP_Post $item Item to read. |
|
| 80 | - */ |
|
| 81 | - public function __construct( $item = 0 ) { |
|
| 82 | - parent::__construct( $item ); |
|
| 83 | - |
|
| 84 | - if ( ! empty( $item ) && is_numeric( $item ) && 'wpi_item' == get_post_type( $item ) ) { |
|
| 85 | - $this->set_id( $item ); |
|
| 86 | - } elseif ( $item instanceof self ) { |
|
| 87 | - $this->set_id( $item->get_id() ); |
|
| 88 | - } elseif ( ! empty( $item->ID ) ) { |
|
| 89 | - $this->set_id( $item->ID ); |
|
| 90 | - } elseif ( is_scalar( $item ) && $item_id = self::get_item_id_by_field( $item, 'custom_id' ) ) { |
|
| 91 | - $this->set_id( $item_id ); |
|
| 92 | - } elseif ( is_scalar( $item ) && $item_id = self::get_item_id_by_field( $item, 'name' ) ) { |
|
| 93 | - $this->set_id( $item_id ); |
|
| 94 | - } else { |
|
| 95 | - $this->set_object_read( true ); |
|
| 96 | - } |
|
| 77 | + * Get the item if ID is passed, otherwise the item is new and empty. |
|
| 78 | + * |
|
| 79 | + * @param int|object|WPInv_Item|WP_Post $item Item to read. |
|
| 80 | + */ |
|
| 81 | + public function __construct( $item = 0 ) { |
|
| 82 | + parent::__construct( $item ); |
|
| 83 | + |
|
| 84 | + if ( ! empty( $item ) && is_numeric( $item ) && 'wpi_item' == get_post_type( $item ) ) { |
|
| 85 | + $this->set_id( $item ); |
|
| 86 | + } elseif ( $item instanceof self ) { |
|
| 87 | + $this->set_id( $item->get_id() ); |
|
| 88 | + } elseif ( ! empty( $item->ID ) ) { |
|
| 89 | + $this->set_id( $item->ID ); |
|
| 90 | + } elseif ( is_scalar( $item ) && $item_id = self::get_item_id_by_field( $item, 'custom_id' ) ) { |
|
| 91 | + $this->set_id( $item_id ); |
|
| 92 | + } elseif ( is_scalar( $item ) && $item_id = self::get_item_id_by_field( $item, 'name' ) ) { |
|
| 93 | + $this->set_id( $item_id ); |
|
| 94 | + } else { |
|
| 95 | + $this->set_object_read( true ); |
|
| 96 | + } |
|
| 97 | 97 | |
| 98 | 98 | // Load the datastore. |
| 99 | - $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
| 99 | + $this->data_store = GetPaid_Data_Store::load( $this->data_store_name ); |
|
| 100 | 100 | |
| 101 | - if ( $this->get_id() > 0 ) { |
|
| 101 | + if ( $this->get_id() > 0 ) { |
|
| 102 | 102 | $this->post = get_post( $this->get_id() ); |
| 103 | 103 | $this->ID = $this->get_id(); |
| 104 | - $this->data_store->read( $this ); |
|
| 104 | + $this->data_store->read( $this ); |
|
| 105 | 105 | } |
| 106 | 106 | |
| 107 | - } |
|
| 107 | + } |
|
| 108 | 108 | |
| 109 | 109 | /* |
| 110 | 110 | |-------------------------------------------------------------------------- |
@@ -122,401 +122,401 @@ discard block |
||
| 122 | 122 | */ |
| 123 | 123 | |
| 124 | 124 | /** |
| 125 | - * Get parent item ID. |
|
| 126 | - * |
|
| 127 | - * @since 1.0.19 |
|
| 128 | - * @param string $context View or edit context. |
|
| 129 | - * @return int |
|
| 130 | - */ |
|
| 131 | - public function get_parent_id( $context = 'view' ) { |
|
| 132 | - return (int) $this->get_prop( 'parent_id', $context ); |
|
| 125 | + * Get parent item ID. |
|
| 126 | + * |
|
| 127 | + * @since 1.0.19 |
|
| 128 | + * @param string $context View or edit context. |
|
| 129 | + * @return int |
|
| 130 | + */ |
|
| 131 | + public function get_parent_id( $context = 'view' ) { |
|
| 132 | + return (int) $this->get_prop( 'parent_id', $context ); |
|
| 133 | 133 | } |
| 134 | 134 | |
| 135 | 135 | /** |
| 136 | - * Get item status. |
|
| 137 | - * |
|
| 138 | - * @since 1.0.19 |
|
| 139 | - * @param string $context View or edit context. |
|
| 140 | - * @return string |
|
| 141 | - */ |
|
| 142 | - public function get_status( $context = 'view' ) { |
|
| 143 | - return $this->get_prop( 'status', $context ); |
|
| 136 | + * Get item status. |
|
| 137 | + * |
|
| 138 | + * @since 1.0.19 |
|
| 139 | + * @param string $context View or edit context. |
|
| 140 | + * @return string |
|
| 141 | + */ |
|
| 142 | + public function get_status( $context = 'view' ) { |
|
| 143 | + return $this->get_prop( 'status', $context ); |
|
| 144 | 144 | } |
| 145 | 145 | |
| 146 | 146 | /** |
| 147 | - * Get plugin version when the item was created. |
|
| 148 | - * |
|
| 149 | - * @since 1.0.19 |
|
| 150 | - * @param string $context View or edit context. |
|
| 151 | - * @return string |
|
| 152 | - */ |
|
| 153 | - public function get_version( $context = 'view' ) { |
|
| 154 | - return $this->get_prop( 'version', $context ); |
|
| 147 | + * Get plugin version when the item was created. |
|
| 148 | + * |
|
| 149 | + * @since 1.0.19 |
|
| 150 | + * @param string $context View or edit context. |
|
| 151 | + * @return string |
|
| 152 | + */ |
|
| 153 | + public function get_version( $context = 'view' ) { |
|
| 154 | + return $this->get_prop( 'version', $context ); |
|
| 155 | 155 | } |
| 156 | 156 | |
| 157 | 157 | /** |
| 158 | - * Get date when the item was created. |
|
| 159 | - * |
|
| 160 | - * @since 1.0.19 |
|
| 161 | - * @param string $context View or edit context. |
|
| 162 | - * @return string |
|
| 163 | - */ |
|
| 164 | - public function get_date_created( $context = 'view' ) { |
|
| 165 | - return $this->get_prop( 'date_created', $context ); |
|
| 158 | + * Get date when the item was created. |
|
| 159 | + * |
|
| 160 | + * @since 1.0.19 |
|
| 161 | + * @param string $context View or edit context. |
|
| 162 | + * @return string |
|
| 163 | + */ |
|
| 164 | + public function get_date_created( $context = 'view' ) { |
|
| 165 | + return $this->get_prop( 'date_created', $context ); |
|
| 166 | 166 | } |
| 167 | 167 | |
| 168 | 168 | /** |
| 169 | - * Get GMT date when the item was created. |
|
| 170 | - * |
|
| 171 | - * @since 1.0.19 |
|
| 172 | - * @param string $context View or edit context. |
|
| 173 | - * @return string |
|
| 174 | - */ |
|
| 175 | - public function get_date_created_gmt( $context = 'view' ) { |
|
| 169 | + * Get GMT date when the item was created. |
|
| 170 | + * |
|
| 171 | + * @since 1.0.19 |
|
| 172 | + * @param string $context View or edit context. |
|
| 173 | + * @return string |
|
| 174 | + */ |
|
| 175 | + public function get_date_created_gmt( $context = 'view' ) { |
|
| 176 | 176 | $date = $this->get_date_created( $context ); |
| 177 | 177 | |
| 178 | 178 | if ( $date ) { |
| 179 | 179 | $date = get_gmt_from_date( $date ); |
| 180 | 180 | } |
| 181 | - return $date; |
|
| 181 | + return $date; |
|
| 182 | 182 | } |
| 183 | 183 | |
| 184 | 184 | /** |
| 185 | - * Get date when the item was last modified. |
|
| 186 | - * |
|
| 187 | - * @since 1.0.19 |
|
| 188 | - * @param string $context View or edit context. |
|
| 189 | - * @return string |
|
| 190 | - */ |
|
| 191 | - public function get_date_modified( $context = 'view' ) { |
|
| 192 | - return $this->get_prop( 'date_modified', $context ); |
|
| 185 | + * Get date when the item was last modified. |
|
| 186 | + * |
|
| 187 | + * @since 1.0.19 |
|
| 188 | + * @param string $context View or edit context. |
|
| 189 | + * @return string |
|
| 190 | + */ |
|
| 191 | + public function get_date_modified( $context = 'view' ) { |
|
| 192 | + return $this->get_prop( 'date_modified', $context ); |
|
| 193 | 193 | } |
| 194 | 194 | |
| 195 | 195 | /** |
| 196 | - * Get GMT date when the item was last modified. |
|
| 197 | - * |
|
| 198 | - * @since 1.0.19 |
|
| 199 | - * @param string $context View or edit context. |
|
| 200 | - * @return string |
|
| 201 | - */ |
|
| 202 | - public function get_date_modified_gmt( $context = 'view' ) { |
|
| 196 | + * Get GMT date when the item was last modified. |
|
| 197 | + * |
|
| 198 | + * @since 1.0.19 |
|
| 199 | + * @param string $context View or edit context. |
|
| 200 | + * @return string |
|
| 201 | + */ |
|
| 202 | + public function get_date_modified_gmt( $context = 'view' ) { |
|
| 203 | 203 | $date = $this->get_date_modified( $context ); |
| 204 | 204 | |
| 205 | 205 | if ( $date ) { |
| 206 | 206 | $date = get_gmt_from_date( $date ); |
| 207 | 207 | } |
| 208 | - return $date; |
|
| 208 | + return $date; |
|
| 209 | 209 | } |
| 210 | 210 | |
| 211 | 211 | /** |
| 212 | - * Get the item name. |
|
| 213 | - * |
|
| 214 | - * @since 1.0.19 |
|
| 215 | - * @param string $context View or edit context. |
|
| 216 | - * @return string |
|
| 217 | - */ |
|
| 218 | - public function get_name( $context = 'view' ) { |
|
| 219 | - return $this->get_prop( 'name', $context ); |
|
| 212 | + * Get the item name. |
|
| 213 | + * |
|
| 214 | + * @since 1.0.19 |
|
| 215 | + * @param string $context View or edit context. |
|
| 216 | + * @return string |
|
| 217 | + */ |
|
| 218 | + public function get_name( $context = 'view' ) { |
|
| 219 | + return $this->get_prop( 'name', $context ); |
|
| 220 | 220 | } |
| 221 | 221 | |
| 222 | 222 | /** |
| 223 | - * Alias of self::get_name(). |
|
| 224 | - * |
|
| 225 | - * @since 1.0.19 |
|
| 226 | - * @param string $context View or edit context. |
|
| 227 | - * @return string |
|
| 228 | - */ |
|
| 229 | - public function get_title( $context = 'view' ) { |
|
| 230 | - return $this->get_name( $context ); |
|
| 223 | + * Alias of self::get_name(). |
|
| 224 | + * |
|
| 225 | + * @since 1.0.19 |
|
| 226 | + * @param string $context View or edit context. |
|
| 227 | + * @return string |
|
| 228 | + */ |
|
| 229 | + public function get_title( $context = 'view' ) { |
|
| 230 | + return $this->get_name( $context ); |
|
| 231 | 231 | } |
| 232 | 232 | |
| 233 | 233 | /** |
| 234 | - * Get the item description. |
|
| 235 | - * |
|
| 236 | - * @since 1.0.19 |
|
| 237 | - * @param string $context View or edit context. |
|
| 238 | - * @return string |
|
| 239 | - */ |
|
| 240 | - public function get_description( $context = 'view' ) { |
|
| 241 | - return $this->get_prop( 'description', $context ); |
|
| 234 | + * Get the item description. |
|
| 235 | + * |
|
| 236 | + * @since 1.0.19 |
|
| 237 | + * @param string $context View or edit context. |
|
| 238 | + * @return string |
|
| 239 | + */ |
|
| 240 | + public function get_description( $context = 'view' ) { |
|
| 241 | + return $this->get_prop( 'description', $context ); |
|
| 242 | 242 | } |
| 243 | 243 | |
| 244 | 244 | /** |
| 245 | - * Alias of self::get_description(). |
|
| 246 | - * |
|
| 247 | - * @since 1.0.19 |
|
| 248 | - * @param string $context View or edit context. |
|
| 249 | - * @return string |
|
| 250 | - */ |
|
| 251 | - public function get_excerpt( $context = 'view' ) { |
|
| 252 | - return $this->get_description( $context ); |
|
| 245 | + * Alias of self::get_description(). |
|
| 246 | + * |
|
| 247 | + * @since 1.0.19 |
|
| 248 | + * @param string $context View or edit context. |
|
| 249 | + * @return string |
|
| 250 | + */ |
|
| 251 | + public function get_excerpt( $context = 'view' ) { |
|
| 252 | + return $this->get_description( $context ); |
|
| 253 | 253 | } |
| 254 | 254 | |
| 255 | 255 | /** |
| 256 | - * Alias of self::get_description(). |
|
| 257 | - * |
|
| 258 | - * @since 1.0.19 |
|
| 259 | - * @param string $context View or edit context. |
|
| 260 | - * @return string |
|
| 261 | - */ |
|
| 262 | - public function get_summary( $context = 'view' ) { |
|
| 263 | - return $this->get_description( $context ); |
|
| 256 | + * Alias of self::get_description(). |
|
| 257 | + * |
|
| 258 | + * @since 1.0.19 |
|
| 259 | + * @param string $context View or edit context. |
|
| 260 | + * @return string |
|
| 261 | + */ |
|
| 262 | + public function get_summary( $context = 'view' ) { |
|
| 263 | + return $this->get_description( $context ); |
|
| 264 | 264 | } |
| 265 | 265 | |
| 266 | 266 | /** |
| 267 | - * Get the owner of the item. |
|
| 268 | - * |
|
| 269 | - * @since 1.0.19 |
|
| 270 | - * @param string $context View or edit context. |
|
| 271 | - * @return int |
|
| 272 | - */ |
|
| 273 | - public function get_author( $context = 'view' ) { |
|
| 274 | - return (int) $this->get_prop( 'author', $context ); |
|
| 275 | - } |
|
| 267 | + * Get the owner of the item. |
|
| 268 | + * |
|
| 269 | + * @since 1.0.19 |
|
| 270 | + * @param string $context View or edit context. |
|
| 271 | + * @return int |
|
| 272 | + */ |
|
| 273 | + public function get_author( $context = 'view' ) { |
|
| 274 | + return (int) $this->get_prop( 'author', $context ); |
|
| 275 | + } |
|
| 276 | 276 | |
| 277 | - /** |
|
| 278 | - * Alias of self::get_author(). |
|
| 279 | - * |
|
| 280 | - * @since 1.0.19 |
|
| 281 | - * @param string $context View or edit context. |
|
| 282 | - * @return int |
|
| 283 | - */ |
|
| 284 | - public function get_owner( $context = 'view' ) { |
|
| 285 | - return $this->get_author( $context ); |
|
| 286 | - } |
|
| 287 | - |
|
| 288 | - /** |
|
| 289 | - * Get the price of the item. |
|
| 290 | - * |
|
| 291 | - * @since 1.0.19 |
|
| 292 | - * @param string $context View or edit context. |
|
| 293 | - * @return float |
|
| 294 | - */ |
|
| 295 | - public function get_price( $context = 'view' ) { |
|
| 277 | + /** |
|
| 278 | + * Alias of self::get_author(). |
|
| 279 | + * |
|
| 280 | + * @since 1.0.19 |
|
| 281 | + * @param string $context View or edit context. |
|
| 282 | + * @return int |
|
| 283 | + */ |
|
| 284 | + public function get_owner( $context = 'view' ) { |
|
| 285 | + return $this->get_author( $context ); |
|
| 286 | + } |
|
| 287 | + |
|
| 288 | + /** |
|
| 289 | + * Get the price of the item. |
|
| 290 | + * |
|
| 291 | + * @since 1.0.19 |
|
| 292 | + * @param string $context View or edit context. |
|
| 293 | + * @return float |
|
| 294 | + */ |
|
| 295 | + public function get_price( $context = 'view' ) { |
|
| 296 | 296 | return wpinv_sanitize_amount( $this->get_prop( 'price', $context ) ); |
| 297 | - } |
|
| 297 | + } |
|
| 298 | 298 | |
| 299 | - /** |
|
| 300 | - * Get the inital price of the item. |
|
| 301 | - * |
|
| 302 | - * @since 1.0.19 |
|
| 303 | - * @param string $context View or edit context. |
|
| 304 | - * @return float |
|
| 305 | - */ |
|
| 306 | - public function get_initial_price( $context = 'view' ) { |
|
| 299 | + /** |
|
| 300 | + * Get the inital price of the item. |
|
| 301 | + * |
|
| 302 | + * @since 1.0.19 |
|
| 303 | + * @param string $context View or edit context. |
|
| 304 | + * @return float |
|
| 305 | + */ |
|
| 306 | + public function get_initial_price( $context = 'view' ) { |
|
| 307 | 307 | |
| 308 | - $price = (float) $this->get_price( $context ); |
|
| 308 | + $price = (float) $this->get_price( $context ); |
|
| 309 | 309 | |
| 310 | - if ( $this->has_free_trial() ) { |
|
| 311 | - $price = 0; |
|
| 312 | - } |
|
| 310 | + if ( $this->has_free_trial() ) { |
|
| 311 | + $price = 0; |
|
| 312 | + } |
|
| 313 | 313 | |
| 314 | 314 | return wpinv_sanitize_amount( apply_filters( 'wpinv_get_initial_item_price', $price, $this ) ); |
| 315 | 315 | } |
| 316 | 316 | |
| 317 | 317 | /** |
| 318 | - * Returns a formated price. |
|
| 319 | - * |
|
| 320 | - * @since 1.0.19 |
|
| 321 | - * @param string $context View or edit context. |
|
| 322 | - * @return string |
|
| 323 | - */ |
|
| 318 | + * Returns a formated price. |
|
| 319 | + * |
|
| 320 | + * @since 1.0.19 |
|
| 321 | + * @param string $context View or edit context. |
|
| 322 | + * @return string |
|
| 323 | + */ |
|
| 324 | 324 | public function get_the_price() { |
| 325 | 325 | return wpinv_price( $this->get_price() ); |
| 326 | - } |
|
| 327 | - |
|
| 328 | - /** |
|
| 329 | - * Returns the formated initial price. |
|
| 330 | - * |
|
| 331 | - * @since 1.0.19 |
|
| 332 | - * @param string $context View or edit context. |
|
| 333 | - * @return string |
|
| 334 | - */ |
|
| 326 | + } |
|
| 327 | + |
|
| 328 | + /** |
|
| 329 | + * Returns the formated initial price. |
|
| 330 | + * |
|
| 331 | + * @since 1.0.19 |
|
| 332 | + * @param string $context View or edit context. |
|
| 333 | + * @return string |
|
| 334 | + */ |
|
| 335 | 335 | public function get_the_initial_price() { |
| 336 | 336 | return wpinv_price( $this->get_initial_price() ); |
| 337 | 337 | } |
| 338 | 338 | |
| 339 | 339 | /** |
| 340 | - * Get the VAT rule of the item. |
|
| 341 | - * |
|
| 342 | - * @since 1.0.19 |
|
| 343 | - * @param string $context View or edit context. |
|
| 344 | - * @return string |
|
| 345 | - */ |
|
| 346 | - public function get_vat_rule( $context = 'view' ) { |
|
| 340 | + * Get the VAT rule of the item. |
|
| 341 | + * |
|
| 342 | + * @since 1.0.19 |
|
| 343 | + * @param string $context View or edit context. |
|
| 344 | + * @return string |
|
| 345 | + */ |
|
| 346 | + public function get_vat_rule( $context = 'view' ) { |
|
| 347 | 347 | return $this->get_prop( 'vat_rule', $context ); |
| 348 | 348 | } |
| 349 | 349 | |
| 350 | 350 | /** |
| 351 | - * Get the VAT class of the item. |
|
| 352 | - * |
|
| 353 | - * @since 1.0.19 |
|
| 354 | - * @param string $context View or edit context. |
|
| 355 | - * @return string |
|
| 356 | - */ |
|
| 357 | - public function get_vat_class( $context = 'view' ) { |
|
| 351 | + * Get the VAT class of the item. |
|
| 352 | + * |
|
| 353 | + * @since 1.0.19 |
|
| 354 | + * @param string $context View or edit context. |
|
| 355 | + * @return string |
|
| 356 | + */ |
|
| 357 | + public function get_vat_class( $context = 'view' ) { |
|
| 358 | 358 | return $this->get_prop( 'vat_class', $context ); |
| 359 | 359 | } |
| 360 | 360 | |
| 361 | 361 | /** |
| 362 | - * Get the type of the item. |
|
| 363 | - * |
|
| 364 | - * @since 1.0.19 |
|
| 365 | - * @param string $context View or edit context. |
|
| 366 | - * @return string |
|
| 367 | - */ |
|
| 368 | - public function get_type( $context = 'view' ) { |
|
| 362 | + * Get the type of the item. |
|
| 363 | + * |
|
| 364 | + * @since 1.0.19 |
|
| 365 | + * @param string $context View or edit context. |
|
| 366 | + * @return string |
|
| 367 | + */ |
|
| 368 | + public function get_type( $context = 'view' ) { |
|
| 369 | 369 | return $this->get_prop( 'type', $context ); |
| 370 | 370 | } |
| 371 | 371 | |
| 372 | 372 | /** |
| 373 | - * Get the custom id of the item. |
|
| 374 | - * |
|
| 375 | - * @since 1.0.19 |
|
| 376 | - * @param string $context View or edit context. |
|
| 377 | - * @return string |
|
| 378 | - */ |
|
| 379 | - public function get_custom_id( $context = 'view' ) { |
|
| 373 | + * Get the custom id of the item. |
|
| 374 | + * |
|
| 375 | + * @since 1.0.19 |
|
| 376 | + * @param string $context View or edit context. |
|
| 377 | + * @return string |
|
| 378 | + */ |
|
| 379 | + public function get_custom_id( $context = 'view' ) { |
|
| 380 | 380 | return $this->get_prop( 'custom_id', $context ); |
| 381 | 381 | } |
| 382 | 382 | |
| 383 | 383 | /** |
| 384 | - * Get the custom name of the item. |
|
| 385 | - * |
|
| 386 | - * @since 1.0.19 |
|
| 387 | - * @param string $context View or edit context. |
|
| 388 | - * @return string |
|
| 389 | - */ |
|
| 390 | - public function get_custom_name( $context = 'view' ) { |
|
| 384 | + * Get the custom name of the item. |
|
| 385 | + * |
|
| 386 | + * @since 1.0.19 |
|
| 387 | + * @param string $context View or edit context. |
|
| 388 | + * @return string |
|
| 389 | + */ |
|
| 390 | + public function get_custom_name( $context = 'view' ) { |
|
| 391 | 391 | return $this->get_prop( 'custom_name', $context ); |
| 392 | 392 | } |
| 393 | 393 | |
| 394 | 394 | /** |
| 395 | - * Get the custom singular name of the item. |
|
| 396 | - * |
|
| 397 | - * @since 1.0.19 |
|
| 398 | - * @param string $context View or edit context. |
|
| 399 | - * @return string |
|
| 400 | - */ |
|
| 401 | - public function get_custom_singular_name( $context = 'view' ) { |
|
| 395 | + * Get the custom singular name of the item. |
|
| 396 | + * |
|
| 397 | + * @since 1.0.19 |
|
| 398 | + * @param string $context View or edit context. |
|
| 399 | + * @return string |
|
| 400 | + */ |
|
| 401 | + public function get_custom_singular_name( $context = 'view' ) { |
|
| 402 | 402 | return $this->get_prop( 'custom_singular_name', $context ); |
| 403 | 403 | } |
| 404 | 404 | |
| 405 | 405 | /** |
| 406 | - * Checks if an item is editable.. |
|
| 407 | - * |
|
| 408 | - * @since 1.0.19 |
|
| 409 | - * @param string $context View or edit context. |
|
| 410 | - * @return int |
|
| 411 | - */ |
|
| 412 | - public function get_is_editable( $context = 'view' ) { |
|
| 406 | + * Checks if an item is editable.. |
|
| 407 | + * |
|
| 408 | + * @since 1.0.19 |
|
| 409 | + * @param string $context View or edit context. |
|
| 410 | + * @return int |
|
| 411 | + */ |
|
| 412 | + public function get_is_editable( $context = 'view' ) { |
|
| 413 | 413 | return (int) $this->get_prop( 'is_editable', $context ); |
| 414 | 414 | } |
| 415 | 415 | |
| 416 | 416 | /** |
| 417 | - * Alias of self::get_is_editable(). |
|
| 418 | - * |
|
| 419 | - * @since 1.0.19 |
|
| 420 | - * @param string $context View or edit context. |
|
| 421 | - * @return int |
|
| 422 | - */ |
|
| 423 | - public function get_editable( $context = 'view' ) { |
|
| 424 | - return $this->get_is_editable( $context ); |
|
| 417 | + * Alias of self::get_is_editable(). |
|
| 418 | + * |
|
| 419 | + * @since 1.0.19 |
|
| 420 | + * @param string $context View or edit context. |
|
| 421 | + * @return int |
|
| 422 | + */ |
|
| 423 | + public function get_editable( $context = 'view' ) { |
|
| 424 | + return $this->get_is_editable( $context ); |
|
| 425 | 425 | } |
| 426 | 426 | |
| 427 | 427 | /** |
| 428 | - * Checks if dynamic pricing is enabled. |
|
| 429 | - * |
|
| 430 | - * @since 1.0.19 |
|
| 431 | - * @param string $context View or edit context. |
|
| 432 | - * @return int |
|
| 433 | - */ |
|
| 434 | - public function get_is_dynamic_pricing( $context = 'view' ) { |
|
| 428 | + * Checks if dynamic pricing is enabled. |
|
| 429 | + * |
|
| 430 | + * @since 1.0.19 |
|
| 431 | + * @param string $context View or edit context. |
|
| 432 | + * @return int |
|
| 433 | + */ |
|
| 434 | + public function get_is_dynamic_pricing( $context = 'view' ) { |
|
| 435 | 435 | return (int) $this->get_prop( 'is_dynamic_pricing', $context ); |
| 436 | 436 | } |
| 437 | 437 | |
| 438 | 438 | /** |
| 439 | - * Returns the minimum price if dynamic pricing is enabled. |
|
| 440 | - * |
|
| 441 | - * @since 1.0.19 |
|
| 442 | - * @param string $context View or edit context. |
|
| 443 | - * @return float |
|
| 444 | - */ |
|
| 445 | - public function get_minimum_price( $context = 'view' ) { |
|
| 439 | + * Returns the minimum price if dynamic pricing is enabled. |
|
| 440 | + * |
|
| 441 | + * @since 1.0.19 |
|
| 442 | + * @param string $context View or edit context. |
|
| 443 | + * @return float |
|
| 444 | + */ |
|
| 445 | + public function get_minimum_price( $context = 'view' ) { |
|
| 446 | 446 | return wpinv_sanitize_amount( $this->get_prop( 'minimum_price', $context ) ); |
| 447 | 447 | } |
| 448 | 448 | |
| 449 | 449 | /** |
| 450 | - * Checks if this is a recurring item. |
|
| 451 | - * |
|
| 452 | - * @since 1.0.19 |
|
| 453 | - * @param string $context View or edit context. |
|
| 454 | - * @return int |
|
| 455 | - */ |
|
| 456 | - public function get_is_recurring( $context = 'view' ) { |
|
| 450 | + * Checks if this is a recurring item. |
|
| 451 | + * |
|
| 452 | + * @since 1.0.19 |
|
| 453 | + * @param string $context View or edit context. |
|
| 454 | + * @return int |
|
| 455 | + */ |
|
| 456 | + public function get_is_recurring( $context = 'view' ) { |
|
| 457 | 457 | return (int) $this->get_prop( 'is_recurring', $context ); |
| 458 | - } |
|
| 458 | + } |
|
| 459 | 459 | |
| 460 | - /** |
|
| 461 | - * Get the recurring price of the item. |
|
| 462 | - * |
|
| 463 | - * @since 1.0.19 |
|
| 464 | - * @param string $context View or edit context. |
|
| 465 | - * @return float |
|
| 466 | - */ |
|
| 467 | - public function get_recurring_price( $context = 'view' ) { |
|
| 468 | - $price = $this->get_price( $context ); |
|
| 460 | + /** |
|
| 461 | + * Get the recurring price of the item. |
|
| 462 | + * |
|
| 463 | + * @since 1.0.19 |
|
| 464 | + * @param string $context View or edit context. |
|
| 465 | + * @return float |
|
| 466 | + */ |
|
| 467 | + public function get_recurring_price( $context = 'view' ) { |
|
| 468 | + $price = $this->get_price( $context ); |
|
| 469 | 469 | return wpinv_sanitize_amount( apply_filters( 'wpinv_get_recurring_item_price', $price, $this->ID ) ); |
| 470 | - } |
|
| 471 | - |
|
| 472 | - /** |
|
| 473 | - * Get the formatted recurring price of the item. |
|
| 474 | - * |
|
| 475 | - * @since 1.0.19 |
|
| 476 | - * @param string $context View or edit context. |
|
| 477 | - * @return string |
|
| 478 | - */ |
|
| 470 | + } |
|
| 471 | + |
|
| 472 | + /** |
|
| 473 | + * Get the formatted recurring price of the item. |
|
| 474 | + * |
|
| 475 | + * @since 1.0.19 |
|
| 476 | + * @param string $context View or edit context. |
|
| 477 | + * @return string |
|
| 478 | + */ |
|
| 479 | 479 | public function get_the_recurring_price() { |
| 480 | 480 | return wpinv_price( $this->get_recurring_price() ); |
| 481 | - } |
|
| 482 | - |
|
| 483 | - /** |
|
| 484 | - * Get the first renewal date (in timestamps) of the item. |
|
| 485 | - * |
|
| 486 | - * @since 1.0.19 |
|
| 487 | - * @return int |
|
| 488 | - */ |
|
| 489 | - public function get_first_renewal_date() { |
|
| 490 | - |
|
| 491 | - $periods = array( |
|
| 492 | - 'D' => 'days', |
|
| 493 | - 'W' => 'weeks', |
|
| 494 | - 'M' => 'months', |
|
| 495 | - 'Y' => 'years', |
|
| 496 | - ); |
|
| 497 | - |
|
| 498 | - $period = $this->get_recurring_period(); |
|
| 499 | - $interval = $this->get_recurring_interval(); |
|
| 500 | - |
|
| 501 | - if ( $this->has_free_trial() ) { |
|
| 502 | - $period = $this->get_trial_period(); |
|
| 503 | - $interval = $this->get_trial_interval(); |
|
| 504 | - } |
|
| 505 | - |
|
| 506 | - $period = $periods[ $period ]; |
|
| 507 | - $interval = empty( $interval ) ? 1 : $interval; |
|
| 508 | - $next_renewal = strtotime( "+$interval $period", current_time( 'timestamp' ) ); |
|
| 481 | + } |
|
| 482 | + |
|
| 483 | + /** |
|
| 484 | + * Get the first renewal date (in timestamps) of the item. |
|
| 485 | + * |
|
| 486 | + * @since 1.0.19 |
|
| 487 | + * @return int |
|
| 488 | + */ |
|
| 489 | + public function get_first_renewal_date() { |
|
| 490 | + |
|
| 491 | + $periods = array( |
|
| 492 | + 'D' => 'days', |
|
| 493 | + 'W' => 'weeks', |
|
| 494 | + 'M' => 'months', |
|
| 495 | + 'Y' => 'years', |
|
| 496 | + ); |
|
| 497 | + |
|
| 498 | + $period = $this->get_recurring_period(); |
|
| 499 | + $interval = $this->get_recurring_interval(); |
|
| 500 | + |
|
| 501 | + if ( $this->has_free_trial() ) { |
|
| 502 | + $period = $this->get_trial_period(); |
|
| 503 | + $interval = $this->get_trial_interval(); |
|
| 504 | + } |
|
| 505 | + |
|
| 506 | + $period = $periods[ $period ]; |
|
| 507 | + $interval = empty( $interval ) ? 1 : $interval; |
|
| 508 | + $next_renewal = strtotime( "+$interval $period", current_time( 'timestamp' ) ); |
|
| 509 | 509 | return apply_filters( 'wpinv_get_first_renewal_date', $next_renewal, $this ); |
| 510 | 510 | } |
| 511 | 511 | |
| 512 | 512 | /** |
| 513 | - * Get the recurring period. |
|
| 514 | - * |
|
| 515 | - * @since 1.0.19 |
|
| 516 | - * @param bool $full Return abbreviation or in full. |
|
| 517 | - * @return string |
|
| 518 | - */ |
|
| 519 | - public function get_recurring_period( $full = false ) { |
|
| 513 | + * Get the recurring period. |
|
| 514 | + * |
|
| 515 | + * @since 1.0.19 |
|
| 516 | + * @param bool $full Return abbreviation or in full. |
|
| 517 | + * @return string |
|
| 518 | + */ |
|
| 519 | + public function get_recurring_period( $full = false ) { |
|
| 520 | 520 | $period = $this->get_prop( 'recurring_period', 'view' ); |
| 521 | 521 | |
| 522 | 522 | if ( $full && ! is_bool( $full ) ) { |
@@ -527,63 +527,63 @@ discard block |
||
| 527 | 527 | } |
| 528 | 528 | |
| 529 | 529 | /** |
| 530 | - * Get the recurring interval. |
|
| 531 | - * |
|
| 532 | - * @since 1.0.19 |
|
| 533 | - * @param string $context View or edit context. |
|
| 534 | - * @return int |
|
| 535 | - */ |
|
| 536 | - public function get_recurring_interval( $context = 'view' ) { |
|
| 537 | - $interval = absint( $this->get_prop( 'recurring_interval', $context ) ); |
|
| 530 | + * Get the recurring interval. |
|
| 531 | + * |
|
| 532 | + * @since 1.0.19 |
|
| 533 | + * @param string $context View or edit context. |
|
| 534 | + * @return int |
|
| 535 | + */ |
|
| 536 | + public function get_recurring_interval( $context = 'view' ) { |
|
| 537 | + $interval = absint( $this->get_prop( 'recurring_interval', $context ) ); |
|
| 538 | 538 | |
| 539 | - if ( $interval < 1 ) { |
|
| 540 | - $interval = 1; |
|
| 541 | - } |
|
| 539 | + if ( $interval < 1 ) { |
|
| 540 | + $interval = 1; |
|
| 541 | + } |
|
| 542 | 542 | |
| 543 | 543 | return $interval; |
| 544 | 544 | } |
| 545 | 545 | |
| 546 | 546 | /** |
| 547 | - * Get the recurring limit. |
|
| 548 | - * |
|
| 549 | - * @since 1.0.19 |
|
| 550 | - * @param string $context View or edit context. |
|
| 551 | - * @return int |
|
| 552 | - */ |
|
| 553 | - public function get_recurring_limit( $context = 'view' ) { |
|
| 547 | + * Get the recurring limit. |
|
| 548 | + * |
|
| 549 | + * @since 1.0.19 |
|
| 550 | + * @param string $context View or edit context. |
|
| 551 | + * @return int |
|
| 552 | + */ |
|
| 553 | + public function get_recurring_limit( $context = 'view' ) { |
|
| 554 | 554 | return (int) $this->get_prop( 'recurring_limit', $context ); |
| 555 | 555 | } |
| 556 | 556 | |
| 557 | 557 | /** |
| 558 | - * Checks if we have a free trial. |
|
| 559 | - * |
|
| 560 | - * @since 1.0.19 |
|
| 561 | - * @param string $context View or edit context. |
|
| 562 | - * @return int |
|
| 563 | - */ |
|
| 564 | - public function get_is_free_trial( $context = 'view' ) { |
|
| 558 | + * Checks if we have a free trial. |
|
| 559 | + * |
|
| 560 | + * @since 1.0.19 |
|
| 561 | + * @param string $context View or edit context. |
|
| 562 | + * @return int |
|
| 563 | + */ |
|
| 564 | + public function get_is_free_trial( $context = 'view' ) { |
|
| 565 | 565 | return (int) $this->get_prop( 'is_free_trial', $context ); |
| 566 | 566 | } |
| 567 | 567 | |
| 568 | 568 | /** |
| 569 | - * Alias for self::get_is_free_trial(). |
|
| 570 | - * |
|
| 571 | - * @since 1.0.19 |
|
| 572 | - * @param string $context View or edit context. |
|
| 573 | - * @return int |
|
| 574 | - */ |
|
| 575 | - public function get_free_trial( $context = 'view' ) { |
|
| 569 | + * Alias for self::get_is_free_trial(). |
|
| 570 | + * |
|
| 571 | + * @since 1.0.19 |
|
| 572 | + * @param string $context View or edit context. |
|
| 573 | + * @return int |
|
| 574 | + */ |
|
| 575 | + public function get_free_trial( $context = 'view' ) { |
|
| 576 | 576 | return $this->get_is_free_trial( $context ); |
| 577 | 577 | } |
| 578 | 578 | |
| 579 | 579 | /** |
| 580 | - * Get the trial period. |
|
| 581 | - * |
|
| 582 | - * @since 1.0.19 |
|
| 583 | - * @param bool $full Return abbreviation or in full. |
|
| 584 | - * @return string |
|
| 585 | - */ |
|
| 586 | - public function get_trial_period( $full = false ) { |
|
| 580 | + * Get the trial period. |
|
| 581 | + * |
|
| 582 | + * @since 1.0.19 |
|
| 583 | + * @param bool $full Return abbreviation or in full. |
|
| 584 | + * @return string |
|
| 585 | + */ |
|
| 586 | + public function get_trial_period( $full = false ) { |
|
| 587 | 587 | $period = $this->get_prop( 'trial_period', 'view' ); |
| 588 | 588 | |
| 589 | 589 | if ( $full && ! is_bool( $full ) ) { |
@@ -594,104 +594,104 @@ discard block |
||
| 594 | 594 | } |
| 595 | 595 | |
| 596 | 596 | /** |
| 597 | - * Get the trial interval. |
|
| 598 | - * |
|
| 599 | - * @since 1.0.19 |
|
| 600 | - * @param string $context View or edit context. |
|
| 601 | - * @return int |
|
| 602 | - */ |
|
| 603 | - public function get_trial_interval( $context = 'view' ) { |
|
| 597 | + * Get the trial interval. |
|
| 598 | + * |
|
| 599 | + * @since 1.0.19 |
|
| 600 | + * @param string $context View or edit context. |
|
| 601 | + * @return int |
|
| 602 | + */ |
|
| 603 | + public function get_trial_interval( $context = 'view' ) { |
|
| 604 | 604 | return (int) $this->get_prop( 'trial_interval', $context ); |
| 605 | - } |
|
| 605 | + } |
|
| 606 | 606 | |
| 607 | - /** |
|
| 608 | - * Get the item's edit url. |
|
| 609 | - * |
|
| 610 | - * @since 1.0.19 |
|
| 611 | - * @return string |
|
| 612 | - */ |
|
| 613 | - public function get_edit_url() { |
|
| 607 | + /** |
|
| 608 | + * Get the item's edit url. |
|
| 609 | + * |
|
| 610 | + * @since 1.0.19 |
|
| 611 | + * @return string |
|
| 612 | + */ |
|
| 613 | + public function get_edit_url() { |
|
| 614 | 614 | return get_edit_post_link( $this->get_id() ); |
| 615 | - } |
|
| 616 | - |
|
| 617 | - /** |
|
| 618 | - * Given an item's name/custom id, it returns its id. |
|
| 619 | - * |
|
| 620 | - * |
|
| 621 | - * @static |
|
| 622 | - * @param string $value The item name or custom id. |
|
| 623 | - * @param string $field Either name or custom_id. |
|
| 624 | - * @param string $type in case you need to search for a given type. |
|
| 625 | - * @since 1.0.15 |
|
| 626 | - * @return int |
|
| 627 | - */ |
|
| 628 | - public static function get_item_id_by_field( $value, $field = 'custom_id', $type = '' ) { |
|
| 629 | - |
|
| 630 | - // Trim the value. |
|
| 631 | - $value = sanitize_text_field( $value ); |
|
| 632 | - if ( empty( $value ) ) { |
|
| 633 | - return 0; |
|
| 634 | - } |
|
| 615 | + } |
|
| 616 | + |
|
| 617 | + /** |
|
| 618 | + * Given an item's name/custom id, it returns its id. |
|
| 619 | + * |
|
| 620 | + * |
|
| 621 | + * @static |
|
| 622 | + * @param string $value The item name or custom id. |
|
| 623 | + * @param string $field Either name or custom_id. |
|
| 624 | + * @param string $type in case you need to search for a given type. |
|
| 625 | + * @since 1.0.15 |
|
| 626 | + * @return int |
|
| 627 | + */ |
|
| 628 | + public static function get_item_id_by_field( $value, $field = 'custom_id', $type = '' ) { |
|
| 629 | + |
|
| 630 | + // Trim the value. |
|
| 631 | + $value = sanitize_text_field( $value ); |
|
| 632 | + if ( empty( $value ) ) { |
|
| 633 | + return 0; |
|
| 634 | + } |
|
| 635 | 635 | |
| 636 | 636 | // Valid fields. |
| 637 | 637 | $fields = array( 'custom_id', 'name', 'slug' ); |
| 638 | 638 | |
| 639 | - // Ensure a field has been passed. |
|
| 640 | - if ( empty( $field ) || ! in_array( $field, $fields ) ) { |
|
| 641 | - return 0; |
|
| 642 | - } |
|
| 643 | - |
|
| 644 | - if ( $field == 'name' ) { |
|
| 645 | - $field = 'slug'; |
|
| 646 | - } |
|
| 647 | - |
|
| 648 | - // Maybe retrieve from the cache. |
|
| 649 | - $item_id = wp_cache_get( $value, "getpaid_{$type}_item_{$field}s_to_item_ids" ); |
|
| 650 | - if ( ! empty( $item_id ) ) { |
|
| 651 | - return $item_id; |
|
| 652 | - } |
|
| 653 | - |
|
| 654 | - // Fetch from the db. |
|
| 655 | - $items = array(); |
|
| 656 | - if ( $field == 'slug' ) { |
|
| 657 | - $items = get_posts( |
|
| 658 | - array( |
|
| 659 | - 'post_type' => 'wpi_item', |
|
| 660 | - 'name' => $value, |
|
| 661 | - 'posts_per_page' => 1, |
|
| 662 | - 'post_status' => 'any', |
|
| 663 | - ) |
|
| 664 | - ); |
|
| 665 | - } |
|
| 666 | - |
|
| 667 | - if ( $field =='custom_id' ) { |
|
| 668 | - $items = get_posts( |
|
| 669 | - array( |
|
| 670 | - 'post_type' => 'wpi_item', |
|
| 671 | - 'posts_per_page' => 1, |
|
| 672 | - 'post_status' => 'any', |
|
| 673 | - 'meta_query' => array( |
|
| 674 | - array( |
|
| 675 | - 'key' => '_wpinv_type', |
|
| 676 | - 'value' => $type, |
|
| 677 | - ), |
|
| 678 | - array( |
|
| 679 | - 'key' => '_wpinv_custom_id', |
|
| 680 | - 'value' => $value, |
|
| 681 | - ) |
|
| 682 | - ) |
|
| 683 | - ) |
|
| 684 | - ); |
|
| 685 | - } |
|
| 686 | - |
|
| 687 | - if ( empty( $items ) ) { |
|
| 688 | - return 0; |
|
| 689 | - } |
|
| 690 | - |
|
| 691 | - // Update the cache with our data |
|
| 692 | - wp_cache_set( $value, $items[0]->ID, "getpaid_{$type}_item_{$field}s_to_item_ids" ); |
|
| 693 | - |
|
| 694 | - return $items[0]->ID; |
|
| 639 | + // Ensure a field has been passed. |
|
| 640 | + if ( empty( $field ) || ! in_array( $field, $fields ) ) { |
|
| 641 | + return 0; |
|
| 642 | + } |
|
| 643 | + |
|
| 644 | + if ( $field == 'name' ) { |
|
| 645 | + $field = 'slug'; |
|
| 646 | + } |
|
| 647 | + |
|
| 648 | + // Maybe retrieve from the cache. |
|
| 649 | + $item_id = wp_cache_get( $value, "getpaid_{$type}_item_{$field}s_to_item_ids" ); |
|
| 650 | + if ( ! empty( $item_id ) ) { |
|
| 651 | + return $item_id; |
|
| 652 | + } |
|
| 653 | + |
|
| 654 | + // Fetch from the db. |
|
| 655 | + $items = array(); |
|
| 656 | + if ( $field == 'slug' ) { |
|
| 657 | + $items = get_posts( |
|
| 658 | + array( |
|
| 659 | + 'post_type' => 'wpi_item', |
|
| 660 | + 'name' => $value, |
|
| 661 | + 'posts_per_page' => 1, |
|
| 662 | + 'post_status' => 'any', |
|
| 663 | + ) |
|
| 664 | + ); |
|
| 665 | + } |
|
| 666 | + |
|
| 667 | + if ( $field =='custom_id' ) { |
|
| 668 | + $items = get_posts( |
|
| 669 | + array( |
|
| 670 | + 'post_type' => 'wpi_item', |
|
| 671 | + 'posts_per_page' => 1, |
|
| 672 | + 'post_status' => 'any', |
|
| 673 | + 'meta_query' => array( |
|
| 674 | + array( |
|
| 675 | + 'key' => '_wpinv_type', |
|
| 676 | + 'value' => $type, |
|
| 677 | + ), |
|
| 678 | + array( |
|
| 679 | + 'key' => '_wpinv_custom_id', |
|
| 680 | + 'value' => $value, |
|
| 681 | + ) |
|
| 682 | + ) |
|
| 683 | + ) |
|
| 684 | + ); |
|
| 685 | + } |
|
| 686 | + |
|
| 687 | + if ( empty( $items ) ) { |
|
| 688 | + return 0; |
|
| 689 | + } |
|
| 690 | + |
|
| 691 | + // Update the cache with our data |
|
| 692 | + wp_cache_set( $value, $items[0]->ID, "getpaid_{$type}_item_{$field}s_to_item_ids" ); |
|
| 693 | + |
|
| 694 | + return $items[0]->ID; |
|
| 695 | 695 | } |
| 696 | 696 | |
| 697 | 697 | /** |
@@ -724,52 +724,52 @@ discard block |
||
| 724 | 724 | */ |
| 725 | 725 | |
| 726 | 726 | /** |
| 727 | - * Set parent order ID. |
|
| 728 | - * |
|
| 729 | - * @since 1.0.19 |
|
| 730 | - */ |
|
| 731 | - public function set_parent_id( $value ) { |
|
| 732 | - if ( $value && ( $value === $this->get_id() || ! get_post( $value ) ) ) { |
|
| 733 | - return; |
|
| 734 | - } |
|
| 735 | - $this->set_prop( 'parent_id', absint( $value ) ); |
|
| 736 | - } |
|
| 737 | - |
|
| 738 | - /** |
|
| 739 | - * Sets item status. |
|
| 740 | - * |
|
| 741 | - * @since 1.0.19 |
|
| 742 | - * @param string $status New status. |
|
| 743 | - * @return array details of change. |
|
| 744 | - */ |
|
| 745 | - public function set_status( $status ) { |
|
| 727 | + * Set parent order ID. |
|
| 728 | + * |
|
| 729 | + * @since 1.0.19 |
|
| 730 | + */ |
|
| 731 | + public function set_parent_id( $value ) { |
|
| 732 | + if ( $value && ( $value === $this->get_id() || ! get_post( $value ) ) ) { |
|
| 733 | + return; |
|
| 734 | + } |
|
| 735 | + $this->set_prop( 'parent_id', absint( $value ) ); |
|
| 736 | + } |
|
| 737 | + |
|
| 738 | + /** |
|
| 739 | + * Sets item status. |
|
| 740 | + * |
|
| 741 | + * @since 1.0.19 |
|
| 742 | + * @param string $status New status. |
|
| 743 | + * @return array details of change. |
|
| 744 | + */ |
|
| 745 | + public function set_status( $status ) { |
|
| 746 | 746 | $old_status = $this->get_status(); |
| 747 | 747 | |
| 748 | 748 | $this->set_prop( 'status', $status ); |
| 749 | 749 | |
| 750 | - return array( |
|
| 751 | - 'from' => $old_status, |
|
| 752 | - 'to' => $status, |
|
| 753 | - ); |
|
| 750 | + return array( |
|
| 751 | + 'from' => $old_status, |
|
| 752 | + 'to' => $status, |
|
| 753 | + ); |
|
| 754 | 754 | } |
| 755 | 755 | |
| 756 | 756 | /** |
| 757 | - * Set plugin version when the item was created. |
|
| 758 | - * |
|
| 759 | - * @since 1.0.19 |
|
| 760 | - */ |
|
| 761 | - public function set_version( $value ) { |
|
| 762 | - $this->set_prop( 'version', $value ); |
|
| 757 | + * Set plugin version when the item was created. |
|
| 758 | + * |
|
| 759 | + * @since 1.0.19 |
|
| 760 | + */ |
|
| 761 | + public function set_version( $value ) { |
|
| 762 | + $this->set_prop( 'version', $value ); |
|
| 763 | 763 | } |
| 764 | 764 | |
| 765 | 765 | /** |
| 766 | - * Set date when the item was created. |
|
| 767 | - * |
|
| 768 | - * @since 1.0.19 |
|
| 769 | - * @param string $value Value to set. |
|
| 766 | + * Set date when the item was created. |
|
| 767 | + * |
|
| 768 | + * @since 1.0.19 |
|
| 769 | + * @param string $value Value to set. |
|
| 770 | 770 | * @return bool Whether or not the date was set. |
| 771 | - */ |
|
| 772 | - public function set_date_created( $value ) { |
|
| 771 | + */ |
|
| 772 | + public function set_date_created( $value ) { |
|
| 773 | 773 | $date = strtotime( $value ); |
| 774 | 774 | |
| 775 | 775 | if ( $date ) { |
@@ -782,13 +782,13 @@ discard block |
||
| 782 | 782 | } |
| 783 | 783 | |
| 784 | 784 | /** |
| 785 | - * Set date when the item was last modified. |
|
| 786 | - * |
|
| 787 | - * @since 1.0.19 |
|
| 788 | - * @param string $value Value to set. |
|
| 785 | + * Set date when the item was last modified. |
|
| 786 | + * |
|
| 787 | + * @since 1.0.19 |
|
| 788 | + * @param string $value Value to set. |
|
| 789 | 789 | * @return bool Whether or not the date was set. |
| 790 | - */ |
|
| 791 | - public function set_date_modified( $value ) { |
|
| 790 | + */ |
|
| 791 | + public function set_date_modified( $value ) { |
|
| 792 | 792 | $date = strtotime( $value ); |
| 793 | 793 | |
| 794 | 794 | if ( $date ) { |
@@ -801,115 +801,115 @@ discard block |
||
| 801 | 801 | } |
| 802 | 802 | |
| 803 | 803 | /** |
| 804 | - * Set the item name. |
|
| 805 | - * |
|
| 806 | - * @since 1.0.19 |
|
| 807 | - * @param string $value New name. |
|
| 808 | - */ |
|
| 809 | - public function set_name( $value ) { |
|
| 804 | + * Set the item name. |
|
| 805 | + * |
|
| 806 | + * @since 1.0.19 |
|
| 807 | + * @param string $value New name. |
|
| 808 | + */ |
|
| 809 | + public function set_name( $value ) { |
|
| 810 | 810 | $name = sanitize_text_field( $value ); |
| 811 | - $this->set_prop( 'name', $name ); |
|
| 811 | + $this->set_prop( 'name', $name ); |
|
| 812 | 812 | } |
| 813 | 813 | |
| 814 | 814 | /** |
| 815 | - * Alias of self::set_name(). |
|
| 816 | - * |
|
| 817 | - * @since 1.0.19 |
|
| 818 | - * @param string $value New name. |
|
| 819 | - */ |
|
| 820 | - public function set_title( $value ) { |
|
| 821 | - $this->set_name( $value ); |
|
| 815 | + * Alias of self::set_name(). |
|
| 816 | + * |
|
| 817 | + * @since 1.0.19 |
|
| 818 | + * @param string $value New name. |
|
| 819 | + */ |
|
| 820 | + public function set_title( $value ) { |
|
| 821 | + $this->set_name( $value ); |
|
| 822 | 822 | } |
| 823 | 823 | |
| 824 | 824 | /** |
| 825 | - * Set the item description. |
|
| 826 | - * |
|
| 827 | - * @since 1.0.19 |
|
| 828 | - * @param string $value New description. |
|
| 829 | - */ |
|
| 830 | - public function set_description( $value ) { |
|
| 825 | + * Set the item description. |
|
| 826 | + * |
|
| 827 | + * @since 1.0.19 |
|
| 828 | + * @param string $value New description. |
|
| 829 | + */ |
|
| 830 | + public function set_description( $value ) { |
|
| 831 | 831 | $description = wp_kses_post( $value ); |
| 832 | - return $this->set_prop( 'description', $description ); |
|
| 832 | + return $this->set_prop( 'description', $description ); |
|
| 833 | 833 | } |
| 834 | 834 | |
| 835 | 835 | /** |
| 836 | - * Alias of self::set_description(). |
|
| 837 | - * |
|
| 838 | - * @since 1.0.19 |
|
| 839 | - * @param string $value New description. |
|
| 840 | - */ |
|
| 841 | - public function set_excerpt( $value ) { |
|
| 842 | - $this->set_description( $value ); |
|
| 836 | + * Alias of self::set_description(). |
|
| 837 | + * |
|
| 838 | + * @since 1.0.19 |
|
| 839 | + * @param string $value New description. |
|
| 840 | + */ |
|
| 841 | + public function set_excerpt( $value ) { |
|
| 842 | + $this->set_description( $value ); |
|
| 843 | 843 | } |
| 844 | 844 | |
| 845 | 845 | /** |
| 846 | - * Alias of self::set_description(). |
|
| 847 | - * |
|
| 848 | - * @since 1.0.19 |
|
| 849 | - * @param string $value New description. |
|
| 850 | - */ |
|
| 851 | - public function set_summary( $value ) { |
|
| 852 | - $this->set_description( $value ); |
|
| 846 | + * Alias of self::set_description(). |
|
| 847 | + * |
|
| 848 | + * @since 1.0.19 |
|
| 849 | + * @param string $value New description. |
|
| 850 | + */ |
|
| 851 | + public function set_summary( $value ) { |
|
| 852 | + $this->set_description( $value ); |
|
| 853 | 853 | } |
| 854 | 854 | |
| 855 | 855 | /** |
| 856 | - * Set the owner of the item. |
|
| 857 | - * |
|
| 858 | - * @since 1.0.19 |
|
| 859 | - * @param int $value New author. |
|
| 860 | - */ |
|
| 861 | - public function set_author( $value ) { |
|
| 862 | - $this->set_prop( 'author', (int) $value ); |
|
| 863 | - } |
|
| 856 | + * Set the owner of the item. |
|
| 857 | + * |
|
| 858 | + * @since 1.0.19 |
|
| 859 | + * @param int $value New author. |
|
| 860 | + */ |
|
| 861 | + public function set_author( $value ) { |
|
| 862 | + $this->set_prop( 'author', (int) $value ); |
|
| 863 | + } |
|
| 864 | 864 | |
| 865 | - /** |
|
| 866 | - * Alias of self::set_author(). |
|
| 867 | - * |
|
| 868 | - * @since 1.0.19 |
|
| 869 | - * @param int $value New author. |
|
| 870 | - */ |
|
| 871 | - public function set_owner( $value ) { |
|
| 872 | - $this->set_author( $value ); |
|
| 873 | - } |
|
| 874 | - |
|
| 875 | - /** |
|
| 876 | - * Set the price of the item. |
|
| 877 | - * |
|
| 878 | - * @since 1.0.19 |
|
| 879 | - * @param float $value New price. |
|
| 880 | - */ |
|
| 881 | - public function set_price( $value ) { |
|
| 865 | + /** |
|
| 866 | + * Alias of self::set_author(). |
|
| 867 | + * |
|
| 868 | + * @since 1.0.19 |
|
| 869 | + * @param int $value New author. |
|
| 870 | + */ |
|
| 871 | + public function set_owner( $value ) { |
|
| 872 | + $this->set_author( $value ); |
|
| 873 | + } |
|
| 874 | + |
|
| 875 | + /** |
|
| 876 | + * Set the price of the item. |
|
| 877 | + * |
|
| 878 | + * @since 1.0.19 |
|
| 879 | + * @param float $value New price. |
|
| 880 | + */ |
|
| 881 | + public function set_price( $value ) { |
|
| 882 | 882 | $this->set_prop( 'price', (float) wpinv_sanitize_amount( $value ) ); |
| 883 | 883 | } |
| 884 | 884 | |
| 885 | 885 | /** |
| 886 | - * Set the VAT rule of the item. |
|
| 887 | - * |
|
| 888 | - * @since 1.0.19 |
|
| 889 | - * @param string $value new rule. |
|
| 890 | - */ |
|
| 891 | - public function set_vat_rule( $value ) { |
|
| 886 | + * Set the VAT rule of the item. |
|
| 887 | + * |
|
| 888 | + * @since 1.0.19 |
|
| 889 | + * @param string $value new rule. |
|
| 890 | + */ |
|
| 891 | + public function set_vat_rule( $value ) { |
|
| 892 | 892 | $this->set_prop( 'vat_rule', $value ); |
| 893 | 893 | } |
| 894 | 894 | |
| 895 | 895 | /** |
| 896 | - * Set the VAT class of the item. |
|
| 897 | - * |
|
| 898 | - * @since 1.0.19 |
|
| 899 | - * @param string $value new class. |
|
| 900 | - */ |
|
| 901 | - public function set_vat_class( $value ) { |
|
| 896 | + * Set the VAT class of the item. |
|
| 897 | + * |
|
| 898 | + * @since 1.0.19 |
|
| 899 | + * @param string $value new class. |
|
| 900 | + */ |
|
| 901 | + public function set_vat_class( $value ) { |
|
| 902 | 902 | $this->set_prop( 'vat_class', $value ); |
| 903 | 903 | } |
| 904 | 904 | |
| 905 | 905 | /** |
| 906 | - * Set the type of the item. |
|
| 907 | - * |
|
| 908 | - * @since 1.0.19 |
|
| 909 | - * @param string $value new item type. |
|
| 910 | - * @return string |
|
| 911 | - */ |
|
| 912 | - public function set_type( $value ) { |
|
| 906 | + * Set the type of the item. |
|
| 907 | + * |
|
| 908 | + * @since 1.0.19 |
|
| 909 | + * @param string $value new item type. |
|
| 910 | + * @return string |
|
| 911 | + */ |
|
| 912 | + public function set_type( $value ) { |
|
| 913 | 913 | |
| 914 | 914 | if ( empty( $value ) ) { |
| 915 | 915 | $value = 'custom'; |
@@ -919,132 +919,132 @@ discard block |
||
| 919 | 919 | } |
| 920 | 920 | |
| 921 | 921 | /** |
| 922 | - * Set the custom id of the item. |
|
| 923 | - * |
|
| 924 | - * @since 1.0.19 |
|
| 925 | - * @param string $value new custom id. |
|
| 926 | - */ |
|
| 927 | - public function set_custom_id( $value ) { |
|
| 922 | + * Set the custom id of the item. |
|
| 923 | + * |
|
| 924 | + * @since 1.0.19 |
|
| 925 | + * @param string $value new custom id. |
|
| 926 | + */ |
|
| 927 | + public function set_custom_id( $value ) { |
|
| 928 | 928 | $this->set_prop( 'custom_id', $value ); |
| 929 | 929 | } |
| 930 | 930 | |
| 931 | 931 | /** |
| 932 | - * Set the custom name of the item. |
|
| 933 | - * |
|
| 934 | - * @since 1.0.19 |
|
| 935 | - * @param string $value new custom name. |
|
| 936 | - */ |
|
| 937 | - public function set_custom_name( $value ) { |
|
| 932 | + * Set the custom name of the item. |
|
| 933 | + * |
|
| 934 | + * @since 1.0.19 |
|
| 935 | + * @param string $value new custom name. |
|
| 936 | + */ |
|
| 937 | + public function set_custom_name( $value ) { |
|
| 938 | 938 | $this->set_prop( 'custom_name', $value ); |
| 939 | 939 | } |
| 940 | 940 | |
| 941 | 941 | /** |
| 942 | - * Set the custom singular name of the item. |
|
| 943 | - * |
|
| 944 | - * @since 1.0.19 |
|
| 945 | - * @param string $value new custom singular name. |
|
| 946 | - */ |
|
| 947 | - public function set_custom_singular_name( $value ) { |
|
| 942 | + * Set the custom singular name of the item. |
|
| 943 | + * |
|
| 944 | + * @since 1.0.19 |
|
| 945 | + * @param string $value new custom singular name. |
|
| 946 | + */ |
|
| 947 | + public function set_custom_singular_name( $value ) { |
|
| 948 | 948 | $this->set_prop( 'custom_singular_name', $value ); |
| 949 | 949 | } |
| 950 | 950 | |
| 951 | 951 | /** |
| 952 | - * Sets if an item is editable.. |
|
| 953 | - * |
|
| 954 | - * @since 1.0.19 |
|
| 955 | - * @param int|bool $value whether or not the item is editable. |
|
| 956 | - */ |
|
| 957 | - public function set_is_editable( $value ) { |
|
| 958 | - $this->set_prop( 'is_editable', (int) $value ); |
|
| 952 | + * Sets if an item is editable.. |
|
| 953 | + * |
|
| 954 | + * @since 1.0.19 |
|
| 955 | + * @param int|bool $value whether or not the item is editable. |
|
| 956 | + */ |
|
| 957 | + public function set_is_editable( $value ) { |
|
| 958 | + $this->set_prop( 'is_editable', (int) $value ); |
|
| 959 | 959 | } |
| 960 | 960 | |
| 961 | 961 | /** |
| 962 | - * Sets if dynamic pricing is enabled. |
|
| 963 | - * |
|
| 964 | - * @since 1.0.19 |
|
| 965 | - * @param int|bool $value whether or not dynamic pricing is allowed. |
|
| 966 | - */ |
|
| 967 | - public function set_is_dynamic_pricing( $value ) { |
|
| 962 | + * Sets if dynamic pricing is enabled. |
|
| 963 | + * |
|
| 964 | + * @since 1.0.19 |
|
| 965 | + * @param int|bool $value whether or not dynamic pricing is allowed. |
|
| 966 | + */ |
|
| 967 | + public function set_is_dynamic_pricing( $value ) { |
|
| 968 | 968 | $this->set_prop( 'is_dynamic_pricing', (int) $value ); |
| 969 | 969 | } |
| 970 | 970 | |
| 971 | 971 | /** |
| 972 | - * Sets the minimum price if dynamic pricing is enabled. |
|
| 973 | - * |
|
| 974 | - * @since 1.0.19 |
|
| 975 | - * @param float $value minimum price. |
|
| 976 | - */ |
|
| 977 | - public function set_minimum_price( $value ) { |
|
| 972 | + * Sets the minimum price if dynamic pricing is enabled. |
|
| 973 | + * |
|
| 974 | + * @since 1.0.19 |
|
| 975 | + * @param float $value minimum price. |
|
| 976 | + */ |
|
| 977 | + public function set_minimum_price( $value ) { |
|
| 978 | 978 | $this->set_prop( 'minimum_price', (float) wpinv_sanitize_amount( $value ) ); |
| 979 | 979 | } |
| 980 | 980 | |
| 981 | 981 | /** |
| 982 | - * Sets if this is a recurring item. |
|
| 983 | - * |
|
| 984 | - * @since 1.0.19 |
|
| 985 | - * @param int|bool $value whether or not dynamic pricing is allowed. |
|
| 986 | - */ |
|
| 987 | - public function set_is_recurring( $value ) { |
|
| 982 | + * Sets if this is a recurring item. |
|
| 983 | + * |
|
| 984 | + * @since 1.0.19 |
|
| 985 | + * @param int|bool $value whether or not dynamic pricing is allowed. |
|
| 986 | + */ |
|
| 987 | + public function set_is_recurring( $value ) { |
|
| 988 | 988 | $this->set_prop( 'is_recurring', (int) $value ); |
| 989 | 989 | } |
| 990 | 990 | |
| 991 | 991 | /** |
| 992 | - * Set the recurring period. |
|
| 993 | - * |
|
| 994 | - * @since 1.0.19 |
|
| 995 | - * @param string $value new period. |
|
| 996 | - */ |
|
| 997 | - public function set_recurring_period( $value ) { |
|
| 992 | + * Set the recurring period. |
|
| 993 | + * |
|
| 994 | + * @since 1.0.19 |
|
| 995 | + * @param string $value new period. |
|
| 996 | + */ |
|
| 997 | + public function set_recurring_period( $value ) { |
|
| 998 | 998 | $this->set_prop( 'recurring_period', $value ); |
| 999 | 999 | } |
| 1000 | 1000 | |
| 1001 | 1001 | /** |
| 1002 | - * Set the recurring interval. |
|
| 1003 | - * |
|
| 1004 | - * @since 1.0.19 |
|
| 1005 | - * @param int $value recurring interval. |
|
| 1006 | - */ |
|
| 1007 | - public function set_recurring_interval( $value ) { |
|
| 1002 | + * Set the recurring interval. |
|
| 1003 | + * |
|
| 1004 | + * @since 1.0.19 |
|
| 1005 | + * @param int $value recurring interval. |
|
| 1006 | + */ |
|
| 1007 | + public function set_recurring_interval( $value ) { |
|
| 1008 | 1008 | return $this->set_prop( 'recurring_interval', (int) $value ); |
| 1009 | 1009 | } |
| 1010 | 1010 | |
| 1011 | 1011 | /** |
| 1012 | - * Get the recurring limit. |
|
| 1013 | - * @since 1.0.19 |
|
| 1014 | - * @param int $value The recurring limit. |
|
| 1015 | - * @return int |
|
| 1016 | - */ |
|
| 1017 | - public function set_recurring_limit( $value ) { |
|
| 1012 | + * Get the recurring limit. |
|
| 1013 | + * @since 1.0.19 |
|
| 1014 | + * @param int $value The recurring limit. |
|
| 1015 | + * @return int |
|
| 1016 | + */ |
|
| 1017 | + public function set_recurring_limit( $value ) { |
|
| 1018 | 1018 | $this->set_prop( 'recurring_limit', (int) $value ); |
| 1019 | 1019 | } |
| 1020 | 1020 | |
| 1021 | 1021 | /** |
| 1022 | - * Checks if we have a free trial. |
|
| 1023 | - * |
|
| 1024 | - * @since 1.0.19 |
|
| 1025 | - * @param int|bool $value whether or not it has a free trial. |
|
| 1026 | - */ |
|
| 1027 | - public function set_is_free_trial( $value ) { |
|
| 1022 | + * Checks if we have a free trial. |
|
| 1023 | + * |
|
| 1024 | + * @since 1.0.19 |
|
| 1025 | + * @param int|bool $value whether or not it has a free trial. |
|
| 1026 | + */ |
|
| 1027 | + public function set_is_free_trial( $value ) { |
|
| 1028 | 1028 | $this->set_prop( 'is_free_trial', (int) $value ); |
| 1029 | 1029 | } |
| 1030 | 1030 | |
| 1031 | 1031 | /** |
| 1032 | - * Set the trial period. |
|
| 1033 | - * |
|
| 1034 | - * @since 1.0.19 |
|
| 1035 | - * @param string $value trial period. |
|
| 1036 | - */ |
|
| 1037 | - public function set_trial_period( $value ) { |
|
| 1032 | + * Set the trial period. |
|
| 1033 | + * |
|
| 1034 | + * @since 1.0.19 |
|
| 1035 | + * @param string $value trial period. |
|
| 1036 | + */ |
|
| 1037 | + public function set_trial_period( $value ) { |
|
| 1038 | 1038 | $this->set_prop( 'trial_period', $value ); |
| 1039 | 1039 | } |
| 1040 | 1040 | |
| 1041 | 1041 | /** |
| 1042 | - * Set the trial interval. |
|
| 1043 | - * |
|
| 1044 | - * @since 1.0.19 |
|
| 1045 | - * @param int $value trial interval. |
|
| 1046 | - */ |
|
| 1047 | - public function set_trial_interval( $value ) { |
|
| 1042 | + * Set the trial interval. |
|
| 1043 | + * |
|
| 1044 | + * @since 1.0.19 |
|
| 1045 | + * @param int $value trial interval. |
|
| 1046 | + */ |
|
| 1047 | + public function set_trial_interval( $value ) { |
|
| 1048 | 1048 | $this->set_prop( 'trial_interval', $value ); |
| 1049 | 1049 | } |
| 1050 | 1050 | |
@@ -1052,17 +1052,17 @@ discard block |
||
| 1052 | 1052 | * Create an item. For backwards compatibilty. |
| 1053 | 1053 | * |
| 1054 | 1054 | * @deprecated |
| 1055 | - * @return int item id |
|
| 1055 | + * @return int item id |
|
| 1056 | 1056 | */ |
| 1057 | 1057 | public function create( $data = array() ) { |
| 1058 | 1058 | |
| 1059 | - // Set the properties. |
|
| 1060 | - if ( is_array( $data ) ) { |
|
| 1061 | - $this->set_props( $data ); |
|
| 1062 | - } |
|
| 1059 | + // Set the properties. |
|
| 1060 | + if ( is_array( $data ) ) { |
|
| 1061 | + $this->set_props( $data ); |
|
| 1062 | + } |
|
| 1063 | 1063 | |
| 1064 | - // Save the item. |
|
| 1065 | - return $this->save(); |
|
| 1064 | + // Save the item. |
|
| 1065 | + return $this->save(); |
|
| 1066 | 1066 | |
| 1067 | 1067 | } |
| 1068 | 1068 | |
@@ -1070,7 +1070,7 @@ discard block |
||
| 1070 | 1070 | * Updates an item. For backwards compatibilty. |
| 1071 | 1071 | * |
| 1072 | 1072 | * @deprecated |
| 1073 | - * @return int item id |
|
| 1073 | + * @return int item id |
|
| 1074 | 1074 | */ |
| 1075 | 1075 | public function update( $data = array() ) { |
| 1076 | 1076 | return $this->create( $data ); |
@@ -1086,93 +1086,93 @@ discard block |
||
| 1086 | 1086 | */ |
| 1087 | 1087 | |
| 1088 | 1088 | /** |
| 1089 | - * Checks whether the item has enabled dynamic pricing. |
|
| 1090 | - * |
|
| 1091 | - * @since 1.0.19 |
|
| 1092 | - * @return bool |
|
| 1093 | - */ |
|
| 1094 | - public function user_can_set_their_price() { |
|
| 1089 | + * Checks whether the item has enabled dynamic pricing. |
|
| 1090 | + * |
|
| 1091 | + * @since 1.0.19 |
|
| 1092 | + * @return bool |
|
| 1093 | + */ |
|
| 1094 | + public function user_can_set_their_price() { |
|
| 1095 | 1095 | return (bool) $this->get_is_dynamic_pricing(); |
| 1096 | - } |
|
| 1096 | + } |
|
| 1097 | 1097 | |
| 1098 | - /** |
|
| 1099 | - * Checks whether the item is recurring. |
|
| 1100 | - * |
|
| 1101 | - * @since 1.0.19 |
|
| 1102 | - * @return bool |
|
| 1103 | - */ |
|
| 1104 | - public function is_recurring() { |
|
| 1098 | + /** |
|
| 1099 | + * Checks whether the item is recurring. |
|
| 1100 | + * |
|
| 1101 | + * @since 1.0.19 |
|
| 1102 | + * @return bool |
|
| 1103 | + */ |
|
| 1104 | + public function is_recurring() { |
|
| 1105 | 1105 | return (bool) $this->get_is_recurring(); |
| 1106 | 1106 | } |
| 1107 | 1107 | |
| 1108 | 1108 | /** |
| 1109 | - * Checks whether the item has a free trial. |
|
| 1110 | - * |
|
| 1111 | - * @since 1.0.19 |
|
| 1112 | - * @return bool |
|
| 1113 | - */ |
|
| 1109 | + * Checks whether the item has a free trial. |
|
| 1110 | + * |
|
| 1111 | + * @since 1.0.19 |
|
| 1112 | + * @return bool |
|
| 1113 | + */ |
|
| 1114 | 1114 | public function has_free_trial() { |
| 1115 | 1115 | $has_trial = $this->is_recurring() && (bool) $this->get_free_trial() ? true : false; |
| 1116 | 1116 | return (bool) apply_filters( 'wpinv_item_has_free_trial', $has_trial, $this->ID, $this ); |
| 1117 | 1117 | } |
| 1118 | 1118 | |
| 1119 | 1119 | /** |
| 1120 | - * Checks whether the item is free. |
|
| 1121 | - * |
|
| 1122 | - * @since 1.0.19 |
|
| 1123 | - * @return bool |
|
| 1124 | - */ |
|
| 1120 | + * Checks whether the item is free. |
|
| 1121 | + * |
|
| 1122 | + * @since 1.0.19 |
|
| 1123 | + * @return bool |
|
| 1124 | + */ |
|
| 1125 | 1125 | public function is_free() { |
| 1126 | 1126 | $is_free = $this->get_price() == 0; |
| 1127 | 1127 | return (bool) apply_filters( 'wpinv_is_free_item', $is_free, $this->ID, $this ); |
| 1128 | 1128 | } |
| 1129 | 1129 | |
| 1130 | 1130 | /** |
| 1131 | - * Checks the item status against a passed in status. |
|
| 1132 | - * |
|
| 1133 | - * @param array|string $status Status to check. |
|
| 1134 | - * @return bool |
|
| 1135 | - */ |
|
| 1136 | - public function has_status( $status ) { |
|
| 1137 | - $has_status = ( is_array( $status ) && in_array( $this->get_status(), $status, true ) ) || $this->get_status() === $status; |
|
| 1138 | - return (bool) apply_filters( 'getpaid_item_has_status', $has_status, $this, $status ); |
|
| 1131 | + * Checks the item status against a passed in status. |
|
| 1132 | + * |
|
| 1133 | + * @param array|string $status Status to check. |
|
| 1134 | + * @return bool |
|
| 1135 | + */ |
|
| 1136 | + public function has_status( $status ) { |
|
| 1137 | + $has_status = ( is_array( $status ) && in_array( $this->get_status(), $status, true ) ) || $this->get_status() === $status; |
|
| 1138 | + return (bool) apply_filters( 'getpaid_item_has_status', $has_status, $this, $status ); |
|
| 1139 | 1139 | } |
| 1140 | 1140 | |
| 1141 | 1141 | /** |
| 1142 | - * Checks the item type against a passed in types. |
|
| 1143 | - * |
|
| 1144 | - * @param array|string $type Type to check. |
|
| 1145 | - * @return bool |
|
| 1146 | - */ |
|
| 1147 | - public function is_type( $type ) { |
|
| 1148 | - $is_type = ( is_array( $type ) && in_array( $this->get_type(), $type, true ) ) || $this->get_type() === $type; |
|
| 1149 | - return (bool) apply_filters( 'getpaid_item_is_type', $is_type, $this, $type ); |
|
| 1150 | - } |
|
| 1142 | + * Checks the item type against a passed in types. |
|
| 1143 | + * |
|
| 1144 | + * @param array|string $type Type to check. |
|
| 1145 | + * @return bool |
|
| 1146 | + */ |
|
| 1147 | + public function is_type( $type ) { |
|
| 1148 | + $is_type = ( is_array( $type ) && in_array( $this->get_type(), $type, true ) ) || $this->get_type() === $type; |
|
| 1149 | + return (bool) apply_filters( 'getpaid_item_is_type', $is_type, $this, $type ); |
|
| 1150 | + } |
|
| 1151 | 1151 | |
| 1152 | 1152 | /** |
| 1153 | - * Checks whether the item is editable. |
|
| 1154 | - * |
|
| 1155 | - * @since 1.0.19 |
|
| 1156 | - * @return bool |
|
| 1157 | - */ |
|
| 1153 | + * Checks whether the item is editable. |
|
| 1154 | + * |
|
| 1155 | + * @since 1.0.19 |
|
| 1156 | + * @return bool |
|
| 1157 | + */ |
|
| 1158 | 1158 | public function is_editable() { |
| 1159 | 1159 | $is_editable = $this->get_is_editable(); |
| 1160 | 1160 | return (bool) apply_filters( 'wpinv_item_is_editable', $is_editable, $this->ID, $this ); |
| 1161 | - } |
|
| 1161 | + } |
|
| 1162 | 1162 | |
| 1163 | - /** |
|
| 1164 | - * Returns an array of cart fees. |
|
| 1165 | - */ |
|
| 1166 | - public function get_fees() { |
|
| 1163 | + /** |
|
| 1164 | + * Returns an array of cart fees. |
|
| 1165 | + */ |
|
| 1166 | + public function get_fees() { |
|
| 1167 | 1167 | return array(); |
| 1168 | 1168 | } |
| 1169 | 1169 | |
| 1170 | 1170 | /** |
| 1171 | - * Checks whether the item is purchasable. |
|
| 1172 | - * |
|
| 1173 | - * @since 1.0.19 |
|
| 1174 | - * @return bool |
|
| 1175 | - */ |
|
| 1171 | + * Checks whether the item is purchasable. |
|
| 1172 | + * |
|
| 1173 | + * @since 1.0.19 |
|
| 1174 | + * @return bool |
|
| 1175 | + */ |
|
| 1176 | 1176 | public function can_purchase() { |
| 1177 | 1177 | $can_purchase = $this->exists(); |
| 1178 | 1178 | |
@@ -1184,11 +1184,11 @@ discard block |
||
| 1184 | 1184 | } |
| 1185 | 1185 | |
| 1186 | 1186 | /** |
| 1187 | - * Checks whether the item supports dynamic pricing. |
|
| 1188 | - * |
|
| 1189 | - * @since 1.0.19 |
|
| 1190 | - * @return bool |
|
| 1191 | - */ |
|
| 1187 | + * Checks whether the item supports dynamic pricing. |
|
| 1188 | + * |
|
| 1189 | + * @since 1.0.19 |
|
| 1190 | + * @return bool |
|
| 1191 | + */ |
|
| 1192 | 1192 | public function supports_dynamic_pricing() { |
| 1193 | 1193 | return (bool) apply_filters( 'wpinv_item_supports_dynamic_pricing', true, $this ); |
| 1194 | 1194 | } |
@@ -17,28 +17,28 @@ discard block |
||
| 17 | 17 | */ |
| 18 | 18 | function getpaid_get_subscriptions( $args = array(), $return = 'results' ) { |
| 19 | 19 | |
| 20 | - // Do not retrieve all fields if we just want the count. |
|
| 21 | - if ( 'count' == $return ) { |
|
| 22 | - $args['fields'] = 'id'; |
|
| 23 | - $args['number'] = 1; |
|
| 24 | - } |
|
| 20 | + // Do not retrieve all fields if we just want the count. |
|
| 21 | + if ( 'count' == $return ) { |
|
| 22 | + $args['fields'] = 'id'; |
|
| 23 | + $args['number'] = 1; |
|
| 24 | + } |
|
| 25 | 25 | |
| 26 | - // Do not count all matches if we just want the results. |
|
| 27 | - if ( 'results' == $return ) { |
|
| 28 | - $args['count_total'] = false; |
|
| 29 | - } |
|
| 26 | + // Do not count all matches if we just want the results. |
|
| 27 | + if ( 'results' == $return ) { |
|
| 28 | + $args['count_total'] = false; |
|
| 29 | + } |
|
| 30 | 30 | |
| 31 | - $query = new GetPaid_Subscriptions_Query( $args ); |
|
| 31 | + $query = new GetPaid_Subscriptions_Query( $args ); |
|
| 32 | 32 | |
| 33 | - if ( 'results' == $return ) { |
|
| 34 | - return $query->get_results(); |
|
| 35 | - } |
|
| 33 | + if ( 'results' == $return ) { |
|
| 34 | + return $query->get_results(); |
|
| 35 | + } |
|
| 36 | 36 | |
| 37 | - if ( 'count' == $return ) { |
|
| 38 | - return $query->get_total(); |
|
| 39 | - } |
|
| 37 | + if ( 'count' == $return ) { |
|
| 38 | + return $query->get_total(); |
|
| 39 | + } |
|
| 40 | 40 | |
| 41 | - return $query; |
|
| 41 | + return $query; |
|
| 42 | 42 | } |
| 43 | 43 | |
| 44 | 44 | /** |
@@ -48,18 +48,18 @@ discard block |
||
| 48 | 48 | */ |
| 49 | 49 | function getpaid_get_subscription_statuses() { |
| 50 | 50 | |
| 51 | - return apply_filters( |
|
| 52 | - 'getpaid_get_subscription_statuses', |
|
| 53 | - array( |
|
| 54 | - 'pending' => __( 'Pending', 'invoicing' ), |
|
| 55 | - 'trialling' => __( 'Trialing', 'invoicing' ), |
|
| 56 | - 'active' => __( 'Active', 'invoicing' ), |
|
| 57 | - 'failing' => __( 'Failing', 'invoicing' ), |
|
| 58 | - 'expired' => __( 'Expired', 'invoicing' ), |
|
| 59 | - 'completed' => __( 'Complete', 'invoicing' ), |
|
| 60 | - 'cancelled' => __( 'Cancelled', 'invoicing' ), |
|
| 61 | - ) |
|
| 62 | - ); |
|
| 51 | + return apply_filters( |
|
| 52 | + 'getpaid_get_subscription_statuses', |
|
| 53 | + array( |
|
| 54 | + 'pending' => __( 'Pending', 'invoicing' ), |
|
| 55 | + 'trialling' => __( 'Trialing', 'invoicing' ), |
|
| 56 | + 'active' => __( 'Active', 'invoicing' ), |
|
| 57 | + 'failing' => __( 'Failing', 'invoicing' ), |
|
| 58 | + 'expired' => __( 'Expired', 'invoicing' ), |
|
| 59 | + 'completed' => __( 'Complete', 'invoicing' ), |
|
| 60 | + 'cancelled' => __( 'Cancelled', 'invoicing' ), |
|
| 61 | + ) |
|
| 62 | + ); |
|
| 63 | 63 | |
| 64 | 64 | } |
| 65 | 65 | |
@@ -69,8 +69,8 @@ discard block |
||
| 69 | 69 | * @return string |
| 70 | 70 | */ |
| 71 | 71 | function getpaid_get_subscription_status_label( $status ) { |
| 72 | - $statuses = getpaid_get_subscription_statuses(); |
|
| 73 | - return isset( $statuses[ $status ] ) ? $statuses[ $status ] : ucfirst( sanitize_text_field( $status ) ); |
|
| 72 | + $statuses = getpaid_get_subscription_statuses(); |
|
| 73 | + return isset( $statuses[ $status ] ) ? $statuses[ $status ] : ucfirst( sanitize_text_field( $status ) ); |
|
| 74 | 74 | } |
| 75 | 75 | |
| 76 | 76 | /** |
@@ -80,18 +80,18 @@ discard block |
||
| 80 | 80 | */ |
| 81 | 81 | function getpaid_get_subscription_status_classes() { |
| 82 | 82 | |
| 83 | - return apply_filters( |
|
| 84 | - 'getpaid_get_subscription_status_classes', |
|
| 85 | - array( |
|
| 86 | - 'pending' => 'badge-dark', |
|
| 87 | - 'trialling' => 'badge-info', |
|
| 88 | - 'active' => 'badge-success', |
|
| 89 | - 'failing' => 'badge-warning', |
|
| 90 | - 'expired' => 'badge-danger', |
|
| 91 | - 'completed' => 'badge-primary', |
|
| 92 | - 'cancelled' => 'badge-secondary', |
|
| 93 | - ) |
|
| 94 | - ); |
|
| 83 | + return apply_filters( |
|
| 84 | + 'getpaid_get_subscription_status_classes', |
|
| 85 | + array( |
|
| 86 | + 'pending' => 'badge-dark', |
|
| 87 | + 'trialling' => 'badge-info', |
|
| 88 | + 'active' => 'badge-success', |
|
| 89 | + 'failing' => 'badge-warning', |
|
| 90 | + 'expired' => 'badge-danger', |
|
| 91 | + 'completed' => 'badge-primary', |
|
| 92 | + 'cancelled' => 'badge-secondary', |
|
| 93 | + ) |
|
| 94 | + ); |
|
| 95 | 95 | |
| 96 | 96 | } |
| 97 | 97 | |
@@ -102,15 +102,15 @@ discard block |
||
| 102 | 102 | */ |
| 103 | 103 | function getpaid_get_subscription_status_counts( $args = array() ) { |
| 104 | 104 | |
| 105 | - $statuses = array_keys( getpaid_get_subscription_statuses() ); |
|
| 106 | - $counts = array(); |
|
| 105 | + $statuses = array_keys( getpaid_get_subscription_statuses() ); |
|
| 106 | + $counts = array(); |
|
| 107 | 107 | |
| 108 | - foreach ( $statuses as $status ) { |
|
| 109 | - $_args = wp_parse_args( "status=$status", $args ); |
|
| 110 | - $counts[ $status ] = getpaid_get_subscriptions( $_args, 'count' ); |
|
| 111 | - } |
|
| 108 | + foreach ( $statuses as $status ) { |
|
| 109 | + $_args = wp_parse_args( "status=$status", $args ); |
|
| 110 | + $counts[ $status ] = getpaid_get_subscriptions( $_args, 'count' ); |
|
| 111 | + } |
|
| 112 | 112 | |
| 113 | - return $counts; |
|
| 113 | + return $counts; |
|
| 114 | 114 | |
| 115 | 115 | } |
| 116 | 116 | |
@@ -121,32 +121,32 @@ discard block |
||
| 121 | 121 | */ |
| 122 | 122 | function getpaid_get_subscription_periods() { |
| 123 | 123 | |
| 124 | - return apply_filters( |
|
| 125 | - 'getpaid_get_subscription_periods', |
|
| 126 | - array( |
|
| 124 | + return apply_filters( |
|
| 125 | + 'getpaid_get_subscription_periods', |
|
| 126 | + array( |
|
| 127 | 127 | |
| 128 | - 'day' => array( |
|
| 129 | - 'singular' => __( '%s day', 'invoicing' ), |
|
| 130 | - 'plural' => __( '%d days', 'invoicing' ), |
|
| 131 | - ), |
|
| 128 | + 'day' => array( |
|
| 129 | + 'singular' => __( '%s day', 'invoicing' ), |
|
| 130 | + 'plural' => __( '%d days', 'invoicing' ), |
|
| 131 | + ), |
|
| 132 | 132 | |
| 133 | - 'week' => array( |
|
| 134 | - 'singular' => __( '%s week', 'invoicing' ), |
|
| 135 | - 'plural' => __( '%d weeks', 'invoicing' ), |
|
| 136 | - ), |
|
| 133 | + 'week' => array( |
|
| 134 | + 'singular' => __( '%s week', 'invoicing' ), |
|
| 135 | + 'plural' => __( '%d weeks', 'invoicing' ), |
|
| 136 | + ), |
|
| 137 | 137 | |
| 138 | - 'month' => array( |
|
| 139 | - 'singular' => __( '%s month', 'invoicing' ), |
|
| 140 | - 'plural' => __( '%d months', 'invoicing' ), |
|
| 141 | - ), |
|
| 138 | + 'month' => array( |
|
| 139 | + 'singular' => __( '%s month', 'invoicing' ), |
|
| 140 | + 'plural' => __( '%d months', 'invoicing' ), |
|
| 141 | + ), |
|
| 142 | 142 | |
| 143 | - 'year' => array( |
|
| 144 | - 'singular' => __( '%s year', 'invoicing' ), |
|
| 145 | - 'plural' => __( '%d years', 'invoicing' ), |
|
| 146 | - ), |
|
| 143 | + 'year' => array( |
|
| 144 | + 'singular' => __( '%s year', 'invoicing' ), |
|
| 145 | + 'plural' => __( '%d years', 'invoicing' ), |
|
| 146 | + ), |
|
| 147 | 147 | |
| 148 | - ) |
|
| 149 | - ); |
|
| 148 | + ) |
|
| 149 | + ); |
|
| 150 | 150 | |
| 151 | 151 | } |
| 152 | 152 | |
@@ -157,7 +157,7 @@ discard block |
||
| 157 | 157 | * @return int |
| 158 | 158 | */ |
| 159 | 159 | function getpaid_get_subscription_trial_period_interval( $trial_period ) { |
| 160 | - return (int) preg_replace( '/[^0-9]/', '', $trial_period ); |
|
| 160 | + return (int) preg_replace( '/[^0-9]/', '', $trial_period ); |
|
| 161 | 161 | } |
| 162 | 162 | |
| 163 | 163 | /** |
@@ -167,7 +167,7 @@ discard block |
||
| 167 | 167 | * @return string |
| 168 | 168 | */ |
| 169 | 169 | function getpaid_get_subscription_trial_period_period( $trial_period ) { |
| 170 | - return preg_replace( '/[^a-z]/', '', strtolower( $trial_period ) ); |
|
| 170 | + return preg_replace( '/[^a-z]/', '', strtolower( $trial_period ) ); |
|
| 171 | 171 | } |
| 172 | 172 | |
| 173 | 173 | /** |
@@ -178,8 +178,8 @@ discard block |
||
| 178 | 178 | * @return string |
| 179 | 179 | */ |
| 180 | 180 | function getpaid_get_subscription_period_label( $period, $interval = 1, $singular_prefix = '1' ) { |
| 181 | - $label = (int) $interval > 1 ? getpaid_get_plural_subscription_period_label( $period, $interval ) : getpaid_get_singular_subscription_period_label( $period, $singular_prefix ); |
|
| 182 | - return strtolower( sanitize_text_field( $label ) ); |
|
| 181 | + $label = (int) $interval > 1 ? getpaid_get_plural_subscription_period_label( $period, $interval ) : getpaid_get_singular_subscription_period_label( $period, $singular_prefix ); |
|
| 182 | + return strtolower( sanitize_text_field( $label ) ); |
|
| 183 | 183 | } |
| 184 | 184 | |
| 185 | 185 | /** |
@@ -190,22 +190,22 @@ discard block |
||
| 190 | 190 | */ |
| 191 | 191 | function getpaid_get_singular_subscription_period_label( $period, $singular_prefix = '1' ) { |
| 192 | 192 | |
| 193 | - $periods = getpaid_get_subscription_periods(); |
|
| 194 | - $period = strtolower( $period ); |
|
| 193 | + $periods = getpaid_get_subscription_periods(); |
|
| 194 | + $period = strtolower( $period ); |
|
| 195 | 195 | |
| 196 | - if ( isset( $periods[ $period ] ) ) { |
|
| 197 | - return sprintf( $periods[ $period ]['singular'], $singular_prefix ); |
|
| 198 | - } |
|
| 196 | + if ( isset( $periods[ $period ] ) ) { |
|
| 197 | + return sprintf( $periods[ $period ]['singular'], $singular_prefix ); |
|
| 198 | + } |
|
| 199 | 199 | |
| 200 | - // Backwards compatibility. |
|
| 201 | - foreach ( $periods as $key => $data ) { |
|
| 202 | - if ( strpos( $key, $period ) === 0 ) { |
|
| 203 | - return sprintf( $data['singular'], $singular_prefix ); |
|
| 204 | - } |
|
| 205 | - } |
|
| 200 | + // Backwards compatibility. |
|
| 201 | + foreach ( $periods as $key => $data ) { |
|
| 202 | + if ( strpos( $key, $period ) === 0 ) { |
|
| 203 | + return sprintf( $data['singular'], $singular_prefix ); |
|
| 204 | + } |
|
| 205 | + } |
|
| 206 | 206 | |
| 207 | - // Invalid string. |
|
| 208 | - return ''; |
|
| 207 | + // Invalid string. |
|
| 208 | + return ''; |
|
| 209 | 209 | } |
| 210 | 210 | |
| 211 | 211 | /** |
@@ -217,22 +217,22 @@ discard block |
||
| 217 | 217 | */ |
| 218 | 218 | function getpaid_get_plural_subscription_period_label( $period, $interval ) { |
| 219 | 219 | |
| 220 | - $periods = getpaid_get_subscription_periods(); |
|
| 221 | - $period = strtolower( $period ); |
|
| 220 | + $periods = getpaid_get_subscription_periods(); |
|
| 221 | + $period = strtolower( $period ); |
|
| 222 | 222 | |
| 223 | - if ( isset( $periods[ $period ] ) ) { |
|
| 224 | - return sprintf( $periods[ $period ]['plural'], $interval ); |
|
| 225 | - } |
|
| 223 | + if ( isset( $periods[ $period ] ) ) { |
|
| 224 | + return sprintf( $periods[ $period ]['plural'], $interval ); |
|
| 225 | + } |
|
| 226 | 226 | |
| 227 | - // Backwards compatibility. |
|
| 228 | - foreach ( $periods as $key => $data ) { |
|
| 229 | - if ( strpos( $key, $period ) === 0 ) { |
|
| 230 | - return sprintf( $data['plural'], $interval ); |
|
| 231 | - } |
|
| 232 | - } |
|
| 227 | + // Backwards compatibility. |
|
| 228 | + foreach ( $periods as $key => $data ) { |
|
| 229 | + if ( strpos( $key, $period ) === 0 ) { |
|
| 230 | + return sprintf( $data['plural'], $interval ); |
|
| 231 | + } |
|
| 232 | + } |
|
| 233 | 233 | |
| 234 | - // Invalid string. |
|
| 235 | - return ''; |
|
| 234 | + // Invalid string. |
|
| 235 | + return ''; |
|
| 236 | 236 | } |
| 237 | 237 | |
| 238 | 238 | /** |
@@ -243,50 +243,50 @@ discard block |
||
| 243 | 243 | */ |
| 244 | 244 | function getpaid_get_formatted_subscription_amount( $subscription ) { |
| 245 | 245 | |
| 246 | - $initial = wpinv_price( $subscription->get_initial_amount(), $subscription->get_parent_payment()->get_currency() ); |
|
| 247 | - $recurring = wpinv_price( $subscription->get_recurring_amount(), $subscription->get_parent_payment()->get_currency() ); |
|
| 248 | - $period = getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' ); |
|
| 246 | + $initial = wpinv_price( $subscription->get_initial_amount(), $subscription->get_parent_payment()->get_currency() ); |
|
| 247 | + $recurring = wpinv_price( $subscription->get_recurring_amount(), $subscription->get_parent_payment()->get_currency() ); |
|
| 248 | + $period = getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' ); |
|
| 249 | 249 | |
| 250 | - // Trial periods. |
|
| 251 | - if ( $subscription->has_trial_period() ) { |
|
| 250 | + // Trial periods. |
|
| 251 | + if ( $subscription->has_trial_period() ) { |
|
| 252 | 252 | |
| 253 | - $trial_period = getpaid_get_subscription_trial_period_period( $subscription->get_trial_period() ); |
|
| 254 | - $trial_interval = getpaid_get_subscription_trial_period_interval( $subscription->get_trial_period() ); |
|
| 255 | - return sprintf( |
|
| 253 | + $trial_period = getpaid_get_subscription_trial_period_period( $subscription->get_trial_period() ); |
|
| 254 | + $trial_interval = getpaid_get_subscription_trial_period_interval( $subscription->get_trial_period() ); |
|
| 255 | + return sprintf( |
|
| 256 | 256 | |
| 257 | - // translators: $1: is the initial amount, $2: is the trial period, $3: is the recurring amount, $4: is the recurring period |
|
| 258 | - _x( '%1$s trial for %2$s then %3$s / %4$s', 'Subscription amount. (e.g.: $10 trial for 1 month then $120 / year)', 'invoicing' ), |
|
| 259 | - $initial, |
|
| 260 | - getpaid_get_subscription_period_label( $trial_period, $trial_interval ), |
|
| 261 | - $recurring, |
|
| 262 | - $period |
|
| 257 | + // translators: $1: is the initial amount, $2: is the trial period, $3: is the recurring amount, $4: is the recurring period |
|
| 258 | + _x( '%1$s trial for %2$s then %3$s / %4$s', 'Subscription amount. (e.g.: $10 trial for 1 month then $120 / year)', 'invoicing' ), |
|
| 259 | + $initial, |
|
| 260 | + getpaid_get_subscription_period_label( $trial_period, $trial_interval ), |
|
| 261 | + $recurring, |
|
| 262 | + $period |
|
| 263 | 263 | |
| 264 | - ); |
|
| 264 | + ); |
|
| 265 | 265 | |
| 266 | - } |
|
| 266 | + } |
|
| 267 | 267 | |
| 268 | - if ( $initial != $recurring ) { |
|
| 268 | + if ( $initial != $recurring ) { |
|
| 269 | 269 | |
| 270 | - return sprintf( |
|
| 270 | + return sprintf( |
|
| 271 | 271 | |
| 272 | - // translators: $1: is the initial amount, $2: is the recurring amount, $3: is the recurring period |
|
| 273 | - _x( 'Initial payment of %1$s which renews at %2$s / %3$s', 'Subscription amount. (e.g.:Initial payment of $100 which renews at $120 / year)', 'invoicing' ), |
|
| 274 | - $initial, |
|
| 275 | - $recurring, |
|
| 276 | - $period |
|
| 272 | + // translators: $1: is the initial amount, $2: is the recurring amount, $3: is the recurring period |
|
| 273 | + _x( 'Initial payment of %1$s which renews at %2$s / %3$s', 'Subscription amount. (e.g.:Initial payment of $100 which renews at $120 / year)', 'invoicing' ), |
|
| 274 | + $initial, |
|
| 275 | + $recurring, |
|
| 276 | + $period |
|
| 277 | 277 | |
| 278 | - ); |
|
| 278 | + ); |
|
| 279 | 279 | |
| 280 | - } |
|
| 280 | + } |
|
| 281 | 281 | |
| 282 | - return sprintf( |
|
| 282 | + return sprintf( |
|
| 283 | 283 | |
| 284 | - // translators: $1: is the recurring amount, $2: is the recurring period |
|
| 285 | - _x( '%1$s / %2$s', 'Subscription amount. (e.g.: $120 / year)', 'invoicing' ), |
|
| 286 | - $initial, |
|
| 287 | - $period |
|
| 284 | + // translators: $1: is the recurring amount, $2: is the recurring period |
|
| 285 | + _x( '%1$s / %2$s', 'Subscription amount. (e.g.: $120 / year)', 'invoicing' ), |
|
| 286 | + $initial, |
|
| 287 | + $period |
|
| 288 | 288 | |
| 289 | - ); |
|
| 289 | + ); |
|
| 290 | 290 | |
| 291 | 291 | } |
| 292 | 292 | |
@@ -297,7 +297,7 @@ discard block |
||
| 297 | 297 | * @return WPInv_Subscription|bool |
| 298 | 298 | */ |
| 299 | 299 | function getpaid_get_invoice_subscription( $invoice ) { |
| 300 | - return getpaid_subscriptions()->get_invoice_subscription( $invoice ); |
|
| 300 | + return getpaid_subscriptions()->get_invoice_subscription( $invoice ); |
|
| 301 | 301 | } |
| 302 | 302 | |
| 303 | 303 | /** |
@@ -306,10 +306,10 @@ discard block |
||
| 306 | 306 | * @param WPInv_Invoice $invoice |
| 307 | 307 | */ |
| 308 | 308 | function getpaid_activate_invoice_subscription( $invoice ) { |
| 309 | - $subscription = getpaid_get_invoice_subscription( $invoice ); |
|
| 310 | - if ( is_a( $subscription, 'WPInv_Subscription' ) ) { |
|
| 311 | - $subscription->activate(); |
|
| 312 | - } |
|
| 309 | + $subscription = getpaid_get_invoice_subscription( $invoice ); |
|
| 310 | + if ( is_a( $subscription, 'WPInv_Subscription' ) ) { |
|
| 311 | + $subscription->activate(); |
|
| 312 | + } |
|
| 313 | 313 | } |
| 314 | 314 | |
| 315 | 315 | /** |
@@ -318,7 +318,7 @@ discard block |
||
| 318 | 318 | * @return WPInv_Subscriptions |
| 319 | 319 | */ |
| 320 | 320 | function getpaid_subscriptions() { |
| 321 | - return getpaid()->get( 'subscriptions' ); |
|
| 321 | + return getpaid()->get( 'subscriptions' ); |
|
| 322 | 322 | } |
| 323 | 323 | |
| 324 | 324 | /** |
@@ -336,14 +336,14 @@ discard block |
||
| 336 | 336 | return false; |
| 337 | 337 | } |
| 338 | 338 | |
| 339 | - // Fetch the invoiec subscription. |
|
| 340 | - $subscription = getpaid_get_subscriptions( |
|
| 341 | - array( |
|
| 342 | - 'invoice_in' => $invoice->is_renewal() ? $invoice->get_parent_id() : $invoice->get_id(), |
|
| 343 | - 'number' => 1, |
|
| 344 | - ) |
|
| 345 | - ); |
|
| 339 | + // Fetch the invoiec subscription. |
|
| 340 | + $subscription = getpaid_get_subscriptions( |
|
| 341 | + array( |
|
| 342 | + 'invoice_in' => $invoice->is_renewal() ? $invoice->get_parent_id() : $invoice->get_id(), |
|
| 343 | + 'number' => 1, |
|
| 344 | + ) |
|
| 345 | + ); |
|
| 346 | 346 | |
| 347 | - return empty( $subscription ) ? false : $subscription[0]; |
|
| 347 | + return empty( $subscription ) ? false : $subscription[0]; |
|
| 348 | 348 | |
| 349 | 349 | } |
@@ -1,6 +1,6 @@ discard block |
||
| 1 | 1 | <?php |
| 2 | 2 | if ( ! defined( 'ABSPATH' ) ) { |
| 3 | - exit; |
|
| 3 | + exit; |
|
| 4 | 4 | } |
| 5 | 5 | |
| 6 | 6 | /** |
@@ -10,60 +10,60 @@ discard block |
||
| 10 | 10 | class GetPaid_Form_Item extends WPInv_Item { |
| 11 | 11 | |
| 12 | 12 | /** |
| 13 | - * Stores a custom description for the item. |
|
| 14 | - * |
|
| 15 | - * @var string |
|
| 16 | - */ |
|
| 17 | - protected $custom_description = null; |
|
| 18 | - |
|
| 19 | - /** |
|
| 20 | - * Stores the item quantity. |
|
| 21 | - * |
|
| 22 | - * @var int |
|
| 23 | - */ |
|
| 24 | - protected $quantity = 1; |
|
| 25 | - |
|
| 26 | - /** |
|
| 27 | - * Stores the item meta. |
|
| 28 | - * |
|
| 29 | - * @var array |
|
| 30 | - */ |
|
| 31 | - protected $meta = array(); |
|
| 32 | - |
|
| 33 | - /** |
|
| 34 | - * Is this item required? |
|
| 35 | - * |
|
| 36 | - * @var int |
|
| 37 | - */ |
|
| 38 | - protected $is_required = true; |
|
| 39 | - |
|
| 40 | - /** |
|
| 41 | - * Are quantities allowed? |
|
| 42 | - * |
|
| 43 | - * @var int |
|
| 44 | - */ |
|
| 45 | - protected $allow_quantities = false; |
|
| 46 | - |
|
| 47 | - /** |
|
| 48 | - * Associated invoice. |
|
| 49 | - * |
|
| 50 | - * @var int |
|
| 51 | - */ |
|
| 52 | - public $invoice_id = 0; |
|
| 53 | - |
|
| 54 | - /** |
|
| 55 | - * Item discount. |
|
| 56 | - * |
|
| 57 | - * @var float |
|
| 58 | - */ |
|
| 59 | - public $item_discount = 0; |
|
| 60 | - |
|
| 61 | - /** |
|
| 62 | - * Item tax. |
|
| 63 | - * |
|
| 64 | - * @var float |
|
| 65 | - */ |
|
| 66 | - public $item_tax = 0; |
|
| 13 | + * Stores a custom description for the item. |
|
| 14 | + * |
|
| 15 | + * @var string |
|
| 16 | + */ |
|
| 17 | + protected $custom_description = null; |
|
| 18 | + |
|
| 19 | + /** |
|
| 20 | + * Stores the item quantity. |
|
| 21 | + * |
|
| 22 | + * @var int |
|
| 23 | + */ |
|
| 24 | + protected $quantity = 1; |
|
| 25 | + |
|
| 26 | + /** |
|
| 27 | + * Stores the item meta. |
|
| 28 | + * |
|
| 29 | + * @var array |
|
| 30 | + */ |
|
| 31 | + protected $meta = array(); |
|
| 32 | + |
|
| 33 | + /** |
|
| 34 | + * Is this item required? |
|
| 35 | + * |
|
| 36 | + * @var int |
|
| 37 | + */ |
|
| 38 | + protected $is_required = true; |
|
| 39 | + |
|
| 40 | + /** |
|
| 41 | + * Are quantities allowed? |
|
| 42 | + * |
|
| 43 | + * @var int |
|
| 44 | + */ |
|
| 45 | + protected $allow_quantities = false; |
|
| 46 | + |
|
| 47 | + /** |
|
| 48 | + * Associated invoice. |
|
| 49 | + * |
|
| 50 | + * @var int |
|
| 51 | + */ |
|
| 52 | + public $invoice_id = 0; |
|
| 53 | + |
|
| 54 | + /** |
|
| 55 | + * Item discount. |
|
| 56 | + * |
|
| 57 | + * @var float |
|
| 58 | + */ |
|
| 59 | + public $item_discount = 0; |
|
| 60 | + |
|
| 61 | + /** |
|
| 62 | + * Item tax. |
|
| 63 | + * |
|
| 64 | + * @var float |
|
| 65 | + */ |
|
| 66 | + public $item_tax = 0; |
|
| 67 | 67 | |
| 68 | 68 | /* |
| 69 | 69 | |-------------------------------------------------------------------------- |
@@ -81,232 +81,232 @@ discard block |
||
| 81 | 81 | */ |
| 82 | 82 | |
| 83 | 83 | /** |
| 84 | - * Get the item name. |
|
| 85 | - * |
|
| 86 | - * @since 1.0.19 |
|
| 87 | - * @param string $context View or edit context. |
|
| 88 | - * @return string |
|
| 89 | - */ |
|
| 90 | - public function get_name( $context = 'view' ) { |
|
| 91 | - $name = parent::get_name( $context ); |
|
| 92 | - return $name . wpinv_get_item_suffix( $this ); |
|
| 93 | - } |
|
| 94 | - |
|
| 95 | - /** |
|
| 96 | - * Get the item name without a suffix. |
|
| 97 | - * |
|
| 98 | - * @since 1.0.19 |
|
| 99 | - * @param string $context View or edit context. |
|
| 100 | - * @return string |
|
| 101 | - */ |
|
| 102 | - public function get_raw_name( $context = 'view' ) { |
|
| 103 | - return parent::get_name( $context ); |
|
| 104 | - } |
|
| 105 | - |
|
| 106 | - /** |
|
| 107 | - * Get the item description. |
|
| 108 | - * |
|
| 109 | - * @since 1.0.19 |
|
| 110 | - * @param string $context View or edit context. |
|
| 111 | - * @return string |
|
| 112 | - */ |
|
| 113 | - public function get_description( $context = 'view' ) { |
|
| 114 | - |
|
| 115 | - if ( isset( $this->custom_description ) ) { |
|
| 116 | - return $this->custom_description; |
|
| 117 | - } |
|
| 118 | - |
|
| 119 | - return parent::get_description( $context ); |
|
| 120 | - } |
|
| 121 | - |
|
| 122 | - /** |
|
| 123 | - * Returns the sub total. |
|
| 124 | - * |
|
| 125 | - * @since 1.0.19 |
|
| 126 | - * @param string $context View or edit context. |
|
| 127 | - * @return float |
|
| 128 | - */ |
|
| 129 | - public function get_sub_total( $context = 'view' ) { |
|
| 130 | - return $this->get_quantity( $context ) * $this->get_initial_price( $context ); |
|
| 131 | - } |
|
| 132 | - |
|
| 133 | - /** |
|
| 134 | - * Returns the recurring sub total. |
|
| 135 | - * |
|
| 136 | - * @since 1.0.19 |
|
| 137 | - * @param string $context View or edit context. |
|
| 138 | - * @return float |
|
| 139 | - */ |
|
| 140 | - public function get_recurring_sub_total( $context = 'view' ) { |
|
| 141 | - |
|
| 142 | - if ( $this->is_recurring() ) { |
|
| 143 | - return $this->get_quantity( $context ) * $this->get_price( $context ); |
|
| 144 | - } |
|
| 145 | - |
|
| 146 | - return 0; |
|
| 147 | - } |
|
| 148 | - |
|
| 149 | - /** |
|
| 150 | - * @deprecated |
|
| 151 | - */ |
|
| 152 | - public function get_qantity( $context = 'view' ) { |
|
| 153 | - return $this->get_quantity( $context ); |
|
| 154 | - } |
|
| 155 | - |
|
| 156 | - /** |
|
| 157 | - * Get the item quantity. |
|
| 158 | - * |
|
| 159 | - * @since 1.0.19 |
|
| 160 | - * @param string $context View or edit context. |
|
| 161 | - * @return int |
|
| 162 | - */ |
|
| 163 | - public function get_quantity( $context = 'view' ) { |
|
| 164 | - $quantity = (int) $this->quantity; |
|
| 165 | - |
|
| 166 | - if ( empty( $quantity ) || 1 > $quantity ) { |
|
| 167 | - $quantity = 1; |
|
| 168 | - } |
|
| 169 | - |
|
| 170 | - if ( 'view' == $context ) { |
|
| 171 | - return apply_filters( 'getpaid_payment_form_item_quantity', $quantity, $this ); |
|
| 172 | - } |
|
| 173 | - |
|
| 174 | - return $quantity; |
|
| 175 | - |
|
| 176 | - } |
|
| 177 | - |
|
| 178 | - /** |
|
| 179 | - * Get the item meta data. |
|
| 180 | - * |
|
| 181 | - * @since 1.0.19 |
|
| 182 | - * @param string $context View or edit context. |
|
| 183 | - * @return meta |
|
| 184 | - */ |
|
| 185 | - public function get_item_meta( $context = 'view' ) { |
|
| 186 | - $meta = $this->meta; |
|
| 187 | - |
|
| 188 | - if ( 'view' == $context ) { |
|
| 189 | - return apply_filters( 'getpaid_payment_form_item_meta', $meta, $this ); |
|
| 190 | - } |
|
| 191 | - |
|
| 192 | - return $meta; |
|
| 193 | - |
|
| 194 | - } |
|
| 195 | - |
|
| 196 | - /** |
|
| 197 | - * Returns whether or not customers can update the item quantity. |
|
| 198 | - * |
|
| 199 | - * @since 1.0.19 |
|
| 200 | - * @param string $context View or edit context. |
|
| 201 | - * @return bool |
|
| 202 | - */ |
|
| 203 | - public function get_allow_quantities( $context = 'view' ) { |
|
| 204 | - $allow_quantities = (bool) $this->allow_quantities; |
|
| 205 | - |
|
| 206 | - if ( 'view' == $context ) { |
|
| 207 | - return apply_filters( 'getpaid_payment_form_item_allow_quantities', $allow_quantities, $this ); |
|
| 208 | - } |
|
| 209 | - |
|
| 210 | - return $allow_quantities; |
|
| 211 | - |
|
| 212 | - } |
|
| 213 | - |
|
| 214 | - /** |
|
| 215 | - * Returns whether or not the item is required. |
|
| 216 | - * |
|
| 217 | - * @since 1.0.19 |
|
| 218 | - * @param string $context View or edit context. |
|
| 219 | - * @return bool |
|
| 220 | - */ |
|
| 221 | - public function get_is_required( $context = 'view' ) { |
|
| 222 | - $is_required = (bool) $this->is_required; |
|
| 223 | - |
|
| 224 | - if ( 'view' == $context ) { |
|
| 225 | - return apply_filters( 'getpaid_payment_form_item_is_required', $is_required, $this ); |
|
| 226 | - } |
|
| 227 | - |
|
| 228 | - return $is_required; |
|
| 229 | - |
|
| 230 | - } |
|
| 231 | - |
|
| 232 | - /** |
|
| 233 | - * Prepares form data for use. |
|
| 234 | - * |
|
| 235 | - * @since 1.0.19 |
|
| 236 | - * @return array |
|
| 237 | - */ |
|
| 238 | - public function prepare_data_for_use( $required = null ) { |
|
| 239 | - |
|
| 240 | - $required = is_null( $required ) ? $this->is_required() : $required; |
|
| 241 | - return array( |
|
| 242 | - 'title' => strip_tags( $this->get_name() ), |
|
| 243 | - 'id' => $this->get_id(), |
|
| 244 | - 'price' => $this->get_price(), |
|
| 245 | - 'recurring' => $this->is_recurring(), |
|
| 246 | - 'description' => $this->get_description(), |
|
| 247 | - 'allow_quantities' => $this->allows_quantities(), |
|
| 248 | - 'required' => $required, |
|
| 249 | - ); |
|
| 250 | - |
|
| 251 | - } |
|
| 252 | - |
|
| 253 | - /** |
|
| 254 | - * Prepares form data for ajax use. |
|
| 255 | - * |
|
| 256 | - * @since 1.0.19 |
|
| 257 | - * @return array |
|
| 258 | - */ |
|
| 259 | - public function prepare_data_for_invoice_edit_ajax( $currency = '' ) { |
|
| 260 | - |
|
| 261 | - $description = getpaid_item_recurring_price_help_text( $this, $currency ); |
|
| 262 | - |
|
| 263 | - if ( $description ) { |
|
| 264 | - $description = "<div class='getpaid-subscription-help-text'>$description</div>"; |
|
| 265 | - } |
|
| 266 | - |
|
| 267 | - return array( |
|
| 268 | - 'id' => $this->get_id(), |
|
| 269 | - 'texts' => array( |
|
| 270 | - 'item-name' => sanitize_text_field( $this->get_name() ), |
|
| 271 | - 'item-description' => wp_kses_post( $this->get_description() ) . $description, |
|
| 272 | - 'item-quantity' => absint( $this->get_quantity() ), |
|
| 273 | - 'item-price' => wpinv_price( $this->get_price(), $currency ), |
|
| 274 | - 'item-total' => wpinv_price( $this->get_sub_total(), $currency ), |
|
| 275 | - ), |
|
| 276 | - 'inputs' => array( |
|
| 277 | - 'item-id' => $this->get_id(), |
|
| 278 | - 'item-name' => sanitize_text_field( $this->get_name() ), |
|
| 279 | - 'item-description' => wp_kses_post( $this->get_description() ), |
|
| 280 | - 'item-quantity' => absint( $this->get_quantity() ), |
|
| 281 | - 'item-price' => $this->get_price(), |
|
| 282 | - ) |
|
| 283 | - ); |
|
| 284 | - |
|
| 285 | - } |
|
| 286 | - |
|
| 287 | - /** |
|
| 288 | - * Prepares form data for saving (cart_details). |
|
| 289 | - * |
|
| 290 | - * @since 1.0.19 |
|
| 291 | - * @return array |
|
| 292 | - */ |
|
| 293 | - public function prepare_data_for_saving() { |
|
| 294 | - |
|
| 295 | - return array( |
|
| 296 | - 'post_id' => $this->invoice_id, |
|
| 297 | - 'item_id' => $this->get_id(), |
|
| 298 | - 'item_name' => sanitize_text_field( $this->get_raw_name() ), |
|
| 299 | - 'item_description' => $this->get_description(), |
|
| 300 | - 'tax' => $this->item_tax, |
|
| 301 | - 'item_price' => $this->get_price(), |
|
| 302 | - 'quantity' => (int) $this->get_quantity(), |
|
| 303 | - 'discount' => $this->item_discount, |
|
| 304 | - 'subtotal' => $this->get_sub_total(), |
|
| 305 | - 'price' => $this->get_sub_total() + $this->item_tax + $this->item_discount, |
|
| 306 | - 'meta' => $this->get_item_meta(), |
|
| 307 | - ); |
|
| 308 | - |
|
| 309 | - } |
|
| 84 | + * Get the item name. |
|
| 85 | + * |
|
| 86 | + * @since 1.0.19 |
|
| 87 | + * @param string $context View or edit context. |
|
| 88 | + * @return string |
|
| 89 | + */ |
|
| 90 | + public function get_name( $context = 'view' ) { |
|
| 91 | + $name = parent::get_name( $context ); |
|
| 92 | + return $name . wpinv_get_item_suffix( $this ); |
|
| 93 | + } |
|
| 94 | + |
|
| 95 | + /** |
|
| 96 | + * Get the item name without a suffix. |
|
| 97 | + * |
|
| 98 | + * @since 1.0.19 |
|
| 99 | + * @param string $context View or edit context. |
|
| 100 | + * @return string |
|
| 101 | + */ |
|
| 102 | + public function get_raw_name( $context = 'view' ) { |
|
| 103 | + return parent::get_name( $context ); |
|
| 104 | + } |
|
| 105 | + |
|
| 106 | + /** |
|
| 107 | + * Get the item description. |
|
| 108 | + * |
|
| 109 | + * @since 1.0.19 |
|
| 110 | + * @param string $context View or edit context. |
|
| 111 | + * @return string |
|
| 112 | + */ |
|
| 113 | + public function get_description( $context = 'view' ) { |
|
| 114 | + |
|
| 115 | + if ( isset( $this->custom_description ) ) { |
|
| 116 | + return $this->custom_description; |
|
| 117 | + } |
|
| 118 | + |
|
| 119 | + return parent::get_description( $context ); |
|
| 120 | + } |
|
| 121 | + |
|
| 122 | + /** |
|
| 123 | + * Returns the sub total. |
|
| 124 | + * |
|
| 125 | + * @since 1.0.19 |
|
| 126 | + * @param string $context View or edit context. |
|
| 127 | + * @return float |
|
| 128 | + */ |
|
| 129 | + public function get_sub_total( $context = 'view' ) { |
|
| 130 | + return $this->get_quantity( $context ) * $this->get_initial_price( $context ); |
|
| 131 | + } |
|
| 132 | + |
|
| 133 | + /** |
|
| 134 | + * Returns the recurring sub total. |
|
| 135 | + * |
|
| 136 | + * @since 1.0.19 |
|
| 137 | + * @param string $context View or edit context. |
|
| 138 | + * @return float |
|
| 139 | + */ |
|
| 140 | + public function get_recurring_sub_total( $context = 'view' ) { |
|
| 141 | + |
|
| 142 | + if ( $this->is_recurring() ) { |
|
| 143 | + return $this->get_quantity( $context ) * $this->get_price( $context ); |
|
| 144 | + } |
|
| 145 | + |
|
| 146 | + return 0; |
|
| 147 | + } |
|
| 148 | + |
|
| 149 | + /** |
|
| 150 | + * @deprecated |
|
| 151 | + */ |
|
| 152 | + public function get_qantity( $context = 'view' ) { |
|
| 153 | + return $this->get_quantity( $context ); |
|
| 154 | + } |
|
| 155 | + |
|
| 156 | + /** |
|
| 157 | + * Get the item quantity. |
|
| 158 | + * |
|
| 159 | + * @since 1.0.19 |
|
| 160 | + * @param string $context View or edit context. |
|
| 161 | + * @return int |
|
| 162 | + */ |
|
| 163 | + public function get_quantity( $context = 'view' ) { |
|
| 164 | + $quantity = (int) $this->quantity; |
|
| 165 | + |
|
| 166 | + if ( empty( $quantity ) || 1 > $quantity ) { |
|
| 167 | + $quantity = 1; |
|
| 168 | + } |
|
| 169 | + |
|
| 170 | + if ( 'view' == $context ) { |
|
| 171 | + return apply_filters( 'getpaid_payment_form_item_quantity', $quantity, $this ); |
|
| 172 | + } |
|
| 173 | + |
|
| 174 | + return $quantity; |
|
| 175 | + |
|
| 176 | + } |
|
| 177 | + |
|
| 178 | + /** |
|
| 179 | + * Get the item meta data. |
|
| 180 | + * |
|
| 181 | + * @since 1.0.19 |
|
| 182 | + * @param string $context View or edit context. |
|
| 183 | + * @return meta |
|
| 184 | + */ |
|
| 185 | + public function get_item_meta( $context = 'view' ) { |
|
| 186 | + $meta = $this->meta; |
|
| 187 | + |
|
| 188 | + if ( 'view' == $context ) { |
|
| 189 | + return apply_filters( 'getpaid_payment_form_item_meta', $meta, $this ); |
|
| 190 | + } |
|
| 191 | + |
|
| 192 | + return $meta; |
|
| 193 | + |
|
| 194 | + } |
|
| 195 | + |
|
| 196 | + /** |
|
| 197 | + * Returns whether or not customers can update the item quantity. |
|
| 198 | + * |
|
| 199 | + * @since 1.0.19 |
|
| 200 | + * @param string $context View or edit context. |
|
| 201 | + * @return bool |
|
| 202 | + */ |
|
| 203 | + public function get_allow_quantities( $context = 'view' ) { |
|
| 204 | + $allow_quantities = (bool) $this->allow_quantities; |
|
| 205 | + |
|
| 206 | + if ( 'view' == $context ) { |
|
| 207 | + return apply_filters( 'getpaid_payment_form_item_allow_quantities', $allow_quantities, $this ); |
|
| 208 | + } |
|
| 209 | + |
|
| 210 | + return $allow_quantities; |
|
| 211 | + |
|
| 212 | + } |
|
| 213 | + |
|
| 214 | + /** |
|
| 215 | + * Returns whether or not the item is required. |
|
| 216 | + * |
|
| 217 | + * @since 1.0.19 |
|
| 218 | + * @param string $context View or edit context. |
|
| 219 | + * @return bool |
|
| 220 | + */ |
|
| 221 | + public function get_is_required( $context = 'view' ) { |
|
| 222 | + $is_required = (bool) $this->is_required; |
|
| 223 | + |
|
| 224 | + if ( 'view' == $context ) { |
|
| 225 | + return apply_filters( 'getpaid_payment_form_item_is_required', $is_required, $this ); |
|
| 226 | + } |
|
| 227 | + |
|
| 228 | + return $is_required; |
|
| 229 | + |
|
| 230 | + } |
|
| 231 | + |
|
| 232 | + /** |
|
| 233 | + * Prepares form data for use. |
|
| 234 | + * |
|
| 235 | + * @since 1.0.19 |
|
| 236 | + * @return array |
|
| 237 | + */ |
|
| 238 | + public function prepare_data_for_use( $required = null ) { |
|
| 239 | + |
|
| 240 | + $required = is_null( $required ) ? $this->is_required() : $required; |
|
| 241 | + return array( |
|
| 242 | + 'title' => strip_tags( $this->get_name() ), |
|
| 243 | + 'id' => $this->get_id(), |
|
| 244 | + 'price' => $this->get_price(), |
|
| 245 | + 'recurring' => $this->is_recurring(), |
|
| 246 | + 'description' => $this->get_description(), |
|
| 247 | + 'allow_quantities' => $this->allows_quantities(), |
|
| 248 | + 'required' => $required, |
|
| 249 | + ); |
|
| 250 | + |
|
| 251 | + } |
|
| 252 | + |
|
| 253 | + /** |
|
| 254 | + * Prepares form data for ajax use. |
|
| 255 | + * |
|
| 256 | + * @since 1.0.19 |
|
| 257 | + * @return array |
|
| 258 | + */ |
|
| 259 | + public function prepare_data_for_invoice_edit_ajax( $currency = '' ) { |
|
| 260 | + |
|
| 261 | + $description = getpaid_item_recurring_price_help_text( $this, $currency ); |
|
| 262 | + |
|
| 263 | + if ( $description ) { |
|
| 264 | + $description = "<div class='getpaid-subscription-help-text'>$description</div>"; |
|
| 265 | + } |
|
| 266 | + |
|
| 267 | + return array( |
|
| 268 | + 'id' => $this->get_id(), |
|
| 269 | + 'texts' => array( |
|
| 270 | + 'item-name' => sanitize_text_field( $this->get_name() ), |
|
| 271 | + 'item-description' => wp_kses_post( $this->get_description() ) . $description, |
|
| 272 | + 'item-quantity' => absint( $this->get_quantity() ), |
|
| 273 | + 'item-price' => wpinv_price( $this->get_price(), $currency ), |
|
| 274 | + 'item-total' => wpinv_price( $this->get_sub_total(), $currency ), |
|
| 275 | + ), |
|
| 276 | + 'inputs' => array( |
|
| 277 | + 'item-id' => $this->get_id(), |
|
| 278 | + 'item-name' => sanitize_text_field( $this->get_name() ), |
|
| 279 | + 'item-description' => wp_kses_post( $this->get_description() ), |
|
| 280 | + 'item-quantity' => absint( $this->get_quantity() ), |
|
| 281 | + 'item-price' => $this->get_price(), |
|
| 282 | + ) |
|
| 283 | + ); |
|
| 284 | + |
|
| 285 | + } |
|
| 286 | + |
|
| 287 | + /** |
|
| 288 | + * Prepares form data for saving (cart_details). |
|
| 289 | + * |
|
| 290 | + * @since 1.0.19 |
|
| 291 | + * @return array |
|
| 292 | + */ |
|
| 293 | + public function prepare_data_for_saving() { |
|
| 294 | + |
|
| 295 | + return array( |
|
| 296 | + 'post_id' => $this->invoice_id, |
|
| 297 | + 'item_id' => $this->get_id(), |
|
| 298 | + 'item_name' => sanitize_text_field( $this->get_raw_name() ), |
|
| 299 | + 'item_description' => $this->get_description(), |
|
| 300 | + 'tax' => $this->item_tax, |
|
| 301 | + 'item_price' => $this->get_price(), |
|
| 302 | + 'quantity' => (int) $this->get_quantity(), |
|
| 303 | + 'discount' => $this->item_discount, |
|
| 304 | + 'subtotal' => $this->get_sub_total(), |
|
| 305 | + 'price' => $this->get_sub_total() + $this->item_tax + $this->item_discount, |
|
| 306 | + 'meta' => $this->get_item_meta(), |
|
| 307 | + ); |
|
| 308 | + |
|
| 309 | + } |
|
| 310 | 310 | |
| 311 | 311 | /* |
| 312 | 312 | |-------------------------------------------------------------------------- |
@@ -318,70 +318,70 @@ discard block |
||
| 318 | 318 | | object. |
| 319 | 319 | */ |
| 320 | 320 | |
| 321 | - /** |
|
| 322 | - * Set the item qantity. |
|
| 323 | - * |
|
| 324 | - * @since 1.0.19 |
|
| 325 | - * @param int $quantity The item quantity. |
|
| 326 | - */ |
|
| 327 | - public function set_quantity( $quantity ) { |
|
| 328 | - |
|
| 329 | - if ( empty( $quantity ) || ! is_numeric( $quantity ) ) { |
|
| 330 | - $quantity = 1; |
|
| 331 | - } |
|
| 332 | - |
|
| 333 | - $this->quantity = (int) $quantity; |
|
| 334 | - |
|
| 335 | - } |
|
| 336 | - |
|
| 337 | - /** |
|
| 338 | - * Set the item meta data. |
|
| 339 | - * |
|
| 340 | - * @since 1.0.19 |
|
| 341 | - * @param array $meta The item meta data. |
|
| 342 | - */ |
|
| 343 | - public function set_item_meta( $meta ) { |
|
| 344 | - $this->meta = maybe_unserialize( $meta ); |
|
| 345 | - } |
|
| 346 | - |
|
| 347 | - /** |
|
| 348 | - * Set whether or not the quantities are allowed. |
|
| 349 | - * |
|
| 350 | - * @since 1.0.19 |
|
| 351 | - * @param bool $allow_quantities |
|
| 352 | - */ |
|
| 353 | - public function set_allow_quantities( $allow_quantities ) { |
|
| 354 | - $this->allow_quantities = (bool) $allow_quantities; |
|
| 355 | - } |
|
| 356 | - |
|
| 357 | - /** |
|
| 358 | - * Set whether or not the item is required. |
|
| 359 | - * |
|
| 360 | - * @since 1.0.19 |
|
| 361 | - * @param bool $is_required |
|
| 362 | - */ |
|
| 363 | - public function set_is_required( $is_required ) { |
|
| 364 | - $this->is_required = (bool) $is_required; |
|
| 365 | - } |
|
| 366 | - |
|
| 367 | - /** |
|
| 368 | - * Sets the custom item description. |
|
| 369 | - * |
|
| 370 | - * @since 1.0.19 |
|
| 371 | - * @param string $description |
|
| 372 | - */ |
|
| 373 | - public function set_custom_description( $description ) { |
|
| 374 | - $this->custom_description = $description; |
|
| 375 | - } |
|
| 321 | + /** |
|
| 322 | + * Set the item qantity. |
|
| 323 | + * |
|
| 324 | + * @since 1.0.19 |
|
| 325 | + * @param int $quantity The item quantity. |
|
| 326 | + */ |
|
| 327 | + public function set_quantity( $quantity ) { |
|
| 328 | + |
|
| 329 | + if ( empty( $quantity ) || ! is_numeric( $quantity ) ) { |
|
| 330 | + $quantity = 1; |
|
| 331 | + } |
|
| 332 | + |
|
| 333 | + $this->quantity = (int) $quantity; |
|
| 334 | + |
|
| 335 | + } |
|
| 336 | + |
|
| 337 | + /** |
|
| 338 | + * Set the item meta data. |
|
| 339 | + * |
|
| 340 | + * @since 1.0.19 |
|
| 341 | + * @param array $meta The item meta data. |
|
| 342 | + */ |
|
| 343 | + public function set_item_meta( $meta ) { |
|
| 344 | + $this->meta = maybe_unserialize( $meta ); |
|
| 345 | + } |
|
| 346 | + |
|
| 347 | + /** |
|
| 348 | + * Set whether or not the quantities are allowed. |
|
| 349 | + * |
|
| 350 | + * @since 1.0.19 |
|
| 351 | + * @param bool $allow_quantities |
|
| 352 | + */ |
|
| 353 | + public function set_allow_quantities( $allow_quantities ) { |
|
| 354 | + $this->allow_quantities = (bool) $allow_quantities; |
|
| 355 | + } |
|
| 356 | + |
|
| 357 | + /** |
|
| 358 | + * Set whether or not the item is required. |
|
| 359 | + * |
|
| 360 | + * @since 1.0.19 |
|
| 361 | + * @param bool $is_required |
|
| 362 | + */ |
|
| 363 | + public function set_is_required( $is_required ) { |
|
| 364 | + $this->is_required = (bool) $is_required; |
|
| 365 | + } |
|
| 366 | + |
|
| 367 | + /** |
|
| 368 | + * Sets the custom item description. |
|
| 369 | + * |
|
| 370 | + * @since 1.0.19 |
|
| 371 | + * @param string $description |
|
| 372 | + */ |
|
| 373 | + public function set_custom_description( $description ) { |
|
| 374 | + $this->custom_description = $description; |
|
| 375 | + } |
|
| 376 | 376 | |
| 377 | 377 | /** |
| 378 | 378 | * We do not want to save items to the database. |
| 379 | 379 | * |
| 380 | - * @return int item id |
|
| 380 | + * @return int item id |
|
| 381 | 381 | */ |
| 382 | 382 | public function save( $data = array() ) { |
| 383 | 383 | return $this->get_id(); |
| 384 | - } |
|
| 384 | + } |
|
| 385 | 385 | |
| 386 | 386 | /* |
| 387 | 387 | |-------------------------------------------------------------------------- |
@@ -393,23 +393,23 @@ discard block |
||
| 393 | 393 | */ |
| 394 | 394 | |
| 395 | 395 | /** |
| 396 | - * Checks whether the item has enabled dynamic pricing. |
|
| 397 | - * |
|
| 398 | - * @since 1.0.19 |
|
| 399 | - * @return bool |
|
| 400 | - */ |
|
| 401 | - public function is_required() { |
|
| 396 | + * Checks whether the item has enabled dynamic pricing. |
|
| 397 | + * |
|
| 398 | + * @since 1.0.19 |
|
| 399 | + * @return bool |
|
| 400 | + */ |
|
| 401 | + public function is_required() { |
|
| 402 | 402 | return (bool) $this->get_is_required(); |
| 403 | - } |
|
| 404 | - |
|
| 405 | - /** |
|
| 406 | - * Checks whether users can edit the quantities. |
|
| 407 | - * |
|
| 408 | - * @since 1.0.19 |
|
| 409 | - * @return bool |
|
| 410 | - */ |
|
| 411 | - public function allows_quantities() { |
|
| 403 | + } |
|
| 404 | + |
|
| 405 | + /** |
|
| 406 | + * Checks whether users can edit the quantities. |
|
| 407 | + * |
|
| 408 | + * @since 1.0.19 |
|
| 409 | + * @return bool |
|
| 410 | + */ |
|
| 411 | + public function allows_quantities() { |
|
| 412 | 412 | return (bool) $this->get_allow_quantities(); |
| 413 | - } |
|
| 413 | + } |
|
| 414 | 414 | |
| 415 | 415 | } |