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/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/wpinv-template-functions.php

Doc Comments +9 added lines

@@ -140,6 +140,9 @@ 
 	do_action( 'wpinv_after_template_part', $template_name, $template_path, $located, $args );
 }
 
+/**
+ * @param string $template_name
+ */
 function wpinv_get_template_html( $template_name, $args = array(), $template_path = '', $default_path = '' ) {
 	ob_start();
 	wpinv_get_template( $template_name, $args, $template_path, $default_path );
@@ -172,6 +175,9 @@ 
     return apply_filters( 'wpinv_locate_template', $template, $template_name, $template_path );
 }
 
+/**
+ * @param string $slug
+ */
 function wpinv_get_template_part( $slug, $name = null, $load = true ) {
 	do_action( 'get_template_part_' . $slug, $slug, $name );
 
@@ -871,6 +877,9 @@ 
     return apply_filters( 'wpinv_get_watermark', $output, $id );
 }
 
+/**
+ * @param integer $id
+ */
 function wpinv_get_watermark( $id ) {
     if ( !$id > 0 ) {
         return NULL;

includes/class-wpinv-shortcodes.php

Doc Comments +3 added lines

@@ -22,6 +22,9 @@
         add_shortcode( 'wpinv_messages', __CLASS__ . '::messages' );
     }
 
+    /**
+     * @param string[] $function
+     */
     public static function shortcode_wrapper( $function, $atts = array(), $content = null, $wrapper = array( 'class' => 'wpi-g', 'before' => null, 'after' => null ) ) {
         ob_start();
 

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 );