ClassExtractor.php — WooCommerce 9.9.7

woocommerce / packages / blueprint / src / ClassExtractor.php

woocommerce / packages / blueprint / src Last commit date

Cli 1 year ago Exporters 1 year ago Importers 1 year ago ResourceStorages 1 year ago ResultFormatters 1 year ago Schemas 1 year ago Steps 1 year ago docs 1 year ago BuiltInExporters.php 1 year ago BuiltInStepProcessors.php 1 year ago ClassExtractor.php 1 year ago Cli.php 1 year ago ExportSchema.php 1 year ago ImportSchema.php 1 year ago ImportStep.php 1 year ago Logger.php 1 year ago ResourceStorages.php 1 year ago StepProcessor.php 1 year ago StepProcessorResult.php 1 year ago UsePluginHelpers.php 1 year ago UsePubSub.php 1 year ago UseWPFunctions.php 1 year ago Util.php 1 year ago

ClassExtractor.php

197 lines

1	<?php
2
3	namespace Automattic\WooCommerce\Blueprint;
4
5	/**
6	* Class ClassExtractor
7	*
8	* Provides functionality to manipulate PHP class files by replacing variables,
9	* adding prefixes, and removing strict types declarations.
10	*
11	* This class is used to generate 'code' part for runPHP step from a template file.
12	*/
13	class ClassExtractor {
14	/**
15	* Path to the PHP file being processed.
16	*
17	* @var string
18	*/
19	private string $file_path;
20
21	/**
22	* Whether the file contains a strict types declaration.
23	*
24	* @var bool
25	*/
26	private bool $has_strict_types_declaration = false;
27
28	/**
29	* PHP code to prefix to the final output.
30	*
31	* @var string
32	*/
33	private string $prefix = '';
34
35	/**
36	* Replacements for class variables.
37	*
38	* @var array
39	*/
40	private array $class_variable_replacements = array();
41
42	/**
43	* Replacements for method variables.
44	*
45	* @var array
46	*/
47	private array $method_variable_replacements = array();
48
49	/**
50	* Constructor.
51	*
52	* @param string $file_path Path to the PHP file to process.
53	*
54	* @throws \InvalidArgumentException If the file does not exist.
55	*/
56	public function __construct( string $file_path ) {
57	if ( ! file_exists( $file_path ) ) {
58	throw new \InvalidArgumentException( "File not found: $file_path" );
59	}
60	$this->file_path = $file_path;
61	}
62
63	/**
64	* Adds a prefix to include the WordPress wp-load.php file.
65	*
66	* @return $this
67	*/
68	public function with_wp_load() {
69	$this->prefix .= "<?php require_once 'wordpress/wp-load.php'; ";
70	return $this;
71	}
72
73	/**
74	* Replaces a class variable with a new value.
75	*
76	* @param string $variable_name Name of the class variable.
77	* @param mixed $new_value The new value to assign to the variable.
78	*
79	* @return $this
80	*/
81	public function replace_class_variable( $variable_name, $new_value ) {
82	$this->class_variable_replacements[ $variable_name ] = $new_value;
83	return $this;
84	}
85
86	/**
87	* Replaces a variable inside a method with a new value.
88	*
89	* @param string $method_name Name of the method.
90	* @param string $variable_name Name of the variable to replace.
91	* @param mixed $new_value The new value to assign to the variable.
92	*
93	* @return $this
94	*/
95	public function replace_method_variable( $method_name, $variable_name, $new_value ) {
96	$this->method_variable_replacements[] = array(
97	'method' => $method_name,
98	'variable' => $variable_name,
99	'value' => $new_value,
100	);
101	return $this;
102	}
103
104	/**
105	* Generates the processed PHP code with applied replacements and prefixes.
106	*
107	* @return string The modified PHP code.
108	*/
109	public function get_code() {
110	// Security check: Check if we can replace this with a more secure function.
111	$file_content = file_get_contents( $this->file_path ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
112
113	$file_content = preg_replace( '/<\?php\s*/', '', $file_content );
114
115	if ( preg_match( '/declare\s$\sstrict_types\s=\s1\s$\s;/', $file_content ) ) {
116	$this->has_strict_types_declaration = true;
117	$file_content = preg_replace( '/declare\s$\sstrict_types\s=\s1\s$\s;/', '', $file_content );
118	}
119
120	$file_content = preg_replace( '/\/\.?\\/\|\/\/.?(?=\r?\n)/s', '', $file_content );
121
122	foreach ( $this->class_variable_replacements as $variable => $value ) {
123	$file_content = $this->apply_class_variable_replacement( $file_content, $variable, $value );
124	}
125
126	foreach ( $this->method_variable_replacements as $replacement ) {
127	$file_content = $this->apply_variable_replacement(
128	$file_content,
129	$replacement['method'],
130	$replacement['variable'],
131	$replacement['value']
132	);
133	}
134
135	return $this->prefix . trim( $file_content );
136	}
137
138	/**
139	* Applies a replacement to a class variable in the file content.
140	*
141	* @param string $file_content The content of the PHP file.
142	* @param string $variable_name The name of the variable to replace.
143	* @param mixed $new_value The new value for the variable.
144	*
145	* @return string The updated file content.
146	*/
147	private function apply_class_variable_replacement( $file_content, $variable_name, $new_value ) {
148	// Security check: Check if it's necessary to use var_export.
149	$replacement_value = var_export( $new_value, true ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export
150
151	$pattern = '/(protected\|private\|public)\s+\$' . preg_quote( $variable_name, '/' ) . '\s=\s.*?;\|'
152	. '(protected\|private\|public)\s+\$' . preg_quote( $variable_name, '/' ) . '\s*;?/';
153
154	$replacement = "$1 \$$variable_name = $replacement_value;";
155	return preg_replace( $pattern, $replacement, $file_content, 1 );
156	}
157
158	/**
159	* Applies a replacement to a variable in a specific method.
160	*
161	* @param string $file_content The content of the PHP file.
162	* @param string $method_name The name of the method containing the variable.
163	* @param string $variable_name The name of the variable to replace.
164	* @param mixed $new_value The new value for the variable.
165	*
166	* @return string The updated file content.
167	*/
168	private function apply_variable_replacement( $file_content, $method_name, $variable_name, $new_value ) {
169	$pattern = '/function\s+' . preg_quote( $method_name, '/' ) . '\s$[^)]$\s\{\s(.?)\s\}/s';
170	if ( preg_match( $pattern, $file_content, $matches ) ) {
171	$method_body = $matches[1];
172
173	// Security check: Check if it's necessary to use var_export.
174	$new_value_exported = var_export( $new_value, true ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export
175	$variable_pattern = '/\$' . preg_quote( $variable_name, '/' ) . '\s=\s[^;]+;/';
176	$replacement = '$' . $variable_name . ' = ' . $new_value_exported . ';';
177
178	$updated_method_body = preg_replace( $variable_pattern, $replacement, $method_body, 1 );
179
180	if ( null !== $updated_method_body ) {
181	$file_content = str_replace( $method_body, $updated_method_body, $file_content );
182	}
183	}
184
185	return $file_content;
186	}
187
188	/**
189	* Checks if the file has a strict types declaration.
190	*
191	* @return bool True if the file has a strict types declaration, false otherwise.
192	*/
193	public function has_strict_type_declaration() {
194	return $this->has_strict_types_declaration;
195	}
196	}
197