Automattic\WooCommerce\Internal\RestApi\Routes\V4\Settings\PaymentGateways\Schema

BacsGatewaySettingsSchema{} │ WC 1.0└─ AbstractPaymentGatewaySettingsSchema

BacsGatewaySettingsSchema class.

Extends AbstractPaymentGatewaySettingsSchema to handle BACS-specific settings.

No Hooks.

Usage

$BacsGatewaySettingsSchema = new BacsGatewaySettingsSchema();
// use class methods

Methods

1. public is_special_field( string $field_id )
2. public update_special_fields( WC_Payment_Gateway $gateway, array $values )
3. public validate_and_sanitize_special_fields( WC_Payment_Gateway $gateway, array $values )
4. protected get_special_field_schemas( WC_Payment_Gateway $gateway )
5. protected get_special_field_values( WC_Payment_Gateway $gateway )
6. private validate_bacs_accounts( $value )

BacsGatewaySettingsSchema{} BacsGatewaySettingsSchema{} code ^{WC 10.4.3}

class BacsGatewaySettingsSchema extends AbstractPaymentGatewaySettingsSchema {
	/**
	 * Get values for BACS-specific special fields.
	 *
	 * @param WC_Payment_Gateway $gateway Gateway instance.
	 * @return array
	 */
	protected function get_special_field_values( WC_Payment_Gateway $gateway ): array {
		return array(
			'account_details' => get_option( 'woocommerce_bacs_accounts', array() ),
		);
	}

	/**
	 * Get field schemas for BACS-specific special fields.
	 *
	 * @param WC_Payment_Gateway $gateway Gateway instance.
	 * @return array
	 */
	protected function get_special_field_schemas( WC_Payment_Gateway $gateway ): array {
		$gateway->init_form_fields();

		// Start with information from the gateway's form_fields if available.
		$field = $gateway->form_fields['account_details'] ?? array();

		return array(
			array(
				'id'    => 'account_details',
				'label' => $field['title'] ?? __( 'Account details', 'woocommerce' ),
				'type'  => 'array',
				'desc'  => $field['description'] ?? __( 'Bank account details for direct bank transfer.', 'woocommerce' ),
			),
		);
	}

	/**
	 * Check if a field is a special field for BACS.
	 *
	 * @param string $field_id Field ID.
	 * @return bool
	 */
	public function is_special_field( string $field_id ): bool {
		return 'account_details' === $field_id;
	}

	/**
	 * Validate and sanitize BACS special fields.
	 *
	 * @param WC_Payment_Gateway $gateway Gateway instance.
	 * @param array              $values  Special field values.
	 * @return array|WP_Error Validated values or error.
	 */
	public function validate_and_sanitize_special_fields( WC_Payment_Gateway $gateway, array $values ) {
		$validated = array();

		foreach ( $values as $field_id => $value ) {
			if ( 'account_details' === $field_id ) {
				$validated[ $field_id ] = $this->validate_bacs_accounts( $value );
				if ( is_wp_error( $validated[ $field_id ] ) ) {
					return $validated[ $field_id ];
				}
			}
		}

		return $validated;
	}

	/**
	 * Update BACS special fields in database.
	 *
	 * @param WC_Payment_Gateway $gateway Gateway instance.
	 * @param array              $values  Validated special field values.
	 * @return void
	 */
	public function update_special_fields( WC_Payment_Gateway $gateway, array $values ): void {
		foreach ( $values as $field_id => $value ) {
			if ( 'account_details' === $field_id ) {
				update_option( 'woocommerce_bacs_accounts', $value );
			}
		}
	}

	/**
	 * Validate BACS account details array.
	 *
	 * @param mixed $value Account details value.
	 * @return array|WP_Error Validated accounts or error.
	 */
	private function validate_bacs_accounts( $value ) {
		if ( ! is_array( $value ) ) {
			return new WP_Error(
				'rest_invalid_param',
				__( 'Account details must be an array.', 'woocommerce' ),
				array( 'status' => 400 )
			);
		}

		$validated_accounts = array();
		$valid_fields       = array( 'account_name', 'account_number', 'sort_code', 'bank_name', 'iban', 'bic' );

		foreach ( $value as $index => $account ) {
			if ( ! is_array( $account ) ) {
				return new WP_Error(
					'rest_invalid_param',
					sprintf(
						/* translators: %d: account index */
						__( 'Account at index %d must be an object.', 'woocommerce' ),
						$index
					),
					array( 'status' => 400 )
				);
			}

			$validated_account = array();

			// Sanitize each field.
			foreach ( $valid_fields as $field ) {
				$validated_account[ $field ] = isset( $account[ $field ] )
					? sanitize_text_field( $account[ $field ] )
					: '';
			}

			// Only add if at least one field is filled.
			if ( array_filter( $validated_account ) ) {
				$validated_accounts[] = $validated_account;
			}
		}

		return $validated_accounts;
	}
}