wp-pay-gateways / ems-e-commerce

src/Integration.php

<?php

namespace Pronamic\WordPress\Pay\Gateways\EMS\ECommerce;

use Pronamic\WordPress\Pay\AbstractGatewayIntegration;

/**
 * Title: EMS e-Commerce integration
 * Description:
 * Copyright: 2005-2022 Pronamic
 * Company: Pronamic
 *
 * @author Reüel van der Steege
 * @version 2.1.1
 * @since 1.0.0
 */
class Integration extends AbstractGatewayIntegration {
	/**
	 * Construct EMS e-Commerce integration.
	 *
	 * @param array $args Arguments.
	 */
	public function __construct( $args = array() ) {
		$args = wp_parse_args(
			$args,
			array(
				'id'            => 'ems-ecommerce',
				'name'          => 'EMS e-Commerce',
				'provider'      => 'ems',
				'product_url'   => null,
				'dashboard_url' => array(
					\__( 'test', 'pronamic_ideal' ) => 'https://test.ipg-online.com/vt/login',
					\__( 'live', 'pronamic_ideal' ) => 'https://www.ipg-online.com/vt/login',
				),
				'supports'      => array(
					'webhook',
					'webhook_log',
					'webhook_no_config',
				),
				'manual_url'    => \__( 'https://www.pronamic.eu/support/how-to-connect-ems-with-wordpress-via-pronamic-pay/', 'pronamic_ideal' ),
			)
		);

		parent::__construct( $args );

		// Actions
		$function = array( __NAMESPACE__ . '\Listener', 'listen' );

		if ( ! has_action( 'wp_loaded', $function ) ) {
			add_action( 'wp_loaded', $function );
		}
	}

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

		// Storename.
		$fields[] = array(
			'section'  => 'general',
			'filter'   => FILTER_UNSAFE_RAW,
			'meta_key' => '_pronamic_gateway_ems_ecommerce_storename',
			'title'    => _x( 'Storename', 'ems', 'pronamic_ideal' ),
			'type'     => 'text',
			'classes'  => array( 'code' ),
		);

		// Shared secret.
		$fields[] = array(
			'section'  => 'general',
			'filter'   => FILTER_UNSAFE_RAW,
			'meta_key' => '_pronamic_gateway_ems_ecommerce_secret',
			'title'    => _x( 'Shared Secret', 'ems', 'pronamic_ideal' ),
			'type'     => 'text',
			'classes'  => array( 'large-text', 'code' ),
		);

		// Purchase ID.
		$fields[] = array(
			'section'     => 'advanced',
			'filter'      => array(
				'filter' => FILTER_SANITIZE_STRING,
				'flags'  => FILTER_FLAG_NO_ENCODE_QUOTES,
			),
			'meta_key'    => '_pronamic_gateway_ems_ecommerce_order_id',
			'title'       => __( 'Order ID', 'pronamic_ideal' ),
			'type'        => 'text',
			'classes'     => array( 'regular-text', 'code' ),
			'tooltip'     => sprintf(
				/* translators: %s: <code>{orderId}</code> */
				__( 'The EMS e-Commerce %s parameter.', 'pronamic_ideal' ),
				sprintf( '<code>%s</code>', 'orderId' )
			),
			'description' => sprintf(
				'%s %s<br />%s',
				__( 'Available tags:', 'pronamic_ideal' ),
				sprintf(
					'<code>%s</code> <code>%s</code>',
					'{order_id}',
					'{payment_id}'
				),
				sprintf(
					/* translators: %s: default code */
					__( 'Default: <code>%s</code>', 'pronamic_ideal' ),
					'{payment_id}'
				)
			),
		);

		// Notification URL.
		$fields[] = array(
			'section'  => 'feedback',
			/* translators: Translate 'notification' the same as in the EMS e-Commerce dashboard. */
			'title'    => _x( 'Notification URL', 'EMS e-Commerce', 'pronamic_ideal' ),
			'type'     => 'text',
			'classes'  => array( 'large-text', 'code' ),
			'value'    => home_url( '/' ),
			'readonly' => true,
			/* translators: Translate 'notification' the same as in the EMS e-Commerce dashboard. */
			'tooltip'  => _x(
				'The Notification URL as sent with each transaction to receive automatic payment status updates on.',
				'EMS e-Commerce',
				'pronamic_ideal'
			),
		);

		return $fields;
	}

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

		$config->storename = get_post_meta( $post_id, '_pronamic_gateway_ems_ecommerce_storename', true );

It seems like get_post_meta($post_id, '_pronamic_gateway_ems_ecommerce_storename', true) can also be of type false. However, the property $storename is declared as type null|string. Maybe add an additional type check?

		$config->secret    = get_post_meta( $post_id, '_pronamic_gateway_ems_ecommerce_secret', true );

It seems like get_post_meta($post_id, '_pronamic_gateway_ems_ecommerce_secret', true) can also be of type false. However, the property $secret is declared as type null|string. Maybe add an additional type check?

		$config->mode      = get_post_meta( $post_id, '_pronamic_gateway_mode', true );

It seems like get_post_meta($post_id, '_pronamic_gateway_mode', true) can also be of type false. However, the property $mode is declared as type string. Maybe add an additional type check?

		$config->order_id  = get_post_meta( $post_id, '_pronamic_gateway_ems_ecommerce_order_id', true );

It seems like get_post_meta($post_id, '_pronamic_gateway_ems_ecommerce_order_id', true) can also be of type false. However, the property $order_id is declared as type null|string. Maybe add an additional type check?

		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 ) );
	}
}