<?php

[0] Fix | Delete

declare( strict_types=1 );

[1] Fix | Delete

namespace Automattic\WooCommerce\Internal\AddressProvider;

[2] Fix | Delete

[3] Fix | Delete

use WC_Address_Provider;

[4] Fix | Delete

[5] Fix | Delete

/**

[6] Fix | Delete

* Service class for managing address providers.

[7] Fix | Delete

*/

[8] Fix | Delete

class AddressProviderController {

[9] Fix | Delete

/**

[10] Fix | Delete

* Registered provider instances.

[11] Fix | Delete

*

[12] Fix | Delete

* @var WC_Address_Provider[]

[13] Fix | Delete

*/

[14] Fix | Delete

private $providers = array();

[15] Fix | Delete

[16] Fix | Delete

/**

[17] Fix | Delete

* Preferred provider from options.

[18] Fix | Delete

*

[19] Fix | Delete

* @var string ID of preferred address provider.

[20] Fix | Delete

*/

[21] Fix | Delete

private $preferred_provider_option = '';

[22] Fix | Delete

[23] Fix | Delete

/**

[24] Fix | Delete

* Constructor.

[25] Fix | Delete

*

[26] Fix | Delete

* @internal

[27] Fix | Delete

*/

[28] Fix | Delete

public function __construct() {

[29] Fix | Delete

add_action( 'init', array( $this, 'init' ) );

[30] Fix | Delete

}

[31] Fix | Delete

[32] Fix | Delete

/**

[33] Fix | Delete

* Init function runs after this provider was added to DI container.

[34] Fix | Delete

*

[35] Fix | Delete

* @internal

[36] Fix | Delete

*/

[37] Fix | Delete

final public function init() {

[38] Fix | Delete

$this->preferred_provider_option = get_option( 'woocommerce_address_autocomplete_provider', '' );

[39] Fix | Delete

$this->providers = $this->get_registered_providers();

[40] Fix | Delete

}

[41] Fix | Delete

[42] Fix | Delete

/**

[43] Fix | Delete

* Get the registered providers.

[44] Fix | Delete

*

[45] Fix | Delete

* @return WC_Address_Provider[] array of WC_Address_Providers.

[46] Fix | Delete

*/

[47] Fix | Delete

public function get_providers(): array {

[48] Fix | Delete

return $this->providers;

[49] Fix | Delete

}

[50] Fix | Delete

[51] Fix | Delete

/**

[52] Fix | Delete

* Get all registered providers.

[53] Fix | Delete

*

[54] Fix | Delete

* @return WC_Address_Provider[] array of WC_Address_Providers.

[55] Fix | Delete

*/

[56] Fix | Delete

private function get_registered_providers(): array {

[57] Fix | Delete

/**

[58] Fix | Delete

* Filter the registered address providers.

[59] Fix | Delete

*

[60] Fix | Delete

* @since 9.9.0

[61] Fix | Delete

* @param array $providers Array of fully qualified class names (strings) or WC_Address_Provider instances.

[62] Fix | Delete

* Class names will be instantiated automatically.

[63] Fix | Delete

* Example: array( 'My_Provider_Class', new My_Other_Provider() )

[64] Fix | Delete

*/

[65] Fix | Delete

$provider_items = apply_filters( 'woocommerce_address_providers', array() );

[66] Fix | Delete

[67] Fix | Delete

// The filter returned nothing but an empty array, so we can skip the rest of the function.

[68] Fix | Delete

if ( empty( $provider_items ) && is_array( $provider_items ) ) {

[69] Fix | Delete

return array();

[70] Fix | Delete

}

[71] Fix | Delete

[72] Fix | Delete

$logger = wc_get_logger();

[73] Fix | Delete

[74] Fix | Delete

if ( ! is_array( $provider_items ) ) {

[75] Fix | Delete

$logger->error(

[76] Fix | Delete

'Invalid return value for woocommerce_address_providers, expected an array of class names or instances.',

[77] Fix | Delete

array(

[78] Fix | Delete

'context' => 'address_provider_service',

[79] Fix | Delete

)

[80] Fix | Delete

);

[81] Fix | Delete

return array();

[82] Fix | Delete

}

[83] Fix | Delete

[84] Fix | Delete

$providers = array();

[85] Fix | Delete

$seen_ids = array();

[86] Fix | Delete

[87] Fix | Delete

foreach ( $provider_items as $provider_item ) {

[88] Fix | Delete

if ( is_string( $provider_item ) && class_exists( $provider_item ) ) {

[89] Fix | Delete

$provider_item = new $provider_item();

[90] Fix | Delete

}

[91] Fix | Delete

[92] Fix | Delete

// Providers need to be valid and extend WC_Address_Provider.

[93] Fix | Delete

if ( ! is_a( $provider_item, WC_Address_Provider::class ) ) {

[94] Fix | Delete

$logger->error(

[95] Fix | Delete

sprintf(

[96] Fix | Delete

'Invalid address provider item "%s", expected a string class name or WC_Address_Provider instance.',

[97] Fix | Delete

is_object( $provider_item ) ? get_class( $provider_item ) : gettype( $provider_item )

[98] Fix | Delete

),

[99] Fix | Delete

array(

[100] Fix | Delete

'context' => 'address_provider_service',

[101] Fix | Delete

)

[102] Fix | Delete

);

[103] Fix | Delete

continue;

[104] Fix | Delete

}

[105] Fix | Delete

[106] Fix | Delete

// Validate the instance has the necessary properties.

[107] Fix | Delete

if ( empty( $provider_item->id ) || empty( $provider_item->name ) ) {

[108] Fix | Delete

$logger->error(

[109] Fix | Delete

'Invalid address provider instance, id or name property is missing or empty: ' . get_class( $provider_item ),

[110] Fix | Delete

array(

[111] Fix | Delete

'context' => 'address_provider_service',

[112] Fix | Delete

)

[113] Fix | Delete

);

[114] Fix | Delete

continue;

[115] Fix | Delete

}

[116] Fix | Delete

[117] Fix | Delete

// Check for duplicate IDs.

[118] Fix | Delete

if ( isset( $seen_ids[ $provider_item->id ] ) ) {

[119] Fix | Delete

$logger->error(

[120] Fix | Delete

sprintf(

[121] Fix | Delete

'Duplicate provider ID found. ID "%s" is used by both %s and %s.',

[122] Fix | Delete

$provider_item->id,

[123] Fix | Delete

$seen_ids[ $provider_item->id ],

[124] Fix | Delete

get_class( $provider_item )

[125] Fix | Delete

),

[126] Fix | Delete

array(

[127] Fix | Delete

'context' => 'address_provider_service',

[128] Fix | Delete

)

[129] Fix | Delete

);

[130] Fix | Delete

continue;

[131] Fix | Delete

}

[132] Fix | Delete

[133] Fix | Delete

// Track the ID and its provider class for error reporting.

[134] Fix | Delete

$seen_ids[ $provider_item->id ] = get_class( $provider_item );

[135] Fix | Delete

[136] Fix | Delete

// Add the provider instance to the array after all checks are completed.

[137] Fix | Delete

$providers[] = $provider_item;

[138] Fix | Delete

}

[139] Fix | Delete

[140] Fix | Delete

if ( ! empty( $this->preferred_provider_option ) && ! empty( $providers ) ) {

[141] Fix | Delete

// Look for the preferred provider in the array.

[142] Fix | Delete

foreach ( $providers as $key => $provider ) {

[143] Fix | Delete

if ( $provider->id === $this->preferred_provider_option ) {

[144] Fix | Delete

// Found the preferred provider, move it to the beginning of the array.

[145] Fix | Delete

$preferred_provider = $provider;

[146] Fix | Delete

unset( $providers[ $key ] );

[147] Fix | Delete

array_unshift( $providers, $preferred_provider );

[148] Fix | Delete

break;

[149] Fix | Delete

}

[150] Fix | Delete

}

[151] Fix | Delete

}

[152] Fix | Delete

[153] Fix | Delete

return $providers;

[154] Fix | Delete

}

[155] Fix | Delete

[156] Fix | Delete

/**

[157] Fix | Delete

* Check if a specific provider is registered and available.

[158] Fix | Delete

*

[159] Fix | Delete

* @param string $provider_id The provider ID to check.

[160] Fix | Delete

* @return bool

[161] Fix | Delete

*/

[162] Fix | Delete

public function is_provider_available( string $provider_id ): bool {

[163] Fix | Delete

[164] Fix | Delete

foreach ( $this->providers as $provider ) {

[165] Fix | Delete

if ( $provider->id === $provider_id ) {

[166] Fix | Delete

return true;

[167] Fix | Delete

}

[168] Fix | Delete

}

[169] Fix | Delete

[170] Fix | Delete

return false;

[171] Fix | Delete

}

[172] Fix | Delete

[173] Fix | Delete

/**

[174] Fix | Delete

* Get the preferred provider; this is what was selected in the WooCommerce "preferred provider" setting *or* the

[175] Fix | Delete

* first registered provider if no preference was set. If the provider selected in WC Settings is not registered

[176] Fix | Delete

* anymore, it will fall back to the first registered provider. Any other case will return an empty string.

[177] Fix | Delete

*

[178] Fix | Delete

* @return string

[179] Fix | Delete

*/

[180] Fix | Delete

public function get_preferred_provider(): string {

[181] Fix | Delete

[182] Fix | Delete

if ( $this->is_provider_available( $this->preferred_provider_option ) ) {

[183] Fix | Delete

return $this->preferred_provider_option;

[184] Fix | Delete

}

[185] Fix | Delete

[186] Fix | Delete

// Get the first provider's ID.

[187] Fix | Delete

return $this->providers[0]->id ?? '';

[188] Fix | Delete

}

[189] Fix | Delete

}

[190] Fix | Delete

[191] Fix | Delete