SubscriptionService::getSubscriptionById() - Code Metrics - Inspection of "Method to easily get one subscription" - Speicher210/fastbill-api - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c3e31d...8de32c )

by Dragos

created 2016-06-13 13:13 UTC

SubscriptionService::getSubscriptionById() A

↳ Parent: SubscriptionService

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	9
ccs	1
cts	1
cp	1
rs	9.6666
cc	2
eloc	6
nc	2
nop	1
crap	2

<?php

namespace Speicher210\Fastbill\Api\Service\Subscription;

use Speicher210\Fastbill\Api\AbstractService;
use Speicher210\Fastbill\Api\Model\Feature;
use Speicher210\Fastbill\Api\Model\Subscription;

/**
 * Service for subscriptions.
 */
class SubscriptionService extends AbstractService
{
    /**
     * Get one subscription by using the Fastbill subscription ID.
     *
     * @param integer $subscriptionId The Fastbill subscription ID.
     * @return Subscription|null
     */
    public function getSubscriptionById($subscriptionId)
    {
        $subscriptions = $this
            ->getSubscriptions(null, null, null, $subscriptionId)
            ->getResponse()
            ->getSubscriptions();

        return count($subscriptions) ? reset($subscriptions) : null;
    }

    /**
     * Get the subscriptions.
     *
     * @param integer $customerId The customer ID.
     * @param string $externalCustomerId The external customer ID.
     * @param string $subscriptionExternalId The external subscription ID.
     * @param integer $subscriptionId The subscription ID.
     * @return Get\ApiResponse
     */
    public function getSubscriptions(
        $customerId = null,
        $externalCustomerId = null,
        $subscriptionExternalId = null,
        $subscriptionId = null
    ) {
        $requestData = new Get\RequestData();
        $requestData->setCustomerId($customerId);
        $requestData->setExternalCustomerId($externalCustomerId);
        $requestData->setSubscriptionExternalId($subscriptionExternalId);
        $requestData->setSubscriptionId($subscriptionId);

        $request = new Get\Request($requestData);

        return $this->sendRequest($request, Get\ApiResponse::class);
    }

    /**
     * Create a subscription.
     *
     * @param Create\RequestData $requestData The request data.
     * @return Create\ApiResponse
     */
    public function createSubscription(Create\RequestData $requestData)
    {
        $request = new Create\Request($requestData);

        return $this->sendRequest($request, Create\ApiResponse::class);
    }

    /**
     * Update a subscription.
     *
     * @param integer $subscriptionId The subscription ID.
     * @param \DateTime $nextEvent The next event date and time.
     * @param string $subscriptionExternalId The external subscription ID.
     * @param string $status The subscription status.
     * @param array $xAttributes The subscription x attributes.
     * @param Feature[] $features The features.
     * @return Update\ApiResponse
     */
    public function updateSubscription(
        $subscriptionId,
        $nextEvent = null,
        $subscriptionExternalId = null,
        $status = null,
        array $xAttributes = array(),
        array $features = array()
    ) {
        $requestData = new Update\RequestData($subscriptionId);

        $requestData->setSubscriptionId($subscriptionId);
        $requestData->setNextEvent($nextEvent);
        $requestData->setSubscriptionExternalId($subscriptionExternalId);
        $requestData->setStatus($status);
        $requestData->setXAttributes($xAttributes);
        $requestData->setFeatures($features);

        $request = new Update\Request($requestData);

        return $this->sendRequest($request, Update\ApiResponse::class);
    }

    /**
     * Change article of a subscription.
     *
     * @param ChangeArticle\RequestData $requestData The request data.
     * @return ChangeArticle\ApiResponse
     */
    public function changeSubscriptionArticle(ChangeArticle\RequestData $requestData)
    {
        $request = new ChangeArticle\Request($requestData);

        return $this->sendRequest($request, ChangeArticle\ApiResponse::class);
    }

    /**
     * Set the addon for a subscription.
     *
     * @param SetAddon\RequestData $requestData The request data.
     * @return SetAddon\ApiResponse
     */
    public function setSubscriptionAddon(SetAddon\RequestData $requestData)
    {
        $request = new SetAddon\Request($requestData);

        return $this->sendRequest($request, SetAddon\ApiResponse::class);
    }

    /**
     * Set the usage data of a subscription.
     *
     * @param SetUsageData\RequestData $requestData The request data.
     * @return SetUsageData\ApiResponse
     */
    public function setSubscriptionUsageData(SetUsageData\RequestData $requestData)
    {
        $request = new SetUsageData\Request($requestData);

        return $this->sendRequest($request, SetUsageData\ApiResponse::class);
    }

    /**
     * Get the usage data of a subscription.
     *
     * @param integer $subscriptionId The subscription ID.
     * @param \DateTime $subscriptionStart The subscription start.
     * @param \DateTime $subscriptionEnd The subscription end.
     * @return GetUsageData\ApiResponse
     */
    public function getSubscriptionUsageData(
        $subscriptionId,
        \DateTime $subscriptionStart = null,
        \DateTime $subscriptionEnd = null
    ) {
        $requestData = new GetUsageData\RequestData($subscriptionId);

        $requestData->setSubscriptionId($subscriptionId);
        $requestData->setSubscriptionStart($subscriptionStart);
function notNullable(stdClass $x) { }

// Unsafe
function withoutCheck(stdClass $x = null) {
    notNullable($x);
}

// Safe - Alternative 1: Adding Additional Type-Check
function withCheck(stdClass $x = null) {
    if ($x instanceof stdClass) {
        notNullable($x);
    }
}

// Safe - Alternative 2: Changing Parameter
function withNonNullableParam(stdClass $x) {
    notNullable($x);
}
        $requestData->setSubscriptionEnd($subscriptionEnd);
function notNullable(stdClass $x) { }

// Unsafe
function withoutCheck(stdClass $x = null) {
    notNullable($x);
}

// Safe - Alternative 1: Adding Additional Type-Check
function withCheck(stdClass $x = null) {
    if ($x instanceof stdClass) {
        notNullable($x);
    }
}

// Safe - Alternative 2: Changing Parameter
function withNonNullableParam(stdClass $x) {
    notNullable($x);
}

        $request = new GetUsageData\Request($requestData);

        return $this->sendRequest($request, GetUsageData\ApiResponse::class);
    }

    /**
     * Get the usage data of a subscription.
     *
     * @param string $usageDataId The usage data ID.
     * @return DeleteUsageData\ApiResponse
     */
    public function deleteSubscriptionUsageData($usageDataId)
    {
        $requestData = new DeleteUsageData\RequestData($usageDataId);
        $request = new DeleteUsageData\Request($requestData);

        return $this->sendRequest($request, DeleteUsageData\ApiResponse::class);
    }

    /**
     * Get the upcoming amount.
     *
     * @param GetUpcomingAmount\RequestData $requestData The request data filter.
     * @return GetUpcomingAmount\ApiResponse
     */
    public function getUpcomingAmount(GetUpcomingAmount\RequestData $requestData = null)
    {
        if ($requestData === null) {
            $requestData = new GetUpcomingAmount\RequestData();
        }

        $request = new GetUpcomingAmount\Request($requestData);

        return $this->sendRequest($request, GetUpcomingAmount\ApiResponse::class);
    }

    /**
     * Postpone a subscription shipping.
     *
     * @param integer $subscriptionId
     * @param integer $month The month to postpone.
     * @return Postpone\ApiResponse
     */
    public function postponeSubscription($subscriptionId, $month)
    {
        $requestData = new Postpone\RequestData($subscriptionId, $month);
        $request = new Postpone\Request($requestData);

        return $this->sendRequest($request, Postpone\ApiResponse::class);
    }

    /**
     * Renew a subscription.
     *
     * @param integer $subscriptionId The subscription ID to renew.
     * @return Renew\ApiResponse
     */
    public function renewSubscription($subscriptionId)
    {
        $requestData = new Renew\RequestData($subscriptionId);
        $request = new Renew\Request($requestData);

        return $this->sendRequest($request, Renew\ApiResponse::class);
    }

    /**
     * Create a secure link for a subscription.
     *
     * @param integer $subscriptionId The subscription ID for which to create the secure link.
     * @return CreateSecureLink\ApiResponse
     */
    public function createSecureLink($subscriptionId)
    {
        $requestData = new CreateSecureLink\RequestData($subscriptionId);
        $request = new CreateSecureLink\Request($requestData);

        return $this->sendRequest($request, CreateSecureLink\ApiResponse::class);
    }

    /**
     * Cancel a subscription.
     *
     * @param integer $subscriptionId The subscription ID.
     * @param \DateTime $cancellationDate The cancellation date and time.
     * @param string $cancellationNote The cancellation note.
     * @return Cancel\ApiResponse
     */
    public function cancelSubscription($subscriptionId, \DateTime $cancellationDate = null, $cancellationNote = null)
    {
        $requestData = new Cancel\RequestData($subscriptionId);
        $requestData->setCancellationDate($cancellationDate);
        $requestData->setCancellationNote($cancellationNote);

        $request = new Cancel\Request($requestData);

        return $this->sendRequest($request, Cancel\ApiResponse::class);
    }

    /**
     * Reactivate a subscription.
     *
     * @param integer $subscriptionId The subscription ID to reactivate.
     * @return Reactivate\ApiResponse
     */
    public function reactivateSubscription($subscriptionId)
    {
        $requestData = new Reactivate\RequestData($subscriptionId);
        $request = new Reactivate\Request($requestData);

        return $this->sendRequest($request, Reactivate\ApiResponse::class);
    }
}


1		<?php
2
3		namespace Speicher210\Fastbill\Api\Service\Subscription;
4
5		use Speicher210\Fastbill\Api\AbstractService;
6		use Speicher210\Fastbill\Api\Model\Feature;
7		use Speicher210\Fastbill\Api\Model\Subscription;
8
9		/**
10		* Service for subscriptions.
11		*/
12		class SubscriptionService extends AbstractService
13		{
14		/**
15		* Get one subscription by using the Fastbill subscription ID.
16		*
17		* @param integer $subscriptionId The Fastbill subscription ID.
18		* @return Subscription\|null
19		*/
20		public function getSubscriptionById($subscriptionId)
21		{
22	6	$subscriptions = $this
23		->getSubscriptions(null, null, null, $subscriptionId)
24		->getResponse()
25		->getSubscriptions();
26
27		return count($subscriptions) ? reset($subscriptions) : null;
28		}
29	6
30	6	/**
31	6	* Get the subscriptions.
32	6	*
33	6	* @param integer $customerId The customer ID.
34		* @param string $externalCustomerId The external customer ID.
35	6	* @param string $subscriptionExternalId The external subscription ID.
36		* @param integer $subscriptionId The subscription ID.
37	6	* @return Get\ApiResponse
38		*/
39		public function getSubscriptions(
40		$customerId = null,
41		$externalCustomerId = null,
42		$subscriptionExternalId = null,
43		$subscriptionId = null
44		) {
45		$requestData = new Get\RequestData();
46	9	$requestData->setCustomerId($customerId);
47		$requestData->setExternalCustomerId($externalCustomerId);
48	9	$requestData->setSubscriptionExternalId($subscriptionExternalId);
49		$requestData->setSubscriptionId($subscriptionId);
50	9
51		$request = new Get\Request($requestData);
52
53		return $this->sendRequest($request, Get\ApiResponse::class);
54		}
55
56		/**
57		* Create a subscription.
58		*
59		* @param Create\RequestData $requestData The request data.
60		* @return Create\ApiResponse
61		*/
62		public function createSubscription(Create\RequestData $requestData)
63		{
64	3	$request = new Create\Request($requestData);
65
66		return $this->sendRequest($request, Create\ApiResponse::class);
67		}
68
69		/**
70		* Update a subscription.
71		*
72		* @param integer $subscriptionId The subscription ID.
73	3	* @param \DateTime $nextEvent The next event date and time.
74		* @param string $subscriptionExternalId The external subscription ID.
75	3	* @param string $status The subscription status.
76	3	* @param array $xAttributes The subscription x attributes.
77	3	* @param Feature[] $features The features.
78	3	* @return Update\ApiResponse
79	3	*/
80	3	public function updateSubscription(
81		$subscriptionId,
82	3	$nextEvent = null,
83		$subscriptionExternalId = null,
84	3	$status = null,
85		array $xAttributes = array(),
86		array $features = array()
87		) {
88		$requestData = new Update\RequestData($subscriptionId);
89
90		$requestData->setSubscriptionId($subscriptionId);
91		$requestData->setNextEvent($nextEvent);
92		$requestData->setSubscriptionExternalId($subscriptionExternalId);
93	3	$requestData->setStatus($status);
94		$requestData->setXAttributes($xAttributes);
95	3	$requestData->setFeatures($features);
96
97	3	$request = new Update\Request($requestData);
98
99		return $this->sendRequest($request, Update\ApiResponse::class);
100		}
101
102		/**
103		* Change article of a subscription.
104		*
105		* @param ChangeArticle\RequestData $requestData The request data.
106	3	* @return ChangeArticle\ApiResponse
107		*/
108	3	public function changeSubscriptionArticle(ChangeArticle\RequestData $requestData)
109		{
110	3	$request = new ChangeArticle\Request($requestData);
111
112		return $this->sendRequest($request, ChangeArticle\ApiResponse::class);
113		}
114
115		/**
116		* Set the addon for a subscription.
117		*
118		* @param SetAddon\RequestData $requestData The request data.
119	3	* @return SetAddon\ApiResponse
120		*/
121	3	public function setSubscriptionAddon(SetAddon\RequestData $requestData)
122		{
123	3	$request = new SetAddon\Request($requestData);
124
125		return $this->sendRequest($request, SetAddon\ApiResponse::class);
126		}
127
128		/**
129		* Set the usage data of a subscription.
130		*
131		* @param SetUsageData\RequestData $requestData The request data.
132		* @return SetUsageData\ApiResponse
133		*/
134	3	public function setSubscriptionUsageData(SetUsageData\RequestData $requestData)
135		{
136		$request = new SetUsageData\Request($requestData);
137
138		return $this->sendRequest($request, SetUsageData\ApiResponse::class);
139		}
140	3
141		/**
142	3	* Get the usage data of a subscription.
143	3	*
144	3	* @param integer $subscriptionId The subscription ID.
145		* @param \DateTime $subscriptionStart The subscription start.
146	3	* @param \DateTime $subscriptionEnd The subscription end.
147		* @return GetUsageData\ApiResponse
148	3	*/
149		public function getSubscriptionUsageData(
150		$subscriptionId,
151		\DateTime $subscriptionStart = null,
152		\DateTime $subscriptionEnd = null
153		) {
154		$requestData = new GetUsageData\RequestData($subscriptionId);
155
156		$requestData->setSubscriptionId($subscriptionId);
157	3	$requestData->setSubscriptionStart($subscriptionStart);
		0 ignored issues – show Bug introduced 2016-03-21 14:20 UTC by Report Bug Copy Issue Report It seems like `$subscriptionStart` defined by parameter `$subscriptionStart` on line `151` can be `null`; however, `Speicher210\Fastbill\Api...:setSubscriptionStart()` does not accept `null`, maybe add an additional type check? It seems like you allow that null is being passed for a parameter, however the function which is called does not seem to accept null. We recommend to add an additional type check (or disallow null for the parameter): function notNullable(stdClass $x) { } // Unsafe function withoutCheck(stdClass $x = null) { notNullable($x); } // Safe - Alternative 1: Adding Additional Type-Check function withCheck(stdClass $x = null) { if ($x instanceof stdClass) { notNullable($x); } } // Safe - Alternative 2: Changing Parameter function withNonNullableParam(stdClass $x) { notNullable($x); } Loading history...
158		$requestData->setSubscriptionEnd($subscriptionEnd);
		0 ignored issues – show Bug introduced 2016-03-21 14:20 UTC by Report Bug Copy Issue Report It seems like `$subscriptionEnd` defined by parameter `$subscriptionEnd` on line `152` can be `null`; however, `Speicher210\Fastbill\Api...a::setSubscriptionEnd()` does not accept `null`, maybe add an additional type check? It seems like you allow that null is being passed for a parameter, however the function which is called does not seem to accept null. We recommend to add an additional type check (or disallow null for the parameter): function notNullable(stdClass $x) { } // Unsafe function withoutCheck(stdClass $x = null) { notNullable($x); } // Safe - Alternative 1: Adding Additional Type-Check function withCheck(stdClass $x = null) { if ($x instanceof stdClass) { notNullable($x); } } // Safe - Alternative 2: Changing Parameter function withNonNullableParam(stdClass $x) { notNullable($x); } Loading history...
159	3
160	3	$request = new GetUsageData\Request($requestData);
161
162	3	return $this->sendRequest($request, GetUsageData\ApiResponse::class);
163		}
164
165		/**
166		* Get the usage data of a subscription.
167		*
168		* @param string $usageDataId The usage data ID.
169		* @return DeleteUsageData\ApiResponse
170		*/
171	3	public function deleteSubscriptionUsageData($usageDataId)
172		{
173	3	$requestData = new DeleteUsageData\RequestData($usageDataId);
174		$request = new DeleteUsageData\Request($requestData);
175
176		return $this->sendRequest($request, DeleteUsageData\ApiResponse::class);
177	3	}
178
179	3	/**
180		* Get the upcoming amount.
181		*
182		* @param GetUpcomingAmount\RequestData $requestData The request data filter.
183		* @return GetUpcomingAmount\ApiResponse
184		*/
185		public function getUpcomingAmount(GetUpcomingAmount\RequestData $requestData = null)
186		{
187		if ($requestData === null) {
188		$requestData = new GetUpcomingAmount\RequestData();
189	3	}
190
191	3	$request = new GetUpcomingAmount\Request($requestData);
192	3
193		return $this->sendRequest($request, GetUpcomingAmount\ApiResponse::class);
194	3	}
195
196		/**
197		* Postpone a subscription shipping.
198		*
199		* @param integer $subscriptionId
200		* @param integer $month The month to postpone.
201		* @return Postpone\ApiResponse
202		*/
203	3	public function postponeSubscription($subscriptionId, $month)
204		{
205	3	$requestData = new Postpone\RequestData($subscriptionId, $month);
206	3	$request = new Postpone\Request($requestData);
207
208	3	return $this->sendRequest($request, Postpone\ApiResponse::class);
209		}
210
211		/**
212		* Renew a subscription.
213		*
214		* @param integer $subscriptionId The subscription ID to renew.
215		* @return Renew\ApiResponse
216		*/
217	3	public function renewSubscription($subscriptionId)
218		{
219	3	$requestData = new Renew\RequestData($subscriptionId);
220	3	$request = new Renew\Request($requestData);
221
222	3	return $this->sendRequest($request, Renew\ApiResponse::class);
223		}
224
225		/**
226		* Create a secure link for a subscription.
227		*
228		* @param integer $subscriptionId The subscription ID for which to create the secure link.
229		* @return CreateSecureLink\ApiResponse
230		*/
231		public function createSecureLink($subscriptionId)
232		{
233	3	$requestData = new CreateSecureLink\RequestData($subscriptionId);
234		$request = new CreateSecureLink\Request($requestData);
235	3
236	3	return $this->sendRequest($request, CreateSecureLink\ApiResponse::class);
237	3	}
238
239	3	/**
240		* Cancel a subscription.
241	3	*
242		* @param integer $subscriptionId The subscription ID.
243		* @param \DateTime $cancellationDate The cancellation date and time.
244		* @param string $cancellationNote The cancellation note.
245		* @return Cancel\ApiResponse
246		*/
247		public function cancelSubscription($subscriptionId, \DateTime $cancellationDate = null, $cancellationNote = null)
248		{
249		$requestData = new Cancel\RequestData($subscriptionId);
250	3	$requestData->setCancellationDate($cancellationDate);
251		$requestData->setCancellationNote($cancellationNote);
252	3
253	3	$request = new Cancel\Request($requestData);
254
255	3	return $this->sendRequest($request, Cancel\ApiResponse::class);
256		}
257
258		/**
259		* Reactivate a subscription.
260		*
261		* @param integer $subscriptionId The subscription ID to reactivate.
262		* @return Reactivate\ApiResponse
263		*/
264		public function reactivateSubscription($subscriptionId)
265		{
266		$requestData = new Reactivate\RequestData($subscriptionId);
267		$request = new Reactivate\Request($requestData);
268
269		return $this->sendRequest($request, Reactivate\ApiResponse::class);
270		}
271		}
272

Speicher210 / fastbill-api

Push — master ( c3e31d...8de32c )

SubscriptionService::getSubscriptionById() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like