367 lines
9.4 KiB
PHP
367 lines
9.4 KiB
PHP
<?php
|
|
/**
|
|
* 2007-2022 Apollotheme
|
|
*
|
|
* NOTICE OF LICENSE
|
|
*
|
|
* LeoElements is module help you can build content for your shop
|
|
*
|
|
* DISCLAIMER
|
|
*
|
|
* @author Apollotheme <apollotheme@gmail.com>
|
|
* @copyright 2007-2022 Apollotheme
|
|
* @license http://apollotheme.com - prestashop template provider
|
|
*/
|
|
|
|
namespace LeoElements;
|
|
|
|
use LeoElements\Leo_Helper;
|
|
|
|
if ( ! defined( '_PS_VERSION_' ) ) {
|
|
exit; // Exit if accessed directly.
|
|
}
|
|
|
|
/**
|
|
* Elementor image size control.
|
|
*
|
|
* A base control for creating image size control. Displays input fields to define
|
|
* one of the default image sizes (thumbnail, medium, medium_large, large) or custom
|
|
* image dimensions.
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
class Group_Control_Image_Size extends Group_Control_Base {
|
|
|
|
/**
|
|
* Fields.
|
|
*
|
|
* Holds all the image size control fields.
|
|
*
|
|
* @since 1.2.2
|
|
* @access protected
|
|
* @static
|
|
*
|
|
* @var array Image size control fields.
|
|
*/
|
|
protected static $fields;
|
|
|
|
/**
|
|
* Get image size control type.
|
|
*
|
|
* Retrieve the control type, in this case `image-size`.
|
|
*
|
|
* @since 1.0.0
|
|
* @access public
|
|
* @static
|
|
*
|
|
* @return string Control type.
|
|
*/
|
|
public static function get_type() {
|
|
return 'image-size';
|
|
}
|
|
|
|
/**
|
|
* Get attachment image HTML.
|
|
*
|
|
* Retrieve the attachment image HTML code.
|
|
*
|
|
* Note that some widgets use the same key for the media control that allows
|
|
* the image selection and for the image size control that allows the user
|
|
* to select the image size, in this case the third parameter should be null
|
|
* or the same as the second parameter. But when the widget uses different
|
|
* keys for the media control and the image size control, when calling this
|
|
* method you should pass the keys.
|
|
*
|
|
* @since 1.0.0
|
|
* @access public
|
|
* @static
|
|
*
|
|
* @param array $settings Control settings.
|
|
* @param string $image_size_key Optional. Settings key for image size.
|
|
* Default is `image`.
|
|
* @param string $image_key Optional. Settings key for image. Default
|
|
* is null. If not defined uses image size key
|
|
* as the image key.
|
|
*
|
|
* @return string Image HTML.
|
|
*/
|
|
public static function get_attachment_image_html( $settings, $image_size_key = 'image', $image_key = null ) {
|
|
if ( ! $image_key ) {
|
|
$image_key = $image_size_key;
|
|
}
|
|
|
|
$image = $settings[ $image_key ];
|
|
|
|
// Old version of image settings.
|
|
if ( ! isset( $settings[ $image_size_key . '_size' ] ) ) {
|
|
$settings[ $image_size_key . '_size' ] = '';
|
|
}
|
|
|
|
$size = $settings[ $image_size_key . '_size' ];
|
|
|
|
$image_class = ! empty( $settings['hover_animation'] ) ? 'elementor-animation-' . $settings['hover_animation'] : '';
|
|
|
|
$html = '';
|
|
|
|
$image_src = $image['url'];
|
|
|
|
$alt = '';
|
|
|
|
$title = '';
|
|
|
|
if( isset( $image['alt'] ) && $image['alt'] ){
|
|
$alt = $image['alt'];
|
|
}
|
|
|
|
if( isset( $image['title'] ) && $image['title'] ){
|
|
$title = $image['title'];
|
|
}
|
|
|
|
if ( ! empty( $image_src ) ) {
|
|
$image_class_html = ! empty( $image_class ) ? ' class="' . $image_class . '"' : '';
|
|
|
|
$html .= sprintf( '<img src="%s" title="%s" alt="%s"%s />', Leo_Helper::esc_attr( $image_src ), $title, $alt, $image_class_html );
|
|
}
|
|
|
|
/**
|
|
* Get Attachment Image HTML
|
|
*
|
|
* Filters the Attachment Image HTML
|
|
*
|
|
* @since 1.0.0
|
|
* @param string $html the attachment image HTML string
|
|
* @param array $settings Control settings.
|
|
* @param string $image_size_key Optional. Settings key for image size.
|
|
* Default is `image`.
|
|
* @param string $image_key Optional. Settings key for image. Default
|
|
* is null. If not defined uses image size key
|
|
* as the image key.
|
|
*/
|
|
return Leo_Helper::apply_filters( 'elementor/image_size/get_attachment_image_html', $html, $settings, $image_size_key, $image_key );
|
|
}
|
|
|
|
/**
|
|
* Get all image sizes.
|
|
*
|
|
* Retrieve available image sizes with data like `width`, `height` and `crop`.
|
|
*
|
|
* @since 1.0.0
|
|
* @access public
|
|
* @static
|
|
*
|
|
* @return array An array of available image sizes.
|
|
*/
|
|
public static function get_all_image_sizes() {
|
|
$_wp_additional_image_sizes = &$GLOBALS['_wp_additional_image_sizes'];
|
|
|
|
$default_image_sizes = [ 'thumbnail', 'medium', 'medium_large', 'large' ];
|
|
|
|
$image_sizes = [];
|
|
|
|
foreach ( $default_image_sizes as $size ) {
|
|
$image_sizes[ $size ] = [
|
|
'width' => (int) Leo_Helper::get_option( $size . '_size_w' ),
|
|
'height' => (int) Leo_Helper::get_option( $size . '_size_h' ),
|
|
'crop' => (bool) Leo_Helper::get_option( $size . '_crop' ),
|
|
];
|
|
}
|
|
|
|
if ( $_wp_additional_image_sizes ) {
|
|
$image_sizes = array_merge( $image_sizes, $_wp_additional_image_sizes );
|
|
}
|
|
|
|
/** This filter is documented in wp-admin/includes/media.php */
|
|
return Leo_Helper::apply_filters( 'image_size_names_choose', $image_sizes );
|
|
}
|
|
|
|
/**
|
|
* Get attachment image src.
|
|
*
|
|
* Retrieve the attachment image source URL.
|
|
*
|
|
* @since 1.0.0
|
|
* @access public
|
|
* @static
|
|
*
|
|
* @param string $attachment_id The attachment ID.
|
|
* @param string $image_size_key Settings key for image size.
|
|
* @param array $settings Control settings.
|
|
*
|
|
* @return string Attachment image source URL.
|
|
*/
|
|
public static function get_attachment_image_src( $attachment_id, $image_size_key, array $settings ) {
|
|
return false;
|
|
|
|
if ( empty( $attachment_id ) ) {
|
|
return false;
|
|
}
|
|
|
|
$size = $settings[ $image_size_key . '_size' ];
|
|
|
|
if ( 'custom' !== $size ) {
|
|
$attachment_size = $size;
|
|
} else {
|
|
// Use BFI_Thumb script
|
|
// TODO: Please rewrite this code.
|
|
require_once( LEOELEMENTS_PATH . 'includes/libraries/bfi-thumb/bfi-thumb.php' );
|
|
|
|
$custom_dimension = $settings[ $image_size_key . '_custom_dimension' ];
|
|
|
|
$attachment_size = [
|
|
// Defaults sizes
|
|
0 => null, // Width.
|
|
1 => null, // Height.
|
|
|
|
'bfi_thumb' => true,
|
|
'crop' => true,
|
|
];
|
|
|
|
$has_custom_size = false;
|
|
if ( ! empty( $custom_dimension['width'] ) ) {
|
|
$has_custom_size = true;
|
|
$attachment_size[0] = $custom_dimension['width'];
|
|
}
|
|
|
|
if ( ! empty( $custom_dimension['height'] ) ) {
|
|
$has_custom_size = true;
|
|
$attachment_size[1] = $custom_dimension['height'];
|
|
}
|
|
|
|
if ( ! $has_custom_size ) {
|
|
$attachment_size = 'full';
|
|
}
|
|
}
|
|
|
|
$image_src = wp_get_attachment_image_src( $attachment_id, $attachment_size );
|
|
|
|
if ( empty( $image_src[0] ) && 'thumbnail' !== $attachment_size ) {
|
|
$image_src = wp_get_attachment_image_src( $attachment_id );
|
|
}
|
|
|
|
return ! empty( $image_src[0] ) ? $image_src[0] : '';
|
|
}
|
|
|
|
/**
|
|
* Get child default arguments.
|
|
*
|
|
* Retrieve the default arguments for all the child controls for a specific group
|
|
* control.
|
|
*
|
|
* @since 1.2.2
|
|
* @access protected
|
|
*
|
|
* @return array Default arguments for all the child controls.
|
|
*/
|
|
protected function get_child_default_args() {
|
|
return [
|
|
'include' => [],
|
|
'exclude' => [],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Init fields.
|
|
*
|
|
* Initialize image size control fields.
|
|
*
|
|
* @since 1.2.2
|
|
* @access protected
|
|
*
|
|
* @return array Control fields.
|
|
*/
|
|
protected function init_fields() {
|
|
$fields = [];
|
|
|
|
$fields['size'] = [
|
|
'label' => Leo_Helper::_x( 'Image Size', 'Image Size Control', 'elementor' ),
|
|
'type' => Controls_Manager::SELECT,
|
|
'label_block' => false,
|
|
];
|
|
|
|
$fields['custom_dimension'] = [
|
|
'label' => Leo_Helper::_x( 'Image Dimension', 'Image Size Control', 'elementor' ),
|
|
'type' => Controls_Manager::IMAGE_DIMENSIONS,
|
|
'description' => Leo_Helper::__( 'You can crop the original image size to any custom size. You can also set a single value for height or width in order to keep the original size ratio.', 'elementor' ),
|
|
'condition' => [
|
|
'size' => 'custom',
|
|
],
|
|
'separator' => 'none',
|
|
];
|
|
|
|
return $fields;
|
|
}
|
|
|
|
/**
|
|
* Prepare fields.
|
|
*
|
|
* Process image size control fields before adding them to `add_control()`.
|
|
*
|
|
* @since 1.2.2
|
|
* @access protected
|
|
*
|
|
* @param array $fields Image size control fields.
|
|
*
|
|
* @return array Processed fields.
|
|
*/
|
|
protected function prepare_fields( $fields ) {
|
|
$image_sizes = $this->get_image_sizes();
|
|
|
|
$args = $this->get_args();
|
|
|
|
if ( ! empty( $args['default'] ) && isset( $image_sizes[ $args['default'] ] ) ) {
|
|
$default_value = $args['default'];
|
|
} else {
|
|
// Get the first item for default value.
|
|
$default_value = array_keys( $image_sizes );
|
|
$default_value = array_shift( $default_value );
|
|
}
|
|
|
|
$fields['size']['options'] = $image_sizes;
|
|
|
|
$fields['size']['default'] = $default_value;
|
|
|
|
if ( ! isset( $image_sizes['custom'] ) ) {
|
|
unset( $fields['custom_dimension'] );
|
|
}
|
|
|
|
return parent::prepare_fields( $fields );
|
|
}
|
|
|
|
/**
|
|
* Get image sizes.
|
|
*
|
|
* Retrieve available image sizes after filtering `include` and `exclude` arguments.
|
|
*
|
|
* @since 2.0.0
|
|
* @access private
|
|
*
|
|
* @return array Filtered image sizes.
|
|
*/
|
|
private function get_image_sizes() {
|
|
$image_sizes = [];
|
|
|
|
$image_sizes['full'] = Leo_Helper::_x( 'Full', 'Image Size Control', 'elementor' );
|
|
|
|
$image_sizes['custom'] = Leo_Helper::_x( 'Custom', 'Image Size Control', 'elementor' );
|
|
|
|
return $image_sizes;
|
|
}
|
|
|
|
/**
|
|
* Get default options.
|
|
*
|
|
* Retrieve the default options of the image size control. Used to return the
|
|
* default options while initializing the image size control.
|
|
*
|
|
* @since 1.9.0
|
|
* @access protected
|
|
*
|
|
* @return array Default image size control options.
|
|
*/
|
|
protected function get_default_options() {
|
|
return [
|
|
'popover' => false,
|
|
];
|
|
}
|
|
}
|