Integration::get_settings_fields() - Code Metrics - Inspection of "Merge remote-tracking branch 'origin/develop' into..." - wp-pay-gateways/buckaroo - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — develop ( ba0dec...bb79a4 )

by Reüel

created 2021-06-25 14:33 UTC

Integration::get_settings_fields() A

↳ Parent: Integration

Complexity

Conditions	1
Paths	1

Size

Total Lines	74
Code Lines	50

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	50
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	74
ccs	0
cts	59
cp	0
crap	2
rs	9.0909

How to fix Long Method

<?php

namespace Pronamic\WordPress\Pay\Gateways\Buckaroo;

use Pronamic\WordPress\Pay\AbstractGatewayIntegration;

/**
 * Title: Buckaroo integration
 * Description:
 * Copyright: 2005-2021 Pronamic
 * Company: Pronamic
 *
 * @author Reüel van der Steege
 * @version 2.0.4
 * @since 1.0.0
 */
class Integration extends AbstractGatewayIntegration {
	/**
	 * REST route namespace.
	 *
	 * @var string
	 */
	const REST_ROUTE_NAMESPACE = 'pronamic-pay/buckaroo/v1';

	/**
	 * Construct Buckaroo integration.
	 *
	 * @param array $args Arguments.
	 */
	public function __construct( $args = array() ) {
		$args = wp_parse_args(
			$args,
			array(
				'id'            => 'buckaroo',
				'name'          => 'Buckaroo',
				'url'           => 'https://plaza.buckaroo.nl/',
				'product_url'   => \__( 'http://www.buckaroo-payments.com', 'pronamic_ideal' ),
				'dashboard_url' => 'https://plaza.buckaroo.nl/',
				'provider'      => 'buckaroo',
				'supports'      => array(
					'payment_status_request',
					'refunds',
					'webhook',
					'webhook_log',
					'webhook_no_config',
				),
				'manual_url'    => \__( 'https://www.pronamic.eu/support/how-to-connect-buckaroo-with-wordpress-via-pronamic-pay/', 'pronamic_ideal' ),
			)
		);

		parent::__construct( $args );

		/**
		 * CLI.
		 *
		 * @link https://github.com/woocommerce/woocommerce/blob/3.9.0/includes/class-woocommerce.php#L453-L455
		 */
		if ( defined( 'WP_CLI' ) && WP_CLI ) {

			new CLI( $this );
		}
	}

	/**
	 * Setup.
	 */
	public function setup() {
		\add_filter(
			'pronamic_gateway_configuration_display_value_' . $this->get_id(),
			array( $this, 'gateway_configuration_display_value' ),
			10,
			2
		);

		// Push controller.
		$push_controller = new PushController();

		$push_controller->setup();
	}

	/**
	 * Gateway configuration display value.
	 *
	 * @param string $display_value Display value.
	 * @param int    $post_id       Gateway configuration post ID.
	 * @return string
	 */
	public function gateway_configuration_display_value( $display_value, $post_id ) {
		$config = $this->get_config( $post_id );

		$display_value = $config->website_key;

		return $display_value;
	}

	/**
	 * Get settings fields.
	 *
	 * @return array<int, array<string, callable|int|string|bool|array<int|string,int|string>>>
	 */
	public function get_settings_fields() {
		$fields = array();

		// Website Key.
		$fields[] = array(
			'section'  => 'general',
			'filter'   => FILTER_SANITIZE_STRING,
			'meta_key' => '_pronamic_gateway_buckaroo_website_key',
			'title'    => __( 'Website Key', 'pronamic_ideal' ),
			'type'     => 'text',
			'classes'  => array( 'code' ),
			'tooltip'  => __( 'Website key as mentioned in the Buckaroo dashboard on the page "Profile » Website".', 'pronamic_ideal' ),
		);

		// Secret Key.
		$fields[] = array(
			'section'  => 'general',
			'filter'   => FILTER_SANITIZE_STRING,
			'meta_key' => '_pronamic_gateway_buckaroo_secret_key',
			'title'    => __( 'Secret Key', 'pronamic_ideal' ),
			'type'     => 'text',
			'classes'  => array( 'regular-text', 'code' ),
			'tooltip'  => __( 'Secret key as mentioned in the Buckaroo dashboard on the page "Configuration » Secret Key for Digital Signature".', 'pronamic_ideal' ),
		);

		// Excluded services.
		$fields[] = array(
			'section'  => 'advanced',
			'filter'   => FILTER_SANITIZE_STRING,
			'meta_key' => '_pronamic_gateway_buckaroo_excluded_services',
			'title'    => __( 'Excluded services', 'pronamic_ideal' ),
			'type'     => 'text',
			'classes'  => array( 'regular-text', 'code' ),
			'tooltip'  => sprintf(
				/* translators: %s: <code>brq_parameter</code> */
				__( 'This controls the Buckaroo %s parameter.', 'pronamic_ideal' ),
				sprintf( '<code>%s</code>', 'brq_exludedservices' )
			),
		);

		// Invoice number.
		$fields[] = array(
			'section'     => 'advanced',
			'filter'      => FILTER_SANITIZE_STRING,
			'meta_key'    => '_pronamic_gateway_buckaroo_invoice_number',
			'title'       => __( 'Invoice number', 'pronamic_ideal' ),
			'type'        => 'text',
			'classes'     => array( 'regular-text', 'code' ),
			'tooltip'     => sprintf(
				/* translators: %s: <code>brq_parameter</code> */
				__( 'This controls the Buckaroo %s parameter.', 'pronamic_ideal' ),
				sprintf( '<code>%s</code>', 'brq_invoicenumber' )
			),
			'description' => sprintf(
				'%s<br />%s',
				/* translators: %s: <code>{tag}</code> */
				sprintf( __( 'Available tags: %s', 'pronamic_ideal' ), sprintf( '<code>%s</code> <code>%s</code>', '{order_id}', '{payment_id}' ) ),
				/* translators: %s: default code */
				sprintf( __( 'Default: <code>%s</code>', 'pronamic_ideal' ), '{payment_id}' )
			),
		);

		// Push URL.
		$fields[] = array(
			'section'  => 'feedback',
			'title'    => __( 'Push URL', 'pronamic_ideal' ),
			'type'     => 'text',
			'classes'  => array( 'large-text', 'code' ),
			'value'    => \rest_url( self::REST_ROUTE_NAMESPACE . '/push' ),
			'readonly' => true,
			'tooltip'  => __( 'The Push URL as sent with each transaction to receive automatic payment status updates on.', 'pronamic_ideal' ),
		);

		return $fields;
	}

	/**
	 * Get config.
	 *
	 * @param int $post_id Gateway config post ID.
	 *
	 * @return Config
	 */
	public function get_config( $post_id ) {
		$config = new Config();

		$config->website_key       = get_post_meta( $post_id, '_pronamic_gateway_buckaroo_website_key', true );
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
		$config->secret_key        = get_post_meta( $post_id, '_pronamic_gateway_buckaroo_secret_key', true );
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
		$config->excluded_services = get_post_meta( $post_id, '_pronamic_gateway_buckaroo_excluded_services', true );
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
		$config->invoice_number    = get_post_meta( $post_id, '_pronamic_gateway_buckaroo_invoice_number', true );
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
		$config->mode              = get_post_meta( $post_id, '_pronamic_gateway_mode', true );
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}

		return $config;
	}

	/**
	 * Get gateway.
	 *
	 * @param int $post_id Post ID.
	 * @return Gateway
	 */
	public function get_gateway( $post_id ) {
		return new Gateway( $this->get_config( $post_id ) );
	}
}


1			<?php
2
3			namespace Pronamic\WordPress\Pay\Gateways\Buckaroo;
4
5			use Pronamic\WordPress\Pay\AbstractGatewayIntegration;
6
7			/**
8			* Title: Buckaroo integration
9			* Description:
10			* Copyright: 2005-2021 Pronamic
11			* Company: Pronamic
12			*
13			* @author Reüel van der Steege
14			* @version 2.0.4
15			* @since 1.0.0
16			*/
17			class Integration extends AbstractGatewayIntegration {
18			/**
19			* REST route namespace.
20			*
21			* @var string
22			*/
23			const REST_ROUTE_NAMESPACE = 'pronamic-pay/buckaroo/v1';
24
25			/**
26			* Construct Buckaroo integration.
27			*
28			* @param array $args Arguments.
29			*/
30			public function __construct( $args = array() ) {
31			$args = wp_parse_args(
32			$args,
33			array(
34			'id' => 'buckaroo',
35			'name' => 'Buckaroo',
36			'url' => 'https://plaza.buckaroo.nl/',
37			'product_url' => \__( 'http://www.buckaroo-payments.com', 'pronamic_ideal' ),
38			'dashboard_url' => 'https://plaza.buckaroo.nl/',
39			'provider' => 'buckaroo',
40			'supports' => array(
41			'payment_status_request',
42			'refunds',
43			'webhook',
44			'webhook_log',
45			'webhook_no_config',
46			),
47			'manual_url' => \__( 'https://www.pronamic.eu/support/how-to-connect-buckaroo-with-wordpress-via-pronamic-pay/', 'pronamic_ideal' ),
48			)
49			);
50
51			parent::__construct( $args );
52
53			/**
54			* CLI.
55			*
56			* @link https://github.com/woocommerce/woocommerce/blob/3.9.0/includes/class-woocommerce.php#L453-L455
57			*/
58			if ( defined( 'WP_CLI' ) && WP_CLI ) {
			0 ignored issues – show Bug introduced 2021-06-07 19:19 UTC by Report Bug Copy Issue Report The constant `Pronamic\WordPress\Pay\Gateways\Buckaroo\WP_CLI` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
59			new CLI( $this );
60			}
61			}
62
63			/**
64			* Setup.
65			*/
66			public function setup() {
67			\add_filter(
68			'pronamic_gateway_configuration_display_value_' . $this->get_id(),
69			array( $this, 'gateway_configuration_display_value' ),
70			10,
71			2
72			);
73
74			// Push controller.
75			$push_controller = new PushController();
76
77			$push_controller->setup();
78			}
79
80			/**
81			* Gateway configuration display value.
82			*
83			* @param string $display_value Display value.
84			* @param int $post_id Gateway configuration post ID.
85			* @return string
86			*/
87			public function gateway_configuration_display_value( $display_value, $post_id ) {
88			$config = $this->get_config( $post_id );
89
90			$display_value = $config->website_key;
91
92			return $display_value;
93			}
94
95			/**
96			* Get settings fields.
97			*
98			* @return array<int, array<string, callable\|int\|string\|bool\|array<int\|string,int\|string>>>
99			*/
100			public function get_settings_fields() {
101			$fields = array();
102
103			// Website Key.
104			$fields[] = array(
105			'section' => 'general',
106			'filter' => FILTER_SANITIZE_STRING,
107			'meta_key' => '_pronamic_gateway_buckaroo_website_key',
108			'title' => __( 'Website Key', 'pronamic_ideal' ),
109			'type' => 'text',
110			'classes' => array( 'code' ),
111			'tooltip' => __( 'Website key as mentioned in the Buckaroo dashboard on the page "Profile » Website".', 'pronamic_ideal' ),
112			);
113
114			// Secret Key.
115			$fields[] = array(
116			'section' => 'general',
117			'filter' => FILTER_SANITIZE_STRING,
118			'meta_key' => '_pronamic_gateway_buckaroo_secret_key',
119			'title' => __( 'Secret Key', 'pronamic_ideal' ),
120			'type' => 'text',
121			'classes' => array( 'regular-text', 'code' ),
122			'tooltip' => __( 'Secret key as mentioned in the Buckaroo dashboard on the page "Configuration » Secret Key for Digital Signature".', 'pronamic_ideal' ),
123			);
124
125			// Excluded services.
126			$fields[] = array(
127			'section' => 'advanced',
128			'filter' => FILTER_SANITIZE_STRING,
129			'meta_key' => '_pronamic_gateway_buckaroo_excluded_services',
130			'title' => __( 'Excluded services', 'pronamic_ideal' ),
131			'type' => 'text',
132			'classes' => array( 'regular-text', 'code' ),
133			'tooltip' => sprintf(
134			/* translators: %s: <code>brq_parameter</code> */
135			__( 'This controls the Buckaroo %s parameter.', 'pronamic_ideal' ),
136			sprintf( '<code>%s</code>', 'brq_exludedservices' )
137			),
138			);
139
140			// Invoice number.
141			$fields[] = array(
142			'section' => 'advanced',
143			'filter' => FILTER_SANITIZE_STRING,
144			'meta_key' => '_pronamic_gateway_buckaroo_invoice_number',
145			'title' => __( 'Invoice number', 'pronamic_ideal' ),
146			'type' => 'text',
147			'classes' => array( 'regular-text', 'code' ),
148			'tooltip' => sprintf(
149			/* translators: %s: <code>brq_parameter</code> */
150			__( 'This controls the Buckaroo %s parameter.', 'pronamic_ideal' ),
151			sprintf( '<code>%s</code>', 'brq_invoicenumber' )
152			),
153			'description' => sprintf(
154			'%s<br />%s',
155			/* translators: %s: <code>{tag}</code> */
156			sprintf( __( 'Available tags: %s', 'pronamic_ideal' ), sprintf( '<code>%s</code> <code>%s</code>', '{order_id}', '{payment_id}' ) ),
157			/* translators: %s: default code */
158			sprintf( __( 'Default: <code>%s</code>', 'pronamic_ideal' ), '{payment_id}' )
159			),
160			);
161
162			// Push URL.
163			$fields[] = array(
164			'section' => 'feedback',
165			'title' => __( 'Push URL', 'pronamic_ideal' ),
166			'type' => 'text',
167			'classes' => array( 'large-text', 'code' ),
168			'value' => \rest_url( self::REST_ROUTE_NAMESPACE . '/push' ),
169			'readonly' => true,
170			'tooltip' => __( 'The Push URL as sent with each transaction to receive automatic payment status updates on.', 'pronamic_ideal' ),
171			);
172
173			return $fields;
174			}
175
176			/**
177			* Get config.
178			*
179			* @param int $post_id Gateway config post ID.
180			*
181			* @return Config
182			*/
183			public function get_config( $post_id ) {
184			$config = new Config();
185
186			$config->website_key = get_post_meta( $post_id, '_pronamic_gateway_buckaroo_website_key', true );
			0 ignored issues – show Documentation Bug introduced 2019-12-29 21:40 UTC by Report Bug Copy Issue Report It seems like `get_post_meta($post_id, ...roo_website_key', true)` can also be of type `false`. However, the property `$website_key` is declared as type `null\|string`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
187			$config->secret_key = get_post_meta( $post_id, '_pronamic_gateway_buckaroo_secret_key', true );
			0 ignored issues – show Documentation Bug introduced 2019-12-29 21:40 UTC by Report Bug Copy Issue Report It seems like `get_post_meta($post_id, ...aroo_secret_key', true)` can also be of type `false`. However, the property `$secret_key` is declared as type `null\|string`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
188			$config->excluded_services = get_post_meta( $post_id, '_pronamic_gateway_buckaroo_excluded_services', true );
			0 ignored issues – show Documentation Bug introduced 2019-12-29 21:40 UTC by Report Bug Copy Issue Report It seems like `get_post_meta($post_id, ...cluded_services', true)` can also be of type `false`. However, the property `$excluded_services` is declared as type `null\|string`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
189			$config->invoice_number = get_post_meta( $post_id, '_pronamic_gateway_buckaroo_invoice_number', true );
			0 ignored issues – show Documentation Bug introduced 2019-12-29 21:40 UTC by Report Bug Copy Issue Report It seems like `get_post_meta($post_id, ..._invoice_number', true)` can also be of type `false`. However, the property `$invoice_number` is declared as type `null\|string`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
190			$config->mode = get_post_meta( $post_id, '_pronamic_gateway_mode', true );
			0 ignored issues – show Documentation Bug introduced 2019-02-09 02:23 UTC by Report Bug Copy Issue Report It seems like `get_post_meta($post_id, ...ic_gateway_mode', true)` can also be of type `false`. However, the property `$mode` is declared as type `string`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
191
192			return $config;
193			}
194
195			/**
196			* Get gateway.
197			*
198			* @param int $post_id Post ID.
199			* @return Gateway
200			*/
201			public function get_gateway( $post_id ) {
202			return new Gateway( $this->get_config( $post_id ) );
203			}
204			}
205

wp-pay-gateways / buckaroo

Push — develop ( ba0dec...bb79a4 )

Integration::get_settings_fields() A

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like