AyeCode / invoicing

includes/class-wpinv-api.php

Doc Comments +8 added lines

@@ -47,6 +47,9 @@ 
         }
     }
     
+    /**
+     * @param integer $code
+     */
     public function send_status( $code ) {
         status_header( $code );
     }
@@ -195,6 +198,11 @@ 
 class WPInv_API_Exception extends Exception {
     protected $error_code;
 
+    /**
+     * @param string $error_code
+     * @param string $error_message
+     * @param integer $http_status_code
+     */
     public function __construct( $error_code, $error_message, $http_status_code ) {
         $this->error_code = $error_code;
         parent::__construct( $error_message, $http_status_code );

includes/wpinv-email-functions.php

Doc Comments +6 added lines

@@ -664,6 +664,9 @@ 
     return $sent;
 }
 
+/**
+ * @return string
+ */
 function wpinv_mail_get_from_address() {
     $from_address = apply_filters( 'wpinv_mail_from_address', wpinv_get_option( 'email_from' ) );
     return sanitize_email( $from_address );
@@ -1123,6 +1126,9 @@ 
 }
 add_filter( 'wpinv_settings_sections_emails', 'wpinv_settings_sections_emails', 10, 1 );
 
+/**
+ * @param string $email_type
+ */
 function wpinv_email_is_enabled( $email_type ) {
     $emails = wpinv_get_emails();
     $enabled = isset( $emails[$email_type] ) && wpinv_get_option( 'email_'. $email_type . '_active', 0 ) ? true : false;

includes/class-wpinv-invoice.php

Doc Comments +24 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',
@@ -1381,6 +1387,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 ) {
@@ -1389,6 +1398,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;
@@ -1491,10 +1503,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 );
     }
@@ -1537,6 +1555,9 @@ 
         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 );
     }
@@ -1555,6 +1576,9 @@ 
         return apply_filters( 'wpinv_completed_date', $this->completed_date, $this->ID, $this );
     }
     
+    /**
+     * @return string
+     */
     public function get_invoice_date( $formatted = true ) {
         $date_completed = $this->completed_date;
         $invoice_date   = $date_completed != '' && $date_completed != '0000-00-00 00:00:00' ? $date_completed : '';

includes/wpinv-helper-functions.php

Doc Comments +30 added lines, -1 removed lines

@@ -31,6 +31,9 @@ 
     return apply_filters( 'wpinv_get_ip', $ip );
 }
 
+/**
+ * @return string
+ */
 function wpinv_get_user_agent() {
     if ( ! empty( $_SERVER['HTTP_USER_AGENT'] ) ) {
         $user_agent = sanitize_text_field( $_SERVER['HTTP_USER_AGENT'] );
@@ -41,6 +44,9 @@ 
     return apply_filters( 'wpinv_get_user_agent', $user_agent );
 }
 
+/**
+ * @param integer $decimals
+ */
 function wpinv_sanitize_amount( $amount, $decimals = NULL ) {
     $is_negative   = false;
     $thousands_sep = wpinv_thousands_separator();
@@ -79,6 +85,9 @@ 
 }
 add_filter( 'wpinv_sanitize_amount_decimals', 'wpinv_currency_decimal_filter', 10, 1 );
 
+/**
+ * @param integer $decimals
+ */
 function wpinv_round_amount( $amount, $decimals = NULL ) {
     if ( $decimals === NULL ) {
         $decimals = wpinv_decimals();
@@ -298,6 +307,9 @@ 
     return apply_filters( 'wpinv_currency_symbol', $currency_symbol, $currency );
 }
 
+/**
+ * @return string
+ */
 function wpinv_currency_position() {
     $position = wpinv_get_option( 'currency_position', 'left' );
     
@@ -556,6 +568,9 @@ 
     return $price;
 }
 
+/**
+ * @return string
+ */
 function wpinv_format_amount( $amount, $decimals = NULL, $calculate = false ) {
     $thousands_sep = wpinv_thousands_separator();
     $decimal_sep   = wpinv_decimal_separator();
@@ -606,6 +621,9 @@ 
     return apply_filters( 'wpinv_sanitize_key', $key, $raw_key );
 }
 
+/**
+ * @return string
+ */
 function wpinv_get_file_extension( $str ) {
     $parts = explode( '.', $str );
     return end( $parts );
@@ -810,6 +828,9 @@ 
     return strlen( $str );
 }
 
+/**
+ * @param string $str
+ */
 function wpinv_utf8_strtolower( $str, $encoding = 'UTF-8' ) {
     if ( function_exists( 'mb_strtolower' ) ) {
         return mb_strtolower( $str, $encoding );
@@ -818,6 +839,9 @@ 
     return strtolower( $str );
 }
 
+/**
+ * @param string $str
+ */
 function wpinv_utf8_strtoupper( $str, $encoding = 'UTF-8' ) {
     if ( function_exists( 'mb_strtoupper' ) ) {
         return mb_strtoupper( $str, $encoding );
@@ -895,7 +919,7 @@ 
  *
  * @param string $str The string being decoded.
  * @param string $encoding The encoding parameter is the character encoding. Default "UTF-8".
- * @return string The width of string.
+ * @return integer The width of string.
  */
 function wpinv_utf8_strwidth( $str, $encoding = 'UTF-8' ) {
     if ( function_exists( 'mb_strwidth' ) ) {
@@ -946,6 +970,11 @@ 
     return $period;
 }
 
+/**
+ * @param integer $calendar
+ * @param string $month
+ * @param string $year
+ */
 function wpinv_cal_days_in_month( $calendar, $month, $year ) {
     if ( function_exists( 'cal_days_in_month' ) ) {
         return cal_days_in_month( $calendar, $month, $year );

includes/wpinv-invoice-functions.php

Doc Comments +12 added lines

@@ -488,6 +488,9 @@ 
     return $invoice->get_description();
 }
 
+/**
+ * @return string
+ */
 function wpinv_get_invoice_currency_code( $invoice_id = 0 ) {
     $invoice = new WPInv_Invoice( $invoice_id );
     return $invoice->get_currency();
@@ -521,6 +524,9 @@ 
     return $invoice->get_gateway_title();
 }
 
+/**
+ * @return string
+ */
 function wpinv_get_payment_transaction_id( $invoice_id ) {
     $invoice = new WPInv_Invoice( $invoice_id );
     
@@ -616,6 +622,9 @@ 
     return $invoice->get_total( $currency );
 }
 
+/**
+ * @return string
+ */
 function wpinv_get_date_created( $invoice_id = 0, $format = '' ) {
     $invoice = new WPInv_Invoice( $invoice_id );
 
@@ -626,6 +635,9 @@ 
     return $date_created;
 }
 
+/**
+ * @return string
+ */
 function wpinv_get_invoice_date( $invoice_id = 0, $format = '', $default = true ) {
     $invoice = new WPInv_Invoice( $invoice_id );
     

includes/wpinv-subscription.php

Doc Comments +5 added lines, -5 removed lines

@@ -370,7 +370,7 @@ 
 	 * Retrieves the transaction ID from the subscription
 	 *
 	 * @since  1.0.0
-	 * @return bool
+	 * @return string
 	 */
 	public function get_transaction_id() {
 
@@ -392,7 +392,7 @@ 
 	 * Stores the transaction ID for the subscription purchase
 	 *
 	 * @since  1.0.0.4
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public function set_transaction_id( $txn_id = '' ) {
 		$this->update( array( 'transaction_id' => $txn_id ) );
@@ -403,7 +403,7 @@ 
 	 * Renews a subscription
 	 *
 	 * @since  1.0.0
-	 * @return bool
+	 * @return boolean|null
 	 */
 	public function renew() {
 
@@ -492,7 +492,7 @@ 
 	 *
 	 * @since  1.0.0
 	 * @param  $check_expiration bool True if expiration date should be checked with merchant processor before expiring
-	 * @return void
+	 * @return false|null
 	 */
 	public function expire( $check_expiration = false ) {
 
@@ -744,7 +744,7 @@ 
 	 * Retrieves the subscription status
 	 *
 	 * @since  1.0.0
-	 * @return int
+	 * @return string
 	 */
 	public function get_status() {
 

includes/gateways/authorizenet.php

Doc Comments +3 added lines

@@ -648,6 +648,9 @@
 }
 add_filter( 'wpinv_enabled_payment_gateways', 'wpinv_check_authorizenet_currency_support', 10, 1 );
 
+/**
+ * @param WPInv_Invoice $invoice
+ */
 function wpinv_authorizenet_link_transaction_id( $transaction_id, $invoice_id, $invoice ) {
     if ( $transaction_id == $invoice_id ) {
         $link = $transaction_id;

includes/gateways/paypal.php

Doc Comments +3 added lines

@@ -757,6 +757,9 @@
 }
 add_filter( 'wpinv_payment_get_transaction_id-paypal', 'wpinv_paypal_get_transaction_id', 10, 1 );
 
+/**
+ * @param WPInv_Invoice $invoice
+ */
 function wpinv_paypal_link_transaction_id( $transaction_id, $invoice_id, $invoice ) {
     if ( $transaction_id == $invoice_id ) {
         $transaction_link = $transaction_id;

includes/wpinv-tax-functions.php

Doc Comments +3 added lines

@@ -194,6 +194,9 @@
     return apply_filters( 'wpinv_is_tax_exclusive', $ret, $item_id );
 }
 
+/**
+ * @return integer|null
+ */
 function wpinv_currency_decimal_filter( $decimals = 2 ) {
     $currency = wpinv_get_currency();