Issues in PaymentsResultController.php - Failed Issues - Inspection of "Added missing parameter comment." - wp-pay-gateways/adyen - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — develop ( 54383a...8049e9 )

by Remco

created 2020-01-30 14:25 UTC

src/PaymentsResultController.php (1 issue)

Labels

Bug 1

Severity

Minor 1

<?php
/**
 * Payments result controller
 *
 * @author    Pronamic <[email protected]>
 * @copyright 2005-2020 Pronamic
 * @license   GPL-3.0-or-later
 * @package   Pronamic\WordPress\Pay\Gateways\Adyen
 */

namespace Pronamic\WordPress\Pay\Gateways\Adyen;

use JsonSchema\Exception\ValidationException;
use Pronamic\WordPress\Pay\Plugin;
use WP_Error;
use WP_REST_Request;

/**
 * Payments result controller
 *
 * @link https://docs.adyen.com/developers/checkout/web-sdk/customization/logic#beforecomplete
 *
 * @author  Remco Tolsma
 * @version 1.0.3
 * @since   1.0.0
 */
class PaymentsResultController {
	/**
	 * Setup.
	 *
	 * @return void
	 */
	public function setup() {
		add_action( 'rest_api_init', array( $this, 'rest_api_init' ) );
	}

	/**
	 * REST API init.
	 *
	 * @link https://developer.wordpress.org/rest-api/extending-the-rest-api/adding-custom-endpoints/
	 * @link https://developer.wordpress.org/reference/hooks/rest_api_init/
	 *
	 * @return void
	 */
	public function rest_api_init() {
		register_rest_route(
			Integration::REST_ROUTE_NAMESPACE,
			'/payments/result/(?P<config_id>\d+)',
			array(
				'methods'  => 'POST',
				'callback' => array( $this, 'rest_api_adyen_payments_result' ),
				'args'     => array(
					'config_id'  => array(
						'description' => __( 'Gateway configuration ID.', 'pronamic_ideal' ),
						'type'        => 'integer',
					),
					'payload'    => array(
						'description' => __( 'Payload.', 'pronamic_ideal' ),
						'type'        => 'string',
					),
					'resultCode' => array(
						'description' => __( 'Result code.', 'pronamic_ideal' ),
						'type'        => 'string',
					),
					'resultText' => array(
						'description' => __( 'Result text.', 'pronamic_ideal' ),
						'type'        => 'string',
					),
				),
			)
		);
	}

	/**
	 * REST API Adyen payments result handler.
	 *
	 * @param WP_REST_Request $request Request.
	 * @return object
	 */
	public function rest_api_adyen_payments_result( WP_REST_Request $request ) {
		$config_id = $request->get_param( 'config_id' );

		if ( null === $config_id ) {
			return new WP_Error(
				'pronamic-pay-adyen-no-gateway-configuration-id',
				__( 'No gateway configuration ID given in `config_id` parameter.', 'pronamic_ideal' )
			);
		}

		$payload = $request->get_param( 'payload' );

		if ( null === $payload ) {
			return new WP_Error(
				'pronamic-pay-adyen-no-payload',
				__( 'No payload given in `payload` parameter.', 'pronamic_ideal' )
			);
		}

		// Gateway.
		$gateway = Plugin::get_gateway( $config_id );
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();

		if ( empty( $gateway ) ) {
			return new WP_Error(
				'pronamic-pay-adyen-gateway-not-found',
				sprintf(
					/* translators: %s: Gateway configuration ID */
					__( 'Could not found gateway with ID `%s`.', 'pronamic_ideal' ),
					$config_id
				),
				$config_id
			);
		}

		if ( ! isset( $gateway->client ) ) {
			return new WP_Error(
				'pronamic-pay-adyen-client-not-found',
				sprintf(
					/* translators: %s: Gateway configuration ID */
					__( 'Could not found client in gateway with ID `%s`.', 'pronamic_ideal' ),
					$config_id
				),
				$config_id
			);
		}

		// Client.
		$payment_result_request = new PaymentResultRequest( $payload );

		$payment_result_response = $gateway->client->get_payment_result( $payment_result_request );

		$merchant_reference = $payment_result_response->get_merchant_reference();

		// Payment.
		$payment = get_pronamic_payment( $merchant_reference );

		if ( empty( $payment ) ) {
			return new WP_Error(
				'pronamic-pay-adyen-payment-not-found',
				sprintf(
					/* translators: %s: Adyen merchant reference */
					__( 'Could not found payment with ID `%s`.', 'pronamic_ideal' ),
					$merchant_reference
				),
				$payment_result_response
			);
		}

		PaymentResultHelper::update_payment( $payment, $payment_result_response );

		// Return payment result response.
		return $payment_result_response->get_json();
	}
}


1		<?php
2		/**
3		* Payments result controller
4		*
5		* @author Pronamic <[email protected]>
6		* @copyright 2005-2020 Pronamic
7		* @license GPL-3.0-or-later
8		* @package Pronamic\WordPress\Pay\Gateways\Adyen
9		*/
10
11		namespace Pronamic\WordPress\Pay\Gateways\Adyen;
12
13		use JsonSchema\Exception\ValidationException;
14		use Pronamic\WordPress\Pay\Plugin;
15		use WP_Error;
16		use WP_REST_Request;
17
18		/**
19		* Payments result controller
20		*
21		* @link https://docs.adyen.com/developers/checkout/web-sdk/customization/logic#beforecomplete
22		*
23		* @author Remco Tolsma
24		* @version 1.0.3
25		* @since 1.0.0
26		*/
27		class PaymentsResultController {
28		/**
29		* Setup.
30		*
31		* @return void
32		*/
33	9	public function setup() {
34	9	add_action( 'rest_api_init', array( $this, 'rest_api_init' ) );
35	9	}
36
37		/**
38		* REST API init.
39		*
40		* @link https://developer.wordpress.org/rest-api/extending-the-rest-api/adding-custom-endpoints/
41		* @link https://developer.wordpress.org/reference/hooks/rest_api_init/
42		*
43		* @return void
44		*/
45	10	public function rest_api_init() {
46	10	register_rest_route(
47	10	Integration::REST_ROUTE_NAMESPACE,
48	10	'/payments/result/(?P<config_id>\d+)',
49		array(
50	10	'methods' => 'POST',
51	10	'callback' => array( $this, 'rest_api_adyen_payments_result' ),
52		'args' => array(
53		'config_id' => array(
54	10	'description' => __( 'Gateway configuration ID.', 'pronamic_ideal' ),
55	10	'type' => 'integer',
56		),
57		'payload' => array(
58	10	'description' => __( 'Payload.', 'pronamic_ideal' ),
59	10	'type' => 'string',
60		),
61		'resultCode' => array(
62	10	'description' => __( 'Result code.', 'pronamic_ideal' ),
63	10	'type' => 'string',
64		),
65		'resultText' => array(
66	10	'description' => __( 'Result text.', 'pronamic_ideal' ),
67	10	'type' => 'string',
68		),
69		),
70		)
71		);
72	10	}
73
74		/**
75		* REST API Adyen payments result handler.
76		*
77		* @param WP_REST_Request $request Request.
78		* @return object
79		*/
80	2	public function rest_api_adyen_payments_result( WP_REST_Request $request ) {
81	2	$config_id = $request->get_param( 'config_id' );
82
83	2	if ( null === $config_id ) {
84		return new WP_Error(
85		'pronamic-pay-adyen-no-gateway-configuration-id',
86		__( 'No gateway configuration ID given in `config_id` parameter.', 'pronamic_ideal' )
87		);
88		}
89
90	2	$payload = $request->get_param( 'payload' );
91
92	2	if ( null === $payload ) {
93	1	return new WP_Error(
94	1	'pronamic-pay-adyen-no-payload',
95	1	__( 'No payload given in `payload` parameter.', 'pronamic_ideal' )
96		);
97		}
98
99		// Gateway.
100	1	$gateway = Plugin::get_gateway( $config_id );
		0 ignored issues – show Bug introduced 2020-01-22 13:14 UTC by Report Bug Copy Issue Report Show Similar Issues like this Are you sure the assignment to `$gateway` is correct as `Pronamic\WordPress\Pay\P...get_gateway($config_id)` targeting `Pronamic\WordPress\Pay\Plugin::get_gateway()` seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
101
102	1	if ( empty( $gateway ) ) {
103		return new WP_Error(
104		'pronamic-pay-adyen-gateway-not-found',
105		sprintf(
106		/* translators: %s: Gateway configuration ID */
107		__( 'Could not found gateway with ID `%s`.', 'pronamic_ideal' ),
108		$config_id
109		),
110		$config_id
111		);
112		}
113
114	1	if ( ! isset( $gateway->client ) ) {
115		return new WP_Error(
116		'pronamic-pay-adyen-client-not-found',
117		sprintf(
118		/* translators: %s: Gateway configuration ID */
119		__( 'Could not found client in gateway with ID `%s`.', 'pronamic_ideal' ),
120		$config_id
121		),
122		$config_id
123		);
124		}
125
126		// Client.
127	1	$payment_result_request = new PaymentResultRequest( $payload );
128
129	1	$payment_result_response = $gateway->client->get_payment_result( $payment_result_request );
130
131		$merchant_reference = $payment_result_response->get_merchant_reference();
132
133		// Payment.
134		$payment = get_pronamic_payment( $merchant_reference );
135
136		if ( empty( $payment ) ) {
137		return new WP_Error(
138		'pronamic-pay-adyen-payment-not-found',
139		sprintf(
140		/* translators: %s: Adyen merchant reference */
141		__( 'Could not found payment with ID `%s`.', 'pronamic_ideal' ),
142		$merchant_reference
143		),
144		$payment_result_response
145		);
146		}
147
148		PaymentResultHelper::update_payment( $payment, $payment_result_response );
149
150		// Return payment result response.
151		return $payment_result_response->get_json();
152		}
153		}
154

wp-pay-gateways / adyen

Push — develop ( 54383a...8049e9 )

src/PaymentsResultController.php (1 issue)

Labels

Severity

Introduced By

Duplication Side-by-Side

Filter issues like