AyeCode / invoicing

includes/libraries/wp-session/class-wp-session.php

Doc Comments -1 removed lines

@@ -48,7 +48,6 @@
 	/**
 	 * Retrieve the current session instance.
 	 *
-	 * @param bool $session_id Session ID from which to populate data.
 	 *
 	 * @return bool|WP_Session
 	 */

includes/libraries/wpinv-euvat/class-wpinv-euvat.php

Doc Comments +10 added lines

@@ -407,6 +407,10 @@ 
         exit;
     }
     
+    /**
+     * @param string $source_url
+     * @param string $destination_file
+     */
     public static function geoip2_download_file( $source_url, $destination_file ) {
         $success    = false;
         $message    = '';
@@ -1192,6 +1196,9 @@ 
         return apply_filters( 'wpinv_response_euvatrates', $response, $group );
     }    
     
+    /**
+     * @param boolean $is_digital
+     */
     public static function requires_vat( $requires_vat = false, $user_id = 0, $is_digital = null ) {
         global $wpi_item_id, $wpi_country;
         
@@ -1412,6 +1419,9 @@ 
         return apply_filters( 'wpinv_item_is_taxable', $is_taxable, $item_id, $country , $state );
     }
     
+    /**
+     * @param string|null $state
+     */
     public static function find_rate( $country, $state, $rate, $class ) {
         global $wpi_zero_tax;
 

includes/wpinv-discount-functions.php

Doc Comments +18 added lines

@@ -324,12 +324,18 @@ 
     return apply_filters( 'wpinv_get_discount_code', $code, $code_id );
 }
 
+/**
+ * @return string
+ */
 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 );
 }
 
+/**
+ * @return string
+ */
 function wpinv_get_discount_expiration( $code_id = null ) {
     $expiration = get_post_meta( $code_id, '_wpi_discount_expiration', true );
 
@@ -652,6 +658,9 @@ 
     return (bool) apply_filters( 'wpinv_is_discount_item_req_met', $ret, $code_id, $condition );
 }
 
+/**
+ * @param string $code
+ */
 function wpinv_is_discount_used( $code = null, $user = '', $code_id = 0 ) {
     global $wpi_checkout_id;
     
@@ -817,6 +826,9 @@ 
 
 }
 
+/**
+ * @param double $amount
+ */
 function wpinv_format_discount_rate( $type, $amount ) {
     if ( $type == 'flat' ) {
         return wpinv_price( wpinv_format_amount( $amount ) );
@@ -861,6 +873,9 @@ 
     return $discounts;
 }
 
+/**
+ * @return boolean
+ */
 function wpinv_unset_cart_discount( $code = '' ) {    
     $discounts = wpinv_get_cart_discounts();
 
@@ -1175,6 +1190,9 @@ 
 }
 //add_action( 'init', 'wpinv_apply_preset_discount', 999 );
 
+/**
+ * @param integer $code
+ */
 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 );

includes/wpinv-invoice-functions.php

Doc Comments +6 added lines

@@ -176,6 +176,9 @@ 
     return $date_created;
 }
 
+/**
+ * @return string
+ */
 function wpinv_get_invoice_date( $invoice_id = 0, $format = '' ) {
     $invoice = new WPInv_Invoice( $invoice_id );
     
@@ -1375,6 +1378,9 @@ 
     return $display;
 }
 
+/**
+ * @return integer
+ */
 function wpinv_get_invoice_id_by_key( $key ) {
 	global $wpdb;
 

includes/wpinv-item-functions.php

Doc Comments +3 added lines

@@ -529,6 +529,9 @@
     return apply_filters( 'wpinv_get_cart_item_price_name', $name, $item['id'], $price_id, $item );
 }
 
+/**
+ * @return string
+ */
 function wpinv_get_cart_item_name( $item = array() ) {
     $item_title = !empty( $item['name'] ) ? $item['name'] : get_the_title( $item['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
+ */
 function wpinv_currency_decimal_filter( $decimals = 2 ) {
     $currency = wpinv_get_currency();
 

includes/wpinv-user-functions.php

Doc Comments +3 added lines

@@ -161,6 +161,9 @@
     wp_redirect( $redirect_to );
 }
 
+/**
+ * @param integer $user_id
+ */
 function wpinv_login_user( $user_id ) {
     if ( is_user_logged_in() ) {
         return true;

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-helper-functions.php

Doc Comments +28 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();
@@ -117,6 +126,9 @@ 
     return $status;
 }
 
+/**
+ * @return string
+ */
 function wpinv_get_currency() {
     $currency = wpinv_get_option( 'currency', 'USD' );
     
@@ -187,6 +199,9 @@ 
     return apply_filters( 'wpinv_currency_symbol', $currency_symbol, $currency );
 }
 
+/**
+ * @return string
+ */
 function wpinv_currency_position() {
     $position = wpinv_get_option( 'currency_position', 'left' );
     
@@ -315,6 +330,9 @@ 
     return $price;
 }
 
+/**
+ * @return string
+ */
 function wpinv_format_amount( $amount, $decimals = NULL, $calculate = false ) {
     $thousands_sep = wpinv_thousands_separator();
     $decimal_sep   = wpinv_decimal_separator();
@@ -365,6 +383,9 @@ 
     return apply_filters( 'wpinv_sanitize_key', $key, $raw_key );
 }
 
+/**
+ * @return string
+ */
 function wpinv_get_file_extension( $str ) {
     $parts = explode( '.', $str );
     return end( $parts );
@@ -569,6 +590,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 );
@@ -577,6 +601,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 );
@@ -654,7 +681,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' ) ) {