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/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' );
 
@@ -916,6 +919,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',
@@ -1375,6 +1381,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 ) {
@@ -1383,6 +1392,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;
@@ -1479,10 +1491,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 );
     }
@@ -1525,10 +1543,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 );
         
@@ -2081,6 +2105,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;
@@ -2096,6 +2123,9 @@ 
         return $cancelled_date;
     }
     
+    /**
+     * @return string
+     */
     public function get_trial_end_date( $formatted = true ) {
         if ( !$this->is_free_trial() || !$this->is_paid() ) {
             return NULL;
@@ -2117,6 +2147,9 @@ 
         return $trial_end_date;
     }
     
+    /**
+     * @return string
+     */
     public function get_subscription_created( $default = true ) {
         $created = $this->get_meta( '_wpinv_subscr_created', true );
         
@@ -2126,6 +2159,9 @@ 
         return $created;
     }
     
+    /**
+     * @return string
+     */
     public function get_subscription_start( $formatted = true ) {
         if ( !$this->is_paid() ) {
             return '-';

includes/wpinv-gd-functions.php

Doc Comments +3 added lines

@@ -740,6 +740,9 @@
 add_action( 'geodir_dashboard_links', 'wpinv_gdp_dashboard_invoice_history_link' );
 remove_action( 'geodir_dashboard_links', 'geodir_payment_invoices_list_page_link' );
 
+/**
+ * @param string $new_status
+ */
 function wpinv_wpi_to_gdp_update_status( $invoice_id, $new_status, $old_status ) {
     if (!defined('GEODIRPAYMENT_VERSION')) {
         return false;

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

templates/wpinv-invoice-history.php

Indentation +40 added lines, -40 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 if ( !( $user_id = get_current_user_id() ) ) {
@@ -30,7 +30,7 @@ 
 
 		<tbody>
 			<?php foreach ( $user_invoices->invoices as $invoice ) {
-				?>
+                ?>
 				<tr class="wpinv-item wpinv-item-<?php echo $invoice_status = $invoice->get_status(); ?>">
 					<?php foreach ( wpinv_get_user_invoices_columns() as $column_id => $column_name ) : ?>
 						<td class="<?php echo esc_attr( $column_id ); ?> <?php echo (!empty($column_name['class']) ? $column_name['class'] : '');?>" data-title="<?php echo esc_attr( $column_name['title'] ); ?>">
@@ -53,31 +53,31 @@ 
 
 							<?php elseif ( 'invoice-actions' === $column_id ) : ?>
 								<?php
-									$actions = array(
-										'pay'    => array(
-											'url'  => $invoice->get_checkout_payment_url(),
-											'name' => __( 'Pay Now', 'invoicing' ),
+                                    $actions = array(
+                                        'pay'    => array(
+                                            'url'  => $invoice->get_checkout_payment_url(),
+                                            'name' => __( 'Pay Now', 'invoicing' ),
                                             'class' => 'btn-success'
-										),
+                                        ),
                                         'print'   => array(
-											'url'  => $invoice->get_view_url(),
-											'name' => __( 'Print', 'invoicing' ),
+                                            'url'  => $invoice->get_view_url(),
+                                            'name' => __( 'Print', 'invoicing' ),
                                             'class' => 'btn-primary',
                                             'attrs' => 'target="_blank"'
-										)
-									);
+                                        )
+                                    );
 
-									if ( ! $invoice->needs_payment() ) {
-										unset( $actions['pay'] );
-									}
+                                    if ( ! $invoice->needs_payment() ) {
+                                        unset( $actions['pay'] );
+                                    }
 
-									if ( $actions = apply_filters( 'wpinv_user_invoices_actions', $actions, $invoice ) ) {
-										foreach ( $actions as $key => $action ) {
-											$class = !empty($action['class']) ? sanitize_html_class($action['class']) : '';
+                                    if ( $actions = apply_filters( 'wpinv_user_invoices_actions', $actions, $invoice ) ) {
+                                        foreach ( $actions as $key => $action ) {
+                                            $class = !empty($action['class']) ? sanitize_html_class($action['class']) : '';
                                             echo '<a href="' . esc_url( $action['url'] ) . '" class="btn btn-sm ' . $class . ' ' . sanitize_html_class( $key ) . '" ' . ( !empty($action['attrs']) ? $action['attrs'] : '' ) . '>' . $action['name'] . '</a>';
-										}
-									}
-								?>
+                                        }
+                                    }
+                                ?>
 							<?php endif; ?>
 						</td>
 					<?php endforeach; ?>
@@ -91,26 +91,26 @@ 
 	<?php if ( 1 < $user_invoices->max_num_pages ) : ?>
 		<div class="invoicing-Pagination">
 			<?php
-			$big = 999999;
-			$wpinv_cpt = isset($_REQUEST['wpinv-cpt']) ? $_REQUEST['wpinv-cpt'] : '';
-
-			if (get_query_var('paged') && 'wpi_invoice' == $wpinv_cpt)
-				$current_page = get_query_var('paged');
-			elseif (get_query_var('page') && 'wpi_invoice' == $wpinv_cpt)
-				$current_page = get_query_var('page');
-			else
-				$current_page = 1;
-
-			echo paginate_links( array(
-				'base'    => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ),
-				'format'  => '?paged=%#%',
-				'current' => max( 1, $current_page ),
-				'total'   => $user_invoices->max_num_pages,
-				'add_args' => array(
-					'wpinv-cpt' => 'wpi_invoice',
-				)
-			) );
-			?>
+            $big = 999999;
+            $wpinv_cpt = isset($_REQUEST['wpinv-cpt']) ? $_REQUEST['wpinv-cpt'] : '';
+
+            if (get_query_var('paged') && 'wpi_invoice' == $wpinv_cpt)
+                $current_page = get_query_var('paged');
+            elseif (get_query_var('page') && 'wpi_invoice' == $wpinv_cpt)
+                $current_page = get_query_var('page');
+            else
+                $current_page = 1;
+
+            echo paginate_links( array(
+                'base'    => str_replace( $big, '%#%', esc_url( get_pagenum_link( $big ) ) ),
+                'format'  => '?paged=%#%',
+                'current' => max( 1, $current_page ),
+                'total'   => $user_invoices->max_num_pages,
+                'add_args' => array(
+                    'wpinv-cpt' => 'wpi_invoice',
+                )
+            ) );
+            ?>
 		</div>
 	<?php endif; ?>