wpinv_check_discount_dates() - Code Metrics - Inspection of "Bugs" - AyeCode/invoicing - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#257)

unknown
created 2020-02-07 12:09 UTC
wpinv_check_discount_dates() A

↳ Parent: Project
Complexity

Conditions	2
Paths	2
Size

Total Lines	4
Code Lines	3
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	2
eloc	3
c	1
b	0
f	0
nc	2
nop	1
dl	0
loc	4
rs	10
<?php
/**
 * Contains functions related to Invoicing plugin.
 *
 * @since 1.0.0
 * @package Invoicing
 */
 
// MUST have WordPress.
if ( !defined( 'WPINC' ) ) {
    exit( 'Do NOT access this file directly: ' . basename( __FILE__ ) );
}

function wpinv_get_discount_types() {
    $discount_types = array(
                        'percent'   => __( 'Percentage', 'invoicing' ),
                        'flat'     => __( 'Flat Amount', 'invoicing' ),
                    );
    return (array)apply_filters( 'wpinv_discount_types', $discount_types );
}

function wpinv_get_discount_type_name( $type = '' ) {
    $types = wpinv_get_discount_types();
    return isset( $types[ $type ] ) ? $types[ $type ] : '';
}

function wpinv_delete_discount( $data ) {
    if ( ! isset( $data['_wpnonce'] ) || ! wp_verify_nonce( $data['_wpnonce'], 'wpinv_discount_nonce' ) ) {
        wp_die( __( 'Trying to cheat or something?', 'invoicing' ), __( 'Error', 'invoicing' ), array( 'response' => 403 ) );
    }

    if( ! wpinv_current_user_can_manage_invoicing() ) {
        wp_die( __( 'You do not have permission to delete discount codes', 'invoicing' ), __( 'Error', 'invoicing' ), array( 'response' => 403 ) );
    }

    $discount_id = $data['discount'];
    wpinv_remove_discount( $discount_id );
}
add_action( 'wpinv_delete_discount', 'wpinv_delete_discount' );

function wpinv_activate_discount( $data ) {
    if ( ! isset( $data['_wpnonce'] ) || ! wp_verify_nonce( $data['_wpnonce'], 'wpinv_discount_nonce' ) ) {
        wp_die( __( 'Trying to cheat or something?', 'invoicing' ), __( 'Error', 'invoicing' ), array( 'response' => 403 ) );
    }

    if( ! wpinv_current_user_can_manage_invoicing() ) {
        wp_die( __( 'You do not have permission to edit discount codes', 'invoicing' ), __( 'Error', 'invoicing' ), array( 'response' => 403 ) );
    }

    $id = absint( $data['discount'] );
    wpinv_update_discount_status( $id, 'publish' );
}
add_action( 'wpinv_activate_discount', 'wpinv_activate_discount' );

function wpinv_deactivate_discount( $data ) {
    if ( ! isset( $data['_wpnonce'] ) || ! wp_verify_nonce( $data['_wpnonce'], 'wpinv_discount_nonce' ) ) {
        wp_die( __( 'Trying to cheat or something?', 'invoicing' ), __( 'Error', 'invoicing' ), array( 'response' => 403 ) );
    }

    if( ! wpinv_current_user_can_manage_invoicing() ) {
        wp_die( __( 'You do not have permission to create discount codes', 'invoicing' ), array( 'response' => 403 ) );
        wp_die( __( 'You do not have permission to create discount codes', 'invoicing' ), /** @scrutinizer ignore-type */ array( 'response' => 403 ) );
    }

    $id = absint( $data['discount'] );
    wpinv_update_discount_status( $id, 'pending' );
}
add_action( 'wpinv_deactivate_discount', 'wpinv_deactivate_discount' );

function wpinv_get_discounts( $args = array() ) {
    $defaults = array(
        'post_type'      => 'wpi_discount',
        'posts_per_page' => 20,
        'paged'          => null,
        'post_status'    => array( 'publish', 'pending', 'draft', 'expired' )
    );

    $args = wp_parse_args( $args, $defaults );

    $discounts = get_posts( $args );

    if ( $discounts ) {
        return $discounts;
    }

    if( ! $discounts && ! empty( $args['s'] ) ) {
        $args['meta_key']     = '_wpi_discount_code';
        $args['meta_value']   = $args['s'];
        $args['meta_compare'] = 'LIKE';
        unset( $args['s'] );
        $discounts = get_posts( $args );
    }

    if( $discounts ) {
        return $discounts;
    }

    return false;
}

function wpinv_get_all_discounts( $args = array() ) {

    $args = wp_parse_args( $args, array(
        'status'         => array( 'publish' ),
        'limit'          => get_option( 'posts_per_page' ),
        'page'           => 1,
        'exclude'        => array(),
        'orderby'        => 'date',
        'order'          => 'DESC',
        'type'           => array_keys( wpinv_get_discount_types() ),
        'meta_query'     => array(),
        'return'         => 'objects',
        'paginate'       => false,
    ) );

    $wp_query_args = array(
        'post_type'      => 'wpi_discount',
        'post_status'    => $args['status'],
        'posts_per_page' => $args['limit'],
        'meta_query'     => $args['meta_query'],
        'fields'         => 'ids',
        'orderby'        => $args['orderby'],
        'order'          => $args['order'],
        'paged'          => absint( $args['page'] ),
    );

    if ( ! empty( $args['exclude'] ) ) {
        $wp_query_args['post__not_in'] = array_map( 'absint', $args['exclude'] );
    }

    if ( ! $args['paginate' ] ) {
        $wp_query_args['no_found_rows'] = true;
    }

    if ( ! empty( $args['search'] ) ) {

        $wp_query_args['meta_query'][] = array(
            'key'     => '_wpi_discount_code',
            'value'   => $args['search'],
            'compare' => 'LIKE',
        );

    }
    
    if ( ! empty( $args['type'] ) ) {
        $types = wpinv_parse_list( $args['type'] );
        $wp_query_args['meta_query'][] = array(
            'key'     => '_wpi_discount_type',
            'value'   => implode( ',', $types ),
            'compare' => 'IN',
        );
    }

    $wp_query_args = apply_filters('wpinv_get_discount_args', $wp_query_args, $args);

    // Get results.
    $discounts = new WP_Query( $wp_query_args );

    if ( 'objects' === $args['return'] ) {
        $return = array_map( 'get_post', $discounts->posts );
    } elseif ( 'self' === $args['return'] ) {
        return $discounts;
    } else {
        $return = $discounts->posts;
    }

    if ( $args['paginate' ] ) {
        return (object) array(
            'discounts'      => $return,
            'total'         => $discounts->found_posts,
            'max_num_pages' => $discounts->max_num_pages,
        );
    } else {
        return $return;
    }

}

function wpinv_has_active_discounts() {
    $has_active = false;

    $discounts  = wpinv_get_discounts();

    if ( $discounts) {
        foreach ( $discounts as $discount ) {
            if ( wpinv_is_discount_active( $discount->ID ) ) {
                $has_active = true;
                break;
            }
        }
    }
    return $has_active;
}

function wpinv_get_discount( $discount_id = 0 ) {
    if( empty( $discount_id ) ) {
        return false;
    }
    
    if ( get_post_type( $discount_id ) != 'wpi_discount' ) {
        return false;
    }

    $discount = get_post( $discount_id );

    return $discount;
}

/**
 * Fetches a discount object.
 * 
 * @param int|array|string|WPInv_Discount $discount discount data, object, ID or code.
 * @since 1.0.14
 * @return WPInv_Discount
 */
function wpinv_get_discount_obj( $discount = 0 ) {
    return new WPInv_Discount( $discount );
}

/**
 * Fetch a discount from the db/cache using its discount code.
 * 
 * @param string $code The discount code.
 * @return bool|WP_Post
 */
function wpinv_get_discount_by_code( $code = '' ) {
    return wpinv_get_discount_by( 'code', $code );
}

/**
 * Fetch a discount from the db/cache using a given field.
 * 
 * @param string $field The field to query against: 'ID', 'discount_code', 'code', 'name'
 * @param string|int $value The field value
 * @return bool|WP_Post
 */
function wpinv_get_discount_by( $field = '', $value = '' ) {
    $data = WPInv_Discount::get_data_by( $field, $value );
    if( empty( $data ) ) {
        return false;
    }

    return get_post( $data['ID'] );
}

/**
 * Updates a discount in the database.
 * 
 * @param int $post_id The discount's ID.
 * @param array $data The discount's properties.
 * @return bool
 */
function wpinv_store_discount( $post_id, $data ) {

    // Fetch existing data.
    $existing_data = WPInv_Discount::get_data_by( 'id', $post_id );
    if( empty( $existing_data ) ) {
        return false;
    }

    $meta = array(
        'code'              => isset( $data['code'] )             ? sanitize_text_field( $data['code'] )              : $existing_data['code'],
        'type'              => isset( $data['type'] )             ? sanitize_text_field( $data['type'] )              : $existing_data['type'],
        'amount'            => isset( $data['amount'] )           ? wpinv_sanitize_amount( $data['amount'] )          : $existing_data['amount'],
        'start'             => isset( $data['start'] )            ? sanitize_text_field( $data['start'] )             : $existing_data['start'],
        'expiration'        => isset( $data['expiration'] )       ? sanitize_text_field( $data['expiration'] )        : $existing_data['expiration'],
        'min_total'         => isset( $data['min_total'] )        ? wpinv_sanitize_amount( $data['min_total'] )       : $existing_data['min_total'],
        'max_total'         => isset( $data['max_total'] )        ? wpinv_sanitize_amount( $data['max_total'] )       : $existing_data['max_total'],
        'max_uses'          => isset( $data['max_uses'] )         ? absint( $data['max_uses'] )                       : $existing_data['max_uses'],
        'items'             => isset( $data['items'] )            ? $data['items']                                    : $existing_data['items'],
        'excluded_items'    => isset( $data['excluded_items'] )   ? $data['excluded_items']                           : $existing_data['excluded_items'],
        'is_recurring'      => isset( $data['recurring'] )        ? (bool)$data['recurring']                          : $existing_data['is_recurring'],
        'is_single_use'     => isset( $data['single_use'] )       ? (bool)$data['single_use']                         : false,
        'uses'              => isset( $data['uses'] )             ? (int)$data['uses']                                : $existing_data['uses'],
    );

    // Merge it into the new data and save.
    $data          = array_merge( $existing_data, $meta );
    $data          = array_merge( /** @scrutinizer ignore-type */ $existing_data, $meta );
    $discount      = wpinv_get_discount_obj( $data );
    return $discount->save();
}

/**
 * Delectes a discount from the database.
 * 
 * @param int|array|string|WPInv_Discount $discount discount data, object, ID or code.
 * @return bool
 */
function wpinv_remove_discount( $discount = 0 ) {

    $discount = wpinv_get_discount_obj( $discount );
    if( ! $discount->exists() ) {
        return false;
    }

    $discount->remove();
    return true;
}

/**
 * Updates a discount status.
 * 
 * @param int|array|string|WPInv_Discount $discount discount data, object, ID or code.
 * @param string $new_status
 * @return bool
 */
function wpinv_update_discount_status( $discount = 0, $new_status = 'publish' ) {
    $discount = wpinv_get_discount_obj( $discount );
    return $discount->update_status( $new_status );
}

/**
 * Checks if a discount exists.
 * 
 * @param int|array|string|WPInv_Discount $discount discount data, object, ID or code.
 * @return bool
 */
function wpinv_discount_exists( $discount ) {
    $discount = wpinv_get_discount_obj( $discount );
    return $discount->exists();
}

function wpinv_is_discount_active( $code_id = null ) {
    $discount = wpinv_get_discount(  $code_id );
    $return   = false;

    if ( $discount ) {
        if ( wpinv_is_discount_expired( $code_id ) ) {
            if( defined( 'DOING_AJAX' ) ) {
                wpinv_set_error( 'wpinv-discount-error', __( 'This discount is expired.', 'invoicing' ) );
            }
        } elseif ( $discount->post_status == 'publish' ) {
            $return = true;
        } else {
            if( defined( 'DOING_AJAX' ) ) {
                wpinv_set_error( 'wpinv-discount-error', __( 'This discount is not active.', 'invoicing' ) );
            }
        }
    }

    return apply_filters( 'wpinv_is_discount_active', $return, $code_id );
}

function wpinv_get_discount_code( $code_id = null ) {
    $code = get_post_meta( $code_id, '_wpi_discount_code', true );

    return apply_filters( 'wpinv_get_discount_code', $code, $code_id );
}

function wpinv_get_discount_start_date( $code_id = null ) {
    $start_date = get_post_meta( $code_id, '_wpi_discount_start', true );

    return apply_filters( 'wpinv_get_discount_start_date', $start_date, $code_id );
}

function wpinv_get_discount_expiration( $code_id = null ) {
    $expiration = get_post_meta( $code_id, '_wpi_discount_expiration', true );

    return apply_filters( 'wpinv_get_discount_expiration', $expiration, $code_id );
}

/**
 * Returns the number of maximum number of times a discount can been used.
 * 
 * @param int|array|string|WPInv_Discount $discount discount data, object, ID or code.
 * @return int
 */
function wpinv_get_discount_max_uses( $discount = array() ) {
    $discount = wpinv_get_discount_obj( $discount );
    return (int) $discount->max_uses;
}

/**
 * Returns the number of times a discount has been used.
 * 
 * @param int|array|string|WPInv_Discount $discount discount data, object, ID or code.
 * @return int
 */
function wpinv_get_discount_uses( $discount = array() ) {
    $discount = wpinv_get_discount_obj( $discount );
    return (int) $discount->uses;
}

/**
 * Returns the minimum invoice amount required to use a discount.
 * 
 * @param int|array|string|WPInv_Discount $discount discount data, object, ID or code.
 * @return float
 */
function wpinv_get_discount_min_total( $discount = array() ) {
    $discount = wpinv_get_discount_obj( $discount );
    return (float) $discount->min_total;
}

/**
 * Returns the maximum invoice amount required to use a discount.
 * 
 * @param int|array|string|WPInv_Discount $discount discount data, object, ID or code.
 * @return float
 */
function wpinv_get_discount_max_total( $discount = array() ) {
    $discount = wpinv_get_discount_obj( $discount );
    return (float) $discount->max_total;
}

/**
 * Returns a discount's amount.
 * 
 * @param int|array|string|WPInv_Discount $discount discount data, object, ID or code.
 * @return float
 */
function wpinv_get_discount_amount( $discount = array() ) {
    $discount = wpinv_get_discount_obj( $discount );
    return (float) $discount->amount;
}

/**
 * Returns a discount's type.
 * 
 * @param int|array|string|WPInv_Discount $discount discount data, object, ID or code.
 * @param bool $name 
 * @return string
 */
function wpinv_get_discount_type( $discount = array(), $name = false ) {
    $discount = wpinv_get_discount_obj( $discount );

    // Are we returning the name or just the type.
    if( $name ) {
        return $discount->discount_type_name;

    }

    return $discount->discount_type;

}

function wpinv_discount_status( $status ) {
    switch( $status ){
        case 'expired' :
            $name = __( 'Expired', 'invoicing' );
            break;
        case 'publish' :
        case 'active' :
            $name = __( 'Active', 'invoicing' );
            break;
        default :
            $name = __( 'Inactive', 'invoicing' );
            break;
    }
    return $name;
}

/**
 * Returns a discount's excluded items.
 * 
 * @param int|array|string|WPInv_Discount $discount discount data, object, ID or code.
 * @return array
 */
function wpinv_get_discount_excluded_items( $discount = array() ) {
    $discount = wpinv_get_discount_obj( $discount );
    return $discount->excluded_items;
}

/**
 * Returns a discount's required items.
 * 
 * @param int|array|string|WPInv_Discount $discount discount data, object, ID or code.
 * @return array
 */
function wpinv_get_discount_item_reqs( $discount = array() ) {
    $discount = wpinv_get_discount_obj( $discount );
    return $discount->items;
}

function wpinv_get_discount_item_condition( $code_id = 0 ) {
    return get_post_meta( $code_id, '_wpi_discount_item_condition', true );
}

function wpinv_is_discount_not_global( $code_id = 0 ) {
    return (bool) get_post_meta( $code_id, '_wpi_discount_is_not_global', true );
}

/**
 * Checks if a given discount has expired.
 * 
 * @param int|array|string|WPInv_Discount $discount discount data, object, ID or code.
 * @return bool
 */
function wpinv_is_discount_expired( $discount = array() ) {
    $discount = wpinv_get_discount_obj( $discount );

    if ( $discount->is_expired() ) {
        $discount->update_status( 'pending' );
        return true;
    }

    return false;
}

/**
 * Checks if a given discount has started.
 * 
 * @param int|array|string|WPInv_Discount $discount discount data, object, ID or code.
 * @return bool
 */
function wpinv_is_discount_started( $discount = array() ) {
    $discount = wpinv_get_discount_obj( $discount );
    $started  = $discount->has_started();

    if( empty( $started ) ) {
        wpinv_set_error( 'wpinv-discount-error', __( 'This discount is not active yet.', 'invoicing' ) );
    }

    return $started;
}

/**
 * Checks discount dates.
 * 
 * @param int|array|string|WPInv_Discount $discount discount data, object, ID or code.
 * @return bool
 */
function wpinv_check_discount_dates( $discount ) {
    $discount = wpinv_get_discount_obj( $discount );
    $return   = wpinv_is_discount_started( $discount ) && wpinv_is_discount_expired( $discount );
    return apply_filters( 'wpinv_check_discount_dates', $return, $discount->ID, $discount, $discount->code );
}

/**
 * Checks if a discount is maxed out.
 * 
 * @param int|array|string|WPInv_Discount $discount discount data, object, ID or code.
 * @return bool
 */
function wpinv_is_discount_maxed_out( $discount ) {
    $discount    = wpinv_get_discount_obj( $discount );
    $maxed_out   = $discount->has_exceeded_limit();

    if ( $maxed_out ) {
        wpinv_set_error( 'wpinv-discount-error', __( 'This discount has reached its maximum usage.', 'invoicing' ) );
    }

    return $maxed_out;
} 

/**
 * Checks if an amount meets a discount's minimum amount.
 * 
 * @param int|array|string|WPInv_Discount $discount discount data, object, ID or code.
 * @return bool
 */
function wpinv_discount_is_min_met( $discount ) {
    $discount    = wpinv_get_discount_obj( $discount );
    $cart_amount = (float)wpinv_get_cart_discountable_subtotal( $discount->ID );
    $min_met     = $discount->is_minimum_amount_met( $cart_amount );

    if ( ! $min_met ) {
        wpinv_set_error( 'wpinv-discount-error', sprintf( __( 'Minimum invoice amount should be %s', 'invoicing' ), wpinv_price( wpinv_format_amount( $discount->min_total ) ) ) );
    }

    return $min_met;
}

/**
 * Checks if an amount meets a discount's maximum amount.
 * 
 * @param int|array|string|WPInv_Discount $discount discount data, object, ID or code.
 * @return bool
 */
function wpinv_discount_is_max_met( $discount ) {
    $discount    = wpinv_get_discount_obj( $discount );
    $cart_amount = (float)wpinv_get_cart_discountable_subtotal( $discount->ID );
    $max_met     = $discount->is_maximum_amount_met( $cart_amount );

    if ( ! $max_met ) {
        wpinv_set_error( 'wpinv-discount-error', sprintf( __( 'Maximum invoice amount should be %s', 'invoicing' ), wpinv_price( wpinv_format_amount( $discount->max_total ) ) ) );
    }

    return $max_met;
}

/**
 * Checks if a discount can only be used once per user.
 * 
 * @param int|array|string|WPInv_Discount $discount discount data, object, ID or code.
 * @return bool
 */
function wpinv_discount_is_single_use( $discount ) {
    $discount    = wpinv_get_discount_obj( $discount );
    return $discount->is_single_use;
}

/**
 * Checks if a discount is recurring.
 * 
 * @param int|array|string|WPInv_Discount $discount discount data, object, ID or code.
 * @param int|array|string|WPInv_Discount $code discount data, object, ID or code.
 * @return bool
 */
function wpinv_discount_is_recurring( $discount = 0, $code = 0 ) {

    if( ! empty( $discount ) ) {
        $discount    = wpinv_get_discount_obj( $discount );
    } else {
        $discount    = wpinv_get_discount_obj( $code );
    }
    
    return $discount->is_recurring;
}

function wpinv_discount_item_reqs_met( $code_id = null ) {
    $item_reqs    = wpinv_get_discount_item_reqs( $code_id );
    $condition    = wpinv_get_discount_item_condition( $code_id );
    $excluded_ps  = wpinv_get_discount_excluded_items( $code_id );
    $cart_items   = wpinv_get_cart_contents();
    $cart_ids     = $cart_items ? wp_list_pluck( $cart_items, 'id' ) : null;
    $ret          = false;

    if ( empty( $item_reqs ) && empty( $excluded_ps ) ) {
        $ret = true;
    }

    // Normalize our data for item requirements, exclusions and cart data
    // First absint the items, then sort, and reset the array keys
    $item_reqs = array_map( 'absint', $item_reqs );
    asort( $item_reqs );
    $item_reqs = array_values( $item_reqs );

    $excluded_ps  = array_map( 'absint', $excluded_ps );
    asort( $excluded_ps );
    $excluded_ps  = array_values( $excluded_ps );

    $cart_ids     = array_map( 'absint', $cart_ids );
    $cart_ids     = array_map( 'absint', /** @scrutinizer ignore-type */ $cart_ids );
    asort( $cart_ids );
    $cart_ids     = array_values( $cart_ids );

    // Ensure we have requirements before proceeding
    if ( !$ret && ! empty( $item_reqs ) ) {
        switch( $condition ) {
            case 'all' :
                // Default back to true
                $ret = true;

                foreach ( $item_reqs as $item_id ) {
                    if ( !wpinv_item_in_cart( $item_id ) ) {
                        wpinv_set_error( 'wpinv-discount-error', __( 'The item requirements for this discount are not met.', 'invoicing' ) );
                        $ret = false;
                        break;
                    }
                }

                break;

            default : // Any
                foreach ( $item_reqs as $item_id ) {
                    if ( wpinv_item_in_cart( $item_id ) ) {
                        $ret = true;
                        break;
                    }
                }

                if( ! $ret ) {
                    wpinv_set_error( 'wpinv-discount-error', __( 'The item requirements for this discount are not met.', 'invoicing' ) );
                }

                break;
        }
    } else {
        $ret = true;
    }

    if( ! empty( $excluded_ps ) ) {
        // Check that there are items other than excluded ones in the cart
        if( $cart_ids == $excluded_ps ) {
            wpinv_set_error( 'wpinv-discount-error', __( 'This discount is not valid for the cart contents.', 'invoicing' ) );
            $ret = false;
        }
    }

    return (bool) apply_filters( 'wpinv_is_discount_item_req_met', $ret, $code_id, $condition );
}

/**
 * Checks if a discount has already been used by the user.
 * 
 * @param int|array|string|WPInv_Discount $discount discount data, object, ID or code.
 * @param int|string $user The user id, login or email
 * @param int|array|string|WPInv_Discount $code_id discount data, object, ID or code.
 * @return boll
filter:
    dependency_paths: ["lib/*"]
 */
function wpinv_is_discount_used( $discount = array(), $user = '', $code_id = array() ) {
    
    if( ! empty( $discount ) ) {
        $discount = wpinv_get_discount_obj( $discount );
    } else {
        $discount = wpinv_get_discount_obj( $code_id );
    }

    $is_used = ! $discount->is_valid_for_user( $user );
    $is_used = apply_filters( 'wpinv_is_discount_used', $is_used, $discount->code, $user, $discount->id, $discount );


    if( $is_used ) {
        wpinv_set_error( 'wpinv-discount-error', __( 'This discount has already been redeemed.', 'invoicing' ) );
    }

    return $is_used();
}

function wpinv_is_discount_valid( $code = '', $user = '', $set_error = true ) {
    $return      = false;
    $discount_id = wpinv_get_discount_id_by_code( $code );
    $user        = trim( $user );

    if ( wpinv_get_cart_contents() ) {
        if ( $discount_id ) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            if (
                wpinv_is_discount_active( $discount_id ) &&
                wpinv_check_discount_dates( $discount_id ) &&
                !wpinv_is_discount_maxed_out( $discount_id ) &&
                !wpinv_is_discount_used( $code, $user, $discount_id ) &&
                wpinv_discount_is_min_met( $discount_id ) &&
                wpinv_discount_is_max_met( $discount_id ) &&
                wpinv_discount_item_reqs_met( $discount_id )
            ) {
                $return = true;
            }
        } elseif( $set_error ) {
            wpinv_set_error( 'wpinv-discount-error', __( 'This discount is invalid.', 'invoicing' ) );
        }
    }

    return apply_filters( 'wpinv_is_discount_valid', $return, $discount_id, $code, $user );
}

function wpinv_get_discount_id_by_code( $code ) {
    $discount = wpinv_get_discount_by_code( $code );
    if( $discount ) {
        return $discount->ID;
    }
    return false;
}

/**
 * Calculates the discounted amount.
 * 
 * @param int|array|string|WPInv_Discount $discount discount data, object, ID or code.
 * @param float $base_price The number of usages to increase by
 * @return float
 */
function wpinv_get_discounted_amount( $discount, $base_price ) {
    $discount = wpinv_get_discount_obj( $discount );
    return $discount->get_discounted_amount( $base_price );
}

/**
 * Increases a discount's usage count.
 * 
 * @param int|array|string|WPInv_Discount $discount discount data, object, ID or code.
 * @param int $by The number of usages to increase by.
 * @return int the new number of uses.
 */
function wpinv_increase_discount_usage( $discount, $by = 1 ) {
    $discount   = wpinv_get_discount_obj( $discount );
    return $discount->increase_usage( $by );

}

/**
 * Decreases a discount's usage count.
 * 
 * @param int|array|string|WPInv_Discount $discount discount data, object, ID or code.
 * @param int $by The number of usages to decrease by.
 * @return int the new number of uses.
 */
function wpinv_decrease_discount_usage( $discount, $by = 1 ) {
    $discount   = wpinv_get_discount_obj( $discount );
    return $discount->increase_usage( 0 - $by );

}

function wpinv_format_discount_rate( $type, $amount ) {
    if ( $type == 'flat' ) {
        return wpinv_price( wpinv_format_amount( $amount ) );
    } else {
        return $amount . '%';
    }
}

function wpinv_set_cart_discount( $code = '' ) {    
    if ( wpinv_multiple_discounts_allowed() ) {
        // Get all active cart discounts
        $discounts = wpinv_get_cart_discounts();
    } else {
        $discounts = false; // Only one discount allowed per purchase, so override any existing
    }

    if ( $discounts ) {
        $key = array_search( strtolower( $code ), array_map( 'strtolower', $discounts ) );
        if( false !== $key ) {
            unset( $discounts[ $key ] ); // Can't set the same discount more than once
        }
        $discounts[] = $code;
    } else {
        $discounts = array();
        $discounts[] = $code;
    }
    $discounts = array_values( $discounts );
    
    $data = wpinv_get_checkout_session();
    if ( empty( $data ) ) {
        $data = array();
    } else {
        if ( !empty( $data['invoice_id'] ) && $payment_meta = wpinv_get_invoice_meta( $data['invoice_id'] ) ) {
            $payment_meta['user_info']['discount']  = implode( ',', $discounts );
            update_post_meta( $data['invoice_id'], '_wpinv_payment_meta', $payment_meta );
        }
    }
    $data['cart_discounts'] = $discounts;
    
    wpinv_set_checkout_session( $data );
    
    return $discounts;
}

function wpinv_unset_cart_discount( $code = '' ) {    
    $discounts = wpinv_get_cart_discounts();

    if ( $code && !empty( $discounts ) && in_array( $code, $discounts ) ) {
        $key = array_search( $code, $discounts );
        unset( $discounts[ $key ] );
            
        $data = wpinv_get_checkout_session();
        $data['cart_discounts'] = $discounts;
        if ( !empty( $data['invoice_id'] ) && $payment_meta = wpinv_get_invoice_meta( $data['invoice_id'] ) ) {
            $payment_meta['user_info']['discount']  = !empty( $discounts ) ? implode( ',', $discounts ) : '';
            update_post_meta( $data['invoice_id'], '_wpinv_payment_meta', $payment_meta );
        }
        
        wpinv_set_checkout_session( $data );
    }

    return $discounts;
}

function wpinv_unset_all_cart_discounts() {
    $data = wpinv_get_checkout_session();
    
    if ( !empty( $data ) && isset( $data['cart_discounts'] ) ) {
        unset( $data['cart_discounts'] );
        
         wpinv_set_checkout_session( $data );
         return true;
    }
    
    return false;
}

function wpinv_get_cart_discounts( $items = array() ) {
function wpinv_get_cart_discounts( /** @scrutinizer ignore-unused */ $items = array() ) {
    $session = wpinv_get_checkout_session();
    
    $discounts = !empty( $session['cart_discounts'] ) ? $session['cart_discounts'] : false;
    return $discounts;
}

function wpinv_cart_has_discounts( $items = array() ) {
    $ret = false;

    if ( wpinv_get_cart_discounts( $items ) ) {
        $ret = true;
    }
    
    /*
    $invoice = wpinv_get_invoice_cart();
    if ( !empty( $invoice ) && ( $invoice->get_discount() > 0 || $invoice->get_discount_code() ) ) {
        $ret = true;
    }
    */

    return apply_filters( 'wpinv_cart_has_discounts', $ret );
}

function wpinv_get_cart_discounted_amount( $items = array(), $discounts = false ) {
function wpinv_get_cart_discounted_amount( $items = array(), /** @scrutinizer ignore-unused */ $discounts = false ) {
    $amount = 0.00;
    $items  = !empty( $items ) ? $items : wpinv_get_cart_content_details();

    if ( $items ) {
        $discounts = wp_list_pluck( $items, 'discount' );

        if ( is_array( $discounts ) ) {

            $discounts = array_map( 'floatval', $discounts );
            $amount    = array_sum( $discounts );
        }
    }

    return apply_filters( 'wpinv_get_cart_discounted_amount', $amount );
}

function wpinv_get_cart_items_discount_amount( $items = array(), $discount = false ) {
    $items  = !empty( $items ) ? $items : wpinv_get_cart_content_details();
    
    if ( empty( $discount ) || empty( $items ) ) {
        return 0;
    }

    $amount = 0;
    
    foreach ( $items as $item ) {
        $amount += wpinv_get_cart_item_discount_amount( $item, $discount );
    }
    
    $amount = wpinv_round_amount( $amount );

    return $amount;
}

function wpinv_get_cart_item_discount_amount( $item = array(), $discount = false ) {
    global $wpinv_is_last_cart_item, $wpinv_flat_discount_total;
    
    $amount = 0;

    if ( empty( $item ) || empty( $item['id'] ) ) {
        return $amount;
    }

    if ( empty( $item['quantity'] ) ) {
        return $amount;
    }

    if ( empty( $item['options'] ) ) {
        $item['options'] = array();
    }

    $price            = wpinv_get_cart_item_price( $item['id'], $item, $item['options'] );
    $discounted_price = $price;

    $discounts = false === $discount ? wpinv_get_cart_discounts() : $discount;
    if ( empty( $discounts ) ) {
        return $amount;
    }

    if ( $discounts ) {
        if ( is_array( $discounts ) ) {
            $discounts = array_values( $discounts );
        } else {
            $discounts = explode( ',', $discounts );
        }
    }

    if( $discounts ) {
        foreach ( $discounts as $discount ) {
            $code_id = wpinv_get_discount_id_by_code( $discount );

            // Check discount exists
            if( ! $code_id ) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
                continue;
            }

            $reqs           = wpinv_get_discount_item_reqs( $code_id );
            $excluded_items = wpinv_get_discount_excluded_items( $code_id );

            // Make sure requirements are set and that this discount shouldn't apply to the whole cart
            if ( !empty( $reqs ) && wpinv_is_discount_not_global( $code_id ) ) {
                foreach ( $reqs as $item_id ) {
                    if ( $item_id == $item['id'] && ! in_array( $item['id'], $excluded_items ) ) {
                        $discounted_price -= $price - wpinv_get_discounted_amount( $discount, $price );
                    }
                }
            } else {
                // This is a global cart discount
                if ( !in_array( $item['id'], $excluded_items ) ) {
                    if ( 'flat' === wpinv_get_discount_type( $code_id ) ) {
                        $items_subtotal    = 0.00;
                        $cart_items        = wpinv_get_cart_contents();
                        
                        foreach ( $cart_items as $cart_item ) {
                            if ( ! in_array( $cart_item['id'], $excluded_items ) ) {
                                $options = !empty( $cart_item['options'] ) ? $cart_item['options'] : array();
                                $item_price      = wpinv_get_cart_item_price( $cart_item['id'], $cart_item, $options );
                                $items_subtotal += $item_price * $cart_item['quantity'];
                            }
                        }

                        $subtotal_percent  = ( ( $price * $item['quantity'] ) / $items_subtotal );
                        $code_amount       = wpinv_get_discount_amount( $code_id );
                        $discounted_amount = $code_amount * $subtotal_percent;
                        $discounted_price -= $discounted_amount;

                        $wpinv_flat_discount_total += round( $discounted_amount, wpinv_currency_decimal_filter() );

                        if ( $wpinv_is_last_cart_item && $wpinv_flat_discount_total < $code_amount ) {
                            $adjustment = $code_amount - $wpinv_flat_discount_total;
                            $discounted_price -= $adjustment;
                        }
                    } else {
                        $discounted_price -= $price - wpinv_get_discounted_amount( $discount, $price );
                    }
                }
            }
        }

        $amount = ( $price - apply_filters( 'wpinv_get_cart_item_discounted_amount', $discounted_price, $discounts, $item, $price ) );

        if ( 'flat' !== wpinv_get_discount_type( $code_id ) ) {

            $amount = $amount * $item['quantity'];
        }
    }

    return $amount;
}

function wpinv_cart_discounts_html( $items = array() ) {
    echo wpinv_get_cart_discounts_html( $items );
}

function wpinv_get_cart_discounts_html( $items = array(), $discounts = false ) {
    global $wpi_cart_columns;
    
    $items  = !empty( $items ) ? $items : wpinv_get_cart_content_details();
    
    if ( !$discounts ) {
        $discounts = wpinv_get_cart_discounts( $items );
    }

    if ( !$discounts ) {
        return;
    }
    
    $discounts = is_array( $discounts ) ? $discounts : array( $discounts );
    
    $html = '';

    foreach ( $discounts as $discount ) {
        $discount_id    = wpinv_get_discount_id_by_code( $discount );
        $discount_value = wpinv_get_discount_amount( $discount_id );
        $rate           = wpinv_format_discount_rate( wpinv_get_discount_type( $discount_id ), $discount_value );
        $amount         = wpinv_get_cart_items_discount_amount( $items, $discount );
        $remove_btn     = '<a title="' . esc_attr__( 'Remove discount', 'invoicing' ) . '" data-code="' . $discount . '" data-value="' . $discount_value . '" class="wpi-discount-remove" href="javascript:void(0);">[<i class="fa fa-times" aria-hidden="true"></i>]</a> ';
        
        $html .= '<tr class="wpinv_cart_footer_row wpinv_cart_discount_row">';
        ob_start();
        do_action( 'wpinv_checkout_table_discount_first', $items );
        $html .= ob_get_clean();
        $html .= '<td class="wpinv_cart_discount_label text-right" colspan="' . $wpi_cart_columns . '">' . $remove_btn . '<strong>' . wpinv_cart_discount_label( $discount, $rate, false ) . '</strong></td><td class="wpinv_cart_discount text-right"><span data-discount="' . $amount . '" class="wpinv_cart_discount_amount">&ndash;' . wpinv_price( wpinv_format_amount( $amount ) ) . '</span></td>';
        ob_start();
        do_action( 'wpinv_checkout_table_discount_last', $items );
        $html .= ob_get_clean();
        $html .= '</tr>';
    }

    return apply_filters( 'wpinv_get_cart_discounts_html', $html, $discounts, $rate );

}

function wpinv_display_cart_discount( $formatted = false, $echo = false ) {
function wpinv_display_cart_discount( /** @scrutinizer ignore-unused */ $formatted = false, $echo = false ) {
    $discounts = wpinv_get_cart_discounts();

    if ( empty( $discounts ) ) {
        return false;
    }

    $discount_id  = wpinv_get_discount_id_by_code( $discounts[0] );
    $amount       = wpinv_format_discount_rate( wpinv_get_discount_type( $discount_id ), wpinv_get_discount_amount( $discount_id ) );

    if ( $echo ) {
        echo $amount;
    }

    return $amount;
}

function wpinv_remove_cart_discount() {
    if ( !isset( $_GET['discount_id'] ) || ! isset( $_GET['discount_code'] ) ) {
        return;
    }

    do_action( 'wpinv_pre_remove_cart_discount', absint( $_GET['discount_id'] ) );

    wpinv_unset_cart_discount( urldecode( $_GET['discount_code'] ) );

    do_action( 'wpinv_post_remove_cart_discount', absint( $_GET['discount_id'] ) );

    wp_redirect( wpinv_get_checkout_uri() ); wpinv_die();
    wp_redirect( /** @scrutinizer ignore-type */ wpinv_get_checkout_uri() ); wpinv_die();
}
add_action( 'wpinv_remove_cart_discount', 'wpinv_remove_cart_discount' );

function wpinv_maybe_remove_cart_discount( $cart_key = 0 ) {
function wpinv_maybe_remove_cart_discount( /** @scrutinizer ignore-unused */ $cart_key = 0 ) {
    $discounts = wpinv_get_cart_discounts();

    if ( !$discounts ) {
        return;
    }

    foreach ( $discounts as $discount ) {
        if ( !wpinv_is_discount_valid( $discount ) ) {
            wpinv_unset_cart_discount( $discount );
        }
    }
}
add_action( 'wpinv_post_remove_from_cart', 'wpinv_maybe_remove_cart_discount' );

function wpinv_multiple_discounts_allowed() {
    $ret = wpinv_get_option( 'allow_multiple_discounts', false );
    return (bool) apply_filters( 'wpinv_multiple_discounts_allowed', $ret );
}

function wpinv_get_discount_label( $code, $echo = true ) {
    $label = wp_sprintf( __( 'Discount%1$s', 'invoicing' ), ( $code != '' && $code != 'none' ? ' (<code>' . $code . '</code>)': '' ) );
    $label = apply_filters( 'wpinv_get_discount_label', $label, $code );

    if ( $echo ) {
        echo $label;
    } else {
        return $label;
    }
}

function wpinv_cart_discount_label( $code, $rate, $echo = true ) {
    $label = wp_sprintf( __( 'Discount: %s', 'invoicing' ), $code );
    $label = apply_filters( 'wpinv_cart_discount_label', $label, $code, $rate );

    if ( $echo ) {
        echo $label;
    } else {
        return $label;
    }
}

function wpinv_check_delete_discount( $check, $post ) {
    if ( $post->post_type == 'wpi_discount' && wpinv_get_discount_uses( $post->ID ) > 0 ) {
        return true;
    }
    
    return $check;
}
add_filter( 'pre_delete_post', 'wpinv_check_delete_discount', 10, 2 );

function wpinv_checkout_form_validate_discounts() {
    global $wpi_checkout_id;
    
    $discounts = wpinv_get_cart_discounts();
    
    if ( !empty( $discounts ) ) {
        $invalid = false;
        
        foreach ( $discounts as $key => $code ) {
            if ( !wpinv_is_discount_valid( $code, (int)wpinv_get_user_id( $wpi_checkout_id ) ) ) {
                $invalid = true;
                
                wpinv_unset_cart_discount( $code );
            }
        }
        
        if ( $invalid ) {
            $errors = wpinv_get_errors();
            $error  = !empty( $errors['wpinv-discount-error'] ) ? $errors['wpinv-discount-error'] . ' ' : '';
            $error  .= __( 'The discount has been removed from cart.', 'invoicing' );
            wpinv_set_error( 'wpinv-discount-error', $error );
            
            wpinv_recalculate_tax( true );
        }
    }
}
add_action( 'wpinv_before_checkout_form', 'wpinv_checkout_form_validate_discounts', -10 );

function wpinv_discount_amount() {
    $output = 0.00;
    
    return apply_filters( 'wpinv_discount_amount', $output );
}
AyeCode / invoicing

Pull Request — master (#257)

wpinv_check_discount_dates() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
