22

✏️ Editing: class-jet-cw-tools.php

<?php
/**
 * Compare & Wishlist Tools class
 */

// If this file is called directly, abort.
if ( ! defined( 'WPINC' ) ) {
	die;
}

if ( ! class_exists( 'Jet_CW_Tools' ) ) {

/**
	 * Define Jet_CW_Tools class
	 */
	class Jet_CW_Tools {

/**
		 * A reference to an instance of this class.
		 *
		 * @since 1.0.0
		 * @var   object
		 */
		private static $instance = null;

/**
		 * Returns columns classes string
		 *
		 * @param array $columns
		 *
		 * @return string
		 */
		public function col_classes( $columns = array() ) {

$columns = wp_parse_args( $columns, array(
				'desk' => 1,
				'tab'  => 1,
				'mob'  => 1,
			) );

$classes = array();

foreach ( $columns as $device => $cols ) {
				if ( ! empty( $cols ) ) {
					$classes[] = sprintf( 'cw-col-%1$s-%2$s', $device, $cols );
				}
			}

return implode( ' ', $classes );

}

/**
		 * Returns disable columns gap nad rows gap classes string
		 *
		 * @param string $use_cols_gap
		 * @param string $use_rows_gap
		 *
		 * @return string
		 */
		public function gap_classes( $use_cols_gap = 'yes', $use_rows_gap = 'yes' ) {

$result = array();

foreach ( array( 'cols' => $use_cols_gap, 'rows' => $use_rows_gap ) as $element => $value ) {
				if ( 'yes' !== $value ) {
					$result[] = sprintf( 'disable-%s-gap', $element );
				}
			}

return implode( ' ', $result );

}

/**
		 * Returns image size array in slug => name format
		 *
		 * @return  array
		 */
		public function get_image_sizes() {

global $_wp_additional_image_sizes;

$sizes  = get_intermediate_image_sizes();
			$result = array();

foreach ( $sizes as $size ) {
				if ( in_array( $size, array( 'thumbnail', 'medium', 'medium_large', 'large' ) ) ) {
					$result[ $size ] = ucwords( trim( str_replace( array( '-', '_' ), array( ' ', ' ' ), $size ) ) );
				} else {
					$result[ $size ] = sprintf(
						'%1$s (%2$sx%3$s)',
						ucwords( trim( str_replace( array( '-', '_' ), array( ' ', ' ' ), $size ) ) ),
						$_wp_additional_image_sizes[ $size ]['width'],
						$_wp_additional_image_sizes[ $size ]['height']
					);
				}
			}

return array_merge( array( 'full' => esc_html__( 'Full', 'jet-cw' ), ), $result );

}

/**
		 * Get categories list.
		 *
		 * @return array
		 */
		public function get_categories() {

$categories = get_categories();

if ( empty( $categories ) || ! is_array( $categories ) ) {
				return array();
			}

return wp_list_pluck( $categories, 'name', 'term_id' );

}

/**
		 * Return available rating icon list
		 *
		 * @return mixed|void
		 */
		public function get_available_rating_icons_list() {
			return apply_filters(
				'jet-cw/tools/rating/available-icons',
				array(
					'jetcomparewishlist-icon-rating-1'  => __( 'Rating 1', 'jet-cw' ),
					'jetcomparewishlist-icon-rating-2'  => __( 'Rating 2', 'jet-cw' ),
					'jetcomparewishlist-icon-rating-3'  => __( 'Rating 3', 'jet-cw' ),
					'jetcomparewishlist-icon-rating-4'  => __( 'Rating 4', 'jet-cw' ),
					'jetcomparewishlist-icon-rating-5'  => __( 'Rating 5', 'jet-cw' ),
					'jetcomparewishlist-icon-rating-6'  => __( 'Rating 6', 'jet-cw' ),
					'jetcomparewishlist-icon-rating-7'  => __( 'Rating 7', 'jet-cw' ),
					'jetcomparewishlist-icon-rating-8'  => __( 'Rating 8', 'jet-cw' ),
					'jetcomparewishlist-icon-rating-9'  => __( 'Rating 9', 'jet-cw' ),
					'jetcomparewishlist-icon-rating-10' => __( 'Rating 10', 'jet-cw' ),
					'jetcomparewishlist-icon-rating-11' => __( 'Rating 11', 'jet-cw' ),
					'jetcomparewishlist-icon-rating-12' => __( 'Rating 12', 'jet-cw' ),
					'jetcomparewishlist-icon-rating-13' => __( 'Rating 13', 'jet-cw' ),
					'jetcomparewishlist-icon-rating-14' => __( 'Rating 14', 'jet-cw' ),
				)
			);
		}

/**
		 * Products attributes list.
		 *
		 * Returns a list of all available products attributes list.
		 *
		 * @since  1.4.7
		 * @access public
		 *
		 * @return array
		 */
		public function get_products_attributes_list() {

$attributes = wc_get_attribute_taxonomies();

if ( empty( $attributes ) || ! is_array( $attributes ) ) {
				return array();
			}

return wp_list_pluck( $attributes, 'attribute_label', 'attribute_name' );

}

/**
		 * Compare table data list.
		 *
		 * Returns the list of available data output in Compare Table widget.
		 *
		 * @since  1.0.0
		 * @since  1.5.2 Added new data `Add to Wishlist` and hook `jet-cw/tools/compare-table/data-list`.
		 *         Replace `esc_html__()` with `__()`.
		 * @access public
		 *
		 * @return array
		 */
		public function compare_table_data_list() {

$data_list = [
				'compare_remove_button' => __( 'Remove Button', 'jet-cw' ),
				'title'                 => __( 'Title', 'jet-cw' ),
				'thumbnail'             => __( 'Thumbnail', 'jet-cw' ),
				'price'                 => __( 'Price', 'jet-cw' ),
				'rating'                => __( 'Rating', 'jet-cw' ),
				'add_to_cart_button'    => __( 'Add To Cart', 'jet-cw' ),
				'description'           => __( 'Description', 'jet-cw' ),
				'excerpt'               => __( 'Short Description', 'jet-cw' ),
				'sku'                   => __( 'SKU', 'jet-cw' ),
				'stock_status'          => __( 'Stock Status', 'jet-cw' ),
				'weight'                => __( 'Weight', 'jet-cw' ),
				'dimensions'            => __( 'Dimensions', 'jet-cw' ),
				'attributes'            => __( 'Attributes', 'jet-cw' ),
				'categories'            => __( 'Categories', 'jet-cw' ),
				'tags'                  => __( 'Tags', 'jet-cw' ),
				'custom_field'          => __( 'Custom Field', 'jet-cw' ),
			];

if ( filter_var( jet_cw()->wishlist_enabled, FILTER_VALIDATE_BOOLEAN ) ) {
				$data_list['wishlist_button'] = __( 'Add to Wishlist', 'jet-cw' );
			}

return apply_filters( 'jet-cw/tools/compare-table/data-list', $data_list );

}

/**
		 * Returns allowed order by fields for options
		 *
		 * @return array
		 */
		public function orderby_arr() {
			return array(
				'none'          => esc_html__( 'None', 'jet-cw' ),
				'ID'            => esc_html__( 'ID', 'jet-cw' ),
				'author'        => esc_html__( 'Author', 'jet-cw' ),
				'title'         => esc_html__( 'Title', 'jet-cw' ),
				'name'          => esc_html__( 'Name (slug)', 'jet-cw' ),
				'date'          => esc_html__( 'Date', 'jet-cw' ),
				'modified'      => esc_html__( 'Modified', 'jet-cw' ),
				'rand'          => esc_html__( 'Rand', 'jet-cw' ),
				'comment_count' => esc_html__( 'Comment Count', 'jet-cw' ),
				'menu_order'    => esc_html__( 'Menu Order', 'jet-cw' ),
			);
		}

/**
		 * Returns allowed order fields for options
		 *
		 * @return array
		 */
		public function order_arr() {
			return array(
				'desc' => esc_html__( 'Descending', 'jet-cw' ),
				'asc'  => esc_html__( 'Ascending', 'jet-cw' ),
			);
		}

/**
		 * Returns allowed order by fields for options
		 *
		 * @return array
		 */
		public function verrtical_align_attr() {
			return array(
				'baseline'    => esc_html__( 'Baseline', 'jet-cw' ),
				'top'         => esc_html__( 'Top', 'jet-cw' ),
				'middle'      => esc_html__( 'Middle', 'jet-cw' ),
				'bottom'      => esc_html__( 'Bottom', 'jet-cw' ),
				'sub'         => esc_html__( 'Sub', 'jet-cw' ),
				'super'       => esc_html__( 'Super', 'jet-cw' ),
				'text-top'    => esc_html__( 'Text Top', 'jet-cw' ),
				'text-bottom' => esc_html__( 'Text Bottom', 'jet-cw' ),
			);
		}

/**
		 * Return available HTML title tags list
		 *
		 * @return array
		 */
		public function get_available_title_html_tags() {
			return array(
				'h1'   => esc_html__( 'H1', 'jet-cw' ),
				'h2'   => esc_html__( 'H2', 'jet-cw' ),
				'h3'   => esc_html__( 'H3', 'jet-cw' ),
				'h4'   => esc_html__( 'H4', 'jet-cw' ),
				'h5'   => esc_html__( 'H5', 'jet-cw' ),
				'h6'   => esc_html__( 'H6', 'jet-cw' ),
				'div'  => esc_html__( 'div', 'jet-cw' ),
				'span' => esc_html__( 'span', 'jet-cw' ),
				'p'    => esc_html__( 'p', 'jet-cw' ),
			);
		}

/**
		 * Horizontal flex align list.
		 *
		 * Return available horizontal flex alignment list.
		 *
		 * @since  1.5.0
		 * @access public
		 *
		 * @return array
		 */
		public function get_available_flex_horizontal_alignment() {
			return [
				'flex-start' => [
					'title' => __( 'Start', 'jet-cw' ),
					'icon'  => ! is_rtl() ? 'eicon-align-start-h' : 'eicon-align-end-h',
				],
				'center'     => [
					'title' => __( 'Center', 'jet-cw' ),
					'icon'  => 'eicon-align-center-h',
				],
				'flex-end'   => [
					'title' => __( 'End', 'jet-cw' ),
					'icon'  => ! is_rtl() ? 'eicon-align-end-h' : 'eicon-align-start-h',
				],
			];
		}

/**
		 * Return available horizontal alignment list
		 *
		 * @return array
		 */
		public function get_available_horizontal_alignment() {
			return [
				'left'   => [
					'title' => esc_html__( 'Left', 'jet-cw' ),
					'icon'  => 'eicon-text-align-left',
				],
				'center' => [
					'title' => esc_html__( 'Center', 'jet-cw' ),
					'icon'  => 'eicon-text-align-center',
				],
				'right'  => [
					'title' => esc_html__( 'Right', 'jet-cw' ),
					'icon'  => 'eicon-text-align-right',
				],
			];
		}

/**
		 * Return available text decoration styles list
		 *
		 * @return array
		 */
		public function get_available_text_decoration_styles() {
			return [
				'none'         => esc_html__( 'None', 'jet-cw' ),
				'line-through' => esc_html__( 'Line Through', 'jet-cw' ),
				'underline'    => esc_html__( 'Underline', 'jet-cw' ),
			];
		}

/**
		 * Return available font weight styles list
		 *
		 * @return array
		 */
		public function get_available_font_weight_styles() {
			return [
				'100' => esc_html__( '100', 'jet-cw' ),
				'200' => esc_html__( '200', 'jet-cw' ),
				'300' => esc_html__( '300', 'jet-cw' ),
				'400' => esc_html__( '400', 'jet-cw' ),
				'500' => esc_html__( '500', 'jet-cw' ),
				'600' => esc_html__( '600', 'jet-cw' ),
				'700' => esc_html__( '700', 'jet-cw' ),
				'800' => esc_html__( '800', 'jet-cw' ),
				'900' => esc_html__( '900', 'jet-cw' ),
			];
		}

/**
		 * Returns array with numbers in $index => $name format for numeric selects
		 *
		 * @param integer $to Max numbers
		 *
		 * @return array
		 */
		public function get_select_range( $to = 10 ) {
			$range = range( 1, $to );

return array_combine( $range, $range );
		}

/**
		 * Returns image tag or raw SVG
		 *
		 * @param string $url image URL.
		 * @param array  $attr
		 *
		 * @return string
		 */
		public function get_image_by_url( $url = null, $attr = array() ) {

$url = esc_url( $url );

if ( empty( $url ) ) {
				return null;
			}

$ext  = pathinfo( $url, PATHINFO_EXTENSION );
			$attr = array_merge( array( 'alt' => '' ), $attr );

if ( 'svg' !== $ext ) {
				return sprintf( '<img src="%1$s"%2$s>', $url, $this->get_attr_string( $attr ) );
			}

$base_url = network_site_url( '/' );
			$svg_path = str_replace( $base_url, ABSPATH, $url );
			$key      = md5( $svg_path );
			$svg      = get_transient( $key );

if ( ! $svg ) {
				$svg = file_get_contents( $svg_path );
			}

if ( ! $svg ) {
				return sprintf( '<img src="%1$s"%2$s>', $url, $this->get_attr_string( $attr ) );
			}

set_transient( $key, $svg, DAY_IN_SECONDS );

unset( $attr['alt'] );

return sprintf( '<div%2$s>%1$s</div>', $svg, $this->get_attr_string( $attr ) );

}

/**
		 * Return attributes string from attributes array.
		 *
		 * @param array $attr Attributes string.
		 *
		 * @return string
		 */
		public function get_attr_string( $attr = array() ) {

if ( empty( $attr ) || ! is_array( $attr ) ) {
				return null;
			}

$result = '';

foreach ( $attr as $key => $value ) {
				$result .= sprintf( ' %s="%s"', esc_attr( $key ), esc_attr( $value ) );
			}

return $result;

}

/**
		 * Additional HTML tags validation
		 *
		 * @param $input
		 *
		 * @return mixed|string
		 */
		public function sanitize_html_tag( $input ) {
			$available_tags = [ 'div', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'p', 'span', 'a', 'section', 'header', 'footer', 'main', 'b', 'em', 'i', 'nav', 'article', 'aside' ];

return in_array( strtolower( $input ), $available_tags ) ? $input : 'div';
		}

/**
		 * Returns the instance.
		 *
		 * @since  1.0.0
		 * @return object
		 */
		public static function get_instance( $shortcodes = array() ) {

// If the single instance hasn't been set, set it now.
			if ( null == self::$instance ) {
				self::$instance = new self( $shortcodes );
			}

return self::$instance;

}

/**
		* Returns the available products presets.
		*
		* @since  1.5.10
		* @return array
		*/
		public static function get_presets() {
			return [
				'preset-1'  => esc_html__( 'Preset 1', 'jet-cw' ),
				'preset-2'  => esc_html__( 'Preset 2', 'jet-cw' ),
				'preset-3'  => esc_html__( 'Preset 3', 'jet-cw' ),
				'preset-4'  => esc_html__( 'Preset 4', 'jet-cw' ),
				'preset-5'  => esc_html__( 'Preset 5', 'jet-cw' ),
				'preset-6'  => esc_html__( 'Preset 6', 'jet-cw' ),
				'preset-7'  => esc_html__( 'Preset 7', 'jet-cw' ),
				'preset-8'  => esc_html__( 'Preset 8', 'jet-cw' ),
				'preset-9'  => esc_html__( 'Preset 9', 'jet-cw' ),
				'preset-10' => esc_html__( 'Preset 10', 'jet-cw' ),
			];
		}

}

/**
 * Returns instance of Jet_CW_Tools
 *
 * @return object
 */
function jet_cw_tools() {
	return Jet_CW_Tools::get_instance();
}

MR SKB