<?php

[0] Fix | Delete

namespace Automattic\WooCommerce\Blocks\Patterns;

[1] Fix | Delete

[2] Fix | Delete

use Automattic\WooCommerce\Admin\Features\Features;

[3] Fix | Delete

[4] Fix | Delete

/**

[5] Fix | Delete

* PatternRegistry class.

[6] Fix | Delete

*

[7] Fix | Delete

* @internal

[8] Fix | Delete

*/

[9] Fix | Delete

class PatternRegistry {

[10] Fix | Delete

const SLUG_REGEX = '/^[A-z0-9\/_-]+$/';

[11] Fix | Delete

const COMMA_SEPARATED_REGEX = '/[\s,]+/';

[12] Fix | Delete

[13] Fix | Delete

/**

[14] Fix | Delete

* Returns pattern slugs with their localized labels for categorization.

[15] Fix | Delete

*

[16] Fix | Delete

* Each key represents a unique pattern slug, while the value is the localized label.

[17] Fix | Delete

*

[18] Fix | Delete

* @return array<string, string>

[19] Fix | Delete

*/

[20] Fix | Delete

private function get_category_labels() {

[21] Fix | Delete

return [

[22] Fix | Delete

'woo-commerce' => __( 'WooCommerce', 'woocommerce' ),

[23] Fix | Delete

'intro' => __( 'Intro', 'woocommerce' ),

[24] Fix | Delete

'featured-selling' => __( 'Featured Selling', 'woocommerce' ),

[25] Fix | Delete

'about' => __( 'About', 'woocommerce' ),

[26] Fix | Delete

'social-media' => __( 'Social Media', 'woocommerce' ),

[27] Fix | Delete

'services' => __( 'Services', 'woocommerce' ),

[28] Fix | Delete

'reviews' => __( 'Reviews', 'woocommerce' ),

[29] Fix | Delete

];

[30] Fix | Delete

}

[31] Fix | Delete

[32] Fix | Delete

/**

[33] Fix | Delete

* Register a block pattern.

[34] Fix | Delete

*

[35] Fix | Delete

* @param string $source The pattern source.

[36] Fix | Delete

* @param array $pattern_data The pattern data.

[37] Fix | Delete

*

[38] Fix | Delete

* @return void

[39] Fix | Delete

*/

[40] Fix | Delete

public function register_block_pattern( $source, $pattern_data ) {

[41] Fix | Delete

if ( empty( $pattern_data['slug'] ) ) {

[42] Fix | Delete

_doing_it_wrong(

[43] Fix | Delete

'register_block_patterns',

[44] Fix | Delete

esc_html(

[45] Fix | Delete

sprintf(

[46] Fix | Delete

/* translators: %s: file name. */

[47] Fix | Delete

__( 'Could not register pattern "%s" as a block pattern ("Slug" field missing)', 'woocommerce' ),

[48] Fix | Delete

$source

[49] Fix | Delete

)

[50] Fix | Delete

),

[51] Fix | Delete

'6.0.0'

[52] Fix | Delete

);

[53] Fix | Delete

return;

[54] Fix | Delete

}

[55] Fix | Delete

[56] Fix | Delete

if ( ! preg_match( self::SLUG_REGEX, $pattern_data['slug'] ) ) {

[57] Fix | Delete

_doing_it_wrong(

[58] Fix | Delete

'register_block_patterns',

[59] Fix | Delete

esc_html(

[60] Fix | Delete

sprintf(

[61] Fix | Delete

/* translators: %1s: file name; %2s: slug value found. */

[62] Fix | Delete

__( 'Could not register pattern "%1$s" as a block pattern (invalid slug "%2$s")', 'woocommerce' ),

[63] Fix | Delete

$source,

[64] Fix | Delete

$pattern_data['slug']

[65] Fix | Delete

)

[66] Fix | Delete

),

[67] Fix | Delete

'6.0.0'

[68] Fix | Delete

);

[69] Fix | Delete

return;

[70] Fix | Delete

}

[71] Fix | Delete

[72] Fix | Delete

if ( \WP_Block_Patterns_Registry::get_instance()->is_registered( $pattern_data['slug'] ) ) {

[73] Fix | Delete

return;

[74] Fix | Delete

}

[75] Fix | Delete

[76] Fix | Delete

if ( isset( $pattern_data['featureFlag'] ) && '' !== $pattern_data['featureFlag'] && ! Features::is_enabled( $pattern_data['featureFlag'] ) ) {

[77] Fix | Delete

return;

[78] Fix | Delete

}

[79] Fix | Delete

[80] Fix | Delete

// Title is a required property.

[81] Fix | Delete

if ( ! isset( $pattern_data['title'] ) || ! $pattern_data['title'] ) {

[82] Fix | Delete

_doing_it_wrong(

[83] Fix | Delete

'register_block_patterns',

[84] Fix | Delete

esc_html(

[85] Fix | Delete

sprintf(

[86] Fix | Delete

/* translators: %1s: file name; %2s: slug value found. */

[87] Fix | Delete

__( 'Could not register pattern "%s" as a block pattern ("Title" field missing)', 'woocommerce' ),

[88] Fix | Delete

$source

[89] Fix | Delete

)

[90] Fix | Delete

),

[91] Fix | Delete

'6.0.0'

[92] Fix | Delete

);

[93] Fix | Delete

return;

[94] Fix | Delete

}

[95] Fix | Delete

[96] Fix | Delete

// For properties of type array, parse data as comma-separated.

[97] Fix | Delete

foreach ( array( 'categories', 'keywords', 'blockTypes' ) as $property ) {

[98] Fix | Delete

if ( ! empty( $pattern_data[ $property ] ) ) {

[99] Fix | Delete

if ( is_array( $pattern_data[ $property ] ) ) {

[100] Fix | Delete

$pattern_data[ $property ] = array_values(

[101] Fix | Delete

array_map(

[102] Fix | Delete

function ( $property ) {

[103] Fix | Delete

return $property['title'];

[104] Fix | Delete

},

[105] Fix | Delete

$pattern_data[ $property ]

[106] Fix | Delete

)

[107] Fix | Delete

);

[108] Fix | Delete

} else {

[109] Fix | Delete

$pattern_data[ $property ] = array_filter(

[110] Fix | Delete

preg_split(

[111] Fix | Delete

self::COMMA_SEPARATED_REGEX,

[112] Fix | Delete

(string) $pattern_data[ $property ]

[113] Fix | Delete

)

[114] Fix | Delete

);

[115] Fix | Delete

}

[116] Fix | Delete

} else {

[117] Fix | Delete

unset( $pattern_data[ $property ] );

[118] Fix | Delete

}

[119] Fix | Delete

}

[120] Fix | Delete

[121] Fix | Delete

// Parse properties of type int.

[122] Fix | Delete

foreach ( array( 'viewportWidth' ) as $property ) {

[123] Fix | Delete

if ( ! empty( $pattern_data[ $property ] ) ) {

[124] Fix | Delete

$pattern_data[ $property ] = (int) $pattern_data[ $property ];

[125] Fix | Delete

} else {

[126] Fix | Delete

unset( $pattern_data[ $property ] );

[127] Fix | Delete

}

[128] Fix | Delete

}

[129] Fix | Delete

[130] Fix | Delete

// Parse properties of type bool.

[131] Fix | Delete

foreach ( array( 'inserter' ) as $property ) {

[132] Fix | Delete

if ( ! empty( $pattern_data[ $property ] ) ) {

[133] Fix | Delete

$pattern_data[ $property ] = in_array(

[134] Fix | Delete

strtolower( $pattern_data[ $property ] ),

[135] Fix | Delete

array( 'yes', 'true' ),

[136] Fix | Delete

true

[137] Fix | Delete

);

[138] Fix | Delete

} else {

[139] Fix | Delete

unset( $pattern_data[ $property ] );

[140] Fix | Delete

}

[141] Fix | Delete

}

[142] Fix | Delete

[143] Fix | Delete

// phpcs:ignore WordPress.WP.I18n.NonSingularStringLiteralText, WordPress.WP.I18n.LowLevelTranslationFunction

[144] Fix | Delete

$pattern_data['title'] = translate_with_gettext_context( $pattern_data['title'], 'Pattern title', 'woocommerce' );

[145] Fix | Delete

if ( ! empty( $pattern_data['description'] ) ) {

[146] Fix | Delete

// phpcs:ignore WordPress.WP.I18n.NonSingularStringLiteralText, WordPress.WP.I18n.LowLevelTranslationFunction

[147] Fix | Delete

$pattern_data['description'] = translate_with_gettext_context( $pattern_data['description'], 'Pattern description', 'woocommerce' );

[148] Fix | Delete

}

[149] Fix | Delete

[150] Fix | Delete

if ( empty( $pattern_data['content'] ) ) {

[151] Fix | Delete

return;

[152] Fix | Delete

}

[153] Fix | Delete

[154] Fix | Delete

$category_labels = $this->get_category_labels();

[155] Fix | Delete

[156] Fix | Delete

if ( ! empty( $pattern_data['categories'] ) ) {

[157] Fix | Delete

foreach ( $pattern_data['categories'] as $key => $category ) {

[158] Fix | Delete

$category_slug = _wp_to_kebab_case( $category );

[159] Fix | Delete

[160] Fix | Delete

$pattern_data['categories'][ $key ] = $category_slug;

[161] Fix | Delete

[162] Fix | Delete

$label = $category_labels[ $category_slug ] ?? self::kebab_to_capital_case( $category_slug );

[163] Fix | Delete

[164] Fix | Delete

register_block_pattern_category(

[165] Fix | Delete

$category_slug,

[166] Fix | Delete

array(

[167] Fix | Delete

'label' => $label,

[168] Fix | Delete

),

[169] Fix | Delete

);

[170] Fix | Delete

}

[171] Fix | Delete

}

[172] Fix | Delete

[173] Fix | Delete

register_block_pattern( $pattern_data['slug'], $pattern_data );

[174] Fix | Delete

}

[175] Fix | Delete

[176] Fix | Delete

[177] Fix | Delete

/**

[178] Fix | Delete

* Convert a kebab-case string to capital case.

[179] Fix | Delete

*

[180] Fix | Delete

* @param string $value The kebab-case string.

[181] Fix | Delete

*

[182] Fix | Delete

* @return string

[183] Fix | Delete

*/

[184] Fix | Delete

private static function kebab_to_capital_case( $value ) {

[185] Fix | Delete

$string = str_replace( '-', ' ', $value );

[186] Fix | Delete

$string = ucwords( $string );

[187] Fix | Delete

[188] Fix | Delete

return $string;

[189] Fix | Delete

}

[190] Fix | Delete

}

[191] Fix | Delete

[192] Fix | Delete