Webhook::dispatchWebhookEvent() - Code Metrics - Inspection of "Tightening error checking" - drewm/mailchimp-api - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0553b8...f53367 )

by Drew

created 2016-04-23 12:37 UTC

Webhook::dispatchWebhookEvent() A

↳ Parent: Webhook

Complexity

Conditions	3
Paths	3

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	10
rs	9.4285
cc	3
eloc	5
nc	3
nop	2

<?php

namespace DrewM\MailChimp;

/**
 * A MailChimp Webhook request.
 * How to Set Up Webhooks: http://eepurl.com/bs-j_T
 *
 * @author Drew McLellan <[email protected]>
 */
class Webhook
{
	private static $eventSubscriptions = array();
	private static $receivedWebhook = false;

	/**
	 * Subscribe to an incoming webhook request. The callback will be invoked when a matching webhook is received.
	 * @param string $event Name of the webhook event, e.g. subscribe, unsubscribe, campaign
	 * @param callable $callback A callable function to invoke with the data from the received webhook
     * @return void
	 */
	public static function subscribe($event, callable $callback)
	{
		if (!isset(self::$eventSubscriptions[$event])) self::$eventSubscriptions[$event] = array();
		self::$eventSubscriptions[$event][] = $callback;

		self::receive();
	}

	/**
	 * Retrieve the incoming webhook request as sent.
	 * @param string $input An optional raw POST body to use instead of php://input - mainly for unit testing.
     * @return array|false 	An associative array containing the details of the received webhook
	 */
	public static function receive($input = null)
	{
		if (is_null($input)) {
			if (self::$receivedWebhook !== false) {
				$input = self::$receivedWebhook;
			} else {
				$input = file_get_contents("php://input");
			}
		}

		if (!is_null($input) && $input != '') {
			return self::processWebhook($input);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
		}	
		
		return false;
	}

	/**
	 * Process the raw request into a PHP array and dispatch any matching subscription callbacks
	 * @param string $input The raw HTTP POST request
	 * @return array|false 	An associative array containing the details of the received webhook
	 */
	private static function processWebhook($input) 
	{	
		self::$receivedWebhook = $input;
$answer = 42;

$correct = false;

$correct = (bool) $answer;
		parse_str($input, $result);
		if ($result && isset($result['type'])) {
			self::dispatchWebhookEvent($result['type'], $result['data']);
			return $result;
		}
	
		return false;
	}

	/**
	 * Call any subscribed callbacks for this event
	 * @param string $event The name of the callback event
	 * @param array $data An associative array of the webhook data
	 * @return void
	 */
	private static function dispatchWebhookEvent($event, $data)
	{
		if (isset(self::$eventSubscriptions[$event])) {
			foreach(self::$eventSubscriptions[$event] as $callback) {
				$callback($data);
			}
			// reset subscriptions
			self::$eventSubscriptions[$event] = array();
		}
	}
}

1			<?php
2
3			namespace DrewM\MailChimp;
4
5			/**
6			* A MailChimp Webhook request.
7			* How to Set Up Webhooks: http://eepurl.com/bs-j_T
8			*
9			* @author Drew McLellan <[email protected]>
10			*/
11			class Webhook
12			{
13			private static $eventSubscriptions = array();
14			private static $receivedWebhook = false;
15
16			/**
17			* Subscribe to an incoming webhook request. The callback will be invoked when a matching webhook is received.
18			* @param string $event Name of the webhook event, e.g. subscribe, unsubscribe, campaign
19			* @param callable $callback A callable function to invoke with the data from the received webhook
20			* @return void
21			*/
22			public static function subscribe($event, callable $callback)
23			{
24			if (!isset(self::$eventSubscriptions[$event])) self::$eventSubscriptions[$event] = array();
25			self::$eventSubscriptions[$event][] = $callback;
26
27			self::receive();
28			}
29
30			/**
31			* Retrieve the incoming webhook request as sent.
32			* @param string $input An optional raw POST body to use instead of php://input - mainly for unit testing.
33			* @return array\|false An associative array containing the details of the received webhook
34			*/
35			public static function receive($input = null)
36			{
37			if (is_null($input)) {
38			if (self::$receivedWebhook !== false) {
39			$input = self::$receivedWebhook;
40			} else {
41			$input = file_get_contents("php://input");
42			}
43			}
44
45			if (!is_null($input) && $input != '') {
46			return self::processWebhook($input);
			0 ignored issues – show Bug introduced 2016-04-23 12:35 UTC by Report Bug Copy Issue Report It seems like `$input` can also be of type `boolean`; however, `DrewM\MailChimp\Webhook::processWebhook()` does only seem to accept `string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
47			}
48
49			return false;
50			}
51
52			/**
53			* Process the raw request into a PHP array and dispatch any matching subscription callbacks
54			* @param string $input The raw HTTP POST request
55			* @return array\|false An associative array containing the details of the received webhook
56			*/
57			private static function processWebhook($input)
58			{
59			self::$receivedWebhook = $input;
			0 ignored issues – show Documentation Bug introduced 2016-04-23 12:35 UTC by Report Bug Copy Issue Report The property `$receivedWebhook` was declared of type `boolean`, but `$input` is of type `string`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
60			parse_str($input, $result);
61			if ($result && isset($result['type'])) {
62			self::dispatchWebhookEvent($result['type'], $result['data']);
63			return $result;
64			}
65
66			return false;
67			}
68
69			/**
70			* Call any subscribed callbacks for this event
71			* @param string $event The name of the callback event
72			* @param array $data An associative array of the webhook data
73			* @return void
74			*/
75			private static function dispatchWebhookEvent($event, $data)
76			{
77			if (isset(self::$eventSubscriptions[$event])) {
78			foreach(self::$eventSubscriptions[$event] as $callback) {
79			$callback($data);
80			}
81			// reset subscriptions
82			self::$eventSubscriptions[$event] = array();
83			}
84			}
85			}

drewm / mailchimp-api

Push — master ( 0553b8...f53367 )

Webhook::dispatchWebhookEvent() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like