elementor / modules / components / module.php

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

133 lines 5.0 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\PropsResolver\Transformers_Registry;
7	use Elementor\Modules\Components\Styles\Component_Styles;
8	use Elementor\Modules\Components\Documents\Component as Component_Document;
9	use Elementor\Modules\Components\Component_Lock_Manager;
10	use Elementor\Modules\Components\PropTypes\Component_Instance_Prop_Type;
11	use Elementor\Modules\Components\Transformers\Component_Instance_Transformer;
12	use Elementor\Modules\Components\PropTypes\Overridable_Prop_Type;
13	use Elementor\Modules\Components\Transformers\Overridable_Transformer;
14	use Elementor\Core\Base\Document;
15	use Elementor\Modules\Components\PropTypes\Override_Prop_Type;
16	use Elementor\Modules\Components\Transformers\Override_Transformer;
17
18	if ( ! defined( 'ABSPATH' ) ) {
19	exit; // Exit if accessed directly.
20	}
21
22	class Module extends BaseModule {
23	const EXPERIMENT_NAME = 'e_components';
24	const PACKAGES = [ 'editor-components' ];
25
26	public function get_name() {
27	return 'components';
28	}
29
30	public function __construct() {
31	parent::__construct();
32
33	$this->register_component_post_type();
34
35	add_filter( 'elementor/editor/v2/packages', fn ( $packages ) => $this->add_packages( $packages ) );
36	add_filter( 'elementor/atomic-widgets/props-schema', fn ( $schema ) => $this->modify_props_schema( $schema ) );
37	add_action( 'elementor/documents/register', fn ( $documents_manager ) => $this->register_document_type( $documents_manager ) );
38	add_action( 'elementor/document/before_save', fn( Document $document, array $data ) => $this->validate_circular_dependencies( $document, $data ), 10, 2 );
39	add_action( 'elementor/document/after_save', fn( Document $document, array $data ) => $this->set_component_overridable_props( $document, $data ), 10, 2 );
40	add_filter( 'elementor/global_classes/additional_post_types', fn( $post_types ) => array_merge( $post_types, [ Component_Document::TYPE ] ) );
41
42	add_action( 'elementor/atomic-widgets/settings/transformers/register', fn ( $transformers ) => $this->register_settings_transformers( $transformers ) );
43
44	( Component_Lock_Manager::get_instance()->register_hooks() );
45	( new Component_Styles() )->register_hooks();
46	( new Components_REST_API() )->register_hooks();
47	}
48
49	public static function get_experimental_data() {
50	return [
51	'name' => self::EXPERIMENT_NAME,
52	'title' => esc_html__( 'Components', 'elementor' ),
53	'description' => esc_html__( 'Enable components.', 'elementor' ),
54	'hidden' => true,
55	'default' => Experiments_Manager::STATE_ACTIVE,
56	'release_status' => Experiments_Manager::RELEASE_STATUS_BETA,
57	];
58	}
59
60	public function get_widgets() {
61	return [
62	'Component_Instance',
63	];
64	}
65
66	private function add_packages( $packages ) {
67	return array_merge( $packages, self::PACKAGES );
68	}
69
70	private function modify_props_schema( array $schema ) {
71	return Overridable_Schema_Extender::make()->get_extended_schema( $schema );
72	}
73
74	private function register_component_post_type() {
75	register_post_type( Component_Document::TYPE, [
76	'label' => Component_Document::get_title(),
77	'labels' => Component_Document::get_labels(),
78	'public' => false,
79	'supports' => Component_Document::get_supported_features(),
80	] );
81	}
82
83	private function register_document_type( $documents_manager ) {
84	$documents_manager->register_document_type(
85	Component_Document::TYPE,
86	Component_Document::get_class_full_name()
87	);
88	}
89
90	private function validate_circular_dependencies( Document $document, array $data ) {
91	if ( ! $document instanceof Component_Document ) {
92	return;
93	}
94
95	if ( ! isset( $data['elements'] ) ) {
96	return;
97	}
98
99	$component_id = $document->get_main_id();
100	$elements = $data['elements'];
101
102	$result = Circular_Dependency_Validator::make()->validate( $component_id, $elements );
103
104	if ( ! $result['success'] ) {
105	throw new \Exception( esc_html__( "Can't add this component - components that contain each other can't be nested.", 'elementor' ) );
106	}
107	}
108
109	private function set_component_overridable_props( Document $document, array $data ) {
110	if ( ! isset( $data['settings'] ) ) {
111	return;
112	}
113	if ( ( ! $document instanceof Component_Document ) \|\|
114	( ! isset( $data['settings']['overridable_props'] ) )
115	) {
116	return;
117	}
118
119	/* @var Component_Document $document */
120	$result = $document->update_overridable_props( $data['settings']['overridable_props'] );
121
122	if ( ! $result->is_valid() ) {
123	throw new \Exception( esc_html( 'Settings validation failed for component overridable props: ' . $result->errors()->to_string() ) );
124	}
125	}
126
127	private function register_settings_transformers( Transformers_Registry $transformers ) {
128	$transformers->register( Component_Instance_Prop_Type::get_key(), new Component_Instance_Transformer() );
129	$transformers->register( Overridable_Prop_Type::get_key(), new Overridable_Transformer() );
130	$transformers->register( Override_Prop_Type::get_key(), new Override_Transformer() );
131	}
132	}
133