@@ -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 | } |
@@ -15,26 +15,26 @@ discard block |
||
| 15 | 15 | * |
| 16 | 16 | * @return int|array|WPInv_Subscription[]|GetPaid_Subscriptions_Query |
| 17 | 17 | */ |
| 18 | -function getpaid_get_subscriptions( $args = array(), $return = 'results' ) { |
|
| 18 | +function getpaid_get_subscriptions($args = array(), $return = 'results') { |
|
| 19 | 19 | |
| 20 | 20 | // Do not retrieve all fields if we just want the count. |
| 21 | - if ( 'count' == $return ) { |
|
| 21 | + if ('count' == $return) { |
|
| 22 | 22 | $args['fields'] = 'id'; |
| 23 | 23 | $args['number'] = 1; |
| 24 | 24 | } |
| 25 | 25 | |
| 26 | 26 | // Do not count all matches if we just want the results. |
| 27 | - if ( 'results' == $return ) { |
|
| 27 | + if ('results' == $return) { |
|
| 28 | 28 | $args['count_total'] = false; |
| 29 | 29 | } |
| 30 | 30 | |
| 31 | - $query = new GetPaid_Subscriptions_Query( $args ); |
|
| 31 | + $query = new GetPaid_Subscriptions_Query($args); |
|
| 32 | 32 | |
| 33 | - if ( 'results' == $return ) { |
|
| 33 | + if ('results' == $return) { |
|
| 34 | 34 | return $query->get_results(); |
| 35 | 35 | } |
| 36 | 36 | |
| 37 | - if ( 'count' == $return ) { |
|
| 37 | + if ('count' == $return) { |
|
| 38 | 38 | return $query->get_total(); |
| 39 | 39 | } |
| 40 | 40 | |
@@ -51,13 +51,13 @@ discard block |
||
| 51 | 51 | return apply_filters( |
| 52 | 52 | 'getpaid_get_subscription_statuses', |
| 53 | 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' ), |
|
| 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 | 61 | ) |
| 62 | 62 | ); |
| 63 | 63 | |
@@ -68,9 +68,9 @@ discard block |
||
| 68 | 68 | * |
| 69 | 69 | * @return string |
| 70 | 70 | */ |
| 71 | -function getpaid_get_subscription_status_label( $status ) { |
|
| 71 | +function getpaid_get_subscription_status_label($status) { |
|
| 72 | 72 | $statuses = getpaid_get_subscription_statuses(); |
| 73 | - return isset( $statuses[ $status ] ) ? $statuses[ $status ] : ucfirst( sanitize_text_field( $status ) ); |
|
| 73 | + return isset($statuses[$status]) ? $statuses[$status] : ucfirst(sanitize_text_field($status)); |
|
| 74 | 74 | } |
| 75 | 75 | |
| 76 | 76 | /** |
@@ -100,14 +100,14 @@ discard block |
||
| 100 | 100 | * |
| 101 | 101 | * @return array |
| 102 | 102 | */ |
| 103 | -function getpaid_get_subscription_status_counts( $args = array() ) { |
|
| 103 | +function getpaid_get_subscription_status_counts($args = array()) { |
|
| 104 | 104 | |
| 105 | - $statuses = array_keys( getpaid_get_subscription_statuses() ); |
|
| 105 | + $statuses = array_keys(getpaid_get_subscription_statuses()); |
|
| 106 | 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' ); |
|
| 108 | + foreach ($statuses as $status) { |
|
| 109 | + $_args = wp_parse_args("status=$status", $args); |
|
| 110 | + $counts[$status] = getpaid_get_subscriptions($_args, 'count'); |
|
| 111 | 111 | } |
| 112 | 112 | |
| 113 | 113 | return $counts; |
@@ -126,23 +126,23 @@ discard block |
||
| 126 | 126 | array( |
| 127 | 127 | |
| 128 | 128 | 'day' => array( |
| 129 | - 'singular' => __( '%s day', 'invoicing' ), |
|
| 130 | - 'plural' => __( '%d days', 'invoicing' ), |
|
| 129 | + 'singular' => __('%s day', 'invoicing'), |
|
| 130 | + 'plural' => __('%d days', 'invoicing'), |
|
| 131 | 131 | ), |
| 132 | 132 | |
| 133 | 133 | 'week' => array( |
| 134 | - 'singular' => __( '%s week', 'invoicing' ), |
|
| 135 | - 'plural' => __( '%d weeks', 'invoicing' ), |
|
| 134 | + 'singular' => __('%s week', 'invoicing'), |
|
| 135 | + 'plural' => __('%d weeks', 'invoicing'), |
|
| 136 | 136 | ), |
| 137 | 137 | |
| 138 | 138 | 'month' => array( |
| 139 | - 'singular' => __( '%s month', 'invoicing' ), |
|
| 140 | - 'plural' => __( '%d months', 'invoicing' ), |
|
| 139 | + 'singular' => __('%s month', 'invoicing'), |
|
| 140 | + 'plural' => __('%d months', 'invoicing'), |
|
| 141 | 141 | ), |
| 142 | 142 | |
| 143 | 143 | 'year' => array( |
| 144 | - 'singular' => __( '%s year', 'invoicing' ), |
|
| 145 | - 'plural' => __( '%d years', 'invoicing' ), |
|
| 144 | + 'singular' => __('%s year', 'invoicing'), |
|
| 145 | + 'plural' => __('%d years', 'invoicing'), |
|
| 146 | 146 | ), |
| 147 | 147 | |
| 148 | 148 | ) |
@@ -156,8 +156,8 @@ discard block |
||
| 156 | 156 | * @param string $trial_period |
| 157 | 157 | * @return int |
| 158 | 158 | */ |
| 159 | -function getpaid_get_subscription_trial_period_interval( $trial_period ) { |
|
| 160 | - return (int) preg_replace( '/[^0-9]/', '', $trial_period ); |
|
| 159 | +function getpaid_get_subscription_trial_period_interval($trial_period) { |
|
| 160 | + return (int) preg_replace('/[^0-9]/', '', $trial_period); |
|
| 161 | 161 | } |
| 162 | 162 | |
| 163 | 163 | /** |
@@ -166,8 +166,8 @@ discard block |
||
| 166 | 166 | * @param string $trial_period |
| 167 | 167 | * @return string |
| 168 | 168 | */ |
| 169 | -function getpaid_get_subscription_trial_period_period( $trial_period ) { |
|
| 170 | - return preg_replace( '/[^a-z]/', '', strtolower( $trial_period ) ); |
|
| 169 | +function getpaid_get_subscription_trial_period_period($trial_period) { |
|
| 170 | + return preg_replace('/[^a-z]/', '', strtolower($trial_period)); |
|
| 171 | 171 | } |
| 172 | 172 | |
| 173 | 173 | /** |
@@ -177,9 +177,9 @@ discard block |
||
| 177 | 177 | * @param int $interval |
| 178 | 178 | * @return string |
| 179 | 179 | */ |
| 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 ) ); |
|
| 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)); |
|
| 183 | 183 | } |
| 184 | 184 | |
| 185 | 185 | /** |
@@ -188,19 +188,19 @@ discard block |
||
| 188 | 188 | * @param string $period |
| 189 | 189 | * @return string |
| 190 | 190 | */ |
| 191 | -function getpaid_get_singular_subscription_period_label( $period, $singular_prefix = '1' ) { |
|
| 191 | +function getpaid_get_singular_subscription_period_label($period, $singular_prefix = '1') { |
|
| 192 | 192 | |
| 193 | 193 | $periods = getpaid_get_subscription_periods(); |
| 194 | - $period = strtolower( $period ); |
|
| 194 | + $period = strtolower($period); |
|
| 195 | 195 | |
| 196 | - if ( isset( $periods[ $period ] ) ) { |
|
| 197 | - return sprintf( $periods[ $period ]['singular'], $singular_prefix ); |
|
| 196 | + if (isset($periods[$period])) { |
|
| 197 | + return sprintf($periods[$period]['singular'], $singular_prefix); |
|
| 198 | 198 | } |
| 199 | 199 | |
| 200 | 200 | // Backwards compatibility. |
| 201 | - foreach ( $periods as $key => $data ) { |
|
| 202 | - if ( strpos( $key, $period ) === 0 ) { |
|
| 203 | - return sprintf( $data['singular'], $singular_prefix ); |
|
| 201 | + foreach ($periods as $key => $data) { |
|
| 202 | + if (strpos($key, $period) === 0) { |
|
| 203 | + return sprintf($data['singular'], $singular_prefix); |
|
| 204 | 204 | } |
| 205 | 205 | } |
| 206 | 206 | |
@@ -215,19 +215,19 @@ discard block |
||
| 215 | 215 | * @param int $interval |
| 216 | 216 | * @return string |
| 217 | 217 | */ |
| 218 | -function getpaid_get_plural_subscription_period_label( $period, $interval ) { |
|
| 218 | +function getpaid_get_plural_subscription_period_label($period, $interval) { |
|
| 219 | 219 | |
| 220 | 220 | $periods = getpaid_get_subscription_periods(); |
| 221 | - $period = strtolower( $period ); |
|
| 221 | + $period = strtolower($period); |
|
| 222 | 222 | |
| 223 | - if ( isset( $periods[ $period ] ) ) { |
|
| 224 | - return sprintf( $periods[ $period ]['plural'], $interval ); |
|
| 223 | + if (isset($periods[$period])) { |
|
| 224 | + return sprintf($periods[$period]['plural'], $interval); |
|
| 225 | 225 | } |
| 226 | 226 | |
| 227 | 227 | // Backwards compatibility. |
| 228 | - foreach ( $periods as $key => $data ) { |
|
| 229 | - if ( strpos( $key, $period ) === 0 ) { |
|
| 230 | - return sprintf( $data['plural'], $interval ); |
|
| 228 | + foreach ($periods as $key => $data) { |
|
| 229 | + if (strpos($key, $period) === 0) { |
|
| 230 | + return sprintf($data['plural'], $interval); |
|
| 231 | 231 | } |
| 232 | 232 | } |
| 233 | 233 | |
@@ -241,23 +241,23 @@ discard block |
||
| 241 | 241 | * @param WPInv_Subscription $subscription |
| 242 | 242 | * @return string |
| 243 | 243 | */ |
| 244 | -function getpaid_get_formatted_subscription_amount( $subscription ) { |
|
| 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 | 250 | // Trial periods. |
| 251 | - if ( $subscription->has_trial_period() ) { |
|
| 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() ); |
|
| 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 | 255 | return sprintf( |
| 256 | 256 | |
| 257 | 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' ), |
|
| 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 | 259 | $initial, |
| 260 | - getpaid_get_subscription_period_label( $trial_period, $trial_interval ), |
|
| 260 | + getpaid_get_subscription_period_label($trial_period, $trial_interval), |
|
| 261 | 261 | $recurring, |
| 262 | 262 | $period |
| 263 | 263 | |
@@ -265,12 +265,12 @@ discard block |
||
| 265 | 265 | |
| 266 | 266 | } |
| 267 | 267 | |
| 268 | - if ( $initial != $recurring ) { |
|
| 268 | + if ($initial != $recurring) { |
|
| 269 | 269 | |
| 270 | 270 | return sprintf( |
| 271 | 271 | |
| 272 | 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' ), |
|
| 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 | 274 | $initial, |
| 275 | 275 | $recurring, |
| 276 | 276 | $period |
@@ -282,7 +282,7 @@ discard block |
||
| 282 | 282 | return sprintf( |
| 283 | 283 | |
| 284 | 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' ), |
|
| 285 | + _x('%1$s / %2$s', 'Subscription amount. (e.g.: $120 / year)', 'invoicing'), |
|
| 286 | 286 | $initial, |
| 287 | 287 | $period |
| 288 | 288 | |
@@ -296,8 +296,8 @@ discard block |
||
| 296 | 296 | * @param WPInv_Invoice $invoice |
| 297 | 297 | * @return WPInv_Subscription|bool |
| 298 | 298 | */ |
| 299 | -function getpaid_get_invoice_subscription( $invoice ) { |
|
| 300 | - return getpaid_subscriptions()->get_invoice_subscription( $invoice ); |
|
| 299 | +function getpaid_get_invoice_subscription($invoice) { |
|
| 300 | + return getpaid_subscriptions()->get_invoice_subscription($invoice); |
|
| 301 | 301 | } |
| 302 | 302 | |
| 303 | 303 | /** |
@@ -305,9 +305,9 @@ discard block |
||
| 305 | 305 | * |
| 306 | 306 | * @param WPInv_Invoice $invoice |
| 307 | 307 | */ |
| 308 | -function getpaid_activate_invoice_subscription( $invoice ) { |
|
| 309 | - $subscription = getpaid_get_invoice_subscription( $invoice ); |
|
| 310 | - if ( is_a( $subscription, 'WPInv_Subscription' ) ) { |
|
| 308 | +function getpaid_activate_invoice_subscription($invoice) { |
|
| 309 | + $subscription = getpaid_get_invoice_subscription($invoice); |
|
| 310 | + if (is_a($subscription, 'WPInv_Subscription')) { |
|
| 311 | 311 | $subscription->activate(); |
| 312 | 312 | } |
| 313 | 313 | } |
@@ -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 | /** |
@@ -326,13 +326,13 @@ discard block |
||
| 326 | 326 | * |
| 327 | 327 | * @return WPInv_Subscription|bool |
| 328 | 328 | */ |
| 329 | -function wpinv_get_subscription( $invoice ) { |
|
| 329 | +function wpinv_get_subscription($invoice) { |
|
| 330 | 330 | |
| 331 | 331 | // Retrieve the invoice. |
| 332 | - $invoice = new WPInv_Invoice( $invoice ); |
|
| 332 | + $invoice = new WPInv_Invoice($invoice); |
|
| 333 | 333 | |
| 334 | 334 | // Ensure it is a recurring invoice. |
| 335 | - if ( ! $invoice->is_recurring() ) { |
|
| 335 | + if (!$invoice->is_recurring()) { |
|
| 336 | 336 | return false; |
| 337 | 337 | } |
| 338 | 338 | |
@@ -344,6 +344,6 @@ discard block |
||
| 344 | 344 | ) |
| 345 | 345 | ); |
| 346 | 346 | |
| 347 | - return empty( $subscription ) ? false : $subscription[0]; |
|
| 347 | + return empty($subscription) ? false : $subscription[0]; |
|
| 348 | 348 | |
| 349 | 349 | } |
@@ -13,282 +13,282 @@ |
||
| 13 | 13 | class GetPaid_Subscription_Notification_Emails { |
| 14 | 14 | |
| 15 | 15 | /** |
| 16 | - * The array of subscription email actions. |
|
| 17 | - * |
|
| 18 | - * @param array |
|
| 19 | - */ |
|
| 20 | - public $subscription_actions; |
|
| 16 | + * The array of subscription email actions. |
|
| 17 | + * |
|
| 18 | + * @param array |
|
| 19 | + */ |
|
| 20 | + public $subscription_actions; |
|
| 21 | 21 | |
| 22 | 22 | /** |
| 23 | - * Class constructor |
|
| 23 | + * Class constructor |
|
| 24 | 24 | * |
| 25 | - */ |
|
| 26 | - public function __construct() { |
|
| 27 | - |
|
| 28 | - $this->subscription_actions = apply_filters( |
|
| 29 | - 'getpaid_notification_email_subscription_triggers', |
|
| 30 | - array( |
|
| 31 | - 'getpaid_subscription_trialling' => 'subscription_trial', |
|
| 32 | - 'getpaid_subscription_cancelled' => 'subscription_cancelled', |
|
| 33 | - 'getpaid_subscription_expired' => 'subscription_expired', |
|
| 34 | - 'getpaid_subscription_completed' => 'subscription_complete', |
|
| 35 | - 'getpaid_daily_maintenance' => 'renewal_reminder', |
|
| 36 | - ) |
|
| 37 | - ); |
|
| 38 | - |
|
| 39 | - $this->init_hooks(); |
|
| 25 | + */ |
|
| 26 | + public function __construct() { |
|
| 27 | + |
|
| 28 | + $this->subscription_actions = apply_filters( |
|
| 29 | + 'getpaid_notification_email_subscription_triggers', |
|
| 30 | + array( |
|
| 31 | + 'getpaid_subscription_trialling' => 'subscription_trial', |
|
| 32 | + 'getpaid_subscription_cancelled' => 'subscription_cancelled', |
|
| 33 | + 'getpaid_subscription_expired' => 'subscription_expired', |
|
| 34 | + 'getpaid_subscription_completed' => 'subscription_complete', |
|
| 35 | + 'getpaid_daily_maintenance' => 'renewal_reminder', |
|
| 36 | + ) |
|
| 37 | + ); |
|
| 38 | + |
|
| 39 | + $this->init_hooks(); |
|
| 40 | 40 | |
| 41 | 41 | } |
| 42 | 42 | |
| 43 | 43 | /** |
| 44 | - * Registers email hooks. |
|
| 45 | - */ |
|
| 46 | - public function init_hooks() { |
|
| 47 | - |
|
| 48 | - add_filter( 'getpaid_get_email_merge_tags', array( $this, 'subscription_merge_tags' ), 10, 2 ); |
|
| 49 | - foreach ( $this->subscription_actions as $hook => $email_type ) { |
|
| 50 | - |
|
| 51 | - $email = new GetPaid_Notification_Email( $email_type ); |
|
| 52 | - |
|
| 53 | - if ( ! $email->is_active() ) { |
|
| 54 | - continue; |
|
| 55 | - } |
|
| 56 | - |
|
| 57 | - if ( method_exists( $this, $email_type ) ) { |
|
| 58 | - add_action( $hook, array( $this, $email_type ), 100, 2 ); |
|
| 59 | - continue; |
|
| 60 | - } |
|
| 61 | - |
|
| 62 | - do_action( 'getpaid_subscription_notification_email_register_hook', $email_type, $hook ); |
|
| 63 | - |
|
| 64 | - } |
|
| 65 | - |
|
| 66 | - } |
|
| 67 | - |
|
| 68 | - /** |
|
| 69 | - * Filters subscription merge tags. |
|
| 70 | - * |
|
| 71 | - * @param array $merge_tags |
|
| 72 | - * @param mixed|WPInv_Invoice|WPInv_Subscription $object |
|
| 73 | - */ |
|
| 74 | - public function subscription_merge_tags( $merge_tags, $object ) { |
|
| 75 | - |
|
| 76 | - if ( is_a( $object, 'WPInv_Subscription' ) ) { |
|
| 77 | - $merge_tags = array_merge( |
|
| 78 | - $merge_tags, |
|
| 79 | - $this->get_subscription_merge_tags( $object ) |
|
| 80 | - ); |
|
| 81 | - } |
|
| 82 | - |
|
| 83 | - return $merge_tags; |
|
| 84 | - |
|
| 85 | - } |
|
| 86 | - |
|
| 87 | - /** |
|
| 88 | - * Generates subscription merge tags. |
|
| 89 | - * |
|
| 90 | - * @param WPInv_Subscription $subscription |
|
| 91 | - * @return array |
|
| 92 | - */ |
|
| 93 | - public function get_subscription_merge_tags( $subscription ) { |
|
| 94 | - |
|
| 95 | - // Abort if it does not exist. |
|
| 96 | - if ( ! $subscription->get_id() ) { |
|
| 97 | - return array(); |
|
| 98 | - } |
|
| 99 | - |
|
| 100 | - $invoice = $subscription->get_parent_invoice(); |
|
| 101 | - return array( |
|
| 102 | - '{subscription_renewal_date}' => getpaid_format_date_value( $subscription->get_next_renewal_date(), __( 'Never', 'invoicing' ) ), |
|
| 103 | - '{subscription_created}' => getpaid_format_date_value( $subscription->get_date_created() ), |
|
| 104 | - '{subscription_status}' => sanitize_text_field( $subscription->get_status_label() ), |
|
| 105 | - '{subscription_profile_id}' => sanitize_text_field( $subscription->get_profile_id() ), |
|
| 106 | - '{subscription_id}' => absint( $subscription->get_id() ), |
|
| 107 | - '{subscription_recurring_amount}' => sanitize_text_field( wpinv_price( $subscription->get_recurring_amount(), $invoice->get_currency() ) ), |
|
| 108 | - '{subscription_initial_amount}' => sanitize_text_field( wpinv_price( $subscription->get_initial_amount(), $invoice->get_currency() ) ), |
|
| 109 | - '{subscription_recurring_period}' => getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' ), |
|
| 110 | - '{subscription_bill_times}' => $subscription->get_bill_times(), |
|
| 111 | - '{subscription_url}' => esc_url( $subscription->get_view_url() ), |
|
| 112 | - ); |
|
| 113 | - |
|
| 114 | - } |
|
| 115 | - |
|
| 116 | - /** |
|
| 117 | - * Checks if we should send a notification for a subscription. |
|
| 118 | - * |
|
| 119 | - * @param WPInv_Invoice $invoice |
|
| 120 | - * @return bool |
|
| 121 | - */ |
|
| 122 | - public function should_send_notification( $invoice ) { |
|
| 123 | - return 0 != $invoice->get_id(); |
|
| 124 | - } |
|
| 125 | - |
|
| 126 | - /** |
|
| 127 | - * Returns notification recipients. |
|
| 128 | - * |
|
| 129 | - * @param WPInv_Invoice $invoice |
|
| 130 | - * @return array |
|
| 131 | - */ |
|
| 132 | - public function get_recipients( $invoice ) { |
|
| 133 | - $recipients = array( $invoice->get_email() ); |
|
| 134 | - |
|
| 135 | - $cc = $invoice->get_email_cc(); |
|
| 136 | - |
|
| 137 | - if ( ! empty( $cc ) ) { |
|
| 138 | - $cc = array_map( 'sanitize_email', wpinv_parse_list( $cc ) ); |
|
| 139 | - $recipients = array_filter( array_unique( array_merge( $recipients, $cc ) ) ); |
|
| 140 | - } |
|
| 141 | - |
|
| 142 | - return $recipients; |
|
| 143 | - } |
|
| 144 | - |
|
| 145 | - /** |
|
| 146 | - * Helper function to send an email. |
|
| 147 | - * |
|
| 148 | - * @param WPInv_Subscription $subscription |
|
| 149 | - * @param GetPaid_Notification_Email $email |
|
| 150 | - * @param string $type |
|
| 151 | - * @param array $extra_args Extra template args. |
|
| 152 | - */ |
|
| 153 | - public function send_email( $subscription, $email, $type, $extra_args = array() ) { |
|
| 154 | - |
|
| 155 | - // Abort in case the parent invoice does not exist. |
|
| 156 | - $invoice = $subscription->get_parent_invoice(); |
|
| 157 | - if ( ! $this->should_send_notification( $invoice ) ) { |
|
| 158 | - return; |
|
| 159 | - } |
|
| 160 | - |
|
| 161 | - do_action( 'getpaid_before_send_subscription_notification', $type, $subscription, $email ); |
|
| 162 | - |
|
| 163 | - $recipients = $this->get_recipients( $invoice ); |
|
| 164 | - $mailer = new GetPaid_Notification_Email_Sender(); |
|
| 165 | - $merge_tags = $email->get_merge_tags(); |
|
| 166 | - $content = $email->get_content( $merge_tags, $extra_args ); |
|
| 167 | - $subject = $email->add_merge_tags( $email->get_subject(), $merge_tags ); |
|
| 168 | - $attachments = $email->get_attachments(); |
|
| 169 | - |
|
| 170 | - $result = $mailer->send( |
|
| 171 | - apply_filters( 'getpaid_subscription_email_recipients', wpinv_parse_list( $recipients ), $email ), |
|
| 172 | - $subject, |
|
| 173 | - $content, |
|
| 174 | - $attachments |
|
| 175 | - ); |
|
| 176 | - |
|
| 177 | - // Maybe send a copy to the admin. |
|
| 178 | - if ( $email->include_admin_bcc() ) { |
|
| 179 | - $mailer->send( |
|
| 180 | - wpinv_get_admin_email(), |
|
| 181 | - $subject . __( ' - ADMIN BCC COPY', 'invoicing' ), |
|
| 182 | - $content, |
|
| 183 | - $attachments |
|
| 184 | - ); |
|
| 185 | - } |
|
| 186 | - |
|
| 187 | - if ( ! $result ) { |
|
| 188 | - $subscription->get_parent_invoice()->add_note( sprintf( __( 'Failed sending %s notification email.', 'invoicing' ), sanitize_key( $type ) ), false, false, true ); |
|
| 189 | - } |
|
| 190 | - |
|
| 191 | - do_action( 'getpaid_after_send_subscription_notification', $type, $subscription, $email ); |
|
| 192 | - |
|
| 193 | - } |
|
| 44 | + * Registers email hooks. |
|
| 45 | + */ |
|
| 46 | + public function init_hooks() { |
|
| 47 | + |
|
| 48 | + add_filter( 'getpaid_get_email_merge_tags', array( $this, 'subscription_merge_tags' ), 10, 2 ); |
|
| 49 | + foreach ( $this->subscription_actions as $hook => $email_type ) { |
|
| 50 | + |
|
| 51 | + $email = new GetPaid_Notification_Email( $email_type ); |
|
| 52 | + |
|
| 53 | + if ( ! $email->is_active() ) { |
|
| 54 | + continue; |
|
| 55 | + } |
|
| 56 | + |
|
| 57 | + if ( method_exists( $this, $email_type ) ) { |
|
| 58 | + add_action( $hook, array( $this, $email_type ), 100, 2 ); |
|
| 59 | + continue; |
|
| 60 | + } |
|
| 61 | + |
|
| 62 | + do_action( 'getpaid_subscription_notification_email_register_hook', $email_type, $hook ); |
|
| 63 | + |
|
| 64 | + } |
|
| 65 | + |
|
| 66 | + } |
|
| 194 | 67 | |
| 195 | 68 | /** |
| 196 | - * Sends a new trial notification. |
|
| 197 | - * |
|
| 198 | - * @param WPInv_Subscription $subscription |
|
| 199 | - */ |
|
| 200 | - public function subscription_trial( $subscription ) { |
|
| 69 | + * Filters subscription merge tags. |
|
| 70 | + * |
|
| 71 | + * @param array $merge_tags |
|
| 72 | + * @param mixed|WPInv_Invoice|WPInv_Subscription $object |
|
| 73 | + */ |
|
| 74 | + public function subscription_merge_tags( $merge_tags, $object ) { |
|
| 201 | 75 | |
| 202 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $subscription ); |
|
| 203 | - $this->send_email( $subscription, $email, __FUNCTION__ ); |
|
| 76 | + if ( is_a( $object, 'WPInv_Subscription' ) ) { |
|
| 77 | + $merge_tags = array_merge( |
|
| 78 | + $merge_tags, |
|
| 79 | + $this->get_subscription_merge_tags( $object ) |
|
| 80 | + ); |
|
| 81 | + } |
|
| 204 | 82 | |
| 205 | - } |
|
| 83 | + return $merge_tags; |
|
| 206 | 84 | |
| 207 | - /** |
|
| 208 | - * Sends a cancelled subscription notification. |
|
| 209 | - * |
|
| 210 | - * @param WPInv_Subscription $subscription |
|
| 211 | - */ |
|
| 212 | - public function subscription_cancelled( $subscription ) { |
|
| 85 | + } |
|
| 213 | 86 | |
| 214 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $subscription ); |
|
| 215 | - $this->send_email( $subscription, $email, __FUNCTION__ ); |
|
| 87 | + /** |
|
| 88 | + * Generates subscription merge tags. |
|
| 89 | + * |
|
| 90 | + * @param WPInv_Subscription $subscription |
|
| 91 | + * @return array |
|
| 92 | + */ |
|
| 93 | + public function get_subscription_merge_tags( $subscription ) { |
|
| 94 | + |
|
| 95 | + // Abort if it does not exist. |
|
| 96 | + if ( ! $subscription->get_id() ) { |
|
| 97 | + return array(); |
|
| 98 | + } |
|
| 99 | + |
|
| 100 | + $invoice = $subscription->get_parent_invoice(); |
|
| 101 | + return array( |
|
| 102 | + '{subscription_renewal_date}' => getpaid_format_date_value( $subscription->get_next_renewal_date(), __( 'Never', 'invoicing' ) ), |
|
| 103 | + '{subscription_created}' => getpaid_format_date_value( $subscription->get_date_created() ), |
|
| 104 | + '{subscription_status}' => sanitize_text_field( $subscription->get_status_label() ), |
|
| 105 | + '{subscription_profile_id}' => sanitize_text_field( $subscription->get_profile_id() ), |
|
| 106 | + '{subscription_id}' => absint( $subscription->get_id() ), |
|
| 107 | + '{subscription_recurring_amount}' => sanitize_text_field( wpinv_price( $subscription->get_recurring_amount(), $invoice->get_currency() ) ), |
|
| 108 | + '{subscription_initial_amount}' => sanitize_text_field( wpinv_price( $subscription->get_initial_amount(), $invoice->get_currency() ) ), |
|
| 109 | + '{subscription_recurring_period}' => getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' ), |
|
| 110 | + '{subscription_bill_times}' => $subscription->get_bill_times(), |
|
| 111 | + '{subscription_url}' => esc_url( $subscription->get_view_url() ), |
|
| 112 | + ); |
|
| 216 | 113 | |
| 217 | - } |
|
| 114 | + } |
|
| 218 | 115 | |
| 219 | - /** |
|
| 220 | - * Sends a subscription expired notification. |
|
| 221 | - * |
|
| 222 | - * @param WPInv_Subscription $subscription |
|
| 223 | - */ |
|
| 224 | - public function subscription_expired( $subscription ) { |
|
| 116 | + /** |
|
| 117 | + * Checks if we should send a notification for a subscription. |
|
| 118 | + * |
|
| 119 | + * @param WPInv_Invoice $invoice |
|
| 120 | + * @return bool |
|
| 121 | + */ |
|
| 122 | + public function should_send_notification( $invoice ) { |
|
| 123 | + return 0 != $invoice->get_id(); |
|
| 124 | + } |
|
| 225 | 125 | |
| 226 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $subscription ); |
|
| 227 | - $this->send_email( $subscription, $email, __FUNCTION__ ); |
|
| 126 | + /** |
|
| 127 | + * Returns notification recipients. |
|
| 128 | + * |
|
| 129 | + * @param WPInv_Invoice $invoice |
|
| 130 | + * @return array |
|
| 131 | + */ |
|
| 132 | + public function get_recipients( $invoice ) { |
|
| 133 | + $recipients = array( $invoice->get_email() ); |
|
| 228 | 134 | |
| 229 | - } |
|
| 135 | + $cc = $invoice->get_email_cc(); |
|
| 230 | 136 | |
| 231 | - /** |
|
| 232 | - * Sends a completed subscription notification. |
|
| 233 | - * |
|
| 234 | - * @param WPInv_Subscription $subscription |
|
| 235 | - */ |
|
| 236 | - public function subscription_complete( $subscription ) { |
|
| 137 | + if ( ! empty( $cc ) ) { |
|
| 138 | + $cc = array_map( 'sanitize_email', wpinv_parse_list( $cc ) ); |
|
| 139 | + $recipients = array_filter( array_unique( array_merge( $recipients, $cc ) ) ); |
|
| 140 | + } |
|
| 237 | 141 | |
| 238 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $subscription ); |
|
| 239 | - $this->send_email( $subscription, $email, __FUNCTION__ ); |
|
| 142 | + return $recipients; |
|
| 143 | + } |
|
| 240 | 144 | |
| 241 | - } |
|
| 145 | + /** |
|
| 146 | + * Helper function to send an email. |
|
| 147 | + * |
|
| 148 | + * @param WPInv_Subscription $subscription |
|
| 149 | + * @param GetPaid_Notification_Email $email |
|
| 150 | + * @param string $type |
|
| 151 | + * @param array $extra_args Extra template args. |
|
| 152 | + */ |
|
| 153 | + public function send_email( $subscription, $email, $type, $extra_args = array() ) { |
|
| 154 | + |
|
| 155 | + // Abort in case the parent invoice does not exist. |
|
| 156 | + $invoice = $subscription->get_parent_invoice(); |
|
| 157 | + if ( ! $this->should_send_notification( $invoice ) ) { |
|
| 158 | + return; |
|
| 159 | + } |
|
| 160 | + |
|
| 161 | + do_action( 'getpaid_before_send_subscription_notification', $type, $subscription, $email ); |
|
| 162 | + |
|
| 163 | + $recipients = $this->get_recipients( $invoice ); |
|
| 164 | + $mailer = new GetPaid_Notification_Email_Sender(); |
|
| 165 | + $merge_tags = $email->get_merge_tags(); |
|
| 166 | + $content = $email->get_content( $merge_tags, $extra_args ); |
|
| 167 | + $subject = $email->add_merge_tags( $email->get_subject(), $merge_tags ); |
|
| 168 | + $attachments = $email->get_attachments(); |
|
| 169 | + |
|
| 170 | + $result = $mailer->send( |
|
| 171 | + apply_filters( 'getpaid_subscription_email_recipients', wpinv_parse_list( $recipients ), $email ), |
|
| 172 | + $subject, |
|
| 173 | + $content, |
|
| 174 | + $attachments |
|
| 175 | + ); |
|
| 176 | + |
|
| 177 | + // Maybe send a copy to the admin. |
|
| 178 | + if ( $email->include_admin_bcc() ) { |
|
| 179 | + $mailer->send( |
|
| 180 | + wpinv_get_admin_email(), |
|
| 181 | + $subject . __( ' - ADMIN BCC COPY', 'invoicing' ), |
|
| 182 | + $content, |
|
| 183 | + $attachments |
|
| 184 | + ); |
|
| 185 | + } |
|
| 186 | + |
|
| 187 | + if ( ! $result ) { |
|
| 188 | + $subscription->get_parent_invoice()->add_note( sprintf( __( 'Failed sending %s notification email.', 'invoicing' ), sanitize_key( $type ) ), false, false, true ); |
|
| 189 | + } |
|
| 190 | + |
|
| 191 | + do_action( 'getpaid_after_send_subscription_notification', $type, $subscription, $email ); |
|
| 242 | 192 | |
| 243 | - /** |
|
| 244 | - * Sends a subscription renewal reminder notification. |
|
| 245 | - * |
|
| 246 | - */ |
|
| 247 | - public function renewal_reminder() { |
|
| 193 | + } |
|
| 248 | 194 | |
| 249 | - $email = new GetPaid_Notification_Email( __FUNCTION__ ); |
|
| 195 | + /** |
|
| 196 | + * Sends a new trial notification. |
|
| 197 | + * |
|
| 198 | + * @param WPInv_Subscription $subscription |
|
| 199 | + */ |
|
| 200 | + public function subscription_trial( $subscription ) { |
|
| 250 | 201 | |
| 251 | - // Fetch reminder days. |
|
| 252 | - $reminder_days = array_unique( wp_parse_id_list( $email->get_option( 'days' ) ) ); |
|
| 202 | + $email = new GetPaid_Notification_Email( __FUNCTION__, $subscription ); |
|
| 203 | + $this->send_email( $subscription, $email, __FUNCTION__ ); |
|
| 253 | 204 | |
| 254 | - // Abort if non is set. |
|
| 255 | - if ( empty( $reminder_days ) ) { |
|
| 256 | - return; |
|
| 257 | - } |
|
| 205 | + } |
|
| 258 | 206 | |
| 259 | - // Fetch matching subscriptions. |
|
| 207 | + /** |
|
| 208 | + * Sends a cancelled subscription notification. |
|
| 209 | + * |
|
| 210 | + * @param WPInv_Subscription $subscription |
|
| 211 | + */ |
|
| 212 | + public function subscription_cancelled( $subscription ) { |
|
| 213 | + |
|
| 214 | + $email = new GetPaid_Notification_Email( __FUNCTION__, $subscription ); |
|
| 215 | + $this->send_email( $subscription, $email, __FUNCTION__ ); |
|
| 216 | + |
|
| 217 | + } |
|
| 218 | + |
|
| 219 | + /** |
|
| 220 | + * Sends a subscription expired notification. |
|
| 221 | + * |
|
| 222 | + * @param WPInv_Subscription $subscription |
|
| 223 | + */ |
|
| 224 | + public function subscription_expired( $subscription ) { |
|
| 225 | + |
|
| 226 | + $email = new GetPaid_Notification_Email( __FUNCTION__, $subscription ); |
|
| 227 | + $this->send_email( $subscription, $email, __FUNCTION__ ); |
|
| 228 | + |
|
| 229 | + } |
|
| 230 | + |
|
| 231 | + /** |
|
| 232 | + * Sends a completed subscription notification. |
|
| 233 | + * |
|
| 234 | + * @param WPInv_Subscription $subscription |
|
| 235 | + */ |
|
| 236 | + public function subscription_complete( $subscription ) { |
|
| 237 | + |
|
| 238 | + $email = new GetPaid_Notification_Email( __FUNCTION__, $subscription ); |
|
| 239 | + $this->send_email( $subscription, $email, __FUNCTION__ ); |
|
| 240 | + |
|
| 241 | + } |
|
| 242 | + |
|
| 243 | + /** |
|
| 244 | + * Sends a subscription renewal reminder notification. |
|
| 245 | + * |
|
| 246 | + */ |
|
| 247 | + public function renewal_reminder() { |
|
| 248 | + |
|
| 249 | + $email = new GetPaid_Notification_Email( __FUNCTION__ ); |
|
| 250 | + |
|
| 251 | + // Fetch reminder days. |
|
| 252 | + $reminder_days = array_unique( wp_parse_id_list( $email->get_option( 'days' ) ) ); |
|
| 253 | + |
|
| 254 | + // Abort if non is set. |
|
| 255 | + if ( empty( $reminder_days ) ) { |
|
| 256 | + return; |
|
| 257 | + } |
|
| 258 | + |
|
| 259 | + // Fetch matching subscriptions. |
|
| 260 | 260 | $args = array( |
| 261 | 261 | 'number' => -1, |
| 262 | - 'count_total' => false, |
|
| 263 | - 'status' => 'trialling active', |
|
| 262 | + 'count_total' => false, |
|
| 263 | + 'status' => 'trialling active', |
|
| 264 | 264 | 'date_expires_query' => array( |
| 265 | - 'relation' => 'OR' |
|
| 265 | + 'relation' => 'OR' |
|
| 266 | 266 | ), |
| 267 | - ); |
|
| 267 | + ); |
|
| 268 | 268 | |
| 269 | - foreach ( $reminder_days as $days ) { |
|
| 270 | - $date = date_parse( date( 'Y-m-d', strtotime( "+$days days", current_time( 'timestamp' ) ) ) ); |
|
| 269 | + foreach ( $reminder_days as $days ) { |
|
| 270 | + $date = date_parse( date( 'Y-m-d', strtotime( "+$days days", current_time( 'timestamp' ) ) ) ); |
|
| 271 | 271 | |
| 272 | - $args['date_expires_query'][] = array( |
|
| 273 | - 'year' => $date['year'], |
|
| 274 | - 'month' => $date['month'], |
|
| 275 | - 'day' => $date['day'], |
|
| 276 | - ); |
|
| 272 | + $args['date_expires_query'][] = array( |
|
| 273 | + 'year' => $date['year'], |
|
| 274 | + 'month' => $date['month'], |
|
| 275 | + 'day' => $date['day'], |
|
| 276 | + ); |
|
| 277 | 277 | |
| 278 | - } |
|
| 278 | + } |
|
| 279 | 279 | |
| 280 | - $subscriptions = new GetPaid_Subscriptions_Query( $args ); |
|
| 280 | + $subscriptions = new GetPaid_Subscriptions_Query( $args ); |
|
| 281 | 281 | |
| 282 | 282 | foreach ( $subscriptions as $subscription ) { |
| 283 | 283 | |
| 284 | - // Skip packages. |
|
| 285 | - if ( get_post_meta( $subscription->get_product_id(), '_wpinv_type', true ) != 'package' ) { |
|
| 286 | - $email->object = $subscription; |
|
| 287 | - $this->send_email( $subscription, $email, __FUNCTION__ ); |
|
| 288 | - } |
|
| 284 | + // Skip packages. |
|
| 285 | + if ( get_post_meta( $subscription->get_product_id(), '_wpinv_type', true ) != 'package' ) { |
|
| 286 | + $email->object = $subscription; |
|
| 287 | + $this->send_email( $subscription, $email, __FUNCTION__ ); |
|
| 288 | + } |
|
| 289 | 289 | |
| 290 | - } |
|
| 290 | + } |
|
| 291 | 291 | |
| 292 | - } |
|
| 292 | + } |
|
| 293 | 293 | |
| 294 | 294 | } |
@@ -4,7 +4,7 @@ discard block |
||
| 4 | 4 | * |
| 5 | 5 | */ |
| 6 | 6 | |
| 7 | -defined( 'ABSPATH' ) || exit; |
|
| 7 | +defined('ABSPATH') || exit; |
|
| 8 | 8 | |
| 9 | 9 | /** |
| 10 | 10 | * This class handles subscription notificaiton emails. |
@@ -45,21 +45,21 @@ discard block |
||
| 45 | 45 | */ |
| 46 | 46 | public function init_hooks() { |
| 47 | 47 | |
| 48 | - add_filter( 'getpaid_get_email_merge_tags', array( $this, 'subscription_merge_tags' ), 10, 2 ); |
|
| 49 | - foreach ( $this->subscription_actions as $hook => $email_type ) { |
|
| 48 | + add_filter('getpaid_get_email_merge_tags', array($this, 'subscription_merge_tags'), 10, 2); |
|
| 49 | + foreach ($this->subscription_actions as $hook => $email_type) { |
|
| 50 | 50 | |
| 51 | - $email = new GetPaid_Notification_Email( $email_type ); |
|
| 51 | + $email = new GetPaid_Notification_Email($email_type); |
|
| 52 | 52 | |
| 53 | - if ( ! $email->is_active() ) { |
|
| 53 | + if (!$email->is_active()) { |
|
| 54 | 54 | continue; |
| 55 | 55 | } |
| 56 | 56 | |
| 57 | - if ( method_exists( $this, $email_type ) ) { |
|
| 58 | - add_action( $hook, array( $this, $email_type ), 100, 2 ); |
|
| 57 | + if (method_exists($this, $email_type)) { |
|
| 58 | + add_action($hook, array($this, $email_type), 100, 2); |
|
| 59 | 59 | continue; |
| 60 | 60 | } |
| 61 | 61 | |
| 62 | - do_action( 'getpaid_subscription_notification_email_register_hook', $email_type, $hook ); |
|
| 62 | + do_action('getpaid_subscription_notification_email_register_hook', $email_type, $hook); |
|
| 63 | 63 | |
| 64 | 64 | } |
| 65 | 65 | |
@@ -71,12 +71,12 @@ discard block |
||
| 71 | 71 | * @param array $merge_tags |
| 72 | 72 | * @param mixed|WPInv_Invoice|WPInv_Subscription $object |
| 73 | 73 | */ |
| 74 | - public function subscription_merge_tags( $merge_tags, $object ) { |
|
| 74 | + public function subscription_merge_tags($merge_tags, $object) { |
|
| 75 | 75 | |
| 76 | - if ( is_a( $object, 'WPInv_Subscription' ) ) { |
|
| 76 | + if (is_a($object, 'WPInv_Subscription')) { |
|
| 77 | 77 | $merge_tags = array_merge( |
| 78 | 78 | $merge_tags, |
| 79 | - $this->get_subscription_merge_tags( $object ) |
|
| 79 | + $this->get_subscription_merge_tags($object) |
|
| 80 | 80 | ); |
| 81 | 81 | } |
| 82 | 82 | |
@@ -90,25 +90,25 @@ discard block |
||
| 90 | 90 | * @param WPInv_Subscription $subscription |
| 91 | 91 | * @return array |
| 92 | 92 | */ |
| 93 | - public function get_subscription_merge_tags( $subscription ) { |
|
| 93 | + public function get_subscription_merge_tags($subscription) { |
|
| 94 | 94 | |
| 95 | 95 | // Abort if it does not exist. |
| 96 | - if ( ! $subscription->get_id() ) { |
|
| 96 | + if (!$subscription->get_id()) { |
|
| 97 | 97 | return array(); |
| 98 | 98 | } |
| 99 | 99 | |
| 100 | - $invoice = $subscription->get_parent_invoice(); |
|
| 100 | + $invoice = $subscription->get_parent_invoice(); |
|
| 101 | 101 | return array( |
| 102 | - '{subscription_renewal_date}' => getpaid_format_date_value( $subscription->get_next_renewal_date(), __( 'Never', 'invoicing' ) ), |
|
| 103 | - '{subscription_created}' => getpaid_format_date_value( $subscription->get_date_created() ), |
|
| 104 | - '{subscription_status}' => sanitize_text_field( $subscription->get_status_label() ), |
|
| 105 | - '{subscription_profile_id}' => sanitize_text_field( $subscription->get_profile_id() ), |
|
| 106 | - '{subscription_id}' => absint( $subscription->get_id() ), |
|
| 107 | - '{subscription_recurring_amount}' => sanitize_text_field( wpinv_price( $subscription->get_recurring_amount(), $invoice->get_currency() ) ), |
|
| 108 | - '{subscription_initial_amount}' => sanitize_text_field( wpinv_price( $subscription->get_initial_amount(), $invoice->get_currency() ) ), |
|
| 109 | - '{subscription_recurring_period}' => getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' ), |
|
| 102 | + '{subscription_renewal_date}' => getpaid_format_date_value($subscription->get_next_renewal_date(), __('Never', 'invoicing')), |
|
| 103 | + '{subscription_created}' => getpaid_format_date_value($subscription->get_date_created()), |
|
| 104 | + '{subscription_status}' => sanitize_text_field($subscription->get_status_label()), |
|
| 105 | + '{subscription_profile_id}' => sanitize_text_field($subscription->get_profile_id()), |
|
| 106 | + '{subscription_id}' => absint($subscription->get_id()), |
|
| 107 | + '{subscription_recurring_amount}' => sanitize_text_field(wpinv_price($subscription->get_recurring_amount(), $invoice->get_currency())), |
|
| 108 | + '{subscription_initial_amount}' => sanitize_text_field(wpinv_price($subscription->get_initial_amount(), $invoice->get_currency())), |
|
| 109 | + '{subscription_recurring_period}' => getpaid_get_subscription_period_label($subscription->get_period(), $subscription->get_frequency(), ''), |
|
| 110 | 110 | '{subscription_bill_times}' => $subscription->get_bill_times(), |
| 111 | - '{subscription_url}' => esc_url( $subscription->get_view_url() ), |
|
| 111 | + '{subscription_url}' => esc_url($subscription->get_view_url()), |
|
| 112 | 112 | ); |
| 113 | 113 | |
| 114 | 114 | } |
@@ -119,7 +119,7 @@ discard block |
||
| 119 | 119 | * @param WPInv_Invoice $invoice |
| 120 | 120 | * @return bool |
| 121 | 121 | */ |
| 122 | - public function should_send_notification( $invoice ) { |
|
| 122 | + public function should_send_notification($invoice) { |
|
| 123 | 123 | return 0 != $invoice->get_id(); |
| 124 | 124 | } |
| 125 | 125 | |
@@ -129,14 +129,14 @@ discard block |
||
| 129 | 129 | * @param WPInv_Invoice $invoice |
| 130 | 130 | * @return array |
| 131 | 131 | */ |
| 132 | - public function get_recipients( $invoice ) { |
|
| 133 | - $recipients = array( $invoice->get_email() ); |
|
| 132 | + public function get_recipients($invoice) { |
|
| 133 | + $recipients = array($invoice->get_email()); |
|
| 134 | 134 | |
| 135 | 135 | $cc = $invoice->get_email_cc(); |
| 136 | 136 | |
| 137 | - if ( ! empty( $cc ) ) { |
|
| 138 | - $cc = array_map( 'sanitize_email', wpinv_parse_list( $cc ) ); |
|
| 139 | - $recipients = array_filter( array_unique( array_merge( $recipients, $cc ) ) ); |
|
| 137 | + if (!empty($cc)) { |
|
| 138 | + $cc = array_map('sanitize_email', wpinv_parse_list($cc)); |
|
| 139 | + $recipients = array_filter(array_unique(array_merge($recipients, $cc))); |
|
| 140 | 140 | } |
| 141 | 141 | |
| 142 | 142 | return $recipients; |
@@ -150,45 +150,45 @@ discard block |
||
| 150 | 150 | * @param string $type |
| 151 | 151 | * @param array $extra_args Extra template args. |
| 152 | 152 | */ |
| 153 | - public function send_email( $subscription, $email, $type, $extra_args = array() ) { |
|
| 153 | + public function send_email($subscription, $email, $type, $extra_args = array()) { |
|
| 154 | 154 | |
| 155 | 155 | // Abort in case the parent invoice does not exist. |
| 156 | 156 | $invoice = $subscription->get_parent_invoice(); |
| 157 | - if ( ! $this->should_send_notification( $invoice ) ) { |
|
| 157 | + if (!$this->should_send_notification($invoice)) { |
|
| 158 | 158 | return; |
| 159 | 159 | } |
| 160 | 160 | |
| 161 | - do_action( 'getpaid_before_send_subscription_notification', $type, $subscription, $email ); |
|
| 161 | + do_action('getpaid_before_send_subscription_notification', $type, $subscription, $email); |
|
| 162 | 162 | |
| 163 | - $recipients = $this->get_recipients( $invoice ); |
|
| 163 | + $recipients = $this->get_recipients($invoice); |
|
| 164 | 164 | $mailer = new GetPaid_Notification_Email_Sender(); |
| 165 | 165 | $merge_tags = $email->get_merge_tags(); |
| 166 | - $content = $email->get_content( $merge_tags, $extra_args ); |
|
| 167 | - $subject = $email->add_merge_tags( $email->get_subject(), $merge_tags ); |
|
| 166 | + $content = $email->get_content($merge_tags, $extra_args); |
|
| 167 | + $subject = $email->add_merge_tags($email->get_subject(), $merge_tags); |
|
| 168 | 168 | $attachments = $email->get_attachments(); |
| 169 | 169 | |
| 170 | 170 | $result = $mailer->send( |
| 171 | - apply_filters( 'getpaid_subscription_email_recipients', wpinv_parse_list( $recipients ), $email ), |
|
| 171 | + apply_filters('getpaid_subscription_email_recipients', wpinv_parse_list($recipients), $email), |
|
| 172 | 172 | $subject, |
| 173 | 173 | $content, |
| 174 | 174 | $attachments |
| 175 | 175 | ); |
| 176 | 176 | |
| 177 | 177 | // Maybe send a copy to the admin. |
| 178 | - if ( $email->include_admin_bcc() ) { |
|
| 178 | + if ($email->include_admin_bcc()) { |
|
| 179 | 179 | $mailer->send( |
| 180 | 180 | wpinv_get_admin_email(), |
| 181 | - $subject . __( ' - ADMIN BCC COPY', 'invoicing' ), |
|
| 181 | + $subject . __(' - ADMIN BCC COPY', 'invoicing'), |
|
| 182 | 182 | $content, |
| 183 | 183 | $attachments |
| 184 | 184 | ); |
| 185 | 185 | } |
| 186 | 186 | |
| 187 | - if ( ! $result ) { |
|
| 188 | - $subscription->get_parent_invoice()->add_note( sprintf( __( 'Failed sending %s notification email.', 'invoicing' ), sanitize_key( $type ) ), false, false, true ); |
|
| 187 | + if (!$result) { |
|
| 188 | + $subscription->get_parent_invoice()->add_note(sprintf(__('Failed sending %s notification email.', 'invoicing'), sanitize_key($type)), false, false, true); |
|
| 189 | 189 | } |
| 190 | 190 | |
| 191 | - do_action( 'getpaid_after_send_subscription_notification', $type, $subscription, $email ); |
|
| 191 | + do_action('getpaid_after_send_subscription_notification', $type, $subscription, $email); |
|
| 192 | 192 | |
| 193 | 193 | } |
| 194 | 194 | |
@@ -197,10 +197,10 @@ discard block |
||
| 197 | 197 | * |
| 198 | 198 | * @param WPInv_Subscription $subscription |
| 199 | 199 | */ |
| 200 | - public function subscription_trial( $subscription ) { |
|
| 200 | + public function subscription_trial($subscription) { |
|
| 201 | 201 | |
| 202 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $subscription ); |
|
| 203 | - $this->send_email( $subscription, $email, __FUNCTION__ ); |
|
| 202 | + $email = new GetPaid_Notification_Email(__FUNCTION__, $subscription); |
|
| 203 | + $this->send_email($subscription, $email, __FUNCTION__); |
|
| 204 | 204 | |
| 205 | 205 | } |
| 206 | 206 | |
@@ -209,10 +209,10 @@ discard block |
||
| 209 | 209 | * |
| 210 | 210 | * @param WPInv_Subscription $subscription |
| 211 | 211 | */ |
| 212 | - public function subscription_cancelled( $subscription ) { |
|
| 212 | + public function subscription_cancelled($subscription) { |
|
| 213 | 213 | |
| 214 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $subscription ); |
|
| 215 | - $this->send_email( $subscription, $email, __FUNCTION__ ); |
|
| 214 | + $email = new GetPaid_Notification_Email(__FUNCTION__, $subscription); |
|
| 215 | + $this->send_email($subscription, $email, __FUNCTION__); |
|
| 216 | 216 | |
| 217 | 217 | } |
| 218 | 218 | |
@@ -221,10 +221,10 @@ discard block |
||
| 221 | 221 | * |
| 222 | 222 | * @param WPInv_Subscription $subscription |
| 223 | 223 | */ |
| 224 | - public function subscription_expired( $subscription ) { |
|
| 224 | + public function subscription_expired($subscription) { |
|
| 225 | 225 | |
| 226 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $subscription ); |
|
| 227 | - $this->send_email( $subscription, $email, __FUNCTION__ ); |
|
| 226 | + $email = new GetPaid_Notification_Email(__FUNCTION__, $subscription); |
|
| 227 | + $this->send_email($subscription, $email, __FUNCTION__); |
|
| 228 | 228 | |
| 229 | 229 | } |
| 230 | 230 | |
@@ -233,10 +233,10 @@ discard block |
||
| 233 | 233 | * |
| 234 | 234 | * @param WPInv_Subscription $subscription |
| 235 | 235 | */ |
| 236 | - public function subscription_complete( $subscription ) { |
|
| 236 | + public function subscription_complete($subscription) { |
|
| 237 | 237 | |
| 238 | - $email = new GetPaid_Notification_Email( __FUNCTION__, $subscription ); |
|
| 239 | - $this->send_email( $subscription, $email, __FUNCTION__ ); |
|
| 238 | + $email = new GetPaid_Notification_Email(__FUNCTION__, $subscription); |
|
| 239 | + $this->send_email($subscription, $email, __FUNCTION__); |
|
| 240 | 240 | |
| 241 | 241 | } |
| 242 | 242 | |
@@ -246,18 +246,18 @@ discard block |
||
| 246 | 246 | */ |
| 247 | 247 | public function renewal_reminder() { |
| 248 | 248 | |
| 249 | - $email = new GetPaid_Notification_Email( __FUNCTION__ ); |
|
| 249 | + $email = new GetPaid_Notification_Email(__FUNCTION__); |
|
| 250 | 250 | |
| 251 | 251 | // Fetch reminder days. |
| 252 | - $reminder_days = array_unique( wp_parse_id_list( $email->get_option( 'days' ) ) ); |
|
| 252 | + $reminder_days = array_unique(wp_parse_id_list($email->get_option('days'))); |
|
| 253 | 253 | |
| 254 | 254 | // Abort if non is set. |
| 255 | - if ( empty( $reminder_days ) ) { |
|
| 255 | + if (empty($reminder_days)) { |
|
| 256 | 256 | return; |
| 257 | 257 | } |
| 258 | 258 | |
| 259 | 259 | // Fetch matching subscriptions. |
| 260 | - $args = array( |
|
| 260 | + $args = array( |
|
| 261 | 261 | 'number' => -1, |
| 262 | 262 | 'count_total' => false, |
| 263 | 263 | 'status' => 'trialling active', |
@@ -266,8 +266,8 @@ discard block |
||
| 266 | 266 | ), |
| 267 | 267 | ); |
| 268 | 268 | |
| 269 | - foreach ( $reminder_days as $days ) { |
|
| 270 | - $date = date_parse( date( 'Y-m-d', strtotime( "+$days days", current_time( 'timestamp' ) ) ) ); |
|
| 269 | + foreach ($reminder_days as $days) { |
|
| 270 | + $date = date_parse(date('Y-m-d', strtotime("+$days days", current_time('timestamp')))); |
|
| 271 | 271 | |
| 272 | 272 | $args['date_expires_query'][] = array( |
| 273 | 273 | 'year' => $date['year'], |
@@ -277,14 +277,14 @@ discard block |
||
| 277 | 277 | |
| 278 | 278 | } |
| 279 | 279 | |
| 280 | - $subscriptions = new GetPaid_Subscriptions_Query( $args ); |
|
| 280 | + $subscriptions = new GetPaid_Subscriptions_Query($args); |
|
| 281 | 281 | |
| 282 | - foreach ( $subscriptions as $subscription ) { |
|
| 282 | + foreach ($subscriptions as $subscription) { |
|
| 283 | 283 | |
| 284 | 284 | // Skip packages. |
| 285 | - if ( get_post_meta( $subscription->get_product_id(), '_wpinv_type', true ) != 'package' ) { |
|
| 285 | + if (get_post_meta($subscription->get_product_id(), '_wpinv_type', true) != 'package') { |
|
| 286 | 286 | $email->object = $subscription; |
| 287 | - $this->send_email( $subscription, $email, __FUNCTION__ ); |
|
| 287 | + $this->send_email($subscription, $email, __FUNCTION__); |
|
| 288 | 288 | } |
| 289 | 289 | |
| 290 | 290 | } |
@@ -8,18 +8,18 @@ discard block |
||
| 8 | 8 | * @var WPInv_Invoice $invoice |
| 9 | 9 | */ |
| 10 | 10 | |
| 11 | -defined( 'ABSPATH' ) || exit; |
|
| 11 | +defined('ABSPATH') || exit; |
|
| 12 | 12 | |
| 13 | -$column_count = count( $columns ); |
|
| 13 | +$column_count = count($columns); |
|
| 14 | 14 | ?> |
| 15 | 15 | |
| 16 | -<?php do_action( 'wpinv_before_email_items', $invoice ); ?> |
|
| 16 | +<?php do_action('wpinv_before_email_items', $invoice); ?> |
|
| 17 | 17 | |
| 18 | 18 | |
| 19 | 19 | <div id="wpinv-email-items"> |
| 20 | 20 | |
| 21 | 21 | <h3 class="invoice-items-title"> |
| 22 | - <?php echo sprintf( esc_html__( '%s Items', 'invoicing' ), ucfirst( $invoice->get_invoice_quote_type() )); ?> |
|
| 22 | + <?php echo sprintf(esc_html__('%s Items', 'invoicing'), ucfirst($invoice->get_invoice_quote_type())); ?> |
|
| 23 | 23 | </h3> |
| 24 | 24 | |
| 25 | 25 | <table class="table table-bordered table-hover"> |
@@ -28,9 +28,9 @@ discard block |
||
| 28 | 28 | |
| 29 | 29 | <tr class="wpinv_cart_header_row"> |
| 30 | 30 | |
| 31 | - <?php foreach ( $columns as $key => $label ) : ?> |
|
| 32 | - <th class="<?php echo 'name' == $key ? 'text-left' : 'text-right' ?> wpinv_cart_item_<?php echo sanitize_html_class( $key ); ?>"> |
|
| 33 | - <?php echo sanitize_text_field( $label ); ?> |
|
| 31 | + <?php foreach ($columns as $key => $label) : ?> |
|
| 32 | + <th class="<?php echo 'name' == $key ? 'text-left' : 'text-right' ?> wpinv_cart_item_<?php echo sanitize_html_class($key); ?>"> |
|
| 33 | + <?php echo sanitize_text_field($label); ?> |
|
| 34 | 34 | </th> |
| 35 | 35 | <?php endforeach; ?> |
| 36 | 36 | |
@@ -43,13 +43,13 @@ discard block |
||
| 43 | 43 | <?php |
| 44 | 44 | |
| 45 | 45 | // Display the item totals. |
| 46 | - foreach ( $invoice->get_items() as $item ) { |
|
| 47 | - wpinv_get_template( 'emails/invoice-item.php', compact( 'invoice', 'item', 'columns' ) ); |
|
| 46 | + foreach ($invoice->get_items() as $item) { |
|
| 47 | + wpinv_get_template('emails/invoice-item.php', compact('invoice', 'item', 'columns')); |
|
| 48 | 48 | } |
| 49 | 49 | |
| 50 | 50 | // Display the fee totals. |
| 51 | - foreach ( $invoice->get_fees() as $fee ) { |
|
| 52 | - wpinv_get_template( 'emails/fee-item.php', compact( 'invoice', 'fee', 'columns' ) ); |
|
| 51 | + foreach ($invoice->get_fees() as $fee) { |
|
| 52 | + wpinv_get_template('emails/fee-item.php', compact('invoice', 'fee', 'columns')); |
|
| 53 | 53 | } |
| 54 | 54 | |
| 55 | 55 | ?> |
@@ -57,7 +57,7 @@ discard block |
||
| 57 | 57 | </tbody> |
| 58 | 58 | |
| 59 | 59 | <tfoot> |
| 60 | - <?php wpinv_get_template( 'emails/invoice-totals.php', compact( 'invoice', 'column_count' ) ); ?> |
|
| 60 | + <?php wpinv_get_template('emails/invoice-totals.php', compact('invoice', 'column_count')); ?> |
|
| 61 | 61 | </tfoot> |
| 62 | 62 | |
| 63 | 63 | </table> |
@@ -8,45 +8,45 @@ discard block |
||
| 8 | 8 | * @var WPInv_Invoice $invoice |
| 9 | 9 | * @var array $columns |
| 10 | 10 | */ |
| 11 | -defined( 'ABSPATH' ) || exit; |
|
| 11 | +defined('ABSPATH') || exit; |
|
| 12 | 12 | |
| 13 | -$meta_data = getpaid_get_invoice_meta( $invoice ); |
|
| 13 | +$meta_data = getpaid_get_invoice_meta($invoice); |
|
| 14 | 14 | |
| 15 | -if ( isset( $meta_data['status'] ) ) { |
|
| 15 | +if (isset($meta_data['status'])) { |
|
| 16 | 16 | $meta_data['status']['value'] = $invoice->get_status_nicename(); |
| 17 | 17 | } |
| 18 | 18 | |
| 19 | -do_action( 'wpinv_email_before_invoice_details', $invoice, $sent_to_admin ); |
|
| 19 | +do_action('wpinv_email_before_invoice_details', $invoice, $sent_to_admin); |
|
| 20 | 20 | |
| 21 | 21 | ?> |
| 22 | 22 | |
| 23 | 23 | <div id="wpinv-email-details"> |
| 24 | 24 | |
| 25 | 25 | <h3 class="invoice-details-title"> |
| 26 | - <?php echo sprintf( esc_html__( '%s Details', 'invoicing' ), ucfirst( $invoice->get_invoice_quote_type() )); ?> |
|
| 26 | + <?php echo sprintf(esc_html__('%s Details', 'invoicing'), ucfirst($invoice->get_invoice_quote_type())); ?> |
|
| 27 | 27 | </h3> |
| 28 | 28 | |
| 29 | 29 | <table class="table table-bordered table-sm"> |
| 30 | 30 | |
| 31 | - <?php foreach ( $meta_data as $key => $data ) : ?> |
|
| 31 | + <?php foreach ($meta_data as $key => $data) : ?> |
|
| 32 | 32 | |
| 33 | - <?php if ( ! empty( $data['value'] ) ) : ?> |
|
| 33 | + <?php if (!empty($data['value'])) : ?> |
|
| 34 | 34 | |
| 35 | - <?php do_action( "getpaid_before_email_details_$key", $invoice, $data ); ?> |
|
| 35 | + <?php do_action("getpaid_before_email_details_$key", $invoice, $data); ?> |
|
| 36 | 36 | |
| 37 | - <tr class="getpaid-email-details-<?php echo sanitize_html_class( $key ); ?>"> |
|
| 37 | + <tr class="getpaid-email-details-<?php echo sanitize_html_class($key); ?>"> |
|
| 38 | 38 | |
| 39 | 39 | <td class="getpaid-lable-td"> |
| 40 | - <?php echo sanitize_text_field( $data['label'] ); ?> |
|
| 40 | + <?php echo sanitize_text_field($data['label']); ?> |
|
| 41 | 41 | </td> |
| 42 | 42 | |
| 43 | 43 | <td class="getpaid-value-td"> |
| 44 | - <span class="getpaid-invoice-meta-<?php echo sanitize_html_class( $key ); ?>-value"><?php echo wp_kses_post( $data['value'] ); ?></span> |
|
| 44 | + <span class="getpaid-invoice-meta-<?php echo sanitize_html_class($key); ?>-value"><?php echo wp_kses_post($data['value']); ?></span> |
|
| 45 | 45 | </td> |
| 46 | 46 | |
| 47 | 47 | </tr> |
| 48 | 48 | |
| 49 | - <?php do_action( "getpaid_after_email_details_$key", $invoice, $data ); ?> |
|
| 49 | + <?php do_action("getpaid_after_email_details_$key", $invoice, $data); ?> |
|
| 50 | 50 | |
| 51 | 51 | <?php endif; ?> |
| 52 | 52 | |
@@ -56,4 +56,4 @@ discard block |
||
| 56 | 56 | |
| 57 | 57 | </div> |
| 58 | 58 | |
| 59 | -<?php do_action( 'wpinv_email_after_invoice_details', $invoice, $sent_to_admin ); ?> |
|
| 59 | +<?php do_action('wpinv_email_after_invoice_details', $invoice, $sent_to_admin); ?> |
|
@@ -8,7 +8,7 @@ discard block |
||
| 8 | 8 | * @var WPInv_Invoice $invoice |
| 9 | 9 | */ |
| 10 | 10 | |
| 11 | -defined( 'ABSPATH' ) || exit; |
|
| 11 | +defined('ABSPATH') || exit; |
|
| 12 | 12 | |
| 13 | 13 | ?> |
| 14 | 14 | |
@@ -21,43 +21,43 @@ discard block |
||
| 21 | 21 | $actions[] = sprintf( |
| 22 | 22 | '<a href="javascript:void(0)" class="btn btn-sm m-1 d-inline-block btn-secondary invoice-action-print d-none d-lg-inline-block" onclick="window.print();">%s</a>', |
| 23 | 23 | sprintf( |
| 24 | - __( 'Print %s', 'invoicing' ), |
|
| 25 | - ucfirst( $invoice->get_invoice_quote_type() ) |
|
| 24 | + __('Print %s', 'invoicing'), |
|
| 25 | + ucfirst($invoice->get_invoice_quote_type()) |
|
| 26 | 26 | ) |
| 27 | 27 | ); |
| 28 | 28 | |
| 29 | - if ( is_user_logged_in() ) { |
|
| 29 | + if (is_user_logged_in()) { |
|
| 30 | 30 | |
| 31 | 31 | $actions[] = sprintf( |
| 32 | 32 | '<a href="%s" class="btn btn-sm btn-secondary m-1 d-inline-block invoice-action-history">%s</a>', |
| 33 | - esc_url( wpinv_get_history_page_uri( $invoice->get_post_type() ) ), |
|
| 33 | + esc_url(wpinv_get_history_page_uri($invoice->get_post_type())), |
|
| 34 | 34 | sprintf( |
| 35 | - __( '%s History', 'invoicing' ), |
|
| 36 | - ucfirst( $invoice->get_invoice_quote_type() ) |
|
| 35 | + __('%s History', 'invoicing'), |
|
| 36 | + ucfirst($invoice->get_invoice_quote_type()) |
|
| 37 | 37 | ) |
| 38 | 38 | ); |
| 39 | 39 | |
| 40 | 40 | } |
| 41 | 41 | |
| 42 | - if ( wpinv_current_user_can_manage_invoicing() ) { |
|
| 42 | + if (wpinv_current_user_can_manage_invoicing()) { |
|
| 43 | 43 | |
| 44 | 44 | $actions[] = sprintf( |
| 45 | 45 | '<a href="%s" class="btn btn-sm btn-secondary m-1 d-inline-block invoice-action-edit">%s</a>', |
| 46 | - esc_url( get_edit_post_link( $invoice->get_id() ) ), |
|
| 46 | + esc_url(get_edit_post_link($invoice->get_id())), |
|
| 47 | 47 | sprintf( |
| 48 | - __( 'Edit %s', 'invoicing' ), |
|
| 49 | - ucfirst( $invoice->get_invoice_quote_type() ) |
|
| 48 | + __('Edit %s', 'invoicing'), |
|
| 49 | + ucfirst($invoice->get_invoice_quote_type()) |
|
| 50 | 50 | ) |
| 51 | 51 | ); |
| 52 | 52 | |
| 53 | 53 | } |
| 54 | 54 | |
| 55 | - $actions = apply_filters( 'getpaid_invoice_header_right_actions_array', $actions, $invoice ); |
|
| 56 | - echo implode( '', $actions ); |
|
| 55 | + $actions = apply_filters('getpaid_invoice_header_right_actions_array', $actions, $invoice); |
|
| 56 | + echo implode('', $actions); |
|
| 57 | 57 | |
| 58 | 58 | ?> |
| 59 | 59 | |
| 60 | - <?php do_action('wpinv_invoice_display_right_actions', $invoice ); ?> |
|
| 60 | + <?php do_action('wpinv_invoice_display_right_actions', $invoice); ?> |
|
| 61 | 61 | </div> |
| 62 | 62 | |
| 63 | 63 | <?php |
@@ -7,11 +7,11 @@ |
||
| 7 | 7 | * @version 1.0.19 |
| 8 | 8 | */ |
| 9 | 9 | |
| 10 | -defined( 'ABSPATH' ) || exit; |
|
| 10 | +defined('ABSPATH') || exit; |
|
| 11 | 11 | |
| 12 | 12 | ?> |
| 13 | 13 | <h2 class="h3 text-dark"> |
| 14 | - <?php echo apply_filters( 'getpaid_invoice_type_label', ucfirst( $invoice->get_invoice_quote_type() ), $invoice ); ?> |
|
| 14 | + <?php echo apply_filters('getpaid_invoice_type_label', ucfirst($invoice->get_invoice_quote_type()), $invoice); ?> |
|
| 15 | 15 | </h2> |
| 16 | 16 | |
| 17 | 17 | <?php |
@@ -5,7 +5,7 @@ discard block |
||
| 5 | 5 | * |
| 6 | 6 | */ |
| 7 | 7 | if ( ! defined( 'ABSPATH' ) ) { |
| 8 | - exit; |
|
| 8 | + exit; |
|
| 9 | 9 | } |
| 10 | 10 | |
| 11 | 11 | /** |
@@ -15,197 +15,197 @@ discard block |
||
| 15 | 15 | */ |
| 16 | 16 | class GetPaid_Subscription_Data_Store { |
| 17 | 17 | |
| 18 | - /** |
|
| 19 | - * A map of database fields to data types. |
|
| 20 | - * |
|
| 21 | - * @since 1.0.19 |
|
| 22 | - * @var array |
|
| 23 | - */ |
|
| 24 | - protected $database_fields_to_data_type = array( |
|
| 25 | - 'id' => '%d', |
|
| 26 | - 'customer_id' => '%d', |
|
| 27 | - 'frequency' => '%d', |
|
| 28 | - 'period' => '%s', |
|
| 29 | - 'initial_amount' => '%s', |
|
| 30 | - 'recurring_amount' => '%s', |
|
| 31 | - 'bill_times' => '%d', |
|
| 32 | - 'transaction_id' => '%s', |
|
| 33 | - 'parent_payment_id' => '%d', |
|
| 34 | - 'product_id' => '%d', |
|
| 35 | - 'created' => '%s', |
|
| 36 | - 'expiration' => '%s', |
|
| 37 | - 'trial_period' => '%s', |
|
| 38 | - 'status' => '%s', |
|
| 39 | - 'profile_id' => '%s', |
|
| 40 | - ); |
|
| 41 | - |
|
| 42 | - /* |
|
| 18 | + /** |
|
| 19 | + * A map of database fields to data types. |
|
| 20 | + * |
|
| 21 | + * @since 1.0.19 |
|
| 22 | + * @var array |
|
| 23 | + */ |
|
| 24 | + protected $database_fields_to_data_type = array( |
|
| 25 | + 'id' => '%d', |
|
| 26 | + 'customer_id' => '%d', |
|
| 27 | + 'frequency' => '%d', |
|
| 28 | + 'period' => '%s', |
|
| 29 | + 'initial_amount' => '%s', |
|
| 30 | + 'recurring_amount' => '%s', |
|
| 31 | + 'bill_times' => '%d', |
|
| 32 | + 'transaction_id' => '%s', |
|
| 33 | + 'parent_payment_id' => '%d', |
|
| 34 | + 'product_id' => '%d', |
|
| 35 | + 'created' => '%s', |
|
| 36 | + 'expiration' => '%s', |
|
| 37 | + 'trial_period' => '%s', |
|
| 38 | + 'status' => '%s', |
|
| 39 | + 'profile_id' => '%s', |
|
| 40 | + ); |
|
| 41 | + |
|
| 42 | + /* |
|
| 43 | 43 | |-------------------------------------------------------------------------- |
| 44 | 44 | | CRUD Methods |
| 45 | 45 | |-------------------------------------------------------------------------- |
| 46 | 46 | */ |
| 47 | 47 | |
| 48 | - /** |
|
| 49 | - * Method to create a new subscription in the database. |
|
| 50 | - * |
|
| 51 | - * @param WPInv_Subscription $subscription Subscription object. |
|
| 52 | - */ |
|
| 53 | - public function create( &$subscription ) { |
|
| 54 | - global $wpdb; |
|
| 55 | - |
|
| 56 | - $values = array(); |
|
| 57 | - $formats = array(); |
|
| 58 | - |
|
| 59 | - $fields = $this->database_fields_to_data_type; |
|
| 60 | - unset( $fields['id'] ); |
|
| 61 | - |
|
| 62 | - foreach ( $fields as $key => $format ) { |
|
| 63 | - $method = "get_$key"; |
|
| 64 | - $values[$key] = $subscription->$method( 'edit' ); |
|
| 65 | - $formats[] = $format; |
|
| 66 | - } |
|
| 67 | - |
|
| 68 | - $result = $wpdb->insert( $wpdb->prefix . 'wpinv_subscriptions', $values, $formats ); |
|
| 69 | - |
|
| 70 | - if ( $result ) { |
|
| 71 | - $subscription->set_id( $wpdb->insert_id ); |
|
| 72 | - $subscription->apply_changes(); |
|
| 73 | - $subscription->clear_cache(); |
|
| 74 | - update_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscription_id', $subscription->get_id() ); |
|
| 75 | - do_action( 'getpaid_new_subscription', $subscription ); |
|
| 76 | - return true; |
|
| 77 | - } |
|
| 78 | - |
|
| 79 | - return false; |
|
| 80 | - } |
|
| 81 | - |
|
| 82 | - /** |
|
| 83 | - * Method to read a subscription from the database. |
|
| 84 | - * |
|
| 85 | - * @param WPInv_Subscription $subscription Subscription object. |
|
| 86 | - * |
|
| 87 | - */ |
|
| 88 | - public function read( &$subscription ) { |
|
| 89 | - global $wpdb; |
|
| 90 | - |
|
| 91 | - $subscription->set_defaults(); |
|
| 92 | - |
|
| 93 | - if ( ! $subscription->get_id() ) { |
|
| 94 | - $subscription->last_error = __( 'Invalid subscription ID.', 'invoicing' ); |
|
| 95 | - $subscription->set_id( 0 ); |
|
| 96 | - return false; |
|
| 97 | - } |
|
| 98 | - |
|
| 99 | - // Maybe retrieve from the cache. |
|
| 100 | - $raw_subscription = wp_cache_get( $subscription->get_id(), 'getpaid_subscriptions' ); |
|
| 101 | - |
|
| 102 | - // If not found, retrieve from the db. |
|
| 103 | - if ( false === $raw_subscription ) { |
|
| 104 | - |
|
| 105 | - $raw_subscription = $wpdb->get_row( |
|
| 106 | - $wpdb->prepare( |
|
| 107 | - "SELECT * FROM {$wpdb->prefix}wpinv_subscriptions WHERE id = %d", |
|
| 108 | - $subscription->get_id() |
|
| 109 | - ) |
|
| 110 | - ); |
|
| 111 | - |
|
| 112 | - // Update the cache with our data |
|
| 113 | - wp_cache_set( $subscription->get_id(), $raw_subscription, 'getpaid_subscriptions' ); |
|
| 114 | - |
|
| 115 | - } |
|
| 116 | - |
|
| 117 | - if ( ! $raw_subscription ) { |
|
| 118 | - $subscription->last_error = __( 'Invalid subscription ID.', 'invoicing' ); |
|
| 119 | - return false; |
|
| 120 | - } |
|
| 121 | - |
|
| 122 | - foreach ( array_keys( $this->database_fields_to_data_type ) as $key ) { |
|
| 123 | - $method = "set_$key"; |
|
| 124 | - $subscription->$method( $raw_subscription->$key ); |
|
| 125 | - } |
|
| 126 | - |
|
| 127 | - $subscription->set_object_read( true ); |
|
| 128 | - do_action( 'getpaid_read_subscription', $subscription ); |
|
| 129 | - |
|
| 130 | - } |
|
| 131 | - |
|
| 132 | - /** |
|
| 133 | - * Method to update a subscription in the database. |
|
| 134 | - * |
|
| 135 | - * @param WPInv_Subscription $subscription Subscription object. |
|
| 136 | - */ |
|
| 137 | - public function update( &$subscription ) { |
|
| 138 | - global $wpdb; |
|
| 139 | - |
|
| 140 | - $changes = $subscription->get_changes(); |
|
| 141 | - $values = array(); |
|
| 142 | - $formats = array(); |
|
| 143 | - |
|
| 144 | - foreach ( $this->database_fields_to_data_type as $key => $format ) { |
|
| 145 | - if ( array_key_exists( $key, $changes ) ) { |
|
| 146 | - $method = "get_$key"; |
|
| 147 | - $values[$key] = $subscription->$method( 'edit' ); |
|
| 148 | - $formats[] = $format; |
|
| 149 | - } |
|
| 150 | - } |
|
| 151 | - |
|
| 152 | - if ( empty( $values ) ) { |
|
| 153 | - return; |
|
| 154 | - } |
|
| 155 | - |
|
| 156 | - $wpdb->update( |
|
| 157 | - $wpdb->prefix . 'wpinv_subscriptions', |
|
| 158 | - $values, |
|
| 159 | - array( |
|
| 160 | - 'id' => $subscription->get_id(), |
|
| 161 | - ), |
|
| 162 | - $formats, |
|
| 163 | - '%d' |
|
| 164 | - ); |
|
| 165 | - |
|
| 166 | - // Apply the changes. |
|
| 167 | - $subscription->apply_changes(); |
|
| 168 | - |
|
| 169 | - // Delete cache. |
|
| 170 | - $subscription->clear_cache(); |
|
| 171 | - |
|
| 172 | - update_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscr_profile_id', $subscription->get_profile_id() ); |
|
| 173 | - update_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscription_id', $subscription->get_id() ); |
|
| 174 | - |
|
| 175 | - // Fire a hook. |
|
| 176 | - do_action( 'getpaid_update_subscription', $subscription ); |
|
| 177 | - |
|
| 178 | - } |
|
| 179 | - |
|
| 180 | - /** |
|
| 181 | - * Method to delete a subscription from the database. |
|
| 182 | - * |
|
| 183 | - * @param WPInv_Subscription $subscription |
|
| 184 | - */ |
|
| 185 | - public function delete( &$subscription ) { |
|
| 186 | - global $wpdb; |
|
| 187 | - |
|
| 188 | - $wpdb->query( |
|
| 189 | - $wpdb->prepare( |
|
| 190 | - "DELETE FROM {$wpdb->prefix}wpinv_subscriptions |
|
| 48 | + /** |
|
| 49 | + * Method to create a new subscription in the database. |
|
| 50 | + * |
|
| 51 | + * @param WPInv_Subscription $subscription Subscription object. |
|
| 52 | + */ |
|
| 53 | + public function create( &$subscription ) { |
|
| 54 | + global $wpdb; |
|
| 55 | + |
|
| 56 | + $values = array(); |
|
| 57 | + $formats = array(); |
|
| 58 | + |
|
| 59 | + $fields = $this->database_fields_to_data_type; |
|
| 60 | + unset( $fields['id'] ); |
|
| 61 | + |
|
| 62 | + foreach ( $fields as $key => $format ) { |
|
| 63 | + $method = "get_$key"; |
|
| 64 | + $values[$key] = $subscription->$method( 'edit' ); |
|
| 65 | + $formats[] = $format; |
|
| 66 | + } |
|
| 67 | + |
|
| 68 | + $result = $wpdb->insert( $wpdb->prefix . 'wpinv_subscriptions', $values, $formats ); |
|
| 69 | + |
|
| 70 | + if ( $result ) { |
|
| 71 | + $subscription->set_id( $wpdb->insert_id ); |
|
| 72 | + $subscription->apply_changes(); |
|
| 73 | + $subscription->clear_cache(); |
|
| 74 | + update_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscription_id', $subscription->get_id() ); |
|
| 75 | + do_action( 'getpaid_new_subscription', $subscription ); |
|
| 76 | + return true; |
|
| 77 | + } |
|
| 78 | + |
|
| 79 | + return false; |
|
| 80 | + } |
|
| 81 | + |
|
| 82 | + /** |
|
| 83 | + * Method to read a subscription from the database. |
|
| 84 | + * |
|
| 85 | + * @param WPInv_Subscription $subscription Subscription object. |
|
| 86 | + * |
|
| 87 | + */ |
|
| 88 | + public function read( &$subscription ) { |
|
| 89 | + global $wpdb; |
|
| 90 | + |
|
| 91 | + $subscription->set_defaults(); |
|
| 92 | + |
|
| 93 | + if ( ! $subscription->get_id() ) { |
|
| 94 | + $subscription->last_error = __( 'Invalid subscription ID.', 'invoicing' ); |
|
| 95 | + $subscription->set_id( 0 ); |
|
| 96 | + return false; |
|
| 97 | + } |
|
| 98 | + |
|
| 99 | + // Maybe retrieve from the cache. |
|
| 100 | + $raw_subscription = wp_cache_get( $subscription->get_id(), 'getpaid_subscriptions' ); |
|
| 101 | + |
|
| 102 | + // If not found, retrieve from the db. |
|
| 103 | + if ( false === $raw_subscription ) { |
|
| 104 | + |
|
| 105 | + $raw_subscription = $wpdb->get_row( |
|
| 106 | + $wpdb->prepare( |
|
| 107 | + "SELECT * FROM {$wpdb->prefix}wpinv_subscriptions WHERE id = %d", |
|
| 108 | + $subscription->get_id() |
|
| 109 | + ) |
|
| 110 | + ); |
|
| 111 | + |
|
| 112 | + // Update the cache with our data |
|
| 113 | + wp_cache_set( $subscription->get_id(), $raw_subscription, 'getpaid_subscriptions' ); |
|
| 114 | + |
|
| 115 | + } |
|
| 116 | + |
|
| 117 | + if ( ! $raw_subscription ) { |
|
| 118 | + $subscription->last_error = __( 'Invalid subscription ID.', 'invoicing' ); |
|
| 119 | + return false; |
|
| 120 | + } |
|
| 121 | + |
|
| 122 | + foreach ( array_keys( $this->database_fields_to_data_type ) as $key ) { |
|
| 123 | + $method = "set_$key"; |
|
| 124 | + $subscription->$method( $raw_subscription->$key ); |
|
| 125 | + } |
|
| 126 | + |
|
| 127 | + $subscription->set_object_read( true ); |
|
| 128 | + do_action( 'getpaid_read_subscription', $subscription ); |
|
| 129 | + |
|
| 130 | + } |
|
| 131 | + |
|
| 132 | + /** |
|
| 133 | + * Method to update a subscription in the database. |
|
| 134 | + * |
|
| 135 | + * @param WPInv_Subscription $subscription Subscription object. |
|
| 136 | + */ |
|
| 137 | + public function update( &$subscription ) { |
|
| 138 | + global $wpdb; |
|
| 139 | + |
|
| 140 | + $changes = $subscription->get_changes(); |
|
| 141 | + $values = array(); |
|
| 142 | + $formats = array(); |
|
| 143 | + |
|
| 144 | + foreach ( $this->database_fields_to_data_type as $key => $format ) { |
|
| 145 | + if ( array_key_exists( $key, $changes ) ) { |
|
| 146 | + $method = "get_$key"; |
|
| 147 | + $values[$key] = $subscription->$method( 'edit' ); |
|
| 148 | + $formats[] = $format; |
|
| 149 | + } |
|
| 150 | + } |
|
| 151 | + |
|
| 152 | + if ( empty( $values ) ) { |
|
| 153 | + return; |
|
| 154 | + } |
|
| 155 | + |
|
| 156 | + $wpdb->update( |
|
| 157 | + $wpdb->prefix . 'wpinv_subscriptions', |
|
| 158 | + $values, |
|
| 159 | + array( |
|
| 160 | + 'id' => $subscription->get_id(), |
|
| 161 | + ), |
|
| 162 | + $formats, |
|
| 163 | + '%d' |
|
| 164 | + ); |
|
| 165 | + |
|
| 166 | + // Apply the changes. |
|
| 167 | + $subscription->apply_changes(); |
|
| 168 | + |
|
| 169 | + // Delete cache. |
|
| 170 | + $subscription->clear_cache(); |
|
| 171 | + |
|
| 172 | + update_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscr_profile_id', $subscription->get_profile_id() ); |
|
| 173 | + update_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscription_id', $subscription->get_id() ); |
|
| 174 | + |
|
| 175 | + // Fire a hook. |
|
| 176 | + do_action( 'getpaid_update_subscription', $subscription ); |
|
| 177 | + |
|
| 178 | + } |
|
| 179 | + |
|
| 180 | + /** |
|
| 181 | + * Method to delete a subscription from the database. |
|
| 182 | + * |
|
| 183 | + * @param WPInv_Subscription $subscription |
|
| 184 | + */ |
|
| 185 | + public function delete( &$subscription ) { |
|
| 186 | + global $wpdb; |
|
| 187 | + |
|
| 188 | + $wpdb->query( |
|
| 189 | + $wpdb->prepare( |
|
| 190 | + "DELETE FROM {$wpdb->prefix}wpinv_subscriptions |
|
| 191 | 191 | WHERE id = %d", |
| 192 | - $subscription->get_id() |
|
| 193 | - ) |
|
| 194 | - ); |
|
| 192 | + $subscription->get_id() |
|
| 193 | + ) |
|
| 194 | + ); |
|
| 195 | 195 | |
| 196 | - delete_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscr_profile_id' ); |
|
| 197 | - delete_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscription_id' ); |
|
| 196 | + delete_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscr_profile_id' ); |
|
| 197 | + delete_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscription_id' ); |
|
| 198 | 198 | |
| 199 | - // Delete cache. |
|
| 200 | - $subscription->clear_cache(); |
|
| 199 | + // Delete cache. |
|
| 200 | + $subscription->clear_cache(); |
|
| 201 | 201 | |
| 202 | - // Fire a hook. |
|
| 203 | - do_action( 'getpaid_delete_subscription', $subscription ); |
|
| 202 | + // Fire a hook. |
|
| 203 | + do_action( 'getpaid_delete_subscription', $subscription ); |
|
| 204 | 204 | |
| 205 | - $subscription->set_id( 0 ); |
|
| 206 | - } |
|
| 205 | + $subscription->set_id( 0 ); |
|
| 206 | + } |
|
| 207 | 207 | |
| 208 | - /* |
|
| 208 | + /* |
|
| 209 | 209 | |-------------------------------------------------------------------------- |
| 210 | 210 | | Additional Methods |
| 211 | 211 | |-------------------------------------------------------------------------- |
@@ -4,7 +4,7 @@ discard block |
||
| 4 | 4 | * GetPaid_Subscription_Data_Store class file. |
| 5 | 5 | * |
| 6 | 6 | */ |
| 7 | -if ( ! defined( 'ABSPATH' ) ) { |
|
| 7 | +if (!defined('ABSPATH')) { |
|
| 8 | 8 | exit; |
| 9 | 9 | } |
| 10 | 10 | |
@@ -50,29 +50,29 @@ discard block |
||
| 50 | 50 | * |
| 51 | 51 | * @param WPInv_Subscription $subscription Subscription object. |
| 52 | 52 | */ |
| 53 | - public function create( &$subscription ) { |
|
| 53 | + public function create(&$subscription) { |
|
| 54 | 54 | global $wpdb; |
| 55 | 55 | |
| 56 | 56 | $values = array(); |
| 57 | 57 | $formats = array(); |
| 58 | 58 | |
| 59 | 59 | $fields = $this->database_fields_to_data_type; |
| 60 | - unset( $fields['id'] ); |
|
| 60 | + unset($fields['id']); |
|
| 61 | 61 | |
| 62 | - foreach ( $fields as $key => $format ) { |
|
| 62 | + foreach ($fields as $key => $format) { |
|
| 63 | 63 | $method = "get_$key"; |
| 64 | - $values[$key] = $subscription->$method( 'edit' ); |
|
| 64 | + $values[$key] = $subscription->$method('edit'); |
|
| 65 | 65 | $formats[] = $format; |
| 66 | 66 | } |
| 67 | 67 | |
| 68 | - $result = $wpdb->insert( $wpdb->prefix . 'wpinv_subscriptions', $values, $formats ); |
|
| 68 | + $result = $wpdb->insert($wpdb->prefix . 'wpinv_subscriptions', $values, $formats); |
|
| 69 | 69 | |
| 70 | - if ( $result ) { |
|
| 71 | - $subscription->set_id( $wpdb->insert_id ); |
|
| 70 | + if ($result) { |
|
| 71 | + $subscription->set_id($wpdb->insert_id); |
|
| 72 | 72 | $subscription->apply_changes(); |
| 73 | 73 | $subscription->clear_cache(); |
| 74 | - update_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscription_id', $subscription->get_id() ); |
|
| 75 | - do_action( 'getpaid_new_subscription', $subscription ); |
|
| 74 | + update_post_meta($subscription->get_parent_invoice_id(), '_wpinv_subscription_id', $subscription->get_id()); |
|
| 75 | + do_action('getpaid_new_subscription', $subscription); |
|
| 76 | 76 | return true; |
| 77 | 77 | } |
| 78 | 78 | |
@@ -85,22 +85,22 @@ discard block |
||
| 85 | 85 | * @param WPInv_Subscription $subscription Subscription object. |
| 86 | 86 | * |
| 87 | 87 | */ |
| 88 | - public function read( &$subscription ) { |
|
| 88 | + public function read(&$subscription) { |
|
| 89 | 89 | global $wpdb; |
| 90 | 90 | |
| 91 | 91 | $subscription->set_defaults(); |
| 92 | 92 | |
| 93 | - if ( ! $subscription->get_id() ) { |
|
| 94 | - $subscription->last_error = __( 'Invalid subscription ID.', 'invoicing' ); |
|
| 95 | - $subscription->set_id( 0 ); |
|
| 93 | + if (!$subscription->get_id()) { |
|
| 94 | + $subscription->last_error = __('Invalid subscription ID.', 'invoicing'); |
|
| 95 | + $subscription->set_id(0); |
|
| 96 | 96 | return false; |
| 97 | 97 | } |
| 98 | 98 | |
| 99 | 99 | // Maybe retrieve from the cache. |
| 100 | - $raw_subscription = wp_cache_get( $subscription->get_id(), 'getpaid_subscriptions' ); |
|
| 100 | + $raw_subscription = wp_cache_get($subscription->get_id(), 'getpaid_subscriptions'); |
|
| 101 | 101 | |
| 102 | 102 | // If not found, retrieve from the db. |
| 103 | - if ( false === $raw_subscription ) { |
|
| 103 | + if (false === $raw_subscription) { |
|
| 104 | 104 | |
| 105 | 105 | $raw_subscription = $wpdb->get_row( |
| 106 | 106 | $wpdb->prepare( |
@@ -110,22 +110,22 @@ discard block |
||
| 110 | 110 | ); |
| 111 | 111 | |
| 112 | 112 | // Update the cache with our data |
| 113 | - wp_cache_set( $subscription->get_id(), $raw_subscription, 'getpaid_subscriptions' ); |
|
| 113 | + wp_cache_set($subscription->get_id(), $raw_subscription, 'getpaid_subscriptions'); |
|
| 114 | 114 | |
| 115 | 115 | } |
| 116 | 116 | |
| 117 | - if ( ! $raw_subscription ) { |
|
| 118 | - $subscription->last_error = __( 'Invalid subscription ID.', 'invoicing' ); |
|
| 117 | + if (!$raw_subscription) { |
|
| 118 | + $subscription->last_error = __('Invalid subscription ID.', 'invoicing'); |
|
| 119 | 119 | return false; |
| 120 | 120 | } |
| 121 | 121 | |
| 122 | - foreach ( array_keys( $this->database_fields_to_data_type ) as $key ) { |
|
| 123 | - $method = "set_$key"; |
|
| 124 | - $subscription->$method( $raw_subscription->$key ); |
|
| 122 | + foreach (array_keys($this->database_fields_to_data_type) as $key) { |
|
| 123 | + $method = "set_$key"; |
|
| 124 | + $subscription->$method($raw_subscription->$key); |
|
| 125 | 125 | } |
| 126 | 126 | |
| 127 | - $subscription->set_object_read( true ); |
|
| 128 | - do_action( 'getpaid_read_subscription', $subscription ); |
|
| 127 | + $subscription->set_object_read(true); |
|
| 128 | + do_action('getpaid_read_subscription', $subscription); |
|
| 129 | 129 | |
| 130 | 130 | } |
| 131 | 131 | |
@@ -134,22 +134,22 @@ discard block |
||
| 134 | 134 | * |
| 135 | 135 | * @param WPInv_Subscription $subscription Subscription object. |
| 136 | 136 | */ |
| 137 | - public function update( &$subscription ) { |
|
| 137 | + public function update(&$subscription) { |
|
| 138 | 138 | global $wpdb; |
| 139 | 139 | |
| 140 | 140 | $changes = $subscription->get_changes(); |
| 141 | 141 | $values = array(); |
| 142 | 142 | $formats = array(); |
| 143 | 143 | |
| 144 | - foreach ( $this->database_fields_to_data_type as $key => $format ) { |
|
| 145 | - if ( array_key_exists( $key, $changes ) ) { |
|
| 144 | + foreach ($this->database_fields_to_data_type as $key => $format) { |
|
| 145 | + if (array_key_exists($key, $changes)) { |
|
| 146 | 146 | $method = "get_$key"; |
| 147 | - $values[$key] = $subscription->$method( 'edit' ); |
|
| 147 | + $values[$key] = $subscription->$method('edit'); |
|
| 148 | 148 | $formats[] = $format; |
| 149 | 149 | } |
| 150 | 150 | } |
| 151 | 151 | |
| 152 | - if ( empty( $values ) ) { |
|
| 152 | + if (empty($values)) { |
|
| 153 | 153 | return; |
| 154 | 154 | } |
| 155 | 155 | |
@@ -169,11 +169,11 @@ discard block |
||
| 169 | 169 | // Delete cache. |
| 170 | 170 | $subscription->clear_cache(); |
| 171 | 171 | |
| 172 | - update_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscr_profile_id', $subscription->get_profile_id() ); |
|
| 173 | - update_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscription_id', $subscription->get_id() ); |
|
| 172 | + update_post_meta($subscription->get_parent_invoice_id(), '_wpinv_subscr_profile_id', $subscription->get_profile_id()); |
|
| 173 | + update_post_meta($subscription->get_parent_invoice_id(), '_wpinv_subscription_id', $subscription->get_id()); |
|
| 174 | 174 | |
| 175 | 175 | // Fire a hook. |
| 176 | - do_action( 'getpaid_update_subscription', $subscription ); |
|
| 176 | + do_action('getpaid_update_subscription', $subscription); |
|
| 177 | 177 | |
| 178 | 178 | } |
| 179 | 179 | |
@@ -182,7 +182,7 @@ discard block |
||
| 182 | 182 | * |
| 183 | 183 | * @param WPInv_Subscription $subscription |
| 184 | 184 | */ |
| 185 | - public function delete( &$subscription ) { |
|
| 185 | + public function delete(&$subscription) { |
|
| 186 | 186 | global $wpdb; |
| 187 | 187 | |
| 188 | 188 | $wpdb->query( |
@@ -193,16 +193,16 @@ discard block |
||
| 193 | 193 | ) |
| 194 | 194 | ); |
| 195 | 195 | |
| 196 | - delete_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscr_profile_id' ); |
|
| 197 | - delete_post_meta( $subscription->get_parent_invoice_id(), '_wpinv_subscription_id' ); |
|
| 196 | + delete_post_meta($subscription->get_parent_invoice_id(), '_wpinv_subscr_profile_id'); |
|
| 197 | + delete_post_meta($subscription->get_parent_invoice_id(), '_wpinv_subscription_id'); |
|
| 198 | 198 | |
| 199 | 199 | // Delete cache. |
| 200 | 200 | $subscription->clear_cache(); |
| 201 | 201 | |
| 202 | 202 | // Fire a hook. |
| 203 | - do_action( 'getpaid_delete_subscription', $subscription ); |
|
| 203 | + do_action('getpaid_delete_subscription', $subscription); |
|
| 204 | 204 | |
| 205 | - $subscription->set_id( 0 ); |
|
| 205 | + $subscription->set_id(0); |
|
| 206 | 206 | } |
| 207 | 207 | |
| 208 | 208 | /* |
@@ -9,7 +9,7 @@ discard block |
||
| 9 | 9 | */ |
| 10 | 10 | |
| 11 | 11 | if ( ! defined( 'ABSPATH' ) ) { |
| 12 | - exit; |
|
| 12 | + exit; |
|
| 13 | 13 | } |
| 14 | 14 | |
| 15 | 15 | /** |
@@ -21,356 +21,356 @@ discard block |
||
| 21 | 21 | */ |
| 22 | 22 | abstract class GetPaid_Data { |
| 23 | 23 | |
| 24 | - /** |
|
| 25 | - * ID for this object. |
|
| 26 | - * |
|
| 27 | - * @since 1.0.19 |
|
| 28 | - * @var int |
|
| 29 | - */ |
|
| 30 | - protected $id = 0; |
|
| 31 | - |
|
| 32 | - /** |
|
| 33 | - * Core data for this object. Name value pairs (name + default value). |
|
| 34 | - * |
|
| 35 | - * @since 1.0.19 |
|
| 36 | - * @var array |
|
| 37 | - */ |
|
| 38 | - protected $data = array(); |
|
| 39 | - |
|
| 40 | - /** |
|
| 41 | - * Core data changes for this object. |
|
| 42 | - * |
|
| 43 | - * @since 1.0.19 |
|
| 44 | - * @var array |
|
| 45 | - */ |
|
| 46 | - protected $changes = array(); |
|
| 47 | - |
|
| 48 | - /** |
|
| 49 | - * This is false until the object is read from the DB. |
|
| 50 | - * |
|
| 51 | - * @since 1.0.19 |
|
| 52 | - * @var bool |
|
| 53 | - */ |
|
| 54 | - protected $object_read = false; |
|
| 55 | - |
|
| 56 | - /** |
|
| 57 | - * This is the name of this object type. |
|
| 58 | - * |
|
| 59 | - * @since 1.0.19 |
|
| 60 | - * @var string |
|
| 61 | - */ |
|
| 62 | - protected $object_type = 'data'; |
|
| 63 | - |
|
| 64 | - /** |
|
| 65 | - * Extra data for this object. Name value pairs (name + default value). |
|
| 66 | - * Used as a standard way for sub classes (like item types) to add |
|
| 67 | - * additional information to an inherited class. |
|
| 68 | - * |
|
| 69 | - * @since 1.0.19 |
|
| 70 | - * @var array |
|
| 71 | - */ |
|
| 72 | - protected $extra_data = array(); |
|
| 73 | - |
|
| 74 | - /** |
|
| 75 | - * Set to _data on construct so we can track and reset data if needed. |
|
| 76 | - * |
|
| 77 | - * @since 1.0.19 |
|
| 78 | - * @var array |
|
| 79 | - */ |
|
| 80 | - protected $default_data = array(); |
|
| 81 | - |
|
| 82 | - /** |
|
| 83 | - * Contains a reference to the data store for this class. |
|
| 84 | - * |
|
| 85 | - * @since 1.0.19 |
|
| 86 | - * @var GetPaid_Data_Store |
|
| 87 | - */ |
|
| 88 | - protected $data_store; |
|
| 89 | - |
|
| 90 | - /** |
|
| 91 | - * Stores meta in cache for future reads. |
|
| 92 | - * A group must be set to to enable caching. |
|
| 93 | - * |
|
| 94 | - * @since 1.0.19 |
|
| 95 | - * @var string |
|
| 96 | - */ |
|
| 97 | - protected $cache_group = ''; |
|
| 98 | - |
|
| 99 | - /** |
|
| 100 | - * Stores the last error. |
|
| 101 | - * |
|
| 102 | - * @since 1.0.19 |
|
| 103 | - * @var string |
|
| 104 | - */ |
|
| 105 | - public $last_error = ''; |
|
| 106 | - |
|
| 107 | - /** |
|
| 108 | - * Stores additional meta data. |
|
| 109 | - * |
|
| 110 | - * @since 1.0.19 |
|
| 111 | - * @var array |
|
| 112 | - */ |
|
| 113 | - protected $meta_data = null; |
|
| 114 | - |
|
| 115 | - /** |
|
| 116 | - * Default constructor. |
|
| 117 | - * |
|
| 118 | - * @param int|object|array|string $read ID to load from the DB (optional) or already queried data. |
|
| 119 | - */ |
|
| 120 | - public function __construct( $read = 0 ) { |
|
| 121 | - $this->data = array_merge( $this->data, $this->extra_data ); |
|
| 122 | - $this->default_data = $this->data; |
|
| 123 | - } |
|
| 124 | - |
|
| 125 | - /** |
|
| 126 | - * Only store the object ID to avoid serializing the data object instance. |
|
| 127 | - * |
|
| 128 | - * @return array |
|
| 129 | - */ |
|
| 130 | - public function __sleep() { |
|
| 131 | - return array( 'id' ); |
|
| 132 | - } |
|
| 133 | - |
|
| 134 | - /** |
|
| 135 | - * Re-run the constructor with the object ID. |
|
| 136 | - * |
|
| 137 | - * If the object no longer exists, remove the ID. |
|
| 138 | - */ |
|
| 139 | - public function __wakeup() { |
|
| 140 | - $this->__construct( absint( $this->id ) ); |
|
| 141 | - |
|
| 142 | - if ( ! empty( $this->last_error ) ) { |
|
| 143 | - $this->set_id( 0 ); |
|
| 144 | - } |
|
| 145 | - |
|
| 146 | - } |
|
| 147 | - |
|
| 148 | - /** |
|
| 149 | - * When the object is cloned, make sure meta is duplicated correctly. |
|
| 150 | - * |
|
| 151 | - * @since 1.0.19 |
|
| 152 | - */ |
|
| 153 | - public function __clone() { |
|
| 154 | - $this->maybe_read_meta_data(); |
|
| 155 | - if ( ! empty( $this->meta_data ) ) { |
|
| 156 | - foreach ( $this->meta_data as $array_key => $meta ) { |
|
| 157 | - $this->meta_data[ $array_key ] = clone $meta; |
|
| 158 | - if ( ! empty( $meta->id ) ) { |
|
| 159 | - $this->meta_data[ $array_key ]->id = null; |
|
| 160 | - } |
|
| 161 | - } |
|
| 162 | - } |
|
| 163 | - } |
|
| 164 | - |
|
| 165 | - /** |
|
| 166 | - * Get the data store. |
|
| 167 | - * |
|
| 168 | - * @since 1.0.19 |
|
| 169 | - * @return object |
|
| 170 | - */ |
|
| 171 | - public function get_data_store() { |
|
| 172 | - return $this->data_store; |
|
| 173 | - } |
|
| 174 | - |
|
| 175 | - /** |
|
| 176 | - * Get the object type. |
|
| 177 | - * |
|
| 178 | - * @since 1.0.19 |
|
| 179 | - * @return string |
|
| 180 | - */ |
|
| 181 | - public function get_object_type() { |
|
| 182 | - return $this->object_type; |
|
| 183 | - } |
|
| 184 | - |
|
| 185 | - /** |
|
| 186 | - * Returns the unique ID for this object. |
|
| 187 | - * |
|
| 188 | - * @since 1.0.19 |
|
| 189 | - * @return int |
|
| 190 | - */ |
|
| 191 | - public function get_id() { |
|
| 192 | - return $this->id; |
|
| 193 | - } |
|
| 194 | - |
|
| 195 | - /** |
|
| 196 | - * Get form status. |
|
| 197 | - * |
|
| 198 | - * @since 1.0.19 |
|
| 199 | - * @param string $context View or edit context. |
|
| 200 | - * @return string |
|
| 201 | - */ |
|
| 202 | - public function get_status( $context = 'view' ) { |
|
| 203 | - return $this->get_prop( 'status', $context ); |
|
| 204 | - } |
|
| 205 | - |
|
| 206 | - /** |
|
| 207 | - * Delete an object, set the ID to 0, and return result. |
|
| 208 | - * |
|
| 209 | - * @since 1.0.19 |
|
| 210 | - * @param bool $force_delete Should the data be deleted permanently. |
|
| 211 | - * @return bool result |
|
| 212 | - */ |
|
| 213 | - public function delete( $force_delete = false ) { |
|
| 214 | - if ( $this->data_store && $this->exists() ) { |
|
| 215 | - $this->data_store->delete( $this, array( 'force_delete' => $force_delete ) ); |
|
| 216 | - $this->set_id( 0 ); |
|
| 217 | - return true; |
|
| 218 | - } |
|
| 219 | - return false; |
|
| 220 | - } |
|
| 221 | - |
|
| 222 | - /** |
|
| 223 | - * Save should create or update based on object existence. |
|
| 224 | - * |
|
| 225 | - * @since 1.0.19 |
|
| 226 | - * @return int |
|
| 227 | - */ |
|
| 228 | - public function save() { |
|
| 229 | - if ( ! $this->data_store ) { |
|
| 230 | - return $this->get_id(); |
|
| 231 | - } |
|
| 232 | - |
|
| 233 | - /** |
|
| 234 | - * Trigger action before saving to the DB. Allows you to adjust object props before save. |
|
| 235 | - * |
|
| 236 | - * @param GetPaid_Data $this The object being saved. |
|
| 237 | - * @param GetPaid_Data_Store_WP $data_store The data store persisting the data. |
|
| 238 | - */ |
|
| 239 | - do_action( 'getpaid_before_' . $this->object_type . '_object_save', $this, $this->data_store ); |
|
| 240 | - |
|
| 241 | - if ( $this->get_id() ) { |
|
| 242 | - $this->data_store->update( $this ); |
|
| 243 | - } else { |
|
| 244 | - $this->data_store->create( $this ); |
|
| 245 | - } |
|
| 246 | - |
|
| 247 | - /** |
|
| 248 | - * Trigger action after saving to the DB. |
|
| 249 | - * |
|
| 250 | - * @param GetPaid_Data $this The object being saved. |
|
| 251 | - * @param GetPaid_Data_Store_WP $data_store The data store persisting the data. |
|
| 252 | - */ |
|
| 253 | - do_action( 'getpaid_after_' . $this->object_type . '_object_save', $this, $this->data_store ); |
|
| 254 | - |
|
| 255 | - return $this->get_id(); |
|
| 256 | - } |
|
| 257 | - |
|
| 258 | - /** |
|
| 259 | - * Change data to JSON format. |
|
| 260 | - * |
|
| 261 | - * @since 1.0.19 |
|
| 262 | - * @return string Data in JSON format. |
|
| 263 | - */ |
|
| 264 | - public function __toString() { |
|
| 265 | - return wp_json_encode( $this->get_data() ); |
|
| 266 | - } |
|
| 267 | - |
|
| 268 | - /** |
|
| 269 | - * Returns all data for this object. |
|
| 270 | - * |
|
| 271 | - * @since 1.0.19 |
|
| 272 | - * @return array |
|
| 273 | - */ |
|
| 274 | - public function get_data() { |
|
| 275 | - return array_merge( array( 'id' => $this->get_id() ), $this->data, array( 'meta_data' => $this->get_meta_data() ) ); |
|
| 276 | - } |
|
| 277 | - |
|
| 278 | - /** |
|
| 279 | - * Returns array of expected data keys for this object. |
|
| 280 | - * |
|
| 281 | - * @since 1.0.19 |
|
| 282 | - * @return array |
|
| 283 | - */ |
|
| 284 | - public function get_data_keys() { |
|
| 285 | - return array_keys( $this->data ); |
|
| 286 | - } |
|
| 287 | - |
|
| 288 | - /** |
|
| 289 | - * Returns all "extra" data keys for an object (for sub objects like item types). |
|
| 290 | - * |
|
| 291 | - * @since 1.0.19 |
|
| 292 | - * @return array |
|
| 293 | - */ |
|
| 294 | - public function get_extra_data_keys() { |
|
| 295 | - return array_keys( $this->extra_data ); |
|
| 296 | - } |
|
| 297 | - |
|
| 298 | - /** |
|
| 299 | - * Filter null meta values from array. |
|
| 300 | - * |
|
| 301 | - * @since 1.0.19 |
|
| 302 | - * @param mixed $meta Meta value to check. |
|
| 303 | - * @return bool |
|
| 304 | - */ |
|
| 305 | - protected function filter_null_meta( $meta ) { |
|
| 306 | - return ! is_null( $meta->value ); |
|
| 307 | - } |
|
| 308 | - |
|
| 309 | - /** |
|
| 310 | - * Get All Meta Data. |
|
| 311 | - * |
|
| 312 | - * @since 1.0.19 |
|
| 313 | - * @return array of objects. |
|
| 314 | - */ |
|
| 315 | - public function get_meta_data() { |
|
| 316 | - $this->maybe_read_meta_data(); |
|
| 317 | - return array_values( array_filter( $this->meta_data, array( $this, 'filter_null_meta' ) ) ); |
|
| 318 | - } |
|
| 319 | - |
|
| 320 | - /** |
|
| 321 | - * Check if the key is an internal one. |
|
| 322 | - * |
|
| 323 | - * @since 1.0.19 |
|
| 324 | - * @param string $key Key to check. |
|
| 325 | - * @return bool true if it's an internal key, false otherwise |
|
| 326 | - */ |
|
| 327 | - protected function is_internal_meta_key( $key ) { |
|
| 328 | - $internal_meta_key = ! empty( $key ) && $this->data_store && in_array( $key, $this->data_store->get_internal_meta_keys(), true ); |
|
| 329 | - |
|
| 330 | - if ( ! $internal_meta_key ) { |
|
| 331 | - return false; |
|
| 332 | - } |
|
| 333 | - |
|
| 334 | - $has_setter_or_getter = is_callable( array( $this, 'set_' . $key ) ) || is_callable( array( $this, 'get_' . $key ) ); |
|
| 335 | - |
|
| 336 | - if ( ! $has_setter_or_getter ) { |
|
| 337 | - return false; |
|
| 338 | - } |
|
| 339 | - |
|
| 340 | - /* translators: %s: $key Key to check */ |
|
| 341 | - getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Generic add/update/get meta methods should not be used for internal meta data, including "%s". Use getters and setters.', 'invoicing' ), $key ), '1.0.19' ); |
|
| 342 | - |
|
| 343 | - return true; |
|
| 344 | - } |
|
| 345 | - |
|
| 346 | - /** |
|
| 347 | - * Magic method for setting data fields. |
|
| 348 | - * |
|
| 349 | - * This method does not update custom fields in the database. |
|
| 350 | - * |
|
| 351 | - * @since 1.0.19 |
|
| 352 | - * @access public |
|
| 353 | - * |
|
| 354 | - */ |
|
| 355 | - public function __set( $key, $value ) { |
|
| 356 | - |
|
| 357 | - if ( 'id' == strtolower( $key ) ) { |
|
| 358 | - return $this->set_id( $value ); |
|
| 359 | - } |
|
| 360 | - |
|
| 361 | - if ( method_exists( $this, "set_$key") ) { |
|
| 362 | - |
|
| 363 | - /* translators: %s: $key Key to set */ |
|
| 364 | - getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'invoicing' ), $key ), '1.0.19' ); |
|
| 365 | - |
|
| 366 | - call_user_func( array( $this, "set_$key" ), $value ); |
|
| 367 | - } else { |
|
| 368 | - $this->set_prop( $key, $value ); |
|
| 369 | - } |
|
| 370 | - |
|
| 371 | - } |
|
| 372 | - |
|
| 373 | - /** |
|
| 24 | + /** |
|
| 25 | + * ID for this object. |
|
| 26 | + * |
|
| 27 | + * @since 1.0.19 |
|
| 28 | + * @var int |
|
| 29 | + */ |
|
| 30 | + protected $id = 0; |
|
| 31 | + |
|
| 32 | + /** |
|
| 33 | + * Core data for this object. Name value pairs (name + default value). |
|
| 34 | + * |
|
| 35 | + * @since 1.0.19 |
|
| 36 | + * @var array |
|
| 37 | + */ |
|
| 38 | + protected $data = array(); |
|
| 39 | + |
|
| 40 | + /** |
|
| 41 | + * Core data changes for this object. |
|
| 42 | + * |
|
| 43 | + * @since 1.0.19 |
|
| 44 | + * @var array |
|
| 45 | + */ |
|
| 46 | + protected $changes = array(); |
|
| 47 | + |
|
| 48 | + /** |
|
| 49 | + * This is false until the object is read from the DB. |
|
| 50 | + * |
|
| 51 | + * @since 1.0.19 |
|
| 52 | + * @var bool |
|
| 53 | + */ |
|
| 54 | + protected $object_read = false; |
|
| 55 | + |
|
| 56 | + /** |
|
| 57 | + * This is the name of this object type. |
|
| 58 | + * |
|
| 59 | + * @since 1.0.19 |
|
| 60 | + * @var string |
|
| 61 | + */ |
|
| 62 | + protected $object_type = 'data'; |
|
| 63 | + |
|
| 64 | + /** |
|
| 65 | + * Extra data for this object. Name value pairs (name + default value). |
|
| 66 | + * Used as a standard way for sub classes (like item types) to add |
|
| 67 | + * additional information to an inherited class. |
|
| 68 | + * |
|
| 69 | + * @since 1.0.19 |
|
| 70 | + * @var array |
|
| 71 | + */ |
|
| 72 | + protected $extra_data = array(); |
|
| 73 | + |
|
| 74 | + /** |
|
| 75 | + * Set to _data on construct so we can track and reset data if needed. |
|
| 76 | + * |
|
| 77 | + * @since 1.0.19 |
|
| 78 | + * @var array |
|
| 79 | + */ |
|
| 80 | + protected $default_data = array(); |
|
| 81 | + |
|
| 82 | + /** |
|
| 83 | + * Contains a reference to the data store for this class. |
|
| 84 | + * |
|
| 85 | + * @since 1.0.19 |
|
| 86 | + * @var GetPaid_Data_Store |
|
| 87 | + */ |
|
| 88 | + protected $data_store; |
|
| 89 | + |
|
| 90 | + /** |
|
| 91 | + * Stores meta in cache for future reads. |
|
| 92 | + * A group must be set to to enable caching. |
|
| 93 | + * |
|
| 94 | + * @since 1.0.19 |
|
| 95 | + * @var string |
|
| 96 | + */ |
|
| 97 | + protected $cache_group = ''; |
|
| 98 | + |
|
| 99 | + /** |
|
| 100 | + * Stores the last error. |
|
| 101 | + * |
|
| 102 | + * @since 1.0.19 |
|
| 103 | + * @var string |
|
| 104 | + */ |
|
| 105 | + public $last_error = ''; |
|
| 106 | + |
|
| 107 | + /** |
|
| 108 | + * Stores additional meta data. |
|
| 109 | + * |
|
| 110 | + * @since 1.0.19 |
|
| 111 | + * @var array |
|
| 112 | + */ |
|
| 113 | + protected $meta_data = null; |
|
| 114 | + |
|
| 115 | + /** |
|
| 116 | + * Default constructor. |
|
| 117 | + * |
|
| 118 | + * @param int|object|array|string $read ID to load from the DB (optional) or already queried data. |
|
| 119 | + */ |
|
| 120 | + public function __construct( $read = 0 ) { |
|
| 121 | + $this->data = array_merge( $this->data, $this->extra_data ); |
|
| 122 | + $this->default_data = $this->data; |
|
| 123 | + } |
|
| 124 | + |
|
| 125 | + /** |
|
| 126 | + * Only store the object ID to avoid serializing the data object instance. |
|
| 127 | + * |
|
| 128 | + * @return array |
|
| 129 | + */ |
|
| 130 | + public function __sleep() { |
|
| 131 | + return array( 'id' ); |
|
| 132 | + } |
|
| 133 | + |
|
| 134 | + /** |
|
| 135 | + * Re-run the constructor with the object ID. |
|
| 136 | + * |
|
| 137 | + * If the object no longer exists, remove the ID. |
|
| 138 | + */ |
|
| 139 | + public function __wakeup() { |
|
| 140 | + $this->__construct( absint( $this->id ) ); |
|
| 141 | + |
|
| 142 | + if ( ! empty( $this->last_error ) ) { |
|
| 143 | + $this->set_id( 0 ); |
|
| 144 | + } |
|
| 145 | + |
|
| 146 | + } |
|
| 147 | + |
|
| 148 | + /** |
|
| 149 | + * When the object is cloned, make sure meta is duplicated correctly. |
|
| 150 | + * |
|
| 151 | + * @since 1.0.19 |
|
| 152 | + */ |
|
| 153 | + public function __clone() { |
|
| 154 | + $this->maybe_read_meta_data(); |
|
| 155 | + if ( ! empty( $this->meta_data ) ) { |
|
| 156 | + foreach ( $this->meta_data as $array_key => $meta ) { |
|
| 157 | + $this->meta_data[ $array_key ] = clone $meta; |
|
| 158 | + if ( ! empty( $meta->id ) ) { |
|
| 159 | + $this->meta_data[ $array_key ]->id = null; |
|
| 160 | + } |
|
| 161 | + } |
|
| 162 | + } |
|
| 163 | + } |
|
| 164 | + |
|
| 165 | + /** |
|
| 166 | + * Get the data store. |
|
| 167 | + * |
|
| 168 | + * @since 1.0.19 |
|
| 169 | + * @return object |
|
| 170 | + */ |
|
| 171 | + public function get_data_store() { |
|
| 172 | + return $this->data_store; |
|
| 173 | + } |
|
| 174 | + |
|
| 175 | + /** |
|
| 176 | + * Get the object type. |
|
| 177 | + * |
|
| 178 | + * @since 1.0.19 |
|
| 179 | + * @return string |
|
| 180 | + */ |
|
| 181 | + public function get_object_type() { |
|
| 182 | + return $this->object_type; |
|
| 183 | + } |
|
| 184 | + |
|
| 185 | + /** |
|
| 186 | + * Returns the unique ID for this object. |
|
| 187 | + * |
|
| 188 | + * @since 1.0.19 |
|
| 189 | + * @return int |
|
| 190 | + */ |
|
| 191 | + public function get_id() { |
|
| 192 | + return $this->id; |
|
| 193 | + } |
|
| 194 | + |
|
| 195 | + /** |
|
| 196 | + * Get form status. |
|
| 197 | + * |
|
| 198 | + * @since 1.0.19 |
|
| 199 | + * @param string $context View or edit context. |
|
| 200 | + * @return string |
|
| 201 | + */ |
|
| 202 | + public function get_status( $context = 'view' ) { |
|
| 203 | + return $this->get_prop( 'status', $context ); |
|
| 204 | + } |
|
| 205 | + |
|
| 206 | + /** |
|
| 207 | + * Delete an object, set the ID to 0, and return result. |
|
| 208 | + * |
|
| 209 | + * @since 1.0.19 |
|
| 210 | + * @param bool $force_delete Should the data be deleted permanently. |
|
| 211 | + * @return bool result |
|
| 212 | + */ |
|
| 213 | + public function delete( $force_delete = false ) { |
|
| 214 | + if ( $this->data_store && $this->exists() ) { |
|
| 215 | + $this->data_store->delete( $this, array( 'force_delete' => $force_delete ) ); |
|
| 216 | + $this->set_id( 0 ); |
|
| 217 | + return true; |
|
| 218 | + } |
|
| 219 | + return false; |
|
| 220 | + } |
|
| 221 | + |
|
| 222 | + /** |
|
| 223 | + * Save should create or update based on object existence. |
|
| 224 | + * |
|
| 225 | + * @since 1.0.19 |
|
| 226 | + * @return int |
|
| 227 | + */ |
|
| 228 | + public function save() { |
|
| 229 | + if ( ! $this->data_store ) { |
|
| 230 | + return $this->get_id(); |
|
| 231 | + } |
|
| 232 | + |
|
| 233 | + /** |
|
| 234 | + * Trigger action before saving to the DB. Allows you to adjust object props before save. |
|
| 235 | + * |
|
| 236 | + * @param GetPaid_Data $this The object being saved. |
|
| 237 | + * @param GetPaid_Data_Store_WP $data_store The data store persisting the data. |
|
| 238 | + */ |
|
| 239 | + do_action( 'getpaid_before_' . $this->object_type . '_object_save', $this, $this->data_store ); |
|
| 240 | + |
|
| 241 | + if ( $this->get_id() ) { |
|
| 242 | + $this->data_store->update( $this ); |
|
| 243 | + } else { |
|
| 244 | + $this->data_store->create( $this ); |
|
| 245 | + } |
|
| 246 | + |
|
| 247 | + /** |
|
| 248 | + * Trigger action after saving to the DB. |
|
| 249 | + * |
|
| 250 | + * @param GetPaid_Data $this The object being saved. |
|
| 251 | + * @param GetPaid_Data_Store_WP $data_store The data store persisting the data. |
|
| 252 | + */ |
|
| 253 | + do_action( 'getpaid_after_' . $this->object_type . '_object_save', $this, $this->data_store ); |
|
| 254 | + |
|
| 255 | + return $this->get_id(); |
|
| 256 | + } |
|
| 257 | + |
|
| 258 | + /** |
|
| 259 | + * Change data to JSON format. |
|
| 260 | + * |
|
| 261 | + * @since 1.0.19 |
|
| 262 | + * @return string Data in JSON format. |
|
| 263 | + */ |
|
| 264 | + public function __toString() { |
|
| 265 | + return wp_json_encode( $this->get_data() ); |
|
| 266 | + } |
|
| 267 | + |
|
| 268 | + /** |
|
| 269 | + * Returns all data for this object. |
|
| 270 | + * |
|
| 271 | + * @since 1.0.19 |
|
| 272 | + * @return array |
|
| 273 | + */ |
|
| 274 | + public function get_data() { |
|
| 275 | + return array_merge( array( 'id' => $this->get_id() ), $this->data, array( 'meta_data' => $this->get_meta_data() ) ); |
|
| 276 | + } |
|
| 277 | + |
|
| 278 | + /** |
|
| 279 | + * Returns array of expected data keys for this object. |
|
| 280 | + * |
|
| 281 | + * @since 1.0.19 |
|
| 282 | + * @return array |
|
| 283 | + */ |
|
| 284 | + public function get_data_keys() { |
|
| 285 | + return array_keys( $this->data ); |
|
| 286 | + } |
|
| 287 | + |
|
| 288 | + /** |
|
| 289 | + * Returns all "extra" data keys for an object (for sub objects like item types). |
|
| 290 | + * |
|
| 291 | + * @since 1.0.19 |
|
| 292 | + * @return array |
|
| 293 | + */ |
|
| 294 | + public function get_extra_data_keys() { |
|
| 295 | + return array_keys( $this->extra_data ); |
|
| 296 | + } |
|
| 297 | + |
|
| 298 | + /** |
|
| 299 | + * Filter null meta values from array. |
|
| 300 | + * |
|
| 301 | + * @since 1.0.19 |
|
| 302 | + * @param mixed $meta Meta value to check. |
|
| 303 | + * @return bool |
|
| 304 | + */ |
|
| 305 | + protected function filter_null_meta( $meta ) { |
|
| 306 | + return ! is_null( $meta->value ); |
|
| 307 | + } |
|
| 308 | + |
|
| 309 | + /** |
|
| 310 | + * Get All Meta Data. |
|
| 311 | + * |
|
| 312 | + * @since 1.0.19 |
|
| 313 | + * @return array of objects. |
|
| 314 | + */ |
|
| 315 | + public function get_meta_data() { |
|
| 316 | + $this->maybe_read_meta_data(); |
|
| 317 | + return array_values( array_filter( $this->meta_data, array( $this, 'filter_null_meta' ) ) ); |
|
| 318 | + } |
|
| 319 | + |
|
| 320 | + /** |
|
| 321 | + * Check if the key is an internal one. |
|
| 322 | + * |
|
| 323 | + * @since 1.0.19 |
|
| 324 | + * @param string $key Key to check. |
|
| 325 | + * @return bool true if it's an internal key, false otherwise |
|
| 326 | + */ |
|
| 327 | + protected function is_internal_meta_key( $key ) { |
|
| 328 | + $internal_meta_key = ! empty( $key ) && $this->data_store && in_array( $key, $this->data_store->get_internal_meta_keys(), true ); |
|
| 329 | + |
|
| 330 | + if ( ! $internal_meta_key ) { |
|
| 331 | + return false; |
|
| 332 | + } |
|
| 333 | + |
|
| 334 | + $has_setter_or_getter = is_callable( array( $this, 'set_' . $key ) ) || is_callable( array( $this, 'get_' . $key ) ); |
|
| 335 | + |
|
| 336 | + if ( ! $has_setter_or_getter ) { |
|
| 337 | + return false; |
|
| 338 | + } |
|
| 339 | + |
|
| 340 | + /* translators: %s: $key Key to check */ |
|
| 341 | + getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Generic add/update/get meta methods should not be used for internal meta data, including "%s". Use getters and setters.', 'invoicing' ), $key ), '1.0.19' ); |
|
| 342 | + |
|
| 343 | + return true; |
|
| 344 | + } |
|
| 345 | + |
|
| 346 | + /** |
|
| 347 | + * Magic method for setting data fields. |
|
| 348 | + * |
|
| 349 | + * This method does not update custom fields in the database. |
|
| 350 | + * |
|
| 351 | + * @since 1.0.19 |
|
| 352 | + * @access public |
|
| 353 | + * |
|
| 354 | + */ |
|
| 355 | + public function __set( $key, $value ) { |
|
| 356 | + |
|
| 357 | + if ( 'id' == strtolower( $key ) ) { |
|
| 358 | + return $this->set_id( $value ); |
|
| 359 | + } |
|
| 360 | + |
|
| 361 | + if ( method_exists( $this, "set_$key") ) { |
|
| 362 | + |
|
| 363 | + /* translators: %s: $key Key to set */ |
|
| 364 | + getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'invoicing' ), $key ), '1.0.19' ); |
|
| 365 | + |
|
| 366 | + call_user_func( array( $this, "set_$key" ), $value ); |
|
| 367 | + } else { |
|
| 368 | + $this->set_prop( $key, $value ); |
|
| 369 | + } |
|
| 370 | + |
|
| 371 | + } |
|
| 372 | + |
|
| 373 | + /** |
|
| 374 | 374 | * Margic method for retrieving a property. |
| 375 | 375 | */ |
| 376 | 376 | public function __get( $key ) { |
@@ -378,10 +378,10 @@ discard block |
||
| 378 | 378 | // Check if we have a helper method for that. |
| 379 | 379 | if ( method_exists( $this, 'get_' . $key ) ) { |
| 380 | 380 | |
| 381 | - if ( 'post_type' != $key ) { |
|
| 382 | - /* translators: %s: $key Key to set */ |
|
| 383 | - getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'invoicing' ), $key ), '1.0.19' ); |
|
| 384 | - } |
|
| 381 | + if ( 'post_type' != $key ) { |
|
| 382 | + /* translators: %s: $key Key to set */ |
|
| 383 | + getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'invoicing' ), $key ), '1.0.19' ); |
|
| 384 | + } |
|
| 385 | 385 | |
| 386 | 386 | return call_user_func( array( $this, 'get_' . $key ) ); |
| 387 | 387 | } |
@@ -391,512 +391,512 @@ discard block |
||
| 391 | 391 | return $this->post->$key; |
| 392 | 392 | } |
| 393 | 393 | |
| 394 | - return $this->get_prop( $key ); |
|
| 395 | - |
|
| 396 | - } |
|
| 397 | - |
|
| 398 | - /** |
|
| 399 | - * Get Meta Data by Key. |
|
| 400 | - * |
|
| 401 | - * @since 1.0.19 |
|
| 402 | - * @param string $key Meta Key. |
|
| 403 | - * @param bool $single return first found meta with key, or all with $key. |
|
| 404 | - * @param string $context What the value is for. Valid values are view and edit. |
|
| 405 | - * @return mixed |
|
| 406 | - */ |
|
| 407 | - public function get_meta( $key = '', $single = true, $context = 'view' ) { |
|
| 408 | - |
|
| 409 | - // Check if this is an internal meta key. |
|
| 410 | - $_key = str_replace( '_wpinv', '', $key ); |
|
| 411 | - $_key = str_replace( 'wpinv', '', $_key ); |
|
| 412 | - if ( $this->is_internal_meta_key( $_key ) ) { |
|
| 413 | - $function = 'get_' . $_key; |
|
| 414 | - |
|
| 415 | - if ( is_callable( array( $this, $function ) ) ) { |
|
| 416 | - return $this->{$function}(); |
|
| 417 | - } |
|
| 418 | - } |
|
| 419 | - |
|
| 420 | - // Read the meta data if not yet read. |
|
| 421 | - $this->maybe_read_meta_data(); |
|
| 422 | - $meta_data = $this->get_meta_data(); |
|
| 423 | - $array_keys = array_keys( wp_list_pluck( $meta_data, 'key' ), $key, true ); |
|
| 424 | - $value = $single ? '' : array(); |
|
| 425 | - |
|
| 426 | - if ( ! empty( $array_keys ) ) { |
|
| 427 | - // We don't use the $this->meta_data property directly here because we don't want meta with a null value (i.e. meta which has been deleted via $this->delete_meta_data()). |
|
| 428 | - if ( $single ) { |
|
| 429 | - $value = $meta_data[ current( $array_keys ) ]->value; |
|
| 430 | - } else { |
|
| 431 | - $value = array_intersect_key( $meta_data, array_flip( $array_keys ) ); |
|
| 432 | - } |
|
| 433 | - } |
|
| 434 | - |
|
| 435 | - if ( 'view' === $context ) { |
|
| 436 | - $value = apply_filters( $this->get_hook_prefix() . $key, $value, $this ); |
|
| 437 | - } |
|
| 438 | - |
|
| 439 | - return $value; |
|
| 440 | - } |
|
| 441 | - |
|
| 442 | - /** |
|
| 443 | - * See if meta data exists, since get_meta always returns a '' or array(). |
|
| 444 | - * |
|
| 445 | - * @since 1.0.19 |
|
| 446 | - * @param string $key Meta Key. |
|
| 447 | - * @return boolean |
|
| 448 | - */ |
|
| 449 | - public function meta_exists( $key = '' ) { |
|
| 450 | - $this->maybe_read_meta_data(); |
|
| 451 | - $array_keys = wp_list_pluck( $this->get_meta_data(), 'key' ); |
|
| 452 | - return in_array( $key, $array_keys, true ); |
|
| 453 | - } |
|
| 454 | - |
|
| 455 | - /** |
|
| 456 | - * Set all meta data from array. |
|
| 457 | - * |
|
| 458 | - * @since 1.0.19 |
|
| 459 | - * @param array $data Key/Value pairs. |
|
| 460 | - */ |
|
| 461 | - public function set_meta_data( $data ) { |
|
| 462 | - if ( ! empty( $data ) && is_array( $data ) ) { |
|
| 463 | - $this->maybe_read_meta_data(); |
|
| 464 | - foreach ( $data as $meta ) { |
|
| 465 | - $meta = (array) $meta; |
|
| 466 | - if ( isset( $meta['key'], $meta['value'], $meta['id'] ) ) { |
|
| 467 | - $this->meta_data[] = new GetPaid_Meta_Data( |
|
| 468 | - array( |
|
| 469 | - 'id' => $meta['id'], |
|
| 470 | - 'key' => $meta['key'], |
|
| 471 | - 'value' => $meta['value'], |
|
| 472 | - ) |
|
| 473 | - ); |
|
| 474 | - } |
|
| 475 | - } |
|
| 476 | - } |
|
| 477 | - } |
|
| 478 | - |
|
| 479 | - /** |
|
| 480 | - * Add meta data. |
|
| 481 | - * |
|
| 482 | - * @since 1.0.19 |
|
| 483 | - * |
|
| 484 | - * @param string $key Meta key. |
|
| 485 | - * @param string|array $value Meta value. |
|
| 486 | - * @param bool $unique Should this be a unique key?. |
|
| 487 | - */ |
|
| 488 | - public function add_meta_data( $key, $value, $unique = false ) { |
|
| 489 | - if ( $this->is_internal_meta_key( $key ) ) { |
|
| 490 | - $function = 'set_' . $key; |
|
| 491 | - |
|
| 492 | - if ( is_callable( array( $this, $function ) ) ) { |
|
| 493 | - return $this->{$function}( $value ); |
|
| 494 | - } |
|
| 495 | - } |
|
| 496 | - |
|
| 497 | - $this->maybe_read_meta_data(); |
|
| 498 | - if ( $unique ) { |
|
| 499 | - $this->delete_meta_data( $key ); |
|
| 500 | - } |
|
| 501 | - $this->meta_data[] = new GetPaid_Meta_Data( |
|
| 502 | - array( |
|
| 503 | - 'key' => $key, |
|
| 504 | - 'value' => $value, |
|
| 505 | - ) |
|
| 506 | - ); |
|
| 507 | - } |
|
| 508 | - |
|
| 509 | - /** |
|
| 510 | - * Update meta data by key or ID, if provided. |
|
| 511 | - * |
|
| 512 | - * @since 1.0.19 |
|
| 513 | - * |
|
| 514 | - * @param string $key Meta key. |
|
| 515 | - * @param string|array $value Meta value. |
|
| 516 | - * @param int $meta_id Meta ID. |
|
| 517 | - */ |
|
| 518 | - public function update_meta_data( $key, $value, $meta_id = 0 ) { |
|
| 519 | - if ( $this->is_internal_meta_key( $key ) ) { |
|
| 520 | - $function = 'set_' . $key; |
|
| 521 | - |
|
| 522 | - if ( is_callable( array( $this, $function ) ) ) { |
|
| 523 | - return $this->{$function}( $value ); |
|
| 524 | - } |
|
| 525 | - } |
|
| 526 | - |
|
| 527 | - $this->maybe_read_meta_data(); |
|
| 528 | - |
|
| 529 | - $array_key = false; |
|
| 530 | - |
|
| 531 | - if ( $meta_id ) { |
|
| 532 | - $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), $meta_id, true ); |
|
| 533 | - $array_key = $array_keys ? current( $array_keys ) : false; |
|
| 534 | - } else { |
|
| 535 | - // Find matches by key. |
|
| 536 | - $matches = array(); |
|
| 537 | - foreach ( $this->meta_data as $meta_data_array_key => $meta ) { |
|
| 538 | - if ( $meta->key === $key ) { |
|
| 539 | - $matches[] = $meta_data_array_key; |
|
| 540 | - } |
|
| 541 | - } |
|
| 542 | - |
|
| 543 | - if ( ! empty( $matches ) ) { |
|
| 544 | - // Set matches to null so only one key gets the new value. |
|
| 545 | - foreach ( $matches as $meta_data_array_key ) { |
|
| 546 | - $this->meta_data[ $meta_data_array_key ]->value = null; |
|
| 547 | - } |
|
| 548 | - $array_key = current( $matches ); |
|
| 549 | - } |
|
| 550 | - } |
|
| 551 | - |
|
| 552 | - if ( false !== $array_key ) { |
|
| 553 | - $meta = $this->meta_data[ $array_key ]; |
|
| 554 | - $meta->key = $key; |
|
| 555 | - $meta->value = $value; |
|
| 556 | - } else { |
|
| 557 | - $this->add_meta_data( $key, $value, true ); |
|
| 558 | - } |
|
| 559 | - } |
|
| 560 | - |
|
| 561 | - /** |
|
| 562 | - * Delete meta data. |
|
| 563 | - * |
|
| 564 | - * @since 1.0.19 |
|
| 565 | - * @param string $key Meta key. |
|
| 566 | - */ |
|
| 567 | - public function delete_meta_data( $key ) { |
|
| 568 | - $this->maybe_read_meta_data(); |
|
| 569 | - $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'key' ), $key, true ); |
|
| 570 | - |
|
| 571 | - if ( $array_keys ) { |
|
| 572 | - foreach ( $array_keys as $array_key ) { |
|
| 573 | - $this->meta_data[ $array_key ]->value = null; |
|
| 574 | - } |
|
| 575 | - } |
|
| 576 | - } |
|
| 577 | - |
|
| 578 | - /** |
|
| 579 | - * Delete meta data. |
|
| 580 | - * |
|
| 581 | - * @since 1.0.19 |
|
| 582 | - * @param int $mid Meta ID. |
|
| 583 | - */ |
|
| 584 | - public function delete_meta_data_by_mid( $mid ) { |
|
| 585 | - $this->maybe_read_meta_data(); |
|
| 586 | - $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), (int) $mid, true ); |
|
| 587 | - |
|
| 588 | - if ( $array_keys ) { |
|
| 589 | - foreach ( $array_keys as $array_key ) { |
|
| 590 | - $this->meta_data[ $array_key ]->value = null; |
|
| 591 | - } |
|
| 592 | - } |
|
| 593 | - } |
|
| 594 | - |
|
| 595 | - /** |
|
| 596 | - * Read meta data if null. |
|
| 597 | - * |
|
| 598 | - * @since 1.0.19 |
|
| 599 | - */ |
|
| 600 | - protected function maybe_read_meta_data() { |
|
| 601 | - if ( is_null( $this->meta_data ) ) { |
|
| 602 | - $this->read_meta_data(); |
|
| 603 | - } |
|
| 604 | - } |
|
| 605 | - |
|
| 606 | - /** |
|
| 607 | - * Read Meta Data from the database. Ignore any internal properties. |
|
| 608 | - * Uses it's own caches because get_metadata does not provide meta_ids. |
|
| 609 | - * |
|
| 610 | - * @since 1.0.19 |
|
| 611 | - * @param bool $force_read True to force a new DB read (and update cache). |
|
| 612 | - */ |
|
| 613 | - public function read_meta_data( $force_read = false ) { |
|
| 614 | - |
|
| 615 | - // Reset meta data. |
|
| 616 | - $this->meta_data = array(); |
|
| 617 | - |
|
| 618 | - // Maybe abort early. |
|
| 619 | - if ( ! $this->get_id() || ! $this->data_store ) { |
|
| 620 | - return; |
|
| 621 | - } |
|
| 622 | - |
|
| 623 | - // Only read from cache if the cache key is set. |
|
| 624 | - $cache_key = null; |
|
| 625 | - if ( ! $force_read && ! empty( $this->cache_group ) ) { |
|
| 626 | - $cache_key = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id(); |
|
| 627 | - $raw_meta_data = wp_cache_get( $cache_key, $this->cache_group ); |
|
| 628 | - } |
|
| 629 | - |
|
| 630 | - // Should we force read? |
|
| 631 | - if ( empty( $raw_meta_data ) ) { |
|
| 632 | - $raw_meta_data = $this->data_store->read_meta( $this ); |
|
| 633 | - |
|
| 634 | - if ( ! empty( $cache_key ) ) { |
|
| 635 | - wp_cache_set( $cache_key, $raw_meta_data, $this->cache_group ); |
|
| 636 | - } |
|
| 637 | - |
|
| 638 | - } |
|
| 639 | - |
|
| 640 | - // Set meta data. |
|
| 641 | - if ( is_array( $raw_meta_data ) ) { |
|
| 642 | - |
|
| 643 | - foreach ( $raw_meta_data as $meta ) { |
|
| 644 | - $this->meta_data[] = new GetPaid_Meta_Data( |
|
| 645 | - array( |
|
| 646 | - 'id' => (int) $meta->meta_id, |
|
| 647 | - 'key' => $meta->meta_key, |
|
| 648 | - 'value' => maybe_unserialize( $meta->meta_value ), |
|
| 649 | - ) |
|
| 650 | - ); |
|
| 651 | - } |
|
| 652 | - |
|
| 653 | - } |
|
| 654 | - |
|
| 655 | - } |
|
| 656 | - |
|
| 657 | - /** |
|
| 658 | - * Update Meta Data in the database. |
|
| 659 | - * |
|
| 660 | - * @since 1.0.19 |
|
| 661 | - */ |
|
| 662 | - public function save_meta_data() { |
|
| 663 | - if ( ! $this->data_store || is_null( $this->meta_data ) ) { |
|
| 664 | - return; |
|
| 665 | - } |
|
| 666 | - foreach ( $this->meta_data as $array_key => $meta ) { |
|
| 667 | - if ( is_null( $meta->value ) ) { |
|
| 668 | - if ( ! empty( $meta->id ) ) { |
|
| 669 | - $this->data_store->delete_meta( $this, $meta ); |
|
| 670 | - unset( $this->meta_data[ $array_key ] ); |
|
| 671 | - } |
|
| 672 | - } elseif ( empty( $meta->id ) ) { |
|
| 673 | - $meta->id = $this->data_store->add_meta( $this, $meta ); |
|
| 674 | - $meta->apply_changes(); |
|
| 675 | - } else { |
|
| 676 | - if ( $meta->get_changes() ) { |
|
| 677 | - $this->data_store->update_meta( $this, $meta ); |
|
| 678 | - $meta->apply_changes(); |
|
| 679 | - } |
|
| 680 | - } |
|
| 681 | - } |
|
| 682 | - if ( ! empty( $this->cache_group ) ) { |
|
| 683 | - $cache_key = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id(); |
|
| 684 | - wp_cache_delete( $cache_key, $this->cache_group ); |
|
| 685 | - } |
|
| 686 | - } |
|
| 687 | - |
|
| 688 | - /** |
|
| 689 | - * Set ID. |
|
| 690 | - * |
|
| 691 | - * @since 1.0.19 |
|
| 692 | - * @param int $id ID. |
|
| 693 | - */ |
|
| 694 | - public function set_id( $id ) { |
|
| 695 | - $this->id = absint( $id ); |
|
| 696 | - } |
|
| 697 | - |
|
| 698 | - /** |
|
| 699 | - * Sets item status. |
|
| 700 | - * |
|
| 701 | - * @since 1.0.19 |
|
| 702 | - * @param string $status New status. |
|
| 703 | - * @return array details of change. |
|
| 704 | - */ |
|
| 705 | - public function set_status( $status ) { |
|
| 394 | + return $this->get_prop( $key ); |
|
| 395 | + |
|
| 396 | + } |
|
| 397 | + |
|
| 398 | + /** |
|
| 399 | + * Get Meta Data by Key. |
|
| 400 | + * |
|
| 401 | + * @since 1.0.19 |
|
| 402 | + * @param string $key Meta Key. |
|
| 403 | + * @param bool $single return first found meta with key, or all with $key. |
|
| 404 | + * @param string $context What the value is for. Valid values are view and edit. |
|
| 405 | + * @return mixed |
|
| 406 | + */ |
|
| 407 | + public function get_meta( $key = '', $single = true, $context = 'view' ) { |
|
| 408 | + |
|
| 409 | + // Check if this is an internal meta key. |
|
| 410 | + $_key = str_replace( '_wpinv', '', $key ); |
|
| 411 | + $_key = str_replace( 'wpinv', '', $_key ); |
|
| 412 | + if ( $this->is_internal_meta_key( $_key ) ) { |
|
| 413 | + $function = 'get_' . $_key; |
|
| 414 | + |
|
| 415 | + if ( is_callable( array( $this, $function ) ) ) { |
|
| 416 | + return $this->{$function}(); |
|
| 417 | + } |
|
| 418 | + } |
|
| 419 | + |
|
| 420 | + // Read the meta data if not yet read. |
|
| 421 | + $this->maybe_read_meta_data(); |
|
| 422 | + $meta_data = $this->get_meta_data(); |
|
| 423 | + $array_keys = array_keys( wp_list_pluck( $meta_data, 'key' ), $key, true ); |
|
| 424 | + $value = $single ? '' : array(); |
|
| 425 | + |
|
| 426 | + if ( ! empty( $array_keys ) ) { |
|
| 427 | + // We don't use the $this->meta_data property directly here because we don't want meta with a null value (i.e. meta which has been deleted via $this->delete_meta_data()). |
|
| 428 | + if ( $single ) { |
|
| 429 | + $value = $meta_data[ current( $array_keys ) ]->value; |
|
| 430 | + } else { |
|
| 431 | + $value = array_intersect_key( $meta_data, array_flip( $array_keys ) ); |
|
| 432 | + } |
|
| 433 | + } |
|
| 434 | + |
|
| 435 | + if ( 'view' === $context ) { |
|
| 436 | + $value = apply_filters( $this->get_hook_prefix() . $key, $value, $this ); |
|
| 437 | + } |
|
| 438 | + |
|
| 439 | + return $value; |
|
| 440 | + } |
|
| 441 | + |
|
| 442 | + /** |
|
| 443 | + * See if meta data exists, since get_meta always returns a '' or array(). |
|
| 444 | + * |
|
| 445 | + * @since 1.0.19 |
|
| 446 | + * @param string $key Meta Key. |
|
| 447 | + * @return boolean |
|
| 448 | + */ |
|
| 449 | + public function meta_exists( $key = '' ) { |
|
| 450 | + $this->maybe_read_meta_data(); |
|
| 451 | + $array_keys = wp_list_pluck( $this->get_meta_data(), 'key' ); |
|
| 452 | + return in_array( $key, $array_keys, true ); |
|
| 453 | + } |
|
| 454 | + |
|
| 455 | + /** |
|
| 456 | + * Set all meta data from array. |
|
| 457 | + * |
|
| 458 | + * @since 1.0.19 |
|
| 459 | + * @param array $data Key/Value pairs. |
|
| 460 | + */ |
|
| 461 | + public function set_meta_data( $data ) { |
|
| 462 | + if ( ! empty( $data ) && is_array( $data ) ) { |
|
| 463 | + $this->maybe_read_meta_data(); |
|
| 464 | + foreach ( $data as $meta ) { |
|
| 465 | + $meta = (array) $meta; |
|
| 466 | + if ( isset( $meta['key'], $meta['value'], $meta['id'] ) ) { |
|
| 467 | + $this->meta_data[] = new GetPaid_Meta_Data( |
|
| 468 | + array( |
|
| 469 | + 'id' => $meta['id'], |
|
| 470 | + 'key' => $meta['key'], |
|
| 471 | + 'value' => $meta['value'], |
|
| 472 | + ) |
|
| 473 | + ); |
|
| 474 | + } |
|
| 475 | + } |
|
| 476 | + } |
|
| 477 | + } |
|
| 478 | + |
|
| 479 | + /** |
|
| 480 | + * Add meta data. |
|
| 481 | + * |
|
| 482 | + * @since 1.0.19 |
|
| 483 | + * |
|
| 484 | + * @param string $key Meta key. |
|
| 485 | + * @param string|array $value Meta value. |
|
| 486 | + * @param bool $unique Should this be a unique key?. |
|
| 487 | + */ |
|
| 488 | + public function add_meta_data( $key, $value, $unique = false ) { |
|
| 489 | + if ( $this->is_internal_meta_key( $key ) ) { |
|
| 490 | + $function = 'set_' . $key; |
|
| 491 | + |
|
| 492 | + if ( is_callable( array( $this, $function ) ) ) { |
|
| 493 | + return $this->{$function}( $value ); |
|
| 494 | + } |
|
| 495 | + } |
|
| 496 | + |
|
| 497 | + $this->maybe_read_meta_data(); |
|
| 498 | + if ( $unique ) { |
|
| 499 | + $this->delete_meta_data( $key ); |
|
| 500 | + } |
|
| 501 | + $this->meta_data[] = new GetPaid_Meta_Data( |
|
| 502 | + array( |
|
| 503 | + 'key' => $key, |
|
| 504 | + 'value' => $value, |
|
| 505 | + ) |
|
| 506 | + ); |
|
| 507 | + } |
|
| 508 | + |
|
| 509 | + /** |
|
| 510 | + * Update meta data by key or ID, if provided. |
|
| 511 | + * |
|
| 512 | + * @since 1.0.19 |
|
| 513 | + * |
|
| 514 | + * @param string $key Meta key. |
|
| 515 | + * @param string|array $value Meta value. |
|
| 516 | + * @param int $meta_id Meta ID. |
|
| 517 | + */ |
|
| 518 | + public function update_meta_data( $key, $value, $meta_id = 0 ) { |
|
| 519 | + if ( $this->is_internal_meta_key( $key ) ) { |
|
| 520 | + $function = 'set_' . $key; |
|
| 521 | + |
|
| 522 | + if ( is_callable( array( $this, $function ) ) ) { |
|
| 523 | + return $this->{$function}( $value ); |
|
| 524 | + } |
|
| 525 | + } |
|
| 526 | + |
|
| 527 | + $this->maybe_read_meta_data(); |
|
| 528 | + |
|
| 529 | + $array_key = false; |
|
| 530 | + |
|
| 531 | + if ( $meta_id ) { |
|
| 532 | + $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), $meta_id, true ); |
|
| 533 | + $array_key = $array_keys ? current( $array_keys ) : false; |
|
| 534 | + } else { |
|
| 535 | + // Find matches by key. |
|
| 536 | + $matches = array(); |
|
| 537 | + foreach ( $this->meta_data as $meta_data_array_key => $meta ) { |
|
| 538 | + if ( $meta->key === $key ) { |
|
| 539 | + $matches[] = $meta_data_array_key; |
|
| 540 | + } |
|
| 541 | + } |
|
| 542 | + |
|
| 543 | + if ( ! empty( $matches ) ) { |
|
| 544 | + // Set matches to null so only one key gets the new value. |
|
| 545 | + foreach ( $matches as $meta_data_array_key ) { |
|
| 546 | + $this->meta_data[ $meta_data_array_key ]->value = null; |
|
| 547 | + } |
|
| 548 | + $array_key = current( $matches ); |
|
| 549 | + } |
|
| 550 | + } |
|
| 551 | + |
|
| 552 | + if ( false !== $array_key ) { |
|
| 553 | + $meta = $this->meta_data[ $array_key ]; |
|
| 554 | + $meta->key = $key; |
|
| 555 | + $meta->value = $value; |
|
| 556 | + } else { |
|
| 557 | + $this->add_meta_data( $key, $value, true ); |
|
| 558 | + } |
|
| 559 | + } |
|
| 560 | + |
|
| 561 | + /** |
|
| 562 | + * Delete meta data. |
|
| 563 | + * |
|
| 564 | + * @since 1.0.19 |
|
| 565 | + * @param string $key Meta key. |
|
| 566 | + */ |
|
| 567 | + public function delete_meta_data( $key ) { |
|
| 568 | + $this->maybe_read_meta_data(); |
|
| 569 | + $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'key' ), $key, true ); |
|
| 570 | + |
|
| 571 | + if ( $array_keys ) { |
|
| 572 | + foreach ( $array_keys as $array_key ) { |
|
| 573 | + $this->meta_data[ $array_key ]->value = null; |
|
| 574 | + } |
|
| 575 | + } |
|
| 576 | + } |
|
| 577 | + |
|
| 578 | + /** |
|
| 579 | + * Delete meta data. |
|
| 580 | + * |
|
| 581 | + * @since 1.0.19 |
|
| 582 | + * @param int $mid Meta ID. |
|
| 583 | + */ |
|
| 584 | + public function delete_meta_data_by_mid( $mid ) { |
|
| 585 | + $this->maybe_read_meta_data(); |
|
| 586 | + $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), (int) $mid, true ); |
|
| 587 | + |
|
| 588 | + if ( $array_keys ) { |
|
| 589 | + foreach ( $array_keys as $array_key ) { |
|
| 590 | + $this->meta_data[ $array_key ]->value = null; |
|
| 591 | + } |
|
| 592 | + } |
|
| 593 | + } |
|
| 594 | + |
|
| 595 | + /** |
|
| 596 | + * Read meta data if null. |
|
| 597 | + * |
|
| 598 | + * @since 1.0.19 |
|
| 599 | + */ |
|
| 600 | + protected function maybe_read_meta_data() { |
|
| 601 | + if ( is_null( $this->meta_data ) ) { |
|
| 602 | + $this->read_meta_data(); |
|
| 603 | + } |
|
| 604 | + } |
|
| 605 | + |
|
| 606 | + /** |
|
| 607 | + * Read Meta Data from the database. Ignore any internal properties. |
|
| 608 | + * Uses it's own caches because get_metadata does not provide meta_ids. |
|
| 609 | + * |
|
| 610 | + * @since 1.0.19 |
|
| 611 | + * @param bool $force_read True to force a new DB read (and update cache). |
|
| 612 | + */ |
|
| 613 | + public function read_meta_data( $force_read = false ) { |
|
| 614 | + |
|
| 615 | + // Reset meta data. |
|
| 616 | + $this->meta_data = array(); |
|
| 617 | + |
|
| 618 | + // Maybe abort early. |
|
| 619 | + if ( ! $this->get_id() || ! $this->data_store ) { |
|
| 620 | + return; |
|
| 621 | + } |
|
| 622 | + |
|
| 623 | + // Only read from cache if the cache key is set. |
|
| 624 | + $cache_key = null; |
|
| 625 | + if ( ! $force_read && ! empty( $this->cache_group ) ) { |
|
| 626 | + $cache_key = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id(); |
|
| 627 | + $raw_meta_data = wp_cache_get( $cache_key, $this->cache_group ); |
|
| 628 | + } |
|
| 629 | + |
|
| 630 | + // Should we force read? |
|
| 631 | + if ( empty( $raw_meta_data ) ) { |
|
| 632 | + $raw_meta_data = $this->data_store->read_meta( $this ); |
|
| 633 | + |
|
| 634 | + if ( ! empty( $cache_key ) ) { |
|
| 635 | + wp_cache_set( $cache_key, $raw_meta_data, $this->cache_group ); |
|
| 636 | + } |
|
| 637 | + |
|
| 638 | + } |
|
| 639 | + |
|
| 640 | + // Set meta data. |
|
| 641 | + if ( is_array( $raw_meta_data ) ) { |
|
| 642 | + |
|
| 643 | + foreach ( $raw_meta_data as $meta ) { |
|
| 644 | + $this->meta_data[] = new GetPaid_Meta_Data( |
|
| 645 | + array( |
|
| 646 | + 'id' => (int) $meta->meta_id, |
|
| 647 | + 'key' => $meta->meta_key, |
|
| 648 | + 'value' => maybe_unserialize( $meta->meta_value ), |
|
| 649 | + ) |
|
| 650 | + ); |
|
| 651 | + } |
|
| 652 | + |
|
| 653 | + } |
|
| 654 | + |
|
| 655 | + } |
|
| 656 | + |
|
| 657 | + /** |
|
| 658 | + * Update Meta Data in the database. |
|
| 659 | + * |
|
| 660 | + * @since 1.0.19 |
|
| 661 | + */ |
|
| 662 | + public function save_meta_data() { |
|
| 663 | + if ( ! $this->data_store || is_null( $this->meta_data ) ) { |
|
| 664 | + return; |
|
| 665 | + } |
|
| 666 | + foreach ( $this->meta_data as $array_key => $meta ) { |
|
| 667 | + if ( is_null( $meta->value ) ) { |
|
| 668 | + if ( ! empty( $meta->id ) ) { |
|
| 669 | + $this->data_store->delete_meta( $this, $meta ); |
|
| 670 | + unset( $this->meta_data[ $array_key ] ); |
|
| 671 | + } |
|
| 672 | + } elseif ( empty( $meta->id ) ) { |
|
| 673 | + $meta->id = $this->data_store->add_meta( $this, $meta ); |
|
| 674 | + $meta->apply_changes(); |
|
| 675 | + } else { |
|
| 676 | + if ( $meta->get_changes() ) { |
|
| 677 | + $this->data_store->update_meta( $this, $meta ); |
|
| 678 | + $meta->apply_changes(); |
|
| 679 | + } |
|
| 680 | + } |
|
| 681 | + } |
|
| 682 | + if ( ! empty( $this->cache_group ) ) { |
|
| 683 | + $cache_key = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id(); |
|
| 684 | + wp_cache_delete( $cache_key, $this->cache_group ); |
|
| 685 | + } |
|
| 686 | + } |
|
| 687 | + |
|
| 688 | + /** |
|
| 689 | + * Set ID. |
|
| 690 | + * |
|
| 691 | + * @since 1.0.19 |
|
| 692 | + * @param int $id ID. |
|
| 693 | + */ |
|
| 694 | + public function set_id( $id ) { |
|
| 695 | + $this->id = absint( $id ); |
|
| 696 | + } |
|
| 697 | + |
|
| 698 | + /** |
|
| 699 | + * Sets item status. |
|
| 700 | + * |
|
| 701 | + * @since 1.0.19 |
|
| 702 | + * @param string $status New status. |
|
| 703 | + * @return array details of change. |
|
| 704 | + */ |
|
| 705 | + public function set_status( $status ) { |
|
| 706 | 706 | $old_status = $this->get_status(); |
| 707 | 707 | |
| 708 | - $this->set_prop( 'status', $status ); |
|
| 709 | - |
|
| 710 | - return array( |
|
| 711 | - 'from' => $old_status, |
|
| 712 | - 'to' => $status, |
|
| 713 | - ); |
|
| 714 | - } |
|
| 715 | - |
|
| 716 | - /** |
|
| 717 | - * Set all props to default values. |
|
| 718 | - * |
|
| 719 | - * @since 1.0.19 |
|
| 720 | - */ |
|
| 721 | - public function set_defaults() { |
|
| 722 | - $this->data = $this->default_data; |
|
| 723 | - $this->changes = array(); |
|
| 724 | - $this->set_object_read( false ); |
|
| 725 | - } |
|
| 726 | - |
|
| 727 | - /** |
|
| 728 | - * Set object read property. |
|
| 729 | - * |
|
| 730 | - * @since 1.0.19 |
|
| 731 | - * @param boolean $read Should read?. |
|
| 732 | - */ |
|
| 733 | - public function set_object_read( $read = true ) { |
|
| 734 | - $this->object_read = (bool) $read; |
|
| 735 | - } |
|
| 736 | - |
|
| 737 | - /** |
|
| 738 | - * Get object read property. |
|
| 739 | - * |
|
| 740 | - * @since 1.0.19 |
|
| 741 | - * @return boolean |
|
| 742 | - */ |
|
| 743 | - public function get_object_read() { |
|
| 744 | - return (bool) $this->object_read; |
|
| 745 | - } |
|
| 746 | - |
|
| 747 | - /** |
|
| 748 | - * Set a collection of props in one go, collect any errors, and return the result. |
|
| 749 | - * Only sets using public methods. |
|
| 750 | - * |
|
| 751 | - * @since 1.0.19 |
|
| 752 | - * |
|
| 753 | - * @param array $props Key value pairs to set. Key is the prop and should map to a setter function name. |
|
| 754 | - * @param string $context In what context to run this. |
|
| 755 | - * |
|
| 756 | - * @return bool|WP_Error |
|
| 757 | - */ |
|
| 758 | - public function set_props( $props, $context = 'set' ) { |
|
| 759 | - $errors = false; |
|
| 760 | - |
|
| 761 | - foreach ( $props as $prop => $value ) { |
|
| 762 | - try { |
|
| 763 | - /** |
|
| 764 | - * Checks if the prop being set is allowed, and the value is not null. |
|
| 765 | - */ |
|
| 766 | - if ( is_null( $value ) || in_array( $prop, array( 'prop', 'date_prop', 'meta_data' ), true ) ) { |
|
| 767 | - continue; |
|
| 768 | - } |
|
| 769 | - $setter = "set_$prop"; |
|
| 770 | - |
|
| 771 | - if ( is_callable( array( $this, $setter ) ) ) { |
|
| 772 | - $this->{$setter}( $value ); |
|
| 773 | - } |
|
| 774 | - } catch ( Exception $e ) { |
|
| 775 | - if ( ! $errors ) { |
|
| 776 | - $errors = new WP_Error(); |
|
| 777 | - } |
|
| 778 | - $errors->add( $e->getCode(), $e->getMessage() ); |
|
| 779 | - $this->last_error = $e->getMessage(); |
|
| 780 | - } |
|
| 781 | - } |
|
| 782 | - |
|
| 783 | - return $errors && count( $errors->get_error_codes() ) ? $errors : true; |
|
| 784 | - } |
|
| 785 | - |
|
| 786 | - /** |
|
| 787 | - * Sets a prop for a setter method. |
|
| 788 | - * |
|
| 789 | - * This stores changes in a special array so we can track what needs saving |
|
| 790 | - * the the DB later. |
|
| 791 | - * |
|
| 792 | - * @since 1.0.19 |
|
| 793 | - * @param string $prop Name of prop to set. |
|
| 794 | - * @param mixed $value Value of the prop. |
|
| 795 | - */ |
|
| 796 | - protected function set_prop( $prop, $value ) { |
|
| 797 | - if ( array_key_exists( $prop, $this->data ) ) { |
|
| 798 | - if ( true === $this->object_read ) { |
|
| 799 | - if ( $value !== $this->data[ $prop ] || array_key_exists( $prop, $this->changes ) ) { |
|
| 800 | - $this->changes[ $prop ] = $value; |
|
| 801 | - } |
|
| 802 | - } else { |
|
| 803 | - $this->data[ $prop ] = $value; |
|
| 804 | - } |
|
| 805 | - } |
|
| 806 | - } |
|
| 807 | - |
|
| 808 | - /** |
|
| 809 | - * Return data changes only. |
|
| 810 | - * |
|
| 811 | - * @since 1.0.19 |
|
| 812 | - * @return array |
|
| 813 | - */ |
|
| 814 | - public function get_changes() { |
|
| 815 | - return $this->changes; |
|
| 816 | - } |
|
| 817 | - |
|
| 818 | - /** |
|
| 819 | - * Merge changes with data and clear. |
|
| 820 | - * |
|
| 821 | - * @since 1.0.19 |
|
| 822 | - */ |
|
| 823 | - public function apply_changes() { |
|
| 824 | - $this->data = array_replace_recursive( $this->data, $this->changes ); |
|
| 825 | - $this->changes = array(); |
|
| 826 | - } |
|
| 827 | - |
|
| 828 | - /** |
|
| 829 | - * Prefix for action and filter hooks on data. |
|
| 830 | - * |
|
| 831 | - * @since 1.0.19 |
|
| 832 | - * @return string |
|
| 833 | - */ |
|
| 834 | - protected function get_hook_prefix() { |
|
| 835 | - return 'wpinv_get_' . $this->object_type . '_'; |
|
| 836 | - } |
|
| 837 | - |
|
| 838 | - /** |
|
| 839 | - * Gets a prop for a getter method. |
|
| 840 | - * |
|
| 841 | - * Gets the value from either current pending changes, or the data itself. |
|
| 842 | - * Context controls what happens to the value before it's returned. |
|
| 843 | - * |
|
| 844 | - * @since 1.0.19 |
|
| 845 | - * @param string $prop Name of prop to get. |
|
| 846 | - * @param string $context What the value is for. Valid values are view and edit. |
|
| 847 | - * @return mixed |
|
| 848 | - */ |
|
| 849 | - protected function get_prop( $prop, $context = 'view' ) { |
|
| 850 | - $value = null; |
|
| 851 | - |
|
| 852 | - if ( array_key_exists( $prop, $this->data ) ) { |
|
| 853 | - $value = array_key_exists( $prop, $this->changes ) ? $this->changes[ $prop ] : $this->data[ $prop ]; |
|
| 854 | - |
|
| 855 | - if ( 'view' === $context ) { |
|
| 856 | - $value = apply_filters( $this->get_hook_prefix() . $prop, $value, $this ); |
|
| 857 | - } |
|
| 858 | - } |
|
| 859 | - |
|
| 860 | - return $value; |
|
| 861 | - } |
|
| 862 | - |
|
| 863 | - /** |
|
| 864 | - * Sets a date prop whilst handling formatting and datetime objects. |
|
| 865 | - * |
|
| 866 | - * @since 1.0.19 |
|
| 867 | - * @param string $prop Name of prop to set. |
|
| 868 | - * @param string|integer $value Value of the prop. |
|
| 869 | - */ |
|
| 870 | - protected function set_date_prop( $prop, $value ) { |
|
| 871 | - |
|
| 872 | - if ( empty( $value ) ) { |
|
| 873 | - $this->set_prop( $prop, null ); |
|
| 874 | - return; |
|
| 875 | - } |
|
| 876 | - $this->set_prop( $prop, $value ); |
|
| 877 | - |
|
| 878 | - } |
|
| 879 | - |
|
| 880 | - /** |
|
| 881 | - * When invalid data is found, throw an exception unless reading from the DB. |
|
| 882 | - * |
|
| 883 | - * @since 1.0.19 |
|
| 884 | - * @param string $code Error code. |
|
| 885 | - * @param string $message Error message. |
|
| 886 | - */ |
|
| 887 | - protected function error( $code, $message ) { |
|
| 888 | - $this->last_error = $message; |
|
| 889 | - } |
|
| 890 | - |
|
| 891 | - /** |
|
| 892 | - * Checks if the object is saved in the database |
|
| 893 | - * |
|
| 894 | - * @since 1.0.19 |
|
| 895 | - * @return bool |
|
| 896 | - */ |
|
| 897 | - public function exists() { |
|
| 898 | - $id = $this->get_id(); |
|
| 899 | - return ! empty( $id ); |
|
| 900 | - } |
|
| 708 | + $this->set_prop( 'status', $status ); |
|
| 709 | + |
|
| 710 | + return array( |
|
| 711 | + 'from' => $old_status, |
|
| 712 | + 'to' => $status, |
|
| 713 | + ); |
|
| 714 | + } |
|
| 715 | + |
|
| 716 | + /** |
|
| 717 | + * Set all props to default values. |
|
| 718 | + * |
|
| 719 | + * @since 1.0.19 |
|
| 720 | + */ |
|
| 721 | + public function set_defaults() { |
|
| 722 | + $this->data = $this->default_data; |
|
| 723 | + $this->changes = array(); |
|
| 724 | + $this->set_object_read( false ); |
|
| 725 | + } |
|
| 726 | + |
|
| 727 | + /** |
|
| 728 | + * Set object read property. |
|
| 729 | + * |
|
| 730 | + * @since 1.0.19 |
|
| 731 | + * @param boolean $read Should read?. |
|
| 732 | + */ |
|
| 733 | + public function set_object_read( $read = true ) { |
|
| 734 | + $this->object_read = (bool) $read; |
|
| 735 | + } |
|
| 736 | + |
|
| 737 | + /** |
|
| 738 | + * Get object read property. |
|
| 739 | + * |
|
| 740 | + * @since 1.0.19 |
|
| 741 | + * @return boolean |
|
| 742 | + */ |
|
| 743 | + public function get_object_read() { |
|
| 744 | + return (bool) $this->object_read; |
|
| 745 | + } |
|
| 746 | + |
|
| 747 | + /** |
|
| 748 | + * Set a collection of props in one go, collect any errors, and return the result. |
|
| 749 | + * Only sets using public methods. |
|
| 750 | + * |
|
| 751 | + * @since 1.0.19 |
|
| 752 | + * |
|
| 753 | + * @param array $props Key value pairs to set. Key is the prop and should map to a setter function name. |
|
| 754 | + * @param string $context In what context to run this. |
|
| 755 | + * |
|
| 756 | + * @return bool|WP_Error |
|
| 757 | + */ |
|
| 758 | + public function set_props( $props, $context = 'set' ) { |
|
| 759 | + $errors = false; |
|
| 760 | + |
|
| 761 | + foreach ( $props as $prop => $value ) { |
|
| 762 | + try { |
|
| 763 | + /** |
|
| 764 | + * Checks if the prop being set is allowed, and the value is not null. |
|
| 765 | + */ |
|
| 766 | + if ( is_null( $value ) || in_array( $prop, array( 'prop', 'date_prop', 'meta_data' ), true ) ) { |
|
| 767 | + continue; |
|
| 768 | + } |
|
| 769 | + $setter = "set_$prop"; |
|
| 770 | + |
|
| 771 | + if ( is_callable( array( $this, $setter ) ) ) { |
|
| 772 | + $this->{$setter}( $value ); |
|
| 773 | + } |
|
| 774 | + } catch ( Exception $e ) { |
|
| 775 | + if ( ! $errors ) { |
|
| 776 | + $errors = new WP_Error(); |
|
| 777 | + } |
|
| 778 | + $errors->add( $e->getCode(), $e->getMessage() ); |
|
| 779 | + $this->last_error = $e->getMessage(); |
|
| 780 | + } |
|
| 781 | + } |
|
| 782 | + |
|
| 783 | + return $errors && count( $errors->get_error_codes() ) ? $errors : true; |
|
| 784 | + } |
|
| 785 | + |
|
| 786 | + /** |
|
| 787 | + * Sets a prop for a setter method. |
|
| 788 | + * |
|
| 789 | + * This stores changes in a special array so we can track what needs saving |
|
| 790 | + * the the DB later. |
|
| 791 | + * |
|
| 792 | + * @since 1.0.19 |
|
| 793 | + * @param string $prop Name of prop to set. |
|
| 794 | + * @param mixed $value Value of the prop. |
|
| 795 | + */ |
|
| 796 | + protected function set_prop( $prop, $value ) { |
|
| 797 | + if ( array_key_exists( $prop, $this->data ) ) { |
|
| 798 | + if ( true === $this->object_read ) { |
|
| 799 | + if ( $value !== $this->data[ $prop ] || array_key_exists( $prop, $this->changes ) ) { |
|
| 800 | + $this->changes[ $prop ] = $value; |
|
| 801 | + } |
|
| 802 | + } else { |
|
| 803 | + $this->data[ $prop ] = $value; |
|
| 804 | + } |
|
| 805 | + } |
|
| 806 | + } |
|
| 807 | + |
|
| 808 | + /** |
|
| 809 | + * Return data changes only. |
|
| 810 | + * |
|
| 811 | + * @since 1.0.19 |
|
| 812 | + * @return array |
|
| 813 | + */ |
|
| 814 | + public function get_changes() { |
|
| 815 | + return $this->changes; |
|
| 816 | + } |
|
| 817 | + |
|
| 818 | + /** |
|
| 819 | + * Merge changes with data and clear. |
|
| 820 | + * |
|
| 821 | + * @since 1.0.19 |
|
| 822 | + */ |
|
| 823 | + public function apply_changes() { |
|
| 824 | + $this->data = array_replace_recursive( $this->data, $this->changes ); |
|
| 825 | + $this->changes = array(); |
|
| 826 | + } |
|
| 827 | + |
|
| 828 | + /** |
|
| 829 | + * Prefix for action and filter hooks on data. |
|
| 830 | + * |
|
| 831 | + * @since 1.0.19 |
|
| 832 | + * @return string |
|
| 833 | + */ |
|
| 834 | + protected function get_hook_prefix() { |
|
| 835 | + return 'wpinv_get_' . $this->object_type . '_'; |
|
| 836 | + } |
|
| 837 | + |
|
| 838 | + /** |
|
| 839 | + * Gets a prop for a getter method. |
|
| 840 | + * |
|
| 841 | + * Gets the value from either current pending changes, or the data itself. |
|
| 842 | + * Context controls what happens to the value before it's returned. |
|
| 843 | + * |
|
| 844 | + * @since 1.0.19 |
|
| 845 | + * @param string $prop Name of prop to get. |
|
| 846 | + * @param string $context What the value is for. Valid values are view and edit. |
|
| 847 | + * @return mixed |
|
| 848 | + */ |
|
| 849 | + protected function get_prop( $prop, $context = 'view' ) { |
|
| 850 | + $value = null; |
|
| 851 | + |
|
| 852 | + if ( array_key_exists( $prop, $this->data ) ) { |
|
| 853 | + $value = array_key_exists( $prop, $this->changes ) ? $this->changes[ $prop ] : $this->data[ $prop ]; |
|
| 854 | + |
|
| 855 | + if ( 'view' === $context ) { |
|
| 856 | + $value = apply_filters( $this->get_hook_prefix() . $prop, $value, $this ); |
|
| 857 | + } |
|
| 858 | + } |
|
| 859 | + |
|
| 860 | + return $value; |
|
| 861 | + } |
|
| 862 | + |
|
| 863 | + /** |
|
| 864 | + * Sets a date prop whilst handling formatting and datetime objects. |
|
| 865 | + * |
|
| 866 | + * @since 1.0.19 |
|
| 867 | + * @param string $prop Name of prop to set. |
|
| 868 | + * @param string|integer $value Value of the prop. |
|
| 869 | + */ |
|
| 870 | + protected function set_date_prop( $prop, $value ) { |
|
| 871 | + |
|
| 872 | + if ( empty( $value ) ) { |
|
| 873 | + $this->set_prop( $prop, null ); |
|
| 874 | + return; |
|
| 875 | + } |
|
| 876 | + $this->set_prop( $prop, $value ); |
|
| 877 | + |
|
| 878 | + } |
|
| 879 | + |
|
| 880 | + /** |
|
| 881 | + * When invalid data is found, throw an exception unless reading from the DB. |
|
| 882 | + * |
|
| 883 | + * @since 1.0.19 |
|
| 884 | + * @param string $code Error code. |
|
| 885 | + * @param string $message Error message. |
|
| 886 | + */ |
|
| 887 | + protected function error( $code, $message ) { |
|
| 888 | + $this->last_error = $message; |
|
| 889 | + } |
|
| 890 | + |
|
| 891 | + /** |
|
| 892 | + * Checks if the object is saved in the database |
|
| 893 | + * |
|
| 894 | + * @since 1.0.19 |
|
| 895 | + * @return bool |
|
| 896 | + */ |
|
| 897 | + public function exists() { |
|
| 898 | + $id = $this->get_id(); |
|
| 899 | + return ! empty( $id ); |
|
| 900 | + } |
|
| 901 | 901 | |
| 902 | 902 | } |
@@ -8,7 +8,7 @@ discard block |
||
| 8 | 8 | * |
| 9 | 9 | */ |
| 10 | 10 | |
| 11 | -if ( ! defined( 'ABSPATH' ) ) { |
|
| 11 | +if (!defined('ABSPATH')) { |
|
| 12 | 12 | exit; |
| 13 | 13 | } |
| 14 | 14 | |
@@ -117,8 +117,8 @@ discard block |
||
| 117 | 117 | * |
| 118 | 118 | * @param int|object|array|string $read ID to load from the DB (optional) or already queried data. |
| 119 | 119 | */ |
| 120 | - public function __construct( $read = 0 ) { |
|
| 121 | - $this->data = array_merge( $this->data, $this->extra_data ); |
|
| 120 | + public function __construct($read = 0) { |
|
| 121 | + $this->data = array_merge($this->data, $this->extra_data); |
|
| 122 | 122 | $this->default_data = $this->data; |
| 123 | 123 | } |
| 124 | 124 | |
@@ -128,7 +128,7 @@ discard block |
||
| 128 | 128 | * @return array |
| 129 | 129 | */ |
| 130 | 130 | public function __sleep() { |
| 131 | - return array( 'id' ); |
|
| 131 | + return array('id'); |
|
| 132 | 132 | } |
| 133 | 133 | |
| 134 | 134 | /** |
@@ -137,10 +137,10 @@ discard block |
||
| 137 | 137 | * If the object no longer exists, remove the ID. |
| 138 | 138 | */ |
| 139 | 139 | public function __wakeup() { |
| 140 | - $this->__construct( absint( $this->id ) ); |
|
| 140 | + $this->__construct(absint($this->id)); |
|
| 141 | 141 | |
| 142 | - if ( ! empty( $this->last_error ) ) { |
|
| 143 | - $this->set_id( 0 ); |
|
| 142 | + if (!empty($this->last_error)) { |
|
| 143 | + $this->set_id(0); |
|
| 144 | 144 | } |
| 145 | 145 | |
| 146 | 146 | } |
@@ -152,11 +152,11 @@ discard block |
||
| 152 | 152 | */ |
| 153 | 153 | public function __clone() { |
| 154 | 154 | $this->maybe_read_meta_data(); |
| 155 | - if ( ! empty( $this->meta_data ) ) { |
|
| 156 | - foreach ( $this->meta_data as $array_key => $meta ) { |
|
| 157 | - $this->meta_data[ $array_key ] = clone $meta; |
|
| 158 | - if ( ! empty( $meta->id ) ) { |
|
| 159 | - $this->meta_data[ $array_key ]->id = null; |
|
| 155 | + if (!empty($this->meta_data)) { |
|
| 156 | + foreach ($this->meta_data as $array_key => $meta) { |
|
| 157 | + $this->meta_data[$array_key] = clone $meta; |
|
| 158 | + if (!empty($meta->id)) { |
|
| 159 | + $this->meta_data[$array_key]->id = null; |
|
| 160 | 160 | } |
| 161 | 161 | } |
| 162 | 162 | } |
@@ -199,8 +199,8 @@ discard block |
||
| 199 | 199 | * @param string $context View or edit context. |
| 200 | 200 | * @return string |
| 201 | 201 | */ |
| 202 | - public function get_status( $context = 'view' ) { |
|
| 203 | - return $this->get_prop( 'status', $context ); |
|
| 202 | + public function get_status($context = 'view') { |
|
| 203 | + return $this->get_prop('status', $context); |
|
| 204 | 204 | } |
| 205 | 205 | |
| 206 | 206 | /** |
@@ -210,10 +210,10 @@ discard block |
||
| 210 | 210 | * @param bool $force_delete Should the data be deleted permanently. |
| 211 | 211 | * @return bool result |
| 212 | 212 | */ |
| 213 | - public function delete( $force_delete = false ) { |
|
| 214 | - if ( $this->data_store && $this->exists() ) { |
|
| 215 | - $this->data_store->delete( $this, array( 'force_delete' => $force_delete ) ); |
|
| 216 | - $this->set_id( 0 ); |
|
| 213 | + public function delete($force_delete = false) { |
|
| 214 | + if ($this->data_store && $this->exists()) { |
|
| 215 | + $this->data_store->delete($this, array('force_delete' => $force_delete)); |
|
| 216 | + $this->set_id(0); |
|
| 217 | 217 | return true; |
| 218 | 218 | } |
| 219 | 219 | return false; |
@@ -226,7 +226,7 @@ discard block |
||
| 226 | 226 | * @return int |
| 227 | 227 | */ |
| 228 | 228 | public function save() { |
| 229 | - if ( ! $this->data_store ) { |
|
| 229 | + if (!$this->data_store) { |
|
| 230 | 230 | return $this->get_id(); |
| 231 | 231 | } |
| 232 | 232 | |
@@ -236,12 +236,12 @@ discard block |
||
| 236 | 236 | * @param GetPaid_Data $this The object being saved. |
| 237 | 237 | * @param GetPaid_Data_Store_WP $data_store The data store persisting the data. |
| 238 | 238 | */ |
| 239 | - do_action( 'getpaid_before_' . $this->object_type . '_object_save', $this, $this->data_store ); |
|
| 239 | + do_action('getpaid_before_' . $this->object_type . '_object_save', $this, $this->data_store); |
|
| 240 | 240 | |
| 241 | - if ( $this->get_id() ) { |
|
| 242 | - $this->data_store->update( $this ); |
|
| 241 | + if ($this->get_id()) { |
|
| 242 | + $this->data_store->update($this); |
|
| 243 | 243 | } else { |
| 244 | - $this->data_store->create( $this ); |
|
| 244 | + $this->data_store->create($this); |
|
| 245 | 245 | } |
| 246 | 246 | |
| 247 | 247 | /** |
@@ -250,7 +250,7 @@ discard block |
||
| 250 | 250 | * @param GetPaid_Data $this The object being saved. |
| 251 | 251 | * @param GetPaid_Data_Store_WP $data_store The data store persisting the data. |
| 252 | 252 | */ |
| 253 | - do_action( 'getpaid_after_' . $this->object_type . '_object_save', $this, $this->data_store ); |
|
| 253 | + do_action('getpaid_after_' . $this->object_type . '_object_save', $this, $this->data_store); |
|
| 254 | 254 | |
| 255 | 255 | return $this->get_id(); |
| 256 | 256 | } |
@@ -262,7 +262,7 @@ discard block |
||
| 262 | 262 | * @return string Data in JSON format. |
| 263 | 263 | */ |
| 264 | 264 | public function __toString() { |
| 265 | - return wp_json_encode( $this->get_data() ); |
|
| 265 | + return wp_json_encode($this->get_data()); |
|
| 266 | 266 | } |
| 267 | 267 | |
| 268 | 268 | /** |
@@ -272,7 +272,7 @@ discard block |
||
| 272 | 272 | * @return array |
| 273 | 273 | */ |
| 274 | 274 | public function get_data() { |
| 275 | - return array_merge( array( 'id' => $this->get_id() ), $this->data, array( 'meta_data' => $this->get_meta_data() ) ); |
|
| 275 | + return array_merge(array('id' => $this->get_id()), $this->data, array('meta_data' => $this->get_meta_data())); |
|
| 276 | 276 | } |
| 277 | 277 | |
| 278 | 278 | /** |
@@ -282,7 +282,7 @@ discard block |
||
| 282 | 282 | * @return array |
| 283 | 283 | */ |
| 284 | 284 | public function get_data_keys() { |
| 285 | - return array_keys( $this->data ); |
|
| 285 | + return array_keys($this->data); |
|
| 286 | 286 | } |
| 287 | 287 | |
| 288 | 288 | /** |
@@ -292,7 +292,7 @@ discard block |
||
| 292 | 292 | * @return array |
| 293 | 293 | */ |
| 294 | 294 | public function get_extra_data_keys() { |
| 295 | - return array_keys( $this->extra_data ); |
|
| 295 | + return array_keys($this->extra_data); |
|
| 296 | 296 | } |
| 297 | 297 | |
| 298 | 298 | /** |
@@ -302,8 +302,8 @@ discard block |
||
| 302 | 302 | * @param mixed $meta Meta value to check. |
| 303 | 303 | * @return bool |
| 304 | 304 | */ |
| 305 | - protected function filter_null_meta( $meta ) { |
|
| 306 | - return ! is_null( $meta->value ); |
|
| 305 | + protected function filter_null_meta($meta) { |
|
| 306 | + return !is_null($meta->value); |
|
| 307 | 307 | } |
| 308 | 308 | |
| 309 | 309 | /** |
@@ -314,7 +314,7 @@ discard block |
||
| 314 | 314 | */ |
| 315 | 315 | public function get_meta_data() { |
| 316 | 316 | $this->maybe_read_meta_data(); |
| 317 | - return array_values( array_filter( $this->meta_data, array( $this, 'filter_null_meta' ) ) ); |
|
| 317 | + return array_values(array_filter($this->meta_data, array($this, 'filter_null_meta'))); |
|
| 318 | 318 | } |
| 319 | 319 | |
| 320 | 320 | /** |
@@ -324,21 +324,21 @@ discard block |
||
| 324 | 324 | * @param string $key Key to check. |
| 325 | 325 | * @return bool true if it's an internal key, false otherwise |
| 326 | 326 | */ |
| 327 | - protected function is_internal_meta_key( $key ) { |
|
| 328 | - $internal_meta_key = ! empty( $key ) && $this->data_store && in_array( $key, $this->data_store->get_internal_meta_keys(), true ); |
|
| 327 | + protected function is_internal_meta_key($key) { |
|
| 328 | + $internal_meta_key = !empty($key) && $this->data_store && in_array($key, $this->data_store->get_internal_meta_keys(), true); |
|
| 329 | 329 | |
| 330 | - if ( ! $internal_meta_key ) { |
|
| 330 | + if (!$internal_meta_key) { |
|
| 331 | 331 | return false; |
| 332 | 332 | } |
| 333 | 333 | |
| 334 | - $has_setter_or_getter = is_callable( array( $this, 'set_' . $key ) ) || is_callable( array( $this, 'get_' . $key ) ); |
|
| 334 | + $has_setter_or_getter = is_callable(array($this, 'set_' . $key)) || is_callable(array($this, 'get_' . $key)); |
|
| 335 | 335 | |
| 336 | - if ( ! $has_setter_or_getter ) { |
|
| 336 | + if (!$has_setter_or_getter) { |
|
| 337 | 337 | return false; |
| 338 | 338 | } |
| 339 | 339 | |
| 340 | 340 | /* translators: %s: $key Key to check */ |
| 341 | - getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Generic add/update/get meta methods should not be used for internal meta data, including "%s". Use getters and setters.', 'invoicing' ), $key ), '1.0.19' ); |
|
| 341 | + getpaid_doing_it_wrong(__FUNCTION__, sprintf(__('Generic add/update/get meta methods should not be used for internal meta data, including "%s". Use getters and setters.', 'invoicing'), $key), '1.0.19'); |
|
| 342 | 342 | |
| 343 | 343 | return true; |
| 344 | 344 | } |
@@ -352,20 +352,20 @@ discard block |
||
| 352 | 352 | * @access public |
| 353 | 353 | * |
| 354 | 354 | */ |
| 355 | - public function __set( $key, $value ) { |
|
| 355 | + public function __set($key, $value) { |
|
| 356 | 356 | |
| 357 | - if ( 'id' == strtolower( $key ) ) { |
|
| 358 | - return $this->set_id( $value ); |
|
| 357 | + if ('id' == strtolower($key)) { |
|
| 358 | + return $this->set_id($value); |
|
| 359 | 359 | } |
| 360 | 360 | |
| 361 | - if ( method_exists( $this, "set_$key") ) { |
|
| 361 | + if (method_exists($this, "set_$key")) { |
|
| 362 | 362 | |
| 363 | 363 | /* translators: %s: $key Key to set */ |
| 364 | - getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'invoicing' ), $key ), '1.0.19' ); |
|
| 364 | + getpaid_doing_it_wrong(__FUNCTION__, sprintf(__('Object data such as "%s" should not be accessed directly. Use getters and setters.', 'invoicing'), $key), '1.0.19'); |
|
| 365 | 365 | |
| 366 | - call_user_func( array( $this, "set_$key" ), $value ); |
|
| 366 | + call_user_func(array($this, "set_$key"), $value); |
|
| 367 | 367 | } else { |
| 368 | - $this->set_prop( $key, $value ); |
|
| 368 | + $this->set_prop($key, $value); |
|
| 369 | 369 | } |
| 370 | 370 | |
| 371 | 371 | } |
@@ -373,25 +373,25 @@ discard block |
||
| 373 | 373 | /** |
| 374 | 374 | * Margic method for retrieving a property. |
| 375 | 375 | */ |
| 376 | - public function __get( $key ) { |
|
| 376 | + public function __get($key) { |
|
| 377 | 377 | |
| 378 | 378 | // Check if we have a helper method for that. |
| 379 | - if ( method_exists( $this, 'get_' . $key ) ) { |
|
| 379 | + if (method_exists($this, 'get_' . $key)) { |
|
| 380 | 380 | |
| 381 | - if ( 'post_type' != $key ) { |
|
| 381 | + if ('post_type' != $key) { |
|
| 382 | 382 | /* translators: %s: $key Key to set */ |
| 383 | - getpaid_doing_it_wrong( __FUNCTION__, sprintf( __( 'Object data such as "%s" should not be accessed directly. Use getters and setters.', 'invoicing' ), $key ), '1.0.19' ); |
|
| 383 | + getpaid_doing_it_wrong(__FUNCTION__, sprintf(__('Object data such as "%s" should not be accessed directly. Use getters and setters.', 'invoicing'), $key), '1.0.19'); |
|
| 384 | 384 | } |
| 385 | 385 | |
| 386 | - return call_user_func( array( $this, 'get_' . $key ) ); |
|
| 386 | + return call_user_func(array($this, 'get_' . $key)); |
|
| 387 | 387 | } |
| 388 | 388 | |
| 389 | 389 | // Check if the key is in the associated $post object. |
| 390 | - if ( ! empty( $this->post ) && isset( $this->post->$key ) ) { |
|
| 390 | + if (!empty($this->post) && isset($this->post->$key)) { |
|
| 391 | 391 | return $this->post->$key; |
| 392 | 392 | } |
| 393 | 393 | |
| 394 | - return $this->get_prop( $key ); |
|
| 394 | + return $this->get_prop($key); |
|
| 395 | 395 | |
| 396 | 396 | } |
| 397 | 397 | |
@@ -404,15 +404,15 @@ discard block |
||
| 404 | 404 | * @param string $context What the value is for. Valid values are view and edit. |
| 405 | 405 | * @return mixed |
| 406 | 406 | */ |
| 407 | - public function get_meta( $key = '', $single = true, $context = 'view' ) { |
|
| 407 | + public function get_meta($key = '', $single = true, $context = 'view') { |
|
| 408 | 408 | |
| 409 | 409 | // Check if this is an internal meta key. |
| 410 | - $_key = str_replace( '_wpinv', '', $key ); |
|
| 411 | - $_key = str_replace( 'wpinv', '', $_key ); |
|
| 412 | - if ( $this->is_internal_meta_key( $_key ) ) { |
|
| 410 | + $_key = str_replace('_wpinv', '', $key); |
|
| 411 | + $_key = str_replace('wpinv', '', $_key); |
|
| 412 | + if ($this->is_internal_meta_key($_key)) { |
|
| 413 | 413 | $function = 'get_' . $_key; |
| 414 | 414 | |
| 415 | - if ( is_callable( array( $this, $function ) ) ) { |
|
| 415 | + if (is_callable(array($this, $function))) { |
|
| 416 | 416 | return $this->{$function}(); |
| 417 | 417 | } |
| 418 | 418 | } |
@@ -420,20 +420,20 @@ discard block |
||
| 420 | 420 | // Read the meta data if not yet read. |
| 421 | 421 | $this->maybe_read_meta_data(); |
| 422 | 422 | $meta_data = $this->get_meta_data(); |
| 423 | - $array_keys = array_keys( wp_list_pluck( $meta_data, 'key' ), $key, true ); |
|
| 423 | + $array_keys = array_keys(wp_list_pluck($meta_data, 'key'), $key, true); |
|
| 424 | 424 | $value = $single ? '' : array(); |
| 425 | 425 | |
| 426 | - if ( ! empty( $array_keys ) ) { |
|
| 426 | + if (!empty($array_keys)) { |
|
| 427 | 427 | // We don't use the $this->meta_data property directly here because we don't want meta with a null value (i.e. meta which has been deleted via $this->delete_meta_data()). |
| 428 | - if ( $single ) { |
|
| 429 | - $value = $meta_data[ current( $array_keys ) ]->value; |
|
| 428 | + if ($single) { |
|
| 429 | + $value = $meta_data[current($array_keys)]->value; |
|
| 430 | 430 | } else { |
| 431 | - $value = array_intersect_key( $meta_data, array_flip( $array_keys ) ); |
|
| 431 | + $value = array_intersect_key($meta_data, array_flip($array_keys)); |
|
| 432 | 432 | } |
| 433 | 433 | } |
| 434 | 434 | |
| 435 | - if ( 'view' === $context ) { |
|
| 436 | - $value = apply_filters( $this->get_hook_prefix() . $key, $value, $this ); |
|
| 435 | + if ('view' === $context) { |
|
| 436 | + $value = apply_filters($this->get_hook_prefix() . $key, $value, $this); |
|
| 437 | 437 | } |
| 438 | 438 | |
| 439 | 439 | return $value; |
@@ -446,10 +446,10 @@ discard block |
||
| 446 | 446 | * @param string $key Meta Key. |
| 447 | 447 | * @return boolean |
| 448 | 448 | */ |
| 449 | - public function meta_exists( $key = '' ) { |
|
| 449 | + public function meta_exists($key = '') { |
|
| 450 | 450 | $this->maybe_read_meta_data(); |
| 451 | - $array_keys = wp_list_pluck( $this->get_meta_data(), 'key' ); |
|
| 452 | - return in_array( $key, $array_keys, true ); |
|
| 451 | + $array_keys = wp_list_pluck($this->get_meta_data(), 'key'); |
|
| 452 | + return in_array($key, $array_keys, true); |
|
| 453 | 453 | } |
| 454 | 454 | |
| 455 | 455 | /** |
@@ -458,12 +458,12 @@ discard block |
||
| 458 | 458 | * @since 1.0.19 |
| 459 | 459 | * @param array $data Key/Value pairs. |
| 460 | 460 | */ |
| 461 | - public function set_meta_data( $data ) { |
|
| 462 | - if ( ! empty( $data ) && is_array( $data ) ) { |
|
| 461 | + public function set_meta_data($data) { |
|
| 462 | + if (!empty($data) && is_array($data)) { |
|
| 463 | 463 | $this->maybe_read_meta_data(); |
| 464 | - foreach ( $data as $meta ) { |
|
| 464 | + foreach ($data as $meta) { |
|
| 465 | 465 | $meta = (array) $meta; |
| 466 | - if ( isset( $meta['key'], $meta['value'], $meta['id'] ) ) { |
|
| 466 | + if (isset($meta['key'], $meta['value'], $meta['id'])) { |
|
| 467 | 467 | $this->meta_data[] = new GetPaid_Meta_Data( |
| 468 | 468 | array( |
| 469 | 469 | 'id' => $meta['id'], |
@@ -485,18 +485,18 @@ discard block |
||
| 485 | 485 | * @param string|array $value Meta value. |
| 486 | 486 | * @param bool $unique Should this be a unique key?. |
| 487 | 487 | */ |
| 488 | - public function add_meta_data( $key, $value, $unique = false ) { |
|
| 489 | - if ( $this->is_internal_meta_key( $key ) ) { |
|
| 488 | + public function add_meta_data($key, $value, $unique = false) { |
|
| 489 | + if ($this->is_internal_meta_key($key)) { |
|
| 490 | 490 | $function = 'set_' . $key; |
| 491 | 491 | |
| 492 | - if ( is_callable( array( $this, $function ) ) ) { |
|
| 493 | - return $this->{$function}( $value ); |
|
| 492 | + if (is_callable(array($this, $function))) { |
|
| 493 | + return $this->{$function}($value); |
|
| 494 | 494 | } |
| 495 | 495 | } |
| 496 | 496 | |
| 497 | 497 | $this->maybe_read_meta_data(); |
| 498 | - if ( $unique ) { |
|
| 499 | - $this->delete_meta_data( $key ); |
|
| 498 | + if ($unique) { |
|
| 499 | + $this->delete_meta_data($key); |
|
| 500 | 500 | } |
| 501 | 501 | $this->meta_data[] = new GetPaid_Meta_Data( |
| 502 | 502 | array( |
@@ -515,12 +515,12 @@ discard block |
||
| 515 | 515 | * @param string|array $value Meta value. |
| 516 | 516 | * @param int $meta_id Meta ID. |
| 517 | 517 | */ |
| 518 | - public function update_meta_data( $key, $value, $meta_id = 0 ) { |
|
| 519 | - if ( $this->is_internal_meta_key( $key ) ) { |
|
| 518 | + public function update_meta_data($key, $value, $meta_id = 0) { |
|
| 519 | + if ($this->is_internal_meta_key($key)) { |
|
| 520 | 520 | $function = 'set_' . $key; |
| 521 | 521 | |
| 522 | - if ( is_callable( array( $this, $function ) ) ) { |
|
| 523 | - return $this->{$function}( $value ); |
|
| 522 | + if (is_callable(array($this, $function))) { |
|
| 523 | + return $this->{$function}($value); |
|
| 524 | 524 | } |
| 525 | 525 | } |
| 526 | 526 | |
@@ -528,33 +528,33 @@ discard block |
||
| 528 | 528 | |
| 529 | 529 | $array_key = false; |
| 530 | 530 | |
| 531 | - if ( $meta_id ) { |
|
| 532 | - $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), $meta_id, true ); |
|
| 533 | - $array_key = $array_keys ? current( $array_keys ) : false; |
|
| 531 | + if ($meta_id) { |
|
| 532 | + $array_keys = array_keys(wp_list_pluck($this->meta_data, 'id'), $meta_id, true); |
|
| 533 | + $array_key = $array_keys ? current($array_keys) : false; |
|
| 534 | 534 | } else { |
| 535 | 535 | // Find matches by key. |
| 536 | 536 | $matches = array(); |
| 537 | - foreach ( $this->meta_data as $meta_data_array_key => $meta ) { |
|
| 538 | - if ( $meta->key === $key ) { |
|
| 537 | + foreach ($this->meta_data as $meta_data_array_key => $meta) { |
|
| 538 | + if ($meta->key === $key) { |
|
| 539 | 539 | $matches[] = $meta_data_array_key; |
| 540 | 540 | } |
| 541 | 541 | } |
| 542 | 542 | |
| 543 | - if ( ! empty( $matches ) ) { |
|
| 543 | + if (!empty($matches)) { |
|
| 544 | 544 | // Set matches to null so only one key gets the new value. |
| 545 | - foreach ( $matches as $meta_data_array_key ) { |
|
| 546 | - $this->meta_data[ $meta_data_array_key ]->value = null; |
|
| 545 | + foreach ($matches as $meta_data_array_key) { |
|
| 546 | + $this->meta_data[$meta_data_array_key]->value = null; |
|
| 547 | 547 | } |
| 548 | - $array_key = current( $matches ); |
|
| 548 | + $array_key = current($matches); |
|
| 549 | 549 | } |
| 550 | 550 | } |
| 551 | 551 | |
| 552 | - if ( false !== $array_key ) { |
|
| 553 | - $meta = $this->meta_data[ $array_key ]; |
|
| 552 | + if (false !== $array_key) { |
|
| 553 | + $meta = $this->meta_data[$array_key]; |
|
| 554 | 554 | $meta->key = $key; |
| 555 | 555 | $meta->value = $value; |
| 556 | 556 | } else { |
| 557 | - $this->add_meta_data( $key, $value, true ); |
|
| 557 | + $this->add_meta_data($key, $value, true); |
|
| 558 | 558 | } |
| 559 | 559 | } |
| 560 | 560 | |
@@ -564,13 +564,13 @@ discard block |
||
| 564 | 564 | * @since 1.0.19 |
| 565 | 565 | * @param string $key Meta key. |
| 566 | 566 | */ |
| 567 | - public function delete_meta_data( $key ) { |
|
| 567 | + public function delete_meta_data($key) { |
|
| 568 | 568 | $this->maybe_read_meta_data(); |
| 569 | - $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'key' ), $key, true ); |
|
| 569 | + $array_keys = array_keys(wp_list_pluck($this->meta_data, 'key'), $key, true); |
|
| 570 | 570 | |
| 571 | - if ( $array_keys ) { |
|
| 572 | - foreach ( $array_keys as $array_key ) { |
|
| 573 | - $this->meta_data[ $array_key ]->value = null; |
|
| 571 | + if ($array_keys) { |
|
| 572 | + foreach ($array_keys as $array_key) { |
|
| 573 | + $this->meta_data[$array_key]->value = null; |
|
| 574 | 574 | } |
| 575 | 575 | } |
| 576 | 576 | } |
@@ -581,13 +581,13 @@ discard block |
||
| 581 | 581 | * @since 1.0.19 |
| 582 | 582 | * @param int $mid Meta ID. |
| 583 | 583 | */ |
| 584 | - public function delete_meta_data_by_mid( $mid ) { |
|
| 584 | + public function delete_meta_data_by_mid($mid) { |
|
| 585 | 585 | $this->maybe_read_meta_data(); |
| 586 | - $array_keys = array_keys( wp_list_pluck( $this->meta_data, 'id' ), (int) $mid, true ); |
|
| 586 | + $array_keys = array_keys(wp_list_pluck($this->meta_data, 'id'), (int) $mid, true); |
|
| 587 | 587 | |
| 588 | - if ( $array_keys ) { |
|
| 589 | - foreach ( $array_keys as $array_key ) { |
|
| 590 | - $this->meta_data[ $array_key ]->value = null; |
|
| 588 | + if ($array_keys) { |
|
| 589 | + foreach ($array_keys as $array_key) { |
|
| 590 | + $this->meta_data[$array_key]->value = null; |
|
| 591 | 591 | } |
| 592 | 592 | } |
| 593 | 593 | } |
@@ -598,7 +598,7 @@ discard block |
||
| 598 | 598 | * @since 1.0.19 |
| 599 | 599 | */ |
| 600 | 600 | protected function maybe_read_meta_data() { |
| 601 | - if ( is_null( $this->meta_data ) ) { |
|
| 601 | + if (is_null($this->meta_data)) { |
|
| 602 | 602 | $this->read_meta_data(); |
| 603 | 603 | } |
| 604 | 604 | } |
@@ -610,42 +610,42 @@ discard block |
||
| 610 | 610 | * @since 1.0.19 |
| 611 | 611 | * @param bool $force_read True to force a new DB read (and update cache). |
| 612 | 612 | */ |
| 613 | - public function read_meta_data( $force_read = false ) { |
|
| 613 | + public function read_meta_data($force_read = false) { |
|
| 614 | 614 | |
| 615 | 615 | // Reset meta data. |
| 616 | 616 | $this->meta_data = array(); |
| 617 | 617 | |
| 618 | 618 | // Maybe abort early. |
| 619 | - if ( ! $this->get_id() || ! $this->data_store ) { |
|
| 619 | + if (!$this->get_id() || !$this->data_store) { |
|
| 620 | 620 | return; |
| 621 | 621 | } |
| 622 | 622 | |
| 623 | 623 | // Only read from cache if the cache key is set. |
| 624 | 624 | $cache_key = null; |
| 625 | - if ( ! $force_read && ! empty( $this->cache_group ) ) { |
|
| 626 | - $cache_key = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id(); |
|
| 627 | - $raw_meta_data = wp_cache_get( $cache_key, $this->cache_group ); |
|
| 625 | + if (!$force_read && !empty($this->cache_group)) { |
|
| 626 | + $cache_key = GetPaid_Cache_Helper::get_cache_prefix($this->cache_group) . GetPaid_Cache_Helper::get_cache_prefix('object_' . $this->get_id()) . 'object_meta_' . $this->get_id(); |
|
| 627 | + $raw_meta_data = wp_cache_get($cache_key, $this->cache_group); |
|
| 628 | 628 | } |
| 629 | 629 | |
| 630 | 630 | // Should we force read? |
| 631 | - if ( empty( $raw_meta_data ) ) { |
|
| 632 | - $raw_meta_data = $this->data_store->read_meta( $this ); |
|
| 631 | + if (empty($raw_meta_data)) { |
|
| 632 | + $raw_meta_data = $this->data_store->read_meta($this); |
|
| 633 | 633 | |
| 634 | - if ( ! empty( $cache_key ) ) { |
|
| 635 | - wp_cache_set( $cache_key, $raw_meta_data, $this->cache_group ); |
|
| 634 | + if (!empty($cache_key)) { |
|
| 635 | + wp_cache_set($cache_key, $raw_meta_data, $this->cache_group); |
|
| 636 | 636 | } |
| 637 | 637 | |
| 638 | 638 | } |
| 639 | 639 | |
| 640 | 640 | // Set meta data. |
| 641 | - if ( is_array( $raw_meta_data ) ) { |
|
| 641 | + if (is_array($raw_meta_data)) { |
|
| 642 | 642 | |
| 643 | - foreach ( $raw_meta_data as $meta ) { |
|
| 643 | + foreach ($raw_meta_data as $meta) { |
|
| 644 | 644 | $this->meta_data[] = new GetPaid_Meta_Data( |
| 645 | 645 | array( |
| 646 | 646 | 'id' => (int) $meta->meta_id, |
| 647 | 647 | 'key' => $meta->meta_key, |
| 648 | - 'value' => maybe_unserialize( $meta->meta_value ), |
|
| 648 | + 'value' => maybe_unserialize($meta->meta_value), |
|
| 649 | 649 | ) |
| 650 | 650 | ); |
| 651 | 651 | } |
@@ -660,28 +660,28 @@ discard block |
||
| 660 | 660 | * @since 1.0.19 |
| 661 | 661 | */ |
| 662 | 662 | public function save_meta_data() { |
| 663 | - if ( ! $this->data_store || is_null( $this->meta_data ) ) { |
|
| 663 | + if (!$this->data_store || is_null($this->meta_data)) { |
|
| 664 | 664 | return; |
| 665 | 665 | } |
| 666 | - foreach ( $this->meta_data as $array_key => $meta ) { |
|
| 667 | - if ( is_null( $meta->value ) ) { |
|
| 668 | - if ( ! empty( $meta->id ) ) { |
|
| 669 | - $this->data_store->delete_meta( $this, $meta ); |
|
| 670 | - unset( $this->meta_data[ $array_key ] ); |
|
| 666 | + foreach ($this->meta_data as $array_key => $meta) { |
|
| 667 | + if (is_null($meta->value)) { |
|
| 668 | + if (!empty($meta->id)) { |
|
| 669 | + $this->data_store->delete_meta($this, $meta); |
|
| 670 | + unset($this->meta_data[$array_key]); |
|
| 671 | 671 | } |
| 672 | - } elseif ( empty( $meta->id ) ) { |
|
| 673 | - $meta->id = $this->data_store->add_meta( $this, $meta ); |
|
| 672 | + } elseif (empty($meta->id)) { |
|
| 673 | + $meta->id = $this->data_store->add_meta($this, $meta); |
|
| 674 | 674 | $meta->apply_changes(); |
| 675 | 675 | } else { |
| 676 | - if ( $meta->get_changes() ) { |
|
| 677 | - $this->data_store->update_meta( $this, $meta ); |
|
| 676 | + if ($meta->get_changes()) { |
|
| 677 | + $this->data_store->update_meta($this, $meta); |
|
| 678 | 678 | $meta->apply_changes(); |
| 679 | 679 | } |
| 680 | 680 | } |
| 681 | 681 | } |
| 682 | - if ( ! empty( $this->cache_group ) ) { |
|
| 683 | - $cache_key = GetPaid_Cache_Helper::get_cache_prefix( $this->cache_group ) . GetPaid_Cache_Helper::get_cache_prefix( 'object_' . $this->get_id() ) . 'object_meta_' . $this->get_id(); |
|
| 684 | - wp_cache_delete( $cache_key, $this->cache_group ); |
|
| 682 | + if (!empty($this->cache_group)) { |
|
| 683 | + $cache_key = GetPaid_Cache_Helper::get_cache_prefix($this->cache_group) . GetPaid_Cache_Helper::get_cache_prefix('object_' . $this->get_id()) . 'object_meta_' . $this->get_id(); |
|
| 684 | + wp_cache_delete($cache_key, $this->cache_group); |
|
| 685 | 685 | } |
| 686 | 686 | } |
| 687 | 687 | |
@@ -691,8 +691,8 @@ discard block |
||
| 691 | 691 | * @since 1.0.19 |
| 692 | 692 | * @param int $id ID. |
| 693 | 693 | */ |
| 694 | - public function set_id( $id ) { |
|
| 695 | - $this->id = absint( $id ); |
|
| 694 | + public function set_id($id) { |
|
| 695 | + $this->id = absint($id); |
|
| 696 | 696 | } |
| 697 | 697 | |
| 698 | 698 | /** |
@@ -702,10 +702,10 @@ discard block |
||
| 702 | 702 | * @param string $status New status. |
| 703 | 703 | * @return array details of change. |
| 704 | 704 | */ |
| 705 | - public function set_status( $status ) { |
|
| 705 | + public function set_status($status) { |
|
| 706 | 706 | $old_status = $this->get_status(); |
| 707 | 707 | |
| 708 | - $this->set_prop( 'status', $status ); |
|
| 708 | + $this->set_prop('status', $status); |
|
| 709 | 709 | |
| 710 | 710 | return array( |
| 711 | 711 | 'from' => $old_status, |
@@ -721,7 +721,7 @@ discard block |
||
| 721 | 721 | public function set_defaults() { |
| 722 | 722 | $this->data = $this->default_data; |
| 723 | 723 | $this->changes = array(); |
| 724 | - $this->set_object_read( false ); |
|
| 724 | + $this->set_object_read(false); |
|
| 725 | 725 | } |
| 726 | 726 | |
| 727 | 727 | /** |
@@ -730,7 +730,7 @@ discard block |
||
| 730 | 730 | * @since 1.0.19 |
| 731 | 731 | * @param boolean $read Should read?. |
| 732 | 732 | */ |
| 733 | - public function set_object_read( $read = true ) { |
|
| 733 | + public function set_object_read($read = true) { |
|
| 734 | 734 | $this->object_read = (bool) $read; |
| 735 | 735 | } |
| 736 | 736 | |
@@ -755,32 +755,32 @@ discard block |
||
| 755 | 755 | * |
| 756 | 756 | * @return bool|WP_Error |
| 757 | 757 | */ |
| 758 | - public function set_props( $props, $context = 'set' ) { |
|
| 758 | + public function set_props($props, $context = 'set') { |
|
| 759 | 759 | $errors = false; |
| 760 | 760 | |
| 761 | - foreach ( $props as $prop => $value ) { |
|
| 761 | + foreach ($props as $prop => $value) { |
|
| 762 | 762 | try { |
| 763 | 763 | /** |
| 764 | 764 | * Checks if the prop being set is allowed, and the value is not null. |
| 765 | 765 | */ |
| 766 | - if ( is_null( $value ) || in_array( $prop, array( 'prop', 'date_prop', 'meta_data' ), true ) ) { |
|
| 766 | + if (is_null($value) || in_array($prop, array('prop', 'date_prop', 'meta_data'), true)) { |
|
| 767 | 767 | continue; |
| 768 | 768 | } |
| 769 | 769 | $setter = "set_$prop"; |
| 770 | 770 | |
| 771 | - if ( is_callable( array( $this, $setter ) ) ) { |
|
| 772 | - $this->{$setter}( $value ); |
|
| 771 | + if (is_callable(array($this, $setter))) { |
|
| 772 | + $this->{$setter}($value); |
|
| 773 | 773 | } |
| 774 | - } catch ( Exception $e ) { |
|
| 775 | - if ( ! $errors ) { |
|
| 774 | + } catch (Exception $e) { |
|
| 775 | + if (!$errors) { |
|
| 776 | 776 | $errors = new WP_Error(); |
| 777 | 777 | } |
| 778 | - $errors->add( $e->getCode(), $e->getMessage() ); |
|
| 778 | + $errors->add($e->getCode(), $e->getMessage()); |
|
| 779 | 779 | $this->last_error = $e->getMessage(); |
| 780 | 780 | } |
| 781 | 781 | } |
| 782 | 782 | |
| 783 | - return $errors && count( $errors->get_error_codes() ) ? $errors : true; |
|
| 783 | + return $errors && count($errors->get_error_codes()) ? $errors : true; |
|
| 784 | 784 | } |
| 785 | 785 | |
| 786 | 786 | /** |
@@ -793,14 +793,14 @@ discard block |
||
| 793 | 793 | * @param string $prop Name of prop to set. |
| 794 | 794 | * @param mixed $value Value of the prop. |
| 795 | 795 | */ |
| 796 | - protected function set_prop( $prop, $value ) { |
|
| 797 | - if ( array_key_exists( $prop, $this->data ) ) { |
|
| 798 | - if ( true === $this->object_read ) { |
|
| 799 | - if ( $value !== $this->data[ $prop ] || array_key_exists( $prop, $this->changes ) ) { |
|
| 800 | - $this->changes[ $prop ] = $value; |
|
| 796 | + protected function set_prop($prop, $value) { |
|
| 797 | + if (array_key_exists($prop, $this->data)) { |
|
| 798 | + if (true === $this->object_read) { |
|
| 799 | + if ($value !== $this->data[$prop] || array_key_exists($prop, $this->changes)) { |
|
| 800 | + $this->changes[$prop] = $value; |
|
| 801 | 801 | } |
| 802 | 802 | } else { |
| 803 | - $this->data[ $prop ] = $value; |
|
| 803 | + $this->data[$prop] = $value; |
|
| 804 | 804 | } |
| 805 | 805 | } |
| 806 | 806 | } |
@@ -821,7 +821,7 @@ discard block |
||
| 821 | 821 | * @since 1.0.19 |
| 822 | 822 | */ |
| 823 | 823 | public function apply_changes() { |
| 824 | - $this->data = array_replace_recursive( $this->data, $this->changes ); |
|
| 824 | + $this->data = array_replace_recursive($this->data, $this->changes); |
|
| 825 | 825 | $this->changes = array(); |
| 826 | 826 | } |
| 827 | 827 | |
@@ -846,14 +846,14 @@ discard block |
||
| 846 | 846 | * @param string $context What the value is for. Valid values are view and edit. |
| 847 | 847 | * @return mixed |
| 848 | 848 | */ |
| 849 | - protected function get_prop( $prop, $context = 'view' ) { |
|
| 849 | + protected function get_prop($prop, $context = 'view') { |
|
| 850 | 850 | $value = null; |
| 851 | 851 | |
| 852 | - if ( array_key_exists( $prop, $this->data ) ) { |
|
| 853 | - $value = array_key_exists( $prop, $this->changes ) ? $this->changes[ $prop ] : $this->data[ $prop ]; |
|
| 852 | + if (array_key_exists($prop, $this->data)) { |
|
| 853 | + $value = array_key_exists($prop, $this->changes) ? $this->changes[$prop] : $this->data[$prop]; |
|
| 854 | 854 | |
| 855 | - if ( 'view' === $context ) { |
|
| 856 | - $value = apply_filters( $this->get_hook_prefix() . $prop, $value, $this ); |
|
| 855 | + if ('view' === $context) { |
|
| 856 | + $value = apply_filters($this->get_hook_prefix() . $prop, $value, $this); |
|
| 857 | 857 | } |
| 858 | 858 | } |
| 859 | 859 | |
@@ -867,13 +867,13 @@ discard block |
||
| 867 | 867 | * @param string $prop Name of prop to set. |
| 868 | 868 | * @param string|integer $value Value of the prop. |
| 869 | 869 | */ |
| 870 | - protected function set_date_prop( $prop, $value ) { |
|
| 870 | + protected function set_date_prop($prop, $value) { |
|
| 871 | 871 | |
| 872 | - if ( empty( $value ) ) { |
|
| 873 | - $this->set_prop( $prop, null ); |
|
| 872 | + if (empty($value)) { |
|
| 873 | + $this->set_prop($prop, null); |
|
| 874 | 874 | return; |
| 875 | 875 | } |
| 876 | - $this->set_prop( $prop, $value ); |
|
| 876 | + $this->set_prop($prop, $value); |
|
| 877 | 877 | |
| 878 | 878 | } |
| 879 | 879 | |
@@ -884,7 +884,7 @@ discard block |
||
| 884 | 884 | * @param string $code Error code. |
| 885 | 885 | * @param string $message Error message. |
| 886 | 886 | */ |
| 887 | - protected function error( $code, $message ) { |
|
| 887 | + protected function error($code, $message) { |
|
| 888 | 888 | $this->last_error = $message; |
| 889 | 889 | } |
| 890 | 890 | |
@@ -896,7 +896,7 @@ discard block |
||
| 896 | 896 | */ |
| 897 | 897 | public function exists() { |
| 898 | 898 | $id = $this->get_id(); |
| 899 | - return ! empty( $id ); |
|
| 899 | + return !empty($id); |
|
| 900 | 900 | } |
| 901 | 901 | |
| 902 | 902 | } |
@@ -12,49 +12,49 @@ discard block |
||
| 12 | 12 | */ |
| 13 | 13 | class GetPaid_Reports { |
| 14 | 14 | |
| 15 | - /** |
|
| 16 | - * Class constructor. |
|
| 17 | - * |
|
| 18 | - */ |
|
| 19 | - public function __construct() { |
|
| 20 | - add_action( 'admin_menu', array( $this, 'register_reports_page' ), 20 ); |
|
| 21 | - add_action( 'wpinv_reports_tab_reports', array( $this, 'display_reports_tab' ) ); |
|
| 22 | - add_action( 'wpinv_reports_tab_export', array( $this, 'display_exports_tab' ) ); |
|
| 23 | - add_action( 'getpaid_authenticated_admin_action_download_graph', array( $this, 'download_graph' ) ); |
|
| 24 | - add_action( 'getpaid_authenticated_admin_action_export_invoices', array( $this, 'export_invoices' ) ); |
|
| 25 | - |
|
| 26 | - } |
|
| 27 | - |
|
| 28 | - /** |
|
| 29 | - * Registers the reports page. |
|
| 30 | - * |
|
| 31 | - */ |
|
| 32 | - public function register_reports_page() { |
|
| 33 | - |
|
| 34 | - add_submenu_page( |
|
| 15 | + /** |
|
| 16 | + * Class constructor. |
|
| 17 | + * |
|
| 18 | + */ |
|
| 19 | + public function __construct() { |
|
| 20 | + add_action( 'admin_menu', array( $this, 'register_reports_page' ), 20 ); |
|
| 21 | + add_action( 'wpinv_reports_tab_reports', array( $this, 'display_reports_tab' ) ); |
|
| 22 | + add_action( 'wpinv_reports_tab_export', array( $this, 'display_exports_tab' ) ); |
|
| 23 | + add_action( 'getpaid_authenticated_admin_action_download_graph', array( $this, 'download_graph' ) ); |
|
| 24 | + add_action( 'getpaid_authenticated_admin_action_export_invoices', array( $this, 'export_invoices' ) ); |
|
| 25 | + |
|
| 26 | + } |
|
| 27 | + |
|
| 28 | + /** |
|
| 29 | + * Registers the reports page. |
|
| 30 | + * |
|
| 31 | + */ |
|
| 32 | + public function register_reports_page() { |
|
| 33 | + |
|
| 34 | + add_submenu_page( |
|
| 35 | 35 | 'wpinv', |
| 36 | 36 | __( 'Reports', 'invoicing' ), |
| 37 | 37 | __( 'Reports', 'invoicing' ), |
| 38 | 38 | wpinv_get_capability(), |
| 39 | 39 | 'wpinv-reports', |
| 40 | 40 | array( $this, 'display_reports_page' ) |
| 41 | - ); |
|
| 41 | + ); |
|
| 42 | 42 | |
| 43 | - } |
|
| 43 | + } |
|
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * Displays the reports page. |
|
| 47 | - * |
|
| 48 | - */ |
|
| 49 | - public function display_reports_page() { |
|
| 45 | + /** |
|
| 46 | + * Displays the reports page. |
|
| 47 | + * |
|
| 48 | + */ |
|
| 49 | + public function display_reports_page() { |
|
| 50 | 50 | |
| 51 | - // Prepare variables. |
|
| 52 | - $tabs = $this->get_tabs(); |
|
| 53 | - $current_tab = isset( $_GET['tab'] ) ? sanitize_text_field( $_GET['tab'] ) : 'reports'; |
|
| 54 | - $current_tab = array_key_exists( $current_tab, $tabs ) ? $current_tab : 'reports'; |
|
| 51 | + // Prepare variables. |
|
| 52 | + $tabs = $this->get_tabs(); |
|
| 53 | + $current_tab = isset( $_GET['tab'] ) ? sanitize_text_field( $_GET['tab'] ) : 'reports'; |
|
| 54 | + $current_tab = array_key_exists( $current_tab, $tabs ) ? $current_tab : 'reports'; |
|
| 55 | 55 | |
| 56 | - // Display the current tab. |
|
| 57 | - ?> |
|
| 56 | + // Display the current tab. |
|
| 57 | + ?> |
|
| 58 | 58 | |
| 59 | 59 | <div class="wrap"> |
| 60 | 60 | |
@@ -63,19 +63,19 @@ discard block |
||
| 63 | 63 | <nav class="nav-tab-wrapper"> |
| 64 | 64 | |
| 65 | 65 | <?php |
| 66 | - foreach( $tabs as $key => $label ) { |
|
| 66 | + foreach( $tabs as $key => $label ) { |
|
| 67 | 67 | |
| 68 | - $key = sanitize_text_field( $key ); |
|
| 69 | - $label = sanitize_text_field( $label ); |
|
| 70 | - $class = $key == $current_tab ? 'nav-tab nav-tab-active' : 'nav-tab'; |
|
| 71 | - $url = esc_url( |
|
| 72 | - add_query_arg( 'tab', $key, admin_url( 'admin.php?page=wpinv-reports' ) ) |
|
| 73 | - ); |
|
| 68 | + $key = sanitize_text_field( $key ); |
|
| 69 | + $label = sanitize_text_field( $label ); |
|
| 70 | + $class = $key == $current_tab ? 'nav-tab nav-tab-active' : 'nav-tab'; |
|
| 71 | + $url = esc_url( |
|
| 72 | + add_query_arg( 'tab', $key, admin_url( 'admin.php?page=wpinv-reports' ) ) |
|
| 73 | + ); |
|
| 74 | 74 | |
| 75 | - echo "\n\t\t\t<a href='$url' class='$class'>$label</a>"; |
|
| 75 | + echo "\n\t\t\t<a href='$url' class='$class'>$label</a>"; |
|
| 76 | 76 | |
| 77 | - } |
|
| 78 | - ?> |
|
| 77 | + } |
|
| 78 | + ?> |
|
| 79 | 79 | |
| 80 | 80 | </nav> |
| 81 | 81 | |
@@ -86,77 +86,77 @@ discard block |
||
| 86 | 86 | </div> |
| 87 | 87 | <?php |
| 88 | 88 | |
| 89 | - // Wordfence loads an unsupported version of chart js on our page. |
|
| 90 | - wp_deregister_style( 'chart-js' ); |
|
| 91 | - wp_deregister_script( 'chart-js' ); |
|
| 92 | - wp_enqueue_script( 'chart-js', WPINV_PLUGIN_URL . 'assets/js/chart.bundle.min.js', array( 'jquery' ), '2.9.4', true ); |
|
| 93 | - wp_enqueue_style( 'chart-js', WPINV_PLUGIN_URL . 'assets/css/chart.min.css', array(), '2.9.4' ); |
|
| 94 | - |
|
| 95 | - } |
|
| 96 | - |
|
| 97 | - /** |
|
| 98 | - * Retrieves reports page tabs. |
|
| 99 | - * |
|
| 100 | - * @return array |
|
| 101 | - */ |
|
| 102 | - public function get_tabs() { |
|
| 103 | - |
|
| 104 | - $tabs = array( |
|
| 105 | - 'reports' => __( 'Reports', 'invoicing' ), |
|
| 106 | - 'export' => __( 'Export', 'invoicing' ), |
|
| 107 | - ); |
|
| 108 | - |
|
| 109 | - return apply_filters( 'getpaid_report_tabs', $tabs ); |
|
| 110 | - } |
|
| 111 | - |
|
| 112 | - /** |
|
| 113 | - * Displays the reports tab. |
|
| 114 | - * |
|
| 115 | - */ |
|
| 116 | - public function display_reports_tab() { |
|
| 117 | - |
|
| 118 | - $reports = new GetPaid_Reports_Report(); |
|
| 119 | - $reports->display(); |
|
| 120 | - |
|
| 121 | - } |
|
| 122 | - |
|
| 123 | - /** |
|
| 124 | - * Displays the exports tab. |
|
| 125 | - * |
|
| 126 | - */ |
|
| 127 | - public function display_exports_tab() { |
|
| 128 | - |
|
| 129 | - $exports = new GetPaid_Reports_Export(); |
|
| 130 | - $exports->display(); |
|
| 131 | - |
|
| 132 | - } |
|
| 133 | - |
|
| 134 | - /** |
|
| 135 | - * Donwnloads a graph. |
|
| 136 | - * |
|
| 137 | - * @param array $args |
|
| 138 | - */ |
|
| 139 | - public function download_graph( $args ) { |
|
| 140 | - |
|
| 141 | - if ( ! empty( $args['graph'] ) ) { |
|
| 142 | - $downloader = new GetPaid_Graph_Downloader(); |
|
| 143 | - $downloader->download( $args['graph'] ); |
|
| 144 | - } |
|
| 145 | - |
|
| 146 | - } |
|
| 147 | - |
|
| 148 | - /** |
|
| 149 | - * Exports invoices. |
|
| 150 | - * |
|
| 151 | - * @param array $args |
|
| 152 | - */ |
|
| 153 | - public function export_invoices( $args ) { |
|
| 154 | - |
|
| 155 | - if ( ! empty( $args['post_type'] ) ) { |
|
| 156 | - $downloader = new GetPaid_Invoice_Exporter(); |
|
| 157 | - $downloader->export( $args['post_type'], $args ); |
|
| 158 | - } |
|
| 159 | - |
|
| 160 | - } |
|
| 89 | + // Wordfence loads an unsupported version of chart js on our page. |
|
| 90 | + wp_deregister_style( 'chart-js' ); |
|
| 91 | + wp_deregister_script( 'chart-js' ); |
|
| 92 | + wp_enqueue_script( 'chart-js', WPINV_PLUGIN_URL . 'assets/js/chart.bundle.min.js', array( 'jquery' ), '2.9.4', true ); |
|
| 93 | + wp_enqueue_style( 'chart-js', WPINV_PLUGIN_URL . 'assets/css/chart.min.css', array(), '2.9.4' ); |
|
| 94 | + |
|
| 95 | + } |
|
| 96 | + |
|
| 97 | + /** |
|
| 98 | + * Retrieves reports page tabs. |
|
| 99 | + * |
|
| 100 | + * @return array |
|
| 101 | + */ |
|
| 102 | + public function get_tabs() { |
|
| 103 | + |
|
| 104 | + $tabs = array( |
|
| 105 | + 'reports' => __( 'Reports', 'invoicing' ), |
|
| 106 | + 'export' => __( 'Export', 'invoicing' ), |
|
| 107 | + ); |
|
| 108 | + |
|
| 109 | + return apply_filters( 'getpaid_report_tabs', $tabs ); |
|
| 110 | + } |
|
| 111 | + |
|
| 112 | + /** |
|
| 113 | + * Displays the reports tab. |
|
| 114 | + * |
|
| 115 | + */ |
|
| 116 | + public function display_reports_tab() { |
|
| 117 | + |
|
| 118 | + $reports = new GetPaid_Reports_Report(); |
|
| 119 | + $reports->display(); |
|
| 120 | + |
|
| 121 | + } |
|
| 122 | + |
|
| 123 | + /** |
|
| 124 | + * Displays the exports tab. |
|
| 125 | + * |
|
| 126 | + */ |
|
| 127 | + public function display_exports_tab() { |
|
| 128 | + |
|
| 129 | + $exports = new GetPaid_Reports_Export(); |
|
| 130 | + $exports->display(); |
|
| 131 | + |
|
| 132 | + } |
|
| 133 | + |
|
| 134 | + /** |
|
| 135 | + * Donwnloads a graph. |
|
| 136 | + * |
|
| 137 | + * @param array $args |
|
| 138 | + */ |
|
| 139 | + public function download_graph( $args ) { |
|
| 140 | + |
|
| 141 | + if ( ! empty( $args['graph'] ) ) { |
|
| 142 | + $downloader = new GetPaid_Graph_Downloader(); |
|
| 143 | + $downloader->download( $args['graph'] ); |
|
| 144 | + } |
|
| 145 | + |
|
| 146 | + } |
|
| 147 | + |
|
| 148 | + /** |
|
| 149 | + * Exports invoices. |
|
| 150 | + * |
|
| 151 | + * @param array $args |
|
| 152 | + */ |
|
| 153 | + public function export_invoices( $args ) { |
|
| 154 | + |
|
| 155 | + if ( ! empty( $args['post_type'] ) ) { |
|
| 156 | + $downloader = new GetPaid_Invoice_Exporter(); |
|
| 157 | + $downloader->export( $args['post_type'], $args ); |
|
| 158 | + } |
|
| 159 | + |
|
| 160 | + } |
|
| 161 | 161 | |
| 162 | 162 | } |
@@ -5,7 +5,7 @@ discard block |
||
| 5 | 5 | * |
| 6 | 6 | */ |
| 7 | 7 | |
| 8 | -defined( 'ABSPATH' ) || exit; |
|
| 8 | +defined('ABSPATH') || exit; |
|
| 9 | 9 | |
| 10 | 10 | /** |
| 11 | 11 | * GetPaid_Reports Class. |
@@ -17,11 +17,11 @@ discard block |
||
| 17 | 17 | * |
| 18 | 18 | */ |
| 19 | 19 | public function __construct() { |
| 20 | - add_action( 'admin_menu', array( $this, 'register_reports_page' ), 20 ); |
|
| 21 | - add_action( 'wpinv_reports_tab_reports', array( $this, 'display_reports_tab' ) ); |
|
| 22 | - add_action( 'wpinv_reports_tab_export', array( $this, 'display_exports_tab' ) ); |
|
| 23 | - add_action( 'getpaid_authenticated_admin_action_download_graph', array( $this, 'download_graph' ) ); |
|
| 24 | - add_action( 'getpaid_authenticated_admin_action_export_invoices', array( $this, 'export_invoices' ) ); |
|
| 20 | + add_action('admin_menu', array($this, 'register_reports_page'), 20); |
|
| 21 | + add_action('wpinv_reports_tab_reports', array($this, 'display_reports_tab')); |
|
| 22 | + add_action('wpinv_reports_tab_export', array($this, 'display_exports_tab')); |
|
| 23 | + add_action('getpaid_authenticated_admin_action_download_graph', array($this, 'download_graph')); |
|
| 24 | + add_action('getpaid_authenticated_admin_action_export_invoices', array($this, 'export_invoices')); |
|
| 25 | 25 | |
| 26 | 26 | } |
| 27 | 27 | |
@@ -33,11 +33,11 @@ discard block |
||
| 33 | 33 | |
| 34 | 34 | add_submenu_page( |
| 35 | 35 | 'wpinv', |
| 36 | - __( 'Reports', 'invoicing' ), |
|
| 37 | - __( 'Reports', 'invoicing' ), |
|
| 36 | + __('Reports', 'invoicing'), |
|
| 37 | + __('Reports', 'invoicing'), |
|
| 38 | 38 | wpinv_get_capability(), |
| 39 | 39 | 'wpinv-reports', |
| 40 | - array( $this, 'display_reports_page' ) |
|
| 40 | + array($this, 'display_reports_page') |
|
| 41 | 41 | ); |
| 42 | 42 | |
| 43 | 43 | } |
@@ -50,26 +50,26 @@ discard block |
||
| 50 | 50 | |
| 51 | 51 | // Prepare variables. |
| 52 | 52 | $tabs = $this->get_tabs(); |
| 53 | - $current_tab = isset( $_GET['tab'] ) ? sanitize_text_field( $_GET['tab'] ) : 'reports'; |
|
| 54 | - $current_tab = array_key_exists( $current_tab, $tabs ) ? $current_tab : 'reports'; |
|
| 53 | + $current_tab = isset($_GET['tab']) ? sanitize_text_field($_GET['tab']) : 'reports'; |
|
| 54 | + $current_tab = array_key_exists($current_tab, $tabs) ? $current_tab : 'reports'; |
|
| 55 | 55 | |
| 56 | 56 | // Display the current tab. |
| 57 | 57 | ?> |
| 58 | 58 | |
| 59 | 59 | <div class="wrap"> |
| 60 | 60 | |
| 61 | - <h1><?php echo sanitize_text_field( $tabs[ $current_tab ] ); ?></h1> |
|
| 61 | + <h1><?php echo sanitize_text_field($tabs[$current_tab]); ?></h1> |
|
| 62 | 62 | |
| 63 | 63 | <nav class="nav-tab-wrapper"> |
| 64 | 64 | |
| 65 | 65 | <?php |
| 66 | - foreach( $tabs as $key => $label ) { |
|
| 66 | + foreach ($tabs as $key => $label) { |
|
| 67 | 67 | |
| 68 | - $key = sanitize_text_field( $key ); |
|
| 69 | - $label = sanitize_text_field( $label ); |
|
| 68 | + $key = sanitize_text_field($key); |
|
| 69 | + $label = sanitize_text_field($label); |
|
| 70 | 70 | $class = $key == $current_tab ? 'nav-tab nav-tab-active' : 'nav-tab'; |
| 71 | 71 | $url = esc_url( |
| 72 | - add_query_arg( 'tab', $key, admin_url( 'admin.php?page=wpinv-reports' ) ) |
|
| 72 | + add_query_arg('tab', $key, admin_url('admin.php?page=wpinv-reports')) |
|
| 73 | 73 | ); |
| 74 | 74 | |
| 75 | 75 | echo "\n\t\t\t<a href='$url' class='$class'>$label</a>"; |
@@ -79,18 +79,18 @@ discard block |
||
| 79 | 79 | |
| 80 | 80 | </nav> |
| 81 | 81 | |
| 82 | - <div class="bsui <?php echo esc_attr( $current_tab ); ?>"> |
|
| 83 | - <?php do_action( "wpinv_reports_tab_{$current_tab}" ); ?> |
|
| 82 | + <div class="bsui <?php echo esc_attr($current_tab); ?>"> |
|
| 83 | + <?php do_action("wpinv_reports_tab_{$current_tab}"); ?> |
|
| 84 | 84 | </div> |
| 85 | 85 | |
| 86 | 86 | </div> |
| 87 | 87 | <?php |
| 88 | 88 | |
| 89 | 89 | // Wordfence loads an unsupported version of chart js on our page. |
| 90 | - wp_deregister_style( 'chart-js' ); |
|
| 91 | - wp_deregister_script( 'chart-js' ); |
|
| 92 | - wp_enqueue_script( 'chart-js', WPINV_PLUGIN_URL . 'assets/js/chart.bundle.min.js', array( 'jquery' ), '2.9.4', true ); |
|
| 93 | - wp_enqueue_style( 'chart-js', WPINV_PLUGIN_URL . 'assets/css/chart.min.css', array(), '2.9.4' ); |
|
| 90 | + wp_deregister_style('chart-js'); |
|
| 91 | + wp_deregister_script('chart-js'); |
|
| 92 | + wp_enqueue_script('chart-js', WPINV_PLUGIN_URL . 'assets/js/chart.bundle.min.js', array('jquery'), '2.9.4', true); |
|
| 93 | + wp_enqueue_style('chart-js', WPINV_PLUGIN_URL . 'assets/css/chart.min.css', array(), '2.9.4'); |
|
| 94 | 94 | |
| 95 | 95 | } |
| 96 | 96 | |
@@ -102,11 +102,11 @@ discard block |
||
| 102 | 102 | public function get_tabs() { |
| 103 | 103 | |
| 104 | 104 | $tabs = array( |
| 105 | - 'reports' => __( 'Reports', 'invoicing' ), |
|
| 106 | - 'export' => __( 'Export', 'invoicing' ), |
|
| 105 | + 'reports' => __('Reports', 'invoicing'), |
|
| 106 | + 'export' => __('Export', 'invoicing'), |
|
| 107 | 107 | ); |
| 108 | 108 | |
| 109 | - return apply_filters( 'getpaid_report_tabs', $tabs ); |
|
| 109 | + return apply_filters('getpaid_report_tabs', $tabs); |
|
| 110 | 110 | } |
| 111 | 111 | |
| 112 | 112 | /** |
@@ -136,11 +136,11 @@ discard block |
||
| 136 | 136 | * |
| 137 | 137 | * @param array $args |
| 138 | 138 | */ |
| 139 | - public function download_graph( $args ) { |
|
| 139 | + public function download_graph($args) { |
|
| 140 | 140 | |
| 141 | - if ( ! empty( $args['graph'] ) ) { |
|
| 141 | + if (!empty($args['graph'])) { |
|
| 142 | 142 | $downloader = new GetPaid_Graph_Downloader(); |
| 143 | - $downloader->download( $args['graph'] ); |
|
| 143 | + $downloader->download($args['graph']); |
|
| 144 | 144 | } |
| 145 | 145 | |
| 146 | 146 | } |
@@ -150,11 +150,11 @@ discard block |
||
| 150 | 150 | * |
| 151 | 151 | * @param array $args |
| 152 | 152 | */ |
| 153 | - public function export_invoices( $args ) { |
|
| 153 | + public function export_invoices($args) { |
|
| 154 | 154 | |
| 155 | - if ( ! empty( $args['post_type'] ) ) { |
|
| 155 | + if (!empty($args['post_type'])) { |
|
| 156 | 156 | $downloader = new GetPaid_Invoice_Exporter(); |
| 157 | - $downloader->export( $args['post_type'], $args ); |
|
| 157 | + $downloader->export($args['post_type'], $args); |
|
| 158 | 158 | } |
| 159 | 159 | |
| 160 | 160 | } |