elementor / modules / components / widgets / component-instance.php

component-instance.php in Elementor Website Builder – more than just a page builder 4.2.4, at modules/components/widgets/component-instance.php

135 lines 3.6 KB

Raw Download Zip

1	<?php
2	namespace Elementor\Modules\Components\Widgets;
3
4	use Elementor\Modules\AtomicWidgets\Elements\Base\Atomic_Widget_Base;
5	use Elementor\Modules\AtomicWidgets\Elements\Base\Has_Template;
6	use Elementor\Modules\AtomicWidgets\PropsResolver\Render_Props_Resolver;
7	use Elementor\Modules\Components\Components_Repository;
8	use Elementor\Modules\Components\PropTypes\Component_Instance_Prop_Type;
9	use Elementor\Modules\Components\PropTypes\Overridable_Prop_Type;
10	use Elementor\Modules\Components\Transformers\Overridable_Transformer;
11	use Elementor\Modules\Components\Utils\Format_Component_Elements_Id;
12
13	if ( ! defined( 'ABSPATH' ) ) {
14	exit; // Exit if accessed directly.
15	}
16
17	class Component_Instance extends Atomic_Widget_Base {
18	use Has_Template;
19
20	public static function get_element_type(): string {
21	return 'e-component';
22	}
23
24	public function show_in_panel() {
25	return false;
26	}
27
28	public function get_title() {
29	return esc_html__( 'Component', 'elementor' );
30	}
31
32	public function get_keywords() {
33	return [ 'component' ];
34	}
35
36	public function get_icon() {
37	return 'eicon-components';
38	}
39
40	protected static function define_props_schema(): array {
41	return [
42	'component_instance' => Component_Instance_Prop_Type::make()->meta( Overridable_Prop_Type::ignore() )->required(),
43	];
44	}
45
46	protected function parse_editor_settings( array $data ): array {
47	$editor_data = parent::parse_editor_settings( $data );
48
49	if ( isset( $data['component_uid'] ) && is_string( $data['component_uid'] ) ) {
50	$editor_data['component_uid'] = sanitize_text_field( $data['component_uid'] );
51	}
52
53	return $editor_data;
54	}
55
56	protected function define_atomic_controls(): array {
57	return [];
58	}
59
60	protected function get_templates(): array {
61	return [
62	'elementor/elements/component' => __DIR__ . '/component.html.twig',
63	];
64	}
65
66	protected function define_render_context(): array {
67	$resolved_overrides = $this->get_resolved_overrides();
68	$merged_overrides = $this->get_merged_overrides( $resolved_overrides );
69
70	return [
71	[
72	'context_key' => Overridable_Transformer::class,
73	'context' => [ 'overrides' => $merged_overrides ],
74	],
75	[
76	'context' => [ 'instance_id' => $this->get_id() ],
77	],
78	];
79	}
80
81	private function get_resolved_overrides(): array {
82	$props = $this->get_settings();
83	$overrides = $props['component_instance']['value']['overrides'] ?? null;
84
85	if ( ! $overrides ) {
86	return [];
87	}
88
89	$component_schema = $this->get_props_schema();
90	$overrides_schema = $component_schema['component_instance']->get_shape_field( 'overrides' );
91
92	return Render_Props_Resolver::for_settings()->resolve( [ 'overrides' => $overrides_schema ], [ 'overrides' => $overrides ] );
93	}
94
95	private function get_merged_overrides( $value ): array {
96	$overrides_array = $value['overrides'] ?? [];
97	$overrides = [];
98
99	foreach ( $overrides_array as $override ) {
100	$overrides[ $override['override_key'] ] = $override['override_value'];
101	}
102
103	return $overrides;
104	}
105
106	public function get_inner_elements_data_for_search(): array {
107	$component_id = $this->get_component_id();
108
109	if ( null === $component_id ) {
110	return [];
111	}
112
113	$repository = new Components_Repository();
114	$component = $repository->get( $component_id );
115
116	if ( ! $component ) {
117	return [];
118	}
119
120	$elements_data = $component->get_elements_data();
121
122	return Format_Component_Elements_Id::format( $elements_data, [ $this->get_id() ] );
123	}
124
125	private function get_component_id(): ?int {
126	$settings = $this->get_settings();
127
128	if ( ! isset( $settings['component_instance']['value']['component_id']['value'] ) ) {
129	return null;
130	}
131
132	return (int) $settings['component_instance']['value']['component_id']['value'];
133	}
134	}
135