Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo
  • Hook Reference
  • Docs Home

Packages

  • Deposits-for-WooCommerce
    • Bookings
    • Cart
    • Order
    • Other
    • Payment-Plans
      • Views
    • Products
    • Settings

Classes

  • DFW_Deposits
  • DFW_Deposits_For_Bookings
  • DFW_Deposits_Plan
  • DFW_Deposits_Settings
  • DFW_License
  • DFW_Manage_Cart
  • DFW_Manage_Order_Items
  • DFW_Manage_Orders
  • DFW_Manage_Plans
  • DFW_Manage_Products
  • DFW_Payment_Plans_List
  • DFW_Plans_Admin_Settings
  • DFW_Product_Admin_Settings
  • DFW_Scheduled_Plan_Orders
  • DFW_Update_DB
  • EDD_DEPOSITS_Plugin_Updater

Functions

  • dfw_update_po_file
  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 
<?php
/** 
 * Payment Plans 
 * 
 * @author Tyche Softwares
 * @since 1.0 
 * @category Classes
 * @package Deposits-for-WooCommerce/Payment-Plans
 */

class DFW_Deposits_Plan {
    
    private $id;
    private $name;
    private $desc;
    private $schedule;

    /**
     * Constructor function to get a payment plan's data 
     * 
     * @param array $plan Payment Plan object
     * @since 1.0
     */
    public function __construct( $plan ) {

        if( is_numeric( $plan ) ) {
            global $wpdb;
            $wpdb->dfw_deposits_payment_plans = $wpdb->prefix . 'dfw_deposits_payment_plans';
            $plan   = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$wpdb->dfw_deposits_payment_plans} WHERE ID = %d", absint( $plan ) ) );
        }
        $this->id   = $plan->ID;
        $this->name = $plan->name;
        $this->desc = $plan->description;
    }

    /**
     * Get the ID for a payment Plan
     * 
     * @return int
     * @since 1.0
     */
    public function get_plan_id() {
        return $this->id;
    }

    /**
     * Get the name of a payment plan
     * 
     * @return string
     * @since 1.0
     */
    public function get_plan_name() {
        return $this->name;
    }

    /**
     * Get the description for a payment plan
     * 
     * @return string
     * @since 1.0
     */
    public function get_plan_description() {
        return $this->desc;
    }

   /**
     * Get the full schedule for a payment plan
     * 
     * @return array
     * @since 1.0
     */
    public function get_plan_schedule() {

        if( ! $this->schedule ) {
            global $wpdb;
            $wpdb->dfw_deposits_payment_plans_schedule = $wpdb->prefix . 'dfw_deposits_payment_plans_schedule';
            $this->schedule = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM {$wpdb->dfw_deposits_payment_plans_schedule} WHERE plan_id = %d", $this->get_plan_id() ) );
        }

        return $this->schedule;
    }


    /**
     * Get the total amount of percentage added for a payment plan
     * 
     * @return int
     * @since 1.0
     */
    public function get_total_percent() {
        $schedule      = $this->get_plan_schedule();
        $total_percent = 0;

        foreach ( $schedule as $row ) {
            $total_percent += $row->plan_amount;
        }

        return $total_percent;
    }

    /**
     * Display the formatted schedule in the Payment Plans settings
     * 
     * @since 1.0
     */
    public function get_formatted_plan_schedule( $plan_amount = '' ){

        $schedule = $this->get_plan_schedule();
        $percent  = $this->get_total_percent();
        $days     = 0;
        $months   = 0;
        $years    = 0;
        $duration = array();

        foreach( $schedule as $row ){

            switch( $row->plan_interval_time ){
                case 'days':
                    $days += $row->plan_interval_amount;
                break;

                case 'weeks':
                    $days += ( 7 *  $row->plan_interval_amount );
                break;

                case 'months':
                    $months += $row->plan_interval_amount;
                break;

                case 'years':
                    $years += $row->plan_interval_amount;
                break;

            }
        }

        if ( $years ) {
            $duration[] = sprintf( _n( '%s year', '%s years', $years, 'deposits-for-woocommerce' ), $years );
        }

        if ( $months ) {
            $duration[] = sprintf( _n( '%s month', '%s months', $months, 'deposits-for-woocommerce' ), $months );
        }

        if ( $days ) {
            $duration[] = sprintf( _n( '%s day', '%s days', $days, 'deposits-for-woocommerce' ), $days );
        }

        if( ! $plan_amount ){
            $plan_amount = $percent . '%';
        } else{
            $plan_amount = wc_price( $plan_amount );
        }

        if( $duration ) {
             return sprintf( __( '%1$s payable over %2$s', 'deposits-for-woocommerce' ), $plan_amount, implode( ', ', $duration ) );  
        } else {
             return sprintf( __( '%1$s total payable', 'deposits-for-woocommerce' ), $plan_amount );
        }
    }
}

API documentation generated by ApiGen