<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* WooCommerce Settings Data Transformer.

[2] Fix | Delete

*/

[3] Fix | Delete

[4] Fix | Delete

declare( strict_types = 1 );

[5] Fix | Delete

[6] Fix | Delete

namespace Automattic\WooCommerce\Admin\Features\Settings;

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

* Transforms WooCommerce settings data into a structured format with logical groupings.

[10] Fix | Delete

*/

[11] Fix | Delete

class Transformer {

[12] Fix | Delete

/**

[13] Fix | Delete

* Current group being processed.

[14] Fix | Delete

*

[15] Fix | Delete

* @var array|null

[16] Fix | Delete

*/

[17] Fix | Delete

private ?array $current_group = null;

[18] Fix | Delete

[19] Fix | Delete

/**

[20] Fix | Delete

* Current checkbox group being processed.

[21] Fix | Delete

*

[22] Fix | Delete

* @var array|null

[23] Fix | Delete

*/

[24] Fix | Delete

private ?array $current_checkbox_group = null;

[25] Fix | Delete

[26] Fix | Delete

/**

[27] Fix | Delete

* Transform settings data.

[28] Fix | Delete

*

[29] Fix | Delete

* @param array $raw_settings Raw settings data.

[30] Fix | Delete

*

[31] Fix | Delete

* @return array Transformed settings data.

[32] Fix | Delete

*/

[33] Fix | Delete

public function transform( array $raw_settings ): array {

[34] Fix | Delete

$transformed = array();

[35] Fix | Delete

[36] Fix | Delete

foreach ( $raw_settings as $tab_id => $tab ) {

[37] Fix | Delete

// If the tab doesn't have sections, or the sections aren't an array, skip it.

[38] Fix | Delete

if ( ! isset( $tab['sections'] ) || ! is_array( $tab['sections'] ) ) {

[39] Fix | Delete

$transformed[ $tab_id ] = $tab;

[40] Fix | Delete

continue;

[41] Fix | Delete

}

[42] Fix | Delete

[43] Fix | Delete

$transformed[ $tab_id ] = $tab;

[44] Fix | Delete

$transformed[ $tab_id ]['sections'] = $this->transform_sections( $tab['sections'] );

[45] Fix | Delete

}

[46] Fix | Delete

[47] Fix | Delete

return $transformed;

[48] Fix | Delete

}

[49] Fix | Delete

[50] Fix | Delete

/**

[51] Fix | Delete

* Transform sections within a tab.

[52] Fix | Delete

*

[53] Fix | Delete

* @param array $sections Sections to transform.

[54] Fix | Delete

*

[55] Fix | Delete

* @return array Transformed sections.

[56] Fix | Delete

*/

[57] Fix | Delete

private function transform_sections( array $sections ): array {

[58] Fix | Delete

$transformed_sections = array();

[59] Fix | Delete

[60] Fix | Delete

foreach ( $sections as $section_id => $section ) {

[61] Fix | Delete

// If the section doesn't have settings, or the settings aren't an array, skip it.

[62] Fix | Delete

if ( ! isset( $section['settings'] ) || ! is_array( $section['settings'] ) ) {

[63] Fix | Delete

$transformed_sections[ $section_id ] = $section;

[64] Fix | Delete

continue;

[65] Fix | Delete

}

[66] Fix | Delete

[67] Fix | Delete

$transformed_sections[ $section_id ] = $section;

[68] Fix | Delete

$transformed_sections[ $section_id ]['settings'] = $this->transform_section_settings( $section['settings'] );

[69] Fix | Delete

}

[70] Fix | Delete

[71] Fix | Delete

return $transformed_sections;

[72] Fix | Delete

}

[73] Fix | Delete

[74] Fix | Delete

/**

[75] Fix | Delete

* Transform settings within a section.

[76] Fix | Delete

*

[77] Fix | Delete

* @param array $settings Settings to transform.

[78] Fix | Delete

*

[79] Fix | Delete

* @return array Transformed settings.

[80] Fix | Delete

*/

[81] Fix | Delete

private function transform_section_settings( array $settings ): array {

[82] Fix | Delete

$this->reset_state();

[83] Fix | Delete

$transformed_settings = array();

[84] Fix | Delete

[85] Fix | Delete

foreach ( $settings as $setting ) {

[86] Fix | Delete

$this->process_setting( $setting, $transformed_settings );

[87] Fix | Delete

}

[88] Fix | Delete

$this->finalize_transformation( $transformed_settings );

[89] Fix | Delete

[90] Fix | Delete

return $transformed_settings;

[91] Fix | Delete

}

[92] Fix | Delete

[93] Fix | Delete

/**

[94] Fix | Delete

* Process individual setting.

[95] Fix | Delete

*

[96] Fix | Delete

* @param array $setting Setting to process.

[97] Fix | Delete

* @param array $transformed_settings Transformed settings array.

[98] Fix | Delete

*/

[99] Fix | Delete

private function process_setting( ?array $setting, array &$transformed_settings ): void {

[100] Fix | Delete

if ( ! isset( $setting ) ) {

[101] Fix | Delete

return;

[102] Fix | Delete

}

[103] Fix | Delete

[104] Fix | Delete

$type = $setting['type'] ?? '';

[105] Fix | Delete

[106] Fix | Delete

if ( $this->current_checkbox_group && 'checkbox' !== $type ) {

[107] Fix | Delete

// It's expected that a checkbox group will always be closed before a non-checkbox setting.

[108] Fix | Delete

// If not, it's likely a checkbox group was not closed properly so we flush the current checkbox group and add the setting as-is.

[109] Fix | Delete

$this->flush_current_checkbox_group();

[110] Fix | Delete

}

[111] Fix | Delete

[112] Fix | Delete

switch ( $type ) {

[113] Fix | Delete

case 'title':

[114] Fix | Delete

$this->handle_group_start( $setting, $transformed_settings );

[115] Fix | Delete

break;

[116] Fix | Delete

[117] Fix | Delete

case 'sectionend':

[118] Fix | Delete

$this->handle_group_end( $setting, $transformed_settings );

[119] Fix | Delete

break;

[120] Fix | Delete

[121] Fix | Delete

case 'checkbox':

[122] Fix | Delete

$this->handle_checkbox_setting( $setting, $transformed_settings );

[123] Fix | Delete

break;

[124] Fix | Delete

[125] Fix | Delete

case 'info':

[126] Fix | Delete

if ( ! empty( $setting['text'] ) ) {

[127] Fix | Delete

$setting['text'] = wp_kses_post( wpautop( wptexturize( $setting['text'] ) ) );

[128] Fix | Delete

}

[129] Fix | Delete

if ( ! empty( $setting['row_class'] ) && substr( $setting['row_class'], 0, 16 ) !== 'wc-settings-row-' ) {

[130] Fix | Delete

$setting['row_class'] = 'wc-settings-row-' . $setting['row_class'];

[131] Fix | Delete

}

[132] Fix | Delete

[133] Fix | Delete

$this->add_setting( $setting, $transformed_settings );

[134] Fix | Delete

break;

[135] Fix | Delete

[136] Fix | Delete

default:

[137] Fix | Delete

$this->add_setting( $setting, $transformed_settings );

[138] Fix | Delete

break;

[139] Fix | Delete

}

[140] Fix | Delete

}

[141] Fix | Delete

[142] Fix | Delete

/**

[143] Fix | Delete

* Handle the start of a new group.

[144] Fix | Delete

*

[145] Fix | Delete

* @param array $setting Setting to add.

[146] Fix | Delete

* @param array $transformed_settings Transformed settings array.

[147] Fix | Delete

*/

[148] Fix | Delete

private function handle_group_start( array $setting, array &$transformed_settings ): void {

[149] Fix | Delete

// If we already have a group, flush it to settings before starting a new one.

[150] Fix | Delete

if ( $this->current_group ) {

[151] Fix | Delete

$this->flush_current_group( $transformed_settings );

[152] Fix | Delete

}

[153] Fix | Delete

[154] Fix | Delete

$this->current_group = array( $setting );

[155] Fix | Delete

}

[156] Fix | Delete

[157] Fix | Delete

/**

[158] Fix | Delete

* Handle the end of a group.

[159] Fix | Delete

*

[160] Fix | Delete

* @param array $setting Setting to add.

[161] Fix | Delete

* @param array $transformed_settings Transformed settings array.

[162] Fix | Delete

*/

[163] Fix | Delete

private function handle_group_end( array $setting, array &$transformed_settings ): void {

[164] Fix | Delete

$ids_match = $this->current_group &&

[165] Fix | Delete

isset( $this->current_group[0]['id'] ) &&

[166] Fix | Delete

isset( $setting['id'] ) &&

[167] Fix | Delete

$this->current_group[0]['id'] === $setting['id'];

[168] Fix | Delete

[169] Fix | Delete

$ids_match_undefined = $this->current_group &&

[170] Fix | Delete

! isset( $this->current_group[0]['id'] ) &&

[171] Fix | Delete

! isset( $setting['id'] );

[172] Fix | Delete

[173] Fix | Delete

// If IDs match, add the group and close it.

[174] Fix | Delete

if ( $ids_match || $ids_match_undefined ) {

[175] Fix | Delete

// Compose the group setting.

[176] Fix | Delete

$title_setting = array_shift( $this->current_group );

[177] Fix | Delete

$title_setting['id'] = $title_setting['id'] ?? wp_unique_prefixed_id( 'setting_group' );

[178] Fix | Delete

[179] Fix | Delete

$transformed_settings[] = array_merge(

[180] Fix | Delete

$title_setting,

[181] Fix | Delete

array(

[182] Fix | Delete

'type' => 'group',

[183] Fix | Delete

'settings' => $this->current_group,

[184] Fix | Delete

)

[185] Fix | Delete

);

[186] Fix | Delete

$this->current_group = null;

[187] Fix | Delete

return;

[188] Fix | Delete

}

[189] Fix | Delete

[190] Fix | Delete

// If IDs don't match, we don't need to transform anything so flush the current group.

[191] Fix | Delete

$this->flush_current_group( $transformed_settings );

[192] Fix | Delete

$this->add_setting( $setting, $transformed_settings );

[193] Fix | Delete

}

[194] Fix | Delete

[195] Fix | Delete

/**

[196] Fix | Delete

* Flush current group to transformed settings.

[197] Fix | Delete

*

[198] Fix | Delete

* @param array $transformed_settings Transformed settings array.

[199] Fix | Delete

*/

[200] Fix | Delete

private function flush_current_group( array &$transformed_settings ): void {

[201] Fix | Delete

if ( is_array( $this->current_group ) && ! empty( $this->current_group ) ) {

[202] Fix | Delete

$this->current_group[0]['id'] = $this->current_group[0]['id'] ?? wp_unique_prefixed_id( 'setting_title' );

[203] Fix | Delete

$transformed_settings = array_merge( $transformed_settings, $this->current_group );

[204] Fix | Delete

}

[205] Fix | Delete

[206] Fix | Delete

$this->current_group = null;

[207] Fix | Delete

}

[208] Fix | Delete

[209] Fix | Delete

/**

[210] Fix | Delete

* Handle checkbox setting and grouping.

[211] Fix | Delete

*

[212] Fix | Delete

* @param array $setting Setting to add.

[213] Fix | Delete

* @param array $transformed_settings Transformed settings array.

[214] Fix | Delete

*/

[215] Fix | Delete

private function handle_checkbox_setting( array $setting, array &$transformed_settings ): void {

[216] Fix | Delete

$checkboxgroup = $setting['checkboxgroup'] ?? '';

[217] Fix | Delete

[218] Fix | Delete

switch ( $checkboxgroup ) {

[219] Fix | Delete

case 'start':

[220] Fix | Delete

$this->start_checkbox_group( $setting );

[221] Fix | Delete

break;

[222] Fix | Delete

[223] Fix | Delete

case 'end':

[224] Fix | Delete

$this->end_checkbox_group( $setting, $transformed_settings );

[225] Fix | Delete

break;

[226] Fix | Delete

[227] Fix | Delete

default:

[228] Fix | Delete

$this->handle_checkbox_group_item( $setting, $transformed_settings );

[229] Fix | Delete

break;

[230] Fix | Delete

}

[231] Fix | Delete

}

[232] Fix | Delete

[233] Fix | Delete

/**

[234] Fix | Delete

* Start a new checkbox group.

[235] Fix | Delete

*

[236] Fix | Delete

* @param array $setting Setting to add.

[237] Fix | Delete

*/

[238] Fix | Delete

private function start_checkbox_group( array $setting ): void {

[239] Fix | Delete

// If we already have an open checkbox group, flush it to settings before starting a new one.

[240] Fix | Delete

if ( is_array( $this->current_checkbox_group ) ) {

[241] Fix | Delete

$this->flush_current_checkbox_group();

[242] Fix | Delete

}

[243] Fix | Delete

[244] Fix | Delete

$this->current_checkbox_group = array( $setting );

[245] Fix | Delete

}

[246] Fix | Delete

[247] Fix | Delete

/**

[248] Fix | Delete

* End current checkbox group.

[249] Fix | Delete

*

[250] Fix | Delete

* @param array $setting Setting to add.

[251] Fix | Delete

* @param array $transformed_settings Transformed settings array.

[252] Fix | Delete

*/

[253] Fix | Delete

private function end_checkbox_group( array $setting, array &$transformed_settings ): void {

[254] Fix | Delete

if ( empty( $this->current_checkbox_group ) ) {

[255] Fix | Delete

// If we don't have an open checkbox group, add the setting as-is.

[256] Fix | Delete

$this->add_setting( $setting, $transformed_settings );

[257] Fix | Delete

return;

[258] Fix | Delete

}

[259] Fix | Delete

[260] Fix | Delete

$this->current_checkbox_group[] = $setting;

[261] Fix | Delete

$first_setting = $this->current_checkbox_group[0];

[262] Fix | Delete

[263] Fix | Delete

$checkbox_group_setting = array(

[264] Fix | Delete

'id' => wp_unique_prefixed_id( 'setting_checkboxgroup' ),

[265] Fix | Delete

'type' => 'checkboxgroup',

[266] Fix | Delete

'title' => $first_setting['title'] ?? '',

[267] Fix | Delete

'settings' => $this->current_checkbox_group,

[268] Fix | Delete

);

[269] Fix | Delete

[270] Fix | Delete

$this->add_setting( $checkbox_group_setting, $transformed_settings );

[271] Fix | Delete

$this->current_checkbox_group = null;

[272] Fix | Delete

}

[273] Fix | Delete

[274] Fix | Delete

/**

[275] Fix | Delete

* Handle checkbox within a group.

[276] Fix | Delete

*

[277] Fix | Delete

* @param array $setting Setting to add.

[278] Fix | Delete

* @param array $transformed_settings Transformed settings array.

[279] Fix | Delete

*/

[280] Fix | Delete

private function handle_checkbox_group_item( array $setting, array &$transformed_settings ): void {

[281] Fix | Delete

if ( is_array( $this->current_checkbox_group ) ) {

[282] Fix | Delete

$this->current_checkbox_group[] = $setting;

[283] Fix | Delete

return;

[284] Fix | Delete

}

[285] Fix | Delete

[286] Fix | Delete

// If we don't have an open checkbox group, add the setting as-is.

[287] Fix | Delete

$this->add_setting( $setting, $transformed_settings );

[288] Fix | Delete

}

[289] Fix | Delete

[290] Fix | Delete

/**

[291] Fix | Delete

* Flush current checkbox group to transformed settings.

[292] Fix | Delete

*/

[293] Fix | Delete

private function flush_current_checkbox_group(): void {

[294] Fix | Delete

if ( is_array( $this->current_checkbox_group ) ) {

[295] Fix | Delete

if ( is_array( $this->current_group ) ) {

[296] Fix | Delete

$this->current_group = array_merge( $this->current_group, $this->current_checkbox_group );

[297] Fix | Delete

} else {

[298] Fix | Delete

$this->current_group = $this->current_checkbox_group;

[299] Fix | Delete

}

[300] Fix | Delete

[301] Fix | Delete

$this->current_checkbox_group = null;

[302] Fix | Delete

}

[303] Fix | Delete

}

[304] Fix | Delete

[305] Fix | Delete

/**

[306] Fix | Delete

* Add setting to current context (group or root).

[307] Fix | Delete

*

[308] Fix | Delete

* @param array $setting Setting to add.

[309] Fix | Delete

* @param array $transformed_settings Transformed settings array.

[310] Fix | Delete

*/

[311] Fix | Delete

private function add_setting( array $setting, array &$transformed_settings ): void {

[312] Fix | Delete

$setting['id'] = $setting['id'] ?? wp_unique_prefixed_id( 'setting_field' );

[313] Fix | Delete

[314] Fix | Delete

if ( is_array( $this->current_group ) ) {

[315] Fix | Delete

$this->current_group[] = $setting;

[316] Fix | Delete

return;

[317] Fix | Delete

}

[318] Fix | Delete

[319] Fix | Delete

$transformed_settings[] = $setting;

[320] Fix | Delete

}

[321] Fix | Delete

[322] Fix | Delete

/**

[323] Fix | Delete

* Finalize the transformation process.

[324] Fix | Delete

*

[325] Fix | Delete

* @param array &$transformed_settings Transformed settings array.

[326] Fix | Delete

*/

[327] Fix | Delete

private function finalize_transformation( array &$transformed_settings ): void {

[328] Fix | Delete

$this->flush_current_checkbox_group();

[329] Fix | Delete

$this->flush_current_group( $transformed_settings );

[330] Fix | Delete

}

[331] Fix | Delete

[332] Fix | Delete

/**

[333] Fix | Delete

* Reset the state to its initial values.

[334] Fix | Delete

*/

[335] Fix | Delete

public function reset_state(): void {

[336] Fix | Delete

$this->current_group = null;

[337] Fix | Delete

$this->current_checkbox_group = null;

[338] Fix | Delete

}

[339] Fix | Delete

}

[340] Fix | Delete

[341] Fix | Delete