AyeCode / invoicing

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() {