elementor / includes / controls / gallery.php

gallery.php in Elementor Website Builder – more than just a page builder 4.0.9, at includes/controls/gallery.php

238 lines 7.3 KB

Raw Download Zip

1	<?php
2	namespace Elementor;
3
4	use Elementor\Core\Utils\Hints;
5	use Elementor\Modules\DynamicTags\Module as TagsModule;
6
7	if ( ! defined( 'ABSPATH' ) ) {
8	exit; // Exit if accessed directly.
9	}
10
11	/**
12	* Elementor gallery control.
13	*
14	* A base control for creating gallery chooser control. Based on the WordPress
15	* media library galleries. Used to select images from the WordPress media library.
16	*
17	* @since 1.0.0
18	*/
19	class Control_Gallery extends Base_Data_Control {
20
21	/**
22	* Get gallery control type.
23	*
24	* Retrieve the control type, in this case `gallery`.
25	*
26	* @since 1.0.0
27	* @access public
28	*
29	* @return string Control type.
30	*/
31	public function get_type() {
32	return 'gallery';
33	}
34
35	public function on_export( $settings ) {
36	foreach ( $settings as $attachment ) {
37	if ( ! empty( $attachment['url'] ) ) {
38	do_action( 'elementor/templates/collect_media_url', $attachment['url'], $attachment );
39	}
40	}
41
42	return $settings;
43	}
44
45	/**
46	* Import gallery images.
47	*
48	* Used to import gallery control files from external sites while importing
49	* Elementor template JSON file, and replacing the old data.
50	*
51	* @since 1.0.0
52	* @access public
53	*
54	* @param array $settings Control settings.
55	*
56	* @return array Control settings.
57	*/
58	public function on_import( $settings ) {
59	foreach ( $settings as &$attachment ) {
60	if ( empty( $attachment['url'] ) ) {
61	continue;
62	}
63
64	$local_file_path = \Elementor\TemplateLibrary\Classes\Media_Mapper::get_local_file_path( $attachment['url'] );
65	$imported_attachment = false;
66
67	if ( $local_file_path !== $attachment['url'] && file_exists( $local_file_path ) ) {
68	$imported_attachment = Plugin::$instance->templates_manager->get_import_images_instance()->import_local_file( $local_file_path );
69	}
70
71	if ( ! $imported_attachment ) {
72	$imported_attachment = Plugin::$instance->templates_manager->get_import_images_instance()->import( $attachment );
73	}
74
75	$attachment = $imported_attachment;
76	}
77
78	// Filter out attachments that don't exist
79	$settings = array_filter( $settings );
80
81	return $settings;
82	}
83
84	/**
85	* Render gallery control output in the editor.
86	*
87	* Used to generate the control HTML in the editor using Underscore JS
88	* template. The variables for the class are available using `data` JS
89	* object.
90	*
91	* @since 1.0.0
92	* @access public
93	*/
94	public function content_template() {
95	?>
96	<div class="elementor-control-field">
97	<div class="elementor-control-title">{{{ data.label }}}</div>
98	<div class="elementor-control-input-wrapper">
99	<# if ( data.description ) { #>
100	<div class="elementor-control-field-description">{{{ data.description }}}</div>
101	<# } #>
102	<div class="elementor-control-media__content elementor-control-tag-area">
103	<div class="elementor-control-gallery-status elementor-control-dynamic-switcher-wrapper">
104	<span class="elementor-control-gallery-status-title"></span>
105	<button class="elementor-control-gallery-clear elementor-control-unit-1 tooltip-target" data-tooltip="<?php echo esc_attr__( 'Clear gallery', 'elementor' ); ?>" aria-label="<?php echo esc_attr__( 'Clear gallery', 'elementor' ); ?>">
106	<i class="eicon-trash-o" aria-hidden="true"></i>
107	</button>
108	</div>
109	<div class="elementor-control-gallery-content">
110	<div class="elementor-control-gallery-thumbnails" tabindex="0"></div>
111	<div class="elementor-control-gallery-edit">
112	<span><i class="eicon-pencil" aria-hidden="true"></i></span>
113	<span class="elementor-screen-only"><?php echo esc_html__( 'Edit gallery', 'elementor' ); ?></span>
114	</div>
115	<button class="elementor-button elementor-control-gallery-add tooltip-target" data-tooltip="<?php echo esc_attr__( 'Add Images', 'elementor' ); ?>" aria-label="<?php echo esc_attr__( 'Add Images', 'elementor' ); ?>">
116	<i class="eicon-plus-circle" aria-hidden="true"></i>
117	</button>
118	</div>
119	</div>
120
121	<?php
122	/*
123	?>
124	<div class="elementor-control-media__warnings" role="alert" style="display: none;">
125	<?php
126	Hints::get_notice_template( [
127	'type' => 'warning',
128	'content' => esc_html__( 'This image doesn’t contain ALT text - which is necessary for accessibility and SEO.', 'elementor' ),
129	'icon' => true,
130	] );
131	?>
132	</div>
133	<?php
134	*/ ?>
135	<?php $this->maybe_display_io_hints(); ?>
136	</div>
137	</div>
138	<?php
139	}
140
141	private function maybe_display_io_hints() {
142	$plugin_slug = 'image-optimization';
143
144	if ( ! Hints::should_display_hint( $plugin_slug ) ) {
145	return;
146	}
147
148	$one_subscription = Hints::is_plugin_connected_to_one_subscription();
149	$is_installed = Hints::is_plugin_installed( 'image-optimization' );
150	$is_active = Hints::is_plugin_active( 'image-optimization' );
151
152	if ( $is_active ) {
153	return;
154	}
155
156	if ( $one_subscription ) {
157	if ( ! $is_installed ) {
158	$content = esc_html__( 'Optimize your images to improve site speed and performance. Image Optimizer is included in your ONE subscription.', 'elementor' );
159	$button_text = esc_html__( 'Install now', 'elementor' );
160	$button_url = Hints::get_plugin_install_url( $plugin_slug );
161	$source = 'io-editor-gallery-one-install';
162	} elseif ( ! $is_active ) {
163	$content = esc_html__( 'Image Optimizer is installed and included in your ONE subscription. Activate it to optimize images and improve site performance.', 'elementor' );
164	$button_text = esc_html__( 'Activate now', 'elementor' );
165	$button_url = Hints::get_plugin_activate_url( $plugin_slug );
166	$source = 'io-editor-gallery-one-activate';
167	}
168	} else {
169	$content = esc_html__( 'Optimize your images to enhance site performance by using Image Optimizer.', 'elementor' );
170	if ( ! $is_installed ) {
171	$button_text = esc_html__( 'Install now', 'elementor' );
172	$button_url = Hints::get_plugin_install_url( $plugin_slug );
173	$source = 'io-editor-gallery-install';
174	} elseif ( ! $is_active ) {
175	$button_text = esc_html__( 'Activate now', 'elementor' );
176	$button_url = Hints::get_plugin_activate_url( $plugin_slug );
177	$source = 'io-editor-gallery-activate';
178	}
179	}
180	?>
181	<div class="elementor-control-media__promotions" role="alert">
182	<?php
183	Hints::get_notice_template( [
184	'display' => ! Hints::is_dismissed( $plugin_slug ),
185	'type' => 'info',
186	'icon' => true,
187	'heading' => '',
188	'content' => $content,
189	'dismissible' => 'image_optimizer_hint',
190	'button_text' => $button_text,
191	'button_event' => 'image_optimizer_hint',
192	'button_data' => [
193	'action_url' => $button_url,
194	'source' => $source,
195	],
196	] );
197	?>
198	</div>
199	<?php
200	}
201
202	/**
203	* Get gallery control default settings.
204	*
205	* Retrieve the default settings of the gallery control. Used to return the
206	* default settings while initializing the gallery control.
207	*
208	* @since 1.0.0
209	* @access protected
210	*
211	* @return array Control default settings.
212	*/
213	protected function get_default_settings() {
214	return [
215	'label_block' => true,
216	'dynamic' => [
217	'categories' => [ TagsModule::GALLERY_CATEGORY ],
218	'returnType' => 'object',
219	],
220	];
221	}
222
223	/**
224	* Get gallery control default values.
225	*
226	* Retrieve the default value of the gallery control. Used to return the default
227	* values while initializing the gallery control.
228	*
229	* @since 1.0.0
230	* @access public
231	*
232	* @return array Control default value.
233	*/
234	public function get_default_value() {
235	return [];
236	}
237	}
238