elementor / modules / components / module.php

module.php in Elementor Website Builder – more than just a page builder 4.3.0-beta1, at modules/components/module.php

245 lines 9.3 KB

Raw Download Zip

1	<?php
2	namespace Elementor\Modules\Components;
3
4	use Elementor\Core\Base\Module as BaseModule;
5	use Elementor\Core\Experiments\Manager as Experiments_Manager;
6	use Elementor\Modules\AtomicWidgets\Module as AtomicWidgetsModule;
7	use Elementor\Plugin;
8	use Elementor\Modules\AtomicWidgets\PropsResolver\Transformers_Registry;
9	use Elementor\Modules\Components\Styles\Component_Styles;
10	use Elementor\Modules\Components\Documents\Component as Component_Document;
11	use Elementor\Modules\Components\Component_Lock_Manager;
12	use Elementor\Modules\Components\PropTypes\Component_Instance_Prop_Type;
13	use Elementor\Modules\Components\Transformers\Component_Instance_Transformer;
14	use Elementor\Modules\Components\PropTypes\Overridable_Prop_Type;
15	use Elementor\Modules\Components\Transformers\Overridable_Transformer;
16	use Elementor\Core\Base\Document;
17	use Elementor\Modules\Components\PropTypes\Override_Prop_Type;
18	use Elementor\Modules\Components\Transformers\Override_Transformer;
19	use Elementor\Modules\Components\Variants\Component_Variant_Class_Collector;
20	use Elementor\Modules\Components\Widgets\Component_Instance;
21	use Elementor\Modules\Components\Schema\Overridable_LLM_Filter;
22
23	if ( ! defined( 'ABSPATH' ) ) {
24	exit; // Exit if accessed directly.
25	}
26
27	class Module extends BaseModule {
28	const EXPERIMENT_NAME = AtomicWidgetsModule::EXPERIMENT_NAME;
29	const EXPERIMENT_VARIANTS_NAME = 'e_component_variants';
30	const PACKAGES = [ 'editor-components' ];
31
32	/**
33	* Variants meta must be persisted before `Global_Classes_Relations::on_document_save()`
34	* (default priority 10) reads it via the `extract_class_ids_from_post` filter.
35	*/
36	const SAVE_VARIANTS_PRIORITY = 9;
37
38	public function get_name() {
39	return 'components';
40	}
41
42	public function __construct() {
43	parent::__construct();
44
45	if ( ! self::is_experiment_active() ) {
46	return;
47	}
48
49	$this->register_variants_experiment();
50
51	$this->register_component_post_type();
52
53	add_filter( 'elementor/editor/v2/packages', fn ( $packages ) => $this->add_packages( $packages ) );
54	add_filter( 'elementor/atomic-widgets/props-schema', fn ( $schema ) => $this->modify_props_schema( $schema ) );
55	add_action( 'elementor/documents/register', fn ( $documents_manager ) => $this->register_document_type( $documents_manager ) );
56	add_action( 'elementor/document/before_save', fn( Document $document, array $data ) => $this->validate_circular_dependencies( $document, $data ), 10, 2 );
57	add_action( 'elementor/document/after_save', fn( Document $document, array $data ) => $this->set_component_overridable_props( $document, $data ), 10, 2 );
58
59	if ( self::is_variants_experiment_active() ) {
60	add_action( 'elementor/document/after_save', fn( Document $document, array $data ) => $this->set_component_variants( $document, $data ), self::SAVE_VARIANTS_PRIORITY, 2 );
61	add_filter(
62	'elementor/global_classes/extract_class_ids_from_post',
63	fn( array $ids, $post_id ) => $this->add_variant_class_ids( $ids, $post_id ),
64	10,
65	2
66	);
67	}
68	add_filter( 'elementor/global_classes/additional_post_types', fn( $post_types ) => array_merge( $post_types, [ Component_Document::TYPE ] ) );
69	add_filter( 'elementor/utils/find_element_recursive/inner_elements', fn( array $inner_elements, array $element_data ) => $this->get_inner_elements_for_search( $inner_elements, $element_data ), 10, 2 );
70
71	add_action( 'elementor/atomic-widgets/settings/transformers/register', fn ( $transformers ) => $this->register_settings_transformers( $transformers ) );
72	add_action( 'elementor/document/after_migrate', fn( Document $document, array $data ) => $this->after_component_migrate( $document, $data ), 10, 2 );
73
74	add_filter(
75	'elementor/atomic-widgets/llm-json-schema',
76	fn( array $schema ) => ( new Overridable_LLM_Filter() )->apply( $schema )
77	);
78
79	( Component_Lock_Manager::get_instance()->register_hooks() );
80	( new Component_Styles() )->register_hooks();
81	( new Components_REST_API() )->register_hooks();
82	}
83
84	public static function is_experiment_active() {
85	return Plugin::$instance->experiments->is_feature_active( AtomicWidgetsModule::EXPERIMENT_NAME );
86	}
87
88	public static function is_variants_experiment_active(): bool {
89	return Plugin::$instance->experiments->is_feature_active( self::EXPERIMENT_VARIANTS_NAME );
90	}
91
92	/**
93	* Dev-only gate that keeps per-instance Component Variants off trunk while the feature ships
94	* across several tickets. Hidden experiments cannot declare dependencies on other experiments,
95	* so activation is checked manually in the constructor after the parent atomic-elements gate.
96	*/
97	private function register_variants_experiment() {
98	Plugin::$instance->experiments->add_feature( [
99	'name' => self::EXPERIMENT_VARIANTS_NAME,
100	'title' => esc_html__( 'Component Variants', 'elementor' ),
101	'description' => esc_html__( 'Enable per-instance class variants on components.', 'elementor' ),
102	'hidden' => true,
103	'default' => Experiments_Manager::STATE_INACTIVE,
104	'release_status' => Experiments_Manager::RELEASE_STATUS_DEV,
105	] );
106	}
107
108	public function get_widgets() {
109	return [
110	'Component_Instance',
111	];
112	}
113
114	private function add_packages( $packages ) {
115	return array_merge( $packages, self::PACKAGES );
116	}
117
118	private function modify_props_schema( array $schema ) {
119	return Overridable_Schema_Extender::make()->get_extended_schema( $schema );
120	}
121
122	private function register_component_post_type() {
123	register_post_type( Component_Document::TYPE, [
124	'label' => Component_Document::get_title(),
125	'labels' => Component_Document::get_labels(),
126	'public' => false,
127	'supports' => Component_Document::get_supported_features(),
128	] );
129	}
130
131	private function register_document_type( $documents_manager ) {
132	$documents_manager->register_document_type(
133	Component_Document::TYPE,
134	Component_Document::get_class_full_name()
135	);
136	}
137
138	private function validate_circular_dependencies( Document $document, array $data ) {
139	if ( ! $document instanceof Component_Document ) {
140	return;
141	}
142
143	if ( ! isset( $data['elements'] ) ) {
144	return;
145	}
146
147	$component_id = $document->get_main_id();
148	$elements = $data['elements'];
149
150	$result = Circular_Dependency_Validator::make()->validate( $component_id, $elements );
151
152	if ( ! $result['success'] ) {
153	throw new \Exception( esc_html__( "Can't add this component - components that contain each other can't be nested.", 'elementor' ) );
154	}
155	}
156
157	private function set_component_overridable_props( Document $document, array $data ) {
158	if ( ! isset( $data['settings'] ) ) {
159	return;
160	}
161	if ( ( ! $document instanceof Component_Document ) \|\|
162	( ! isset( $data['settings']['overridable_props'] ) )
163	) {
164	return;
165	}
166
167	if ( ! Components_Access_Controller::can_edit() ) {
168	throw new \Exception( esc_html__( 'You do not have permission to edit component source.', 'elementor' ) );
169	}
170
171	/* @var Component_Document $document */
172	$result = $document->update_overridable_props( $data['settings']['overridable_props'] );
173
174	if ( ! $result->is_valid() ) {
175	throw new \Exception( esc_html( 'Settings validation failed for component overridable props: ' . $result->errors()->to_string() ) );
176	}
177	}
178
179	private function set_component_variants( Document $document, array $data ) {
180	if ( ! isset( $data['settings'] ) ) {
181	return;
182	}
183	if ( ( ! $document instanceof Component_Document ) \|\|
184	( ! isset( $data['settings']['variants'] ) )
185	) {
186	return;
187	}
188
189	if ( ! Components_Access_Controller::can_edit() ) {
190	throw new \Exception( esc_html__( 'You do not have permission to edit component source.', 'elementor' ) );
191	}
192
193	/* @var Component_Document $document */
194	$result = $document->update_variants( $data['settings']['variants'] );
195
196	if ( ! $result->is_valid() ) {
197	throw new \Exception( esc_html( 'Settings validation failed for component variants: ' . $result->errors()->to_string() ) );
198	}
199	}
200
201	private function add_variant_class_ids( array $ids, $post_id ): array {
202	$document = Plugin::$instance->documents->get( (int) $post_id );
203
204	if ( ! $document instanceof Component_Document ) {
205	return $ids;
206	}
207
208	return array_merge( $ids, Component_Variant_Class_Collector::collect( $document->get_variants() ) );
209	}
210
211	private function register_settings_transformers( Transformers_Registry $transformers ) {
212	$transformers->register( Component_Instance_Prop_Type::get_key(), new Component_Instance_Transformer() );
213	$transformers->register( Overridable_Prop_Type::get_key(), new Overridable_Transformer() );
214	$transformers->register( Override_Prop_Type::get_key(), new Override_Transformer() );
215	}
216
217	private function after_component_migrate( Document $document, array $data ) {
218	if ( ! $document instanceof Component_Document ) {
219	return;
220	}
221
222	$document->align_overridable_props_with_elements();
223	}
224
225	private function get_inner_elements_for_search( array $inner_elements, array $element_data ): array {
226	if ( ! $this->is_component_instance( $element_data ) ) {
227	return $inner_elements;
228	}
229
230	$element_instance = Plugin::$instance->elements_manager->create_element_instance( $element_data );
231
232	if ( ! $element_instance instanceof Component_Instance ) {
233	return [];
234	}
235
236	return $element_instance->get_inner_elements_data_for_search();
237	}
238
239	private function is_component_instance( array $element_data ): bool {
240	return isset( $element_data['elType'], $element_data['widgetType'] )
241	&& 'widget' === $element_data['elType']
242	&& Component_Instance::get_element_type() === $element_data['widgetType'];
243	}
244	}
245