AyeCode / invoicing

includes/class-wpinv-invoice.php

Doc Comments +36 added lines

@@ -83,6 +83,9 @@ 
         return $value;
     }
 
+    /**
+     * @param string $key
+     */
     public function set( $key, $value ) {
         $ignore = array( 'items', 'cart_details', 'fees', '_ID' );
 
@@ -921,6 +924,9 @@ 
         return $removed;
     }
 
+    /**
+     * @param string $key
+     */
     public function remove_fee_by( $key, $value, $global = false ) {
         $allowed_fee_keys = apply_filters( 'wpinv_fee_keys', array(
             'index', 'label', 'amount', 'type',
@@ -1380,6 +1386,9 @@ 
         return apply_filters( 'wpinv_get_invoice_final_total', $final_total, $this, $currency );
     }
     
+    /**
+     * @return boolean
+     */
     public function get_discounts( $array = false ) {
         $discounts = $this->discounts;
         if ( $array && $discounts ) {
@@ -1388,6 +1397,9 @@ 
         return apply_filters( 'wpinv_payment_discounts', $discounts, $this->ID, $this, $array );
     }
     
+    /**
+     * @return string
+     */
     public function get_discount( $currency = false, $dash = false ) {
         if ( !empty( $this->discounts ) ) {
             global $ajax_cart_details;
@@ -1490,10 +1502,16 @@ 
         return apply_filters( 'wpinv_user_full_name', $this->full_name, $this->ID, $this );
     }
     
+    /**
+     * @return string
+     */
     public function get_user_info() {
         return apply_filters( 'wpinv_user_info', $this->user_info, $this->ID, $this );
     }
     
+    /**
+     * @return string
+     */
     public function get_email() {
         return apply_filters( 'wpinv_user_email', $this->email, $this->ID, $this );
     }
@@ -1536,10 +1554,16 @@ 
         return apply_filters( 'wpinv_currency_code', $this->currency, $this->ID, $this );
     }
     
+    /**
+     * @return string
+     */
     public function get_created_date() {
         return apply_filters( 'wpinv_created_date', $this->date, $this->ID, $this );
     }
     
+    /**
+     * @return string
+     */
     public function get_due_date( $display = false ) {
         $due_date = apply_filters( 'wpinv_due_date', $this->due_date, $this->ID, $this );
         
@@ -2103,6 +2127,9 @@ 
         return apply_filters( 'wpinv_invoice_get_subscription_name', $name, $this );
     }
         
+    /**
+     * @return string
+     */
     public function get_expiration() {
         $expiration = $this->get_meta( '_wpinv_subscr_expiration', true );
         return $expiration;
@@ -2118,6 +2145,9 @@ 
         return $cancelled_date;
     }
     
+    /**
+     * @return string
+     */
     public function get_trial_end_date( $formatted = true ) {
         if ( !$this->is_free_trial() || ! ( $this->is_paid() || $this->is_refunded() ) ) {
             return NULL;
@@ -2139,6 +2169,9 @@ 
         return $trial_end_date;
     }
     
+    /**
+     * @return string
+     */
     public function get_subscription_created( $default = true ) {
         $created = $this->get_meta( '_wpinv_subscr_created', true );
         
@@ -2148,6 +2181,9 @@ 
         return $created;
     }
     
+    /**
+     * @return string
+     */
     public function get_subscription_start( $formatted = true ) {
         if ( ! ( $this->is_paid() || $this->is_refunded() ) ) {
             return '-';