AuthorizeNetARB_Response::getSubscriptionStatus() - Code Metrics - Inspection of "Future to master" - AuthorizeNet/sdk-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#124)

unknown

created 2016-03-18 10:51 UTC

AuthorizeNetARB_Response::getSubscriptionStatus() A

↳ Parent: AuthorizeNetARB_Response

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Metric	Value
dl	0
loc	4
ccs	0
cts	2
cp	0
rs	10
cc	1
eloc	2
nc	1
nop	0
crap	2

<?php
/**
 * Easily interact with the Authorize.Net ARB XML API.
 *
 * @package    AuthorizeNet
 * @subpackage AuthorizeNetARB
 * @link       http://www.authorize.net/support/ARB_guide.pdf ARB Guide
 */


/**
 * A class to send a request to the ARB XML API.
 *
 * @package    AuthorizeNet
 * @subpackage AuthorizeNetARB
 */
class AuthorizeNetARB extends AuthorizeNetRequest
namespace YourVendor;

class YourClass { }
{
    const LIVE_URL = "https://api2.authorize.net/xml/v1/request.api";
    const SANDBOX_URL = "https://apitest.authorize.net/xml/v1/request.api";

    private $_request_type;
    private $_request_payload;
    
    /**
     * Optional. Used if the merchant wants to set a reference ID.
     *
     * @param string $refId
     */
    public function setRefId($refId)
    {
        $this->_request_payload = ($refId ? "<refId>$refId</refId>" : "");
    }
    
    /**
     * Create an ARB subscription
     *
     * @param AuthorizeNet_Subscription $subscription
     *
     * @return AuthorizeNetARB_Response
     */
    public function createSubscription(AuthorizeNet_Subscription $subscription)
    {
        $this->_request_type = "CreateSubscriptionRequest";
        $this->_request_payload .= $subscription->getXml();
        return $this->_sendRequest();
    }
    
    /**
     * Update an ARB subscription
     *
     * @param int                       $subscriptionId
     * @param AuthorizeNet_Subscription $subscription
     *
     * @return AuthorizeNetARB_Response
     */
    public function updateSubscription($subscriptionId, AuthorizeNet_Subscription $subscription)
    {
        $this->_request_type = "UpdateSubscriptionRequest";
        $this->_request_payload .= "<subscriptionId>$subscriptionId</subscriptionId>";
        $this->_request_payload .= $subscription->getXml();
        return $this->_sendRequest();
    }

    /**
     * Get status of a subscription
     *
     * @param int $subscriptionId
     *
     * @return AuthorizeNetARB_Response
     */
    public function getSubscriptionStatus($subscriptionId)
    {
        $this->_request_type = "GetSubscriptionStatusRequest";
        $this->_request_payload .= "<subscriptionId>$subscriptionId</subscriptionId>";
        return $this->_sendRequest();
    }

    /**
     * Cancel a subscription
     *
     * @param int $subscriptionId
     *
     * @return AuthorizeNetARB_Response
     */
    public function cancelSubscription($subscriptionId)
    {
        $this->_request_type = "CancelSubscriptionRequest";
        $this->_request_payload .= "<subscriptionId>$subscriptionId</subscriptionId>";
        return $this->_sendRequest();
    }
    
     /**
     * Create an ARB subscription
     *
     * @param AuthorizeNet_Subscription $subscription
/**
 * @param array $germany
 * @param array $ireland
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return AuthorizeNetARB_Response
     */
    public function getSubscriptionList(AuthorizeNetGetSubscriptionList $subscriptionList)
    {
        $this->_request_type = "GetSubscriptionListRequest";
        $this->_request_payload .= $subscriptionList->getXml();
        return $this->_sendRequest();
    }

     /**
     *
     *
     * @param string $response
     * 
     * @return AuthorizeNetARB_Response
     */
    protected function _handleResponse($response)
    {
        return new AuthorizeNetARB_Response($response);
    }
    
    /**
     * @return string
     */
    protected function _getPostUrl()
    {
        return ($this->_sandbox ? self::SANDBOX_URL : self::LIVE_URL);
    }
    
    /**
     * Prepare the XML document for posting.
     */
    protected function _setPostString()
    {
        $this->_post_string =<<<XML
<?xml version="1.0" encoding="utf-8"?>
<ARB{$this->_request_type} xmlns= "AnetApi/xml/v1/schema/AnetApiSchema.xsd">
    <merchantAuthentication>
        <name>{$this->_api_login}</name>
        <transactionKey>{$this->_transaction_key}</transactionKey>
    </merchantAuthentication>
    {$this->_request_payload}
</ARB{$this->_request_type}>
XML;
    }
    
}


/**
 * A class to parse a response from the ARB XML API.
 *
 * @package    AuthorizeNet
 * @subpackage AuthorizeNetARB
 */
class AuthorizeNetARB_Response extends AuthorizeNetXMLResponse
namespace YourVendor;

class YourClass { }
{

    /**
     * @return int
     */
    public function getSubscriptionId()
    {
        return $this->_getElementContents("subscriptionId");
    }
    
    /**
     * @return string
     */
    public function getSubscriptionStatus()
    {
        return $this->_getElementContents("status");
    }

}

1		<?php
2		/**
3		* Easily interact with the Authorize.Net ARB XML API.
4		*
5		* @package AuthorizeNet
6		* @subpackage AuthorizeNetARB
7		* @link http://www.authorize.net/support/ARB_guide.pdf ARB Guide
8		*/
9
10
11		/**
12		* A class to send a request to the ARB XML API.
13		*
14		* @package AuthorizeNet
15		* @subpackage AuthorizeNetARB
16		*/
17		class AuthorizeNetARB extends AuthorizeNetRequest
		0 ignored issues – show Coding Style Compatibility introduced 2016-03-02 13:20 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
18		{
19		const LIVE_URL = "https://api2.authorize.net/xml/v1/request.api";
20		const SANDBOX_URL = "https://apitest.authorize.net/xml/v1/request.api";
21
22		private $_request_type;
23		private $_request_payload;
24
25		/**
26		* Optional. Used if the merchant wants to set a reference ID.
27		*
28		* @param string $refId
29		*/
30	3	public function setRefId($refId)
31		{
32	3	$this->_request_payload = ($refId ? "<refId>$refId</refId>" : "");
33	3	}
34
35		/**
36		* Create an ARB subscription
37		*
38		* @param AuthorizeNet_Subscription $subscription
39		*
40		* @return AuthorizeNetARB_Response
41		*/
42	2	public function createSubscription(AuthorizeNet_Subscription $subscription)
43		{
44	2	$this->_request_type = "CreateSubscriptionRequest";
45	2	$this->_request_payload .= $subscription->getXml();
46	2	return $this->_sendRequest();
47		}
48
49		/**
50		* Update an ARB subscription
51		*
52		* @param int $subscriptionId
53		* @param AuthorizeNet_Subscription $subscription
54		*
55		* @return AuthorizeNetARB_Response
56		*/
57		public function updateSubscription($subscriptionId, AuthorizeNet_Subscription $subscription)
58		{
59		$this->_request_type = "UpdateSubscriptionRequest";
60		$this->_request_payload .= "<subscriptionId>$subscriptionId</subscriptionId>";
61		$this->_request_payload .= $subscription->getXml();
62		return $this->_sendRequest();
63		}
64
65		/**
66		* Get status of a subscription
67		*
68		* @param int $subscriptionId
69		*
70		* @return AuthorizeNetARB_Response
71		*/
72		public function getSubscriptionStatus($subscriptionId)
73		{
74		$this->_request_type = "GetSubscriptionStatusRequest";
75		$this->_request_payload .= "<subscriptionId>$subscriptionId</subscriptionId>";
76		return $this->_sendRequest();
77		}
78
79		/**
80		* Cancel a subscription
81		*
82		* @param int $subscriptionId
83		*
84		* @return AuthorizeNetARB_Response
85		*/
86	2	public function cancelSubscription($subscriptionId)
87		{
88	2	$this->_request_type = "CancelSubscriptionRequest";
89	2	$this->_request_payload .= "<subscriptionId>$subscriptionId</subscriptionId>";
90	2	return $this->_sendRequest();
91		}
92
93		/**
94		* Create an ARB subscription
95		*
96		* @param AuthorizeNet_Subscription $subscription
		0 ignored issues – show Documentation introduced 2016-03-02 13:20 UTC by Report Bug Copy Issue Report There is no parameter named `$subscription`. Did you maybe mean `$subscriptionList`? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. It has, however, found a similar but not annotated parameter which might be a good fit. Consider the following example. The parameter `$ireland` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $ireland */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was changed, but the annotation was not. Loading history...
97		*
98		* @return AuthorizeNetARB_Response
99		*/
100	1	public function getSubscriptionList(AuthorizeNetGetSubscriptionList $subscriptionList)
101		{
102	1	$this->_request_type = "GetSubscriptionListRequest";
103	1	$this->_request_payload .= $subscriptionList->getXml();
104	1	return $this->_sendRequest();
105		}
106
107		/**
108		*
109		*
110		* @param string $response
111		*
112		* @return AuthorizeNetARB_Response
113		*/
114	3	protected function _handleResponse($response)
115		{
116	3	return new AuthorizeNetARB_Response($response);
117		}
118
119		/**
120		* @return string
121		*/
122	3	protected function _getPostUrl()
123		{
124	3	return ($this->_sandbox ? self::SANDBOX_URL : self::LIVE_URL);
125		}
126
127		/**
128		* Prepare the XML document for posting.
129		*/
130	3	protected function _setPostString()
131		{
132	3	$this->_post_string =<<<XML
133		<?xml version="1.0" encoding="utf-8"?>
134	3	<ARB{$this->_request_type} xmlns= "AnetApi/xml/v1/schema/AnetApiSchema.xsd">
135		<merchantAuthentication>
136	3	<name>{$this->_api_login}</name>
137	3	<transactionKey>{$this->_transaction_key}</transactionKey>
138		</merchantAuthentication>
139	3	{$this->_request_payload}
140	3	</ARB{$this->_request_type}>
141		XML;
142	3	}
143
144		}
145
146
147		/**
148		* A class to parse a response from the ARB XML API.
149		*
150		* @package AuthorizeNet
151		* @subpackage AuthorizeNetARB
152		*/
153		class AuthorizeNetARB_Response extends AuthorizeNetXMLResponse
		0 ignored issues – show Coding Style Compatibility introduced 2016-03-02 13:20 UTC by Report Bug Copy Issue Report PSR1 recommends that each class should be in its own file to aid autoloaders. Having each class in a dedicated file usually plays nice with PSR autoloaders and is therefore a well established practice. If you use other autoloaders, you might not want to follow this rule. Loading history... Coding Style Compatibility introduced 2016-03-02 13:20 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
154		{
155
156		/**
157		* @return int
158		*/
159	2	public function getSubscriptionId()
160		{
161	2	return $this->_getElementContents("subscriptionId");
162		}
163
164		/**
165		* @return string
166		*/
167		public function getSubscriptionStatus()
168		{
169		return $this->_getElementContents("status");
170		}
171
172		}

AuthorizeNet / sdk-php

Pull Request — master (#124)

AuthorizeNetARB_Response::getSubscriptionStatus() A

Complexity

Size

Duplication

Code Coverage

Duplication Side-by-Side

Filter issues like