AyeCode / invoicing

includes/class-wpinv-api.php

Doc Comments +7 added lines

@@ -168,6 +168,9 @@ 
         }
     }
     
+    /**
+     * @param integer $code
+     */
     public function send_status( $code ) {
         status_header( $code );
     }
@@ -320,6 +323,10 @@ 
 class WPInv_API_Exception extends Exception {
     protected $error_code;
 
+    /**
+     * @param string $error_code
+     * @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 +33 added lines

@@ -82,6 +82,9 @@ 
         return $value;
     }
 
+    /**
+     * @param string $key
+     */
     public function set( $key, $value ) {
         $ignore = array( 'items', 'cart_details', 'fees', '_ID' );
 
@@ -918,6 +921,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',
@@ -1374,6 +1380,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 ) {
@@ -1382,6 +1391,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;
@@ -1478,6 +1490,9 @@ 
         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 );
     }
@@ -1524,10 +1539,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 );
         
@@ -2075,6 +2096,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;
@@ -2090,6 +2114,9 @@ 
         return $cancelled_date;
     }
     
+    /**
+     * @return string
+     */
     public function get_trial_end_date( $formatted = true ) {
         if ( !$this->is_free_trial() || !$this->is_paid() ) {
             return NULL;
@@ -2111,6 +2138,9 @@ 
         return $trial_end_date;
     }
     
+    /**
+     * @return string
+     */
     public function get_subscription_created( $default = true ) {
         $created = $this->get_meta( '_wpinv_subscr_created', true );
         
@@ -2120,6 +2150,9 @@ 
         return $created;
     }
     
+    /**
+     * @return string
+     */
     public function get_subscription_start( $formatted = true ) {
         if ( !$this->is_paid() ) {
             return '-';

includes/class-wpinv-session.php

Doc Comments +2 added lines, -4 removed lines

@@ -164,8 +164,7 @@ 
 	 * @since 1.0.0
 	 *
 	 * @param string|array $key Session key.
-	 * @param integer $value Session variable.
-	 * @return string Session variable.
+	 * @return boolean Session variable.
 	 */
 	public function un_set( $key ) {
 		if ( empty( $key ) ) {
@@ -201,8 +200,7 @@ 
 	 * @since 1.0.0
 	 *
 	 * @param string $key Session key.
-	 * @param integer $value Session variable.
-	 * @return string Session variable.
+	 * @return boolean Session variable.
 	 */
 	public function is_set( $key ) {
 		$key = sanitize_key( $key );

includes/gateways/authorizenet/anet_php_sdk/lib/AuthorizeNetAIM.php

Doc Comments +6 added lines, -6 removed lines

@@ -101,7 +101,7 @@ 
      * @param string $card_num The credit card number
      * @param string $exp_date CC expiration date
      *
-     * @return AuthorizeNetAIM_Response
+     * @return AuthorizeNetARB_Response
      */
     public function authorizeAndCapture($amount = false, $card_num = false, $exp_date = false)
     {
@@ -122,7 +122,7 @@ 
      * @param string $trans_id Transaction id to charge
      * @param string $amount   Dollar amount to charge if lesser than auth
      *
-     * @return AuthorizeNetAIM_Response
+     * @return AuthorizeNetARB_Response
      */
     public function priorAuthCapture($trans_id = false, $amount = false)
     {
@@ -141,7 +141,7 @@ 
      * @param string $card_num The credit card number
      * @param string $exp_date CC expiration date
      *
-     * @return AuthorizeNetAIM_Response
+     * @return AuthorizeNetARB_Response
      */
     public function authorizeOnly($amount = false, $card_num = false, $exp_date = false)
     {
@@ -160,7 +160,7 @@ 
      *
      * @param string $trans_id Transaction id to void
      *
-     * @return AuthorizeNetAIM_Response
+     * @return AuthorizeNetARB_Response
      */
     public function void($trans_id = false)
     {
@@ -179,7 +179,7 @@ 
      * @param string $card_num  The last 4 of credit card number
      * @param string $exp_date  CC expiration date
      *
-     * @return AuthorizeNetAIM_Response
+     * @return AuthorizeNetARB_Response
      */
     public function captureOnly($auth_code = false, $amount = false, $card_num = false, $exp_date = false)
     {
@@ -200,7 +200,7 @@ 
      * @param string $amount   The dollar amount to credit
      * @param string $card_num The last 4 of credit card number
      *
-     * @return AuthorizeNetAIM_Response
+     * @return AuthorizeNetARB_Response
      */
     public function credit($trans_id = false, $amount = false, $card_num = false)
     {

includes/gateways/authorizenet/anet_php_sdk/lib/AuthorizeNetCIM.php

Doc Comments +16 added lines, -16 removed lines

@@ -51,7 +51,7 @@ 
      * @param AuthorizeNetCustomer $customerProfile
      * @param string               $validationMode
      *
-     * @return AuthorizeNetCIM_Response
+     * @return AuthorizeNetARB_Response
      */
     public function createCustomerProfile($customerProfile, $validationMode = "none")
     {
@@ -69,7 +69,7 @@ 
      * @param AuthorizeNetPaymentProfile $paymentProfile
      * @param string                     $validationMode
      *
-     * @return AuthorizeNetCIM_Response
+     * @return AuthorizeNetARB_Response
      */
     public function createCustomerPaymentProfile($customerProfileId, $paymentProfile, $validationMode = "none")
     {
@@ -87,7 +87,7 @@ 
      * @param int                        $customerProfileId
      * @param AuthorizeNetAddress        $shippingAddress
      *
-     * @return AuthorizeNetCIM_Response
+     * @return AuthorizeNetARB_Response
      */
     public function createCustomerShippingAddress($customerProfileId, $shippingAddress)
     {
@@ -105,7 +105,7 @@ 
      * @param AuthorizeNetTransaction    $transaction
      * @param string                     $extraOptionsString
      *
-     * @return AuthorizeNetCIM_Response
+     * @return AuthorizeNetARB_Response
      */
     public function createCustomerProfileTransaction($transactionType, $transaction, $extraOptionsString = "")
     {
@@ -122,7 +122,7 @@ 
      *
      * @param int $customerProfileId
      *
-     * @return AuthorizeNetCIM_Response
+     * @return AuthorizeNetARB_Response
      */
     public function deleteCustomerProfile($customerProfileId)
     {
@@ -137,7 +137,7 @@ 
      * @param int $customerProfileId
      * @param int $customerPaymentProfileId
      *
-     * @return AuthorizeNetCIM_Response
+     * @return AuthorizeNetARB_Response
      */
     public function deleteCustomerPaymentProfile($customerProfileId, $customerPaymentProfileId)
     {
@@ -153,7 +153,7 @@ 
      * @param int $customerProfileId
      * @param int $customerAddressId
      *
-     * @return AuthorizeNetCIM_Response
+     * @return AuthorizeNetARB_Response
      */
     public function deleteCustomerShippingAddress($customerProfileId, $customerAddressId)
     {
@@ -166,7 +166,7 @@ 
     /**
      * Get all customer profile ids.
      *
-     * @return AuthorizeNetCIM_Response
+     * @return AuthorizeNetARB_Response
      */
     public function getCustomerProfileIds()
     {
@@ -179,7 +179,7 @@ 
      *
      * @param int $customerProfileId
      *
-     * @return AuthorizeNetCIM_Response
+     * @return AuthorizeNetARB_Response
      */
     public function getCustomerProfile($customerProfileId)
     {
@@ -194,7 +194,7 @@ 
      * @param int $customerProfileId
      * @param int $customerPaymentProfileId
      *
-     * @return AuthorizeNetCIM_Response
+     * @return AuthorizeNetARB_Response
      */
     public function getCustomerPaymentProfile($customerProfileId, $customerPaymentProfileId)
     {
@@ -210,7 +210,7 @@ 
      * @param int $customerProfileId
      * @param int $customerAddressId
      *
-     * @return AuthorizeNetCIM_Response
+     * @return AuthorizeNetARB_Response
      */
     public function getCustomerShippingAddress($customerProfileId, $customerAddressId)
     {
@@ -226,7 +226,7 @@ 
      * @param int                        $customerProfileId
      * @param AuthorizeNetCustomer       $customerProfile
      *
-     * @return AuthorizeNetCIM_Response
+     * @return AuthorizeNetARB_Response
      */
     public function updateCustomerProfile($customerProfileId, $customerProfile)
     {
@@ -245,7 +245,7 @@ 
      * @param AuthorizeNetPaymentProfile $paymentProfile
      * @param string                     $validationMode
      *
-     * @return AuthorizeNetCIM_Response
+     * @return AuthorizeNetARB_Response
      */
     public function updateCustomerPaymentProfile($customerProfileId, $customerPaymentProfileId, $paymentProfile, $validationMode = "none")
     {
@@ -265,7 +265,7 @@ 
      * @param int                        $customerShippingAddressId
      * @param AuthorizeNetAddress        $shippingAddress
      *
-     * @return AuthorizeNetCIM_Response
+     * @return AuthorizeNetARB_Response
      */
     public function updateCustomerShippingAddress($customerProfileId, $customerShippingAddressId, $shippingAddress)
     {
@@ -284,7 +284,7 @@ 
      * @param int                        $splitTenderId
      * @param string                     $splitTenderStatus
      *
-     * @return AuthorizeNetCIM_Response
+     * @return AuthorizeNetARB_Response
      */
     public function updateSplitTenderGroup($splitTenderId, $splitTenderStatus)
     {
@@ -303,7 +303,7 @@ 
      * @param int                        $cardCode
      * @param string                     $validationMode
      *
-     * @return AuthorizeNetCIM_Response
+     * @return AuthorizeNetARB_Response
      */
     public function validateCustomerPaymentProfile($customerProfileId, $customerPaymentProfileId, $customerShippingAddressId, $cardCode, $validationMode = "testMode")
     {

includes/gateways/authorizenet/anet_php_sdk/lib/AuthorizeNetCP.php

Doc Comments +1 added lines, -1 removed lines

@@ -79,7 +79,7 @@
      *
      * @param string $response
      * 
-     * @return AuthorizeNetAIM_Response
+     * @return AuthorizeNetCP_Response
      */
     protected function _handleResponse($response)
     {

includes/gateways/authorizenet/anet_php_sdk/lib/shared/AuthorizeNetRequest.php

Doc Comments +1 added lines

@@ -28,6 +28,7 @@
     /**
      * Get the post url. We need this because until 5.3 you
      * you could not access child constants in a parent class.
+     * @return string|null
      */
     abstract protected function _getPostUrl();
     

includes/gateways/authorizenet/anet_php_sdk/lib/shared/AuthorizeNetXMLResponse.php

Doc Comments +1 added lines

@@ -110,6 +110,7 @@
      * Grabs the contents of a unique element.
      *
      * @param  string
+     * @param string $elementName
      * @return string
      */
     protected function _getElementContents($elementName) 

includes/gateways/authorizenet/Authorize.Net-XML/AuthnetXML.class.php

Doc Comments +4 added lines

@@ -69,6 +69,7 @@ 
      * remove XML response namespaces
      * without this php will spit out warinings
      * @see http://community.developer.authorize.net/t5/Integration-and-Testing/ARB-with-SimpleXML-PHP-Issue/m-p/7128#M5139
+     * @return string
      */
     private function removeResponseXMLNS($input)
     {
@@ -150,6 +151,9 @@ 
 		$this->process();
 	}
 
+	/**
+	 * @param SimpleXMLElement $xml
+	 */
 	private function setParameters($xml, $array)
 	{
 	    if (is_array($array))