module.php
346 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Class: Module |
| 4 | * Name: Premium Equal Height |
| 5 | * Slug: premium-equal-height |
| 6 | */ |
| 7 | |
| 8 | namespace PremiumAddons\Modules\Premium_Equal_Height; |
| 9 | |
| 10 | // PremiumAddons Classes. |
| 11 | use PremiumAddons\Includes\Controls\Premium_Select; |
| 12 | use PremiumAddons\Admin\Includes\Admin_Helper; |
| 13 | use PremiumAddons\Includes\Helper_Functions; |
| 14 | |
| 15 | // Elementor Classes. |
| 16 | use Elementor\Repeater; |
| 17 | use Elementor\Controls_Manager; |
| 18 | |
| 19 | |
| 20 | if ( ! defined( 'ABSPATH' ) ) { |
| 21 | exit; |
| 22 | } |
| 23 | |
| 24 | /** |
| 25 | * Class Module For Premium Equal Height addon. |
| 26 | */ |
| 27 | class Module { |
| 28 | |
| 29 | /** |
| 30 | * Load Script |
| 31 | * |
| 32 | * @var $load_script |
| 33 | */ |
| 34 | private static $load_script = null; |
| 35 | |
| 36 | /** |
| 37 | * Class object |
| 38 | * |
| 39 | * @var instance |
| 40 | */ |
| 41 | private static $instance = null; |
| 42 | |
| 43 | /** |
| 44 | * Class Constructor Function. |
| 45 | */ |
| 46 | public function __construct() { |
| 47 | |
| 48 | // Enqueue the required JS file. |
| 49 | add_action( 'elementor/preview/enqueue_scripts', array( $this, 'enqueue_scripts' ) ); |
| 50 | |
| 51 | // Create Premium Equal Height tab at the end of section layout tab. |
| 52 | add_action( 'elementor/element/section/section_advanced/after_section_end', array( $this, 'register_controls' ), 10 ); |
| 53 | |
| 54 | add_action( 'elementor/section/print_template', array( $this, '_print_template' ), 10, 2 ); |
| 55 | |
| 56 | // Insert data before section rendering. |
| 57 | add_action( 'elementor/frontend/section/before_render', array( $this, 'before_render' ), 10, 1 ); |
| 58 | |
| 59 | // Check if scripts should be loaded. |
| 60 | add_action( 'elementor/frontend/section/before_render', array( $this, 'check_script_enqueue' ) ); |
| 61 | |
| 62 | add_action( 'elementor/element/container/section_layout/after_section_end', array( $this, 'register_controls' ), 10 ); |
| 63 | add_action( 'elementor/container/print_template', array( $this, '_print_template' ), 10, 2 ); |
| 64 | add_action( 'elementor/frontend/container/before_render', array( $this, 'before_render' ), 100, 1 ); |
| 65 | add_action( 'elementor/frontend/container/before_render', array( $this, 'check_script_enqueue' ) ); |
| 66 | } |
| 67 | |
| 68 | /** |
| 69 | * Enqueue scripts. |
| 70 | * |
| 71 | * Registers required dependencies for the extension and enqueues them. |
| 72 | * |
| 73 | * @since 1.6.5 |
| 74 | * @access public |
| 75 | */ |
| 76 | public function enqueue_scripts() { |
| 77 | |
| 78 | if ( ! wp_script_is( 'pa-eq-height', 'enqueued' ) ) { |
| 79 | wp_enqueue_script( 'pa-eq-height' ); |
| 80 | } |
| 81 | } |
| 82 | |
| 83 | /** |
| 84 | * Register Premium Equal Height controls. |
| 85 | * |
| 86 | * @access public |
| 87 | * @param object $element for current element. |
| 88 | */ |
| 89 | public function register_controls( $element ) { |
| 90 | |
| 91 | $element->start_controls_section( |
| 92 | 'section_premium_eq_height', |
| 93 | array( |
| 94 | 'label' => sprintf( '<i class="pa-extension-icon pa-dash-icon"></i> %s', __( 'Equal Height', 'premium-addons-for-elementor' ) ), |
| 95 | 'tab' => Controls_Manager::TAB_ADVANCED, |
| 96 | ) |
| 97 | ); |
| 98 | |
| 99 | $element->add_control( |
| 100 | 'premium_eq_height_update', |
| 101 | array( |
| 102 | 'label' => '<div class="elementor-update-preview editor-pa-preview-update" style="background-color: #fff;"><div class="elementor-update-preview-title">Update changes to page</div><div class="elementor-update-preview-button-wrapper"><button class="elementor-update-preview-button elementor-button elementor-button-success">Apply</button></div></div>', |
| 103 | 'type' => Controls_Manager::RAW_HTML, |
| 104 | ) |
| 105 | ); |
| 106 | |
| 107 | $element->add_control( |
| 108 | 'premium_eq_height_switcher', |
| 109 | array( |
| 110 | 'label' => __( 'Enable Equal Height', 'premium-addons-for-elementor' ), |
| 111 | 'type' => Controls_Manager::SWITCHER, |
| 112 | 'return_value' => 'yes', |
| 113 | 'render_type' => 'template', |
| 114 | 'prefix_class' => 'premium-equal-height-', |
| 115 | 'frontend_available' => true, |
| 116 | ) |
| 117 | ); |
| 118 | |
| 119 | $element->add_control( |
| 120 | 'premium_eq_height_type', |
| 121 | array( |
| 122 | 'label' => __( 'Apply on', 'premium-addons-for-elementor' ), |
| 123 | 'type' => Controls_Manager::SELECT, |
| 124 | 'default' => 'widget', |
| 125 | 'options' => array( |
| 126 | 'widget' => __( 'Widgets', 'premium-addons-for-elementor' ), |
| 127 | 'custom' => __( 'Custom Selector', 'premium-addons-for-elementor' ), |
| 128 | ), |
| 129 | 'condition' => array( |
| 130 | 'premium_eq_height_switcher' => 'yes', |
| 131 | ), |
| 132 | ) |
| 133 | ); |
| 134 | |
| 135 | $element->add_control( |
| 136 | 'premium_eq_height_target', |
| 137 | array( |
| 138 | 'label' => __( 'Widgets', 'premium-addons-for-elementor' ), |
| 139 | 'type' => Premium_Select::TYPE, |
| 140 | 'render_type' => 'template', |
| 141 | 'label_block' => true, |
| 142 | 'multiple' => true, |
| 143 | 'frontend_available' => true, |
| 144 | 'condition' => array( |
| 145 | 'premium_eq_height_switcher' => 'yes', |
| 146 | 'premium_eq_height_type' => 'widget', |
| 147 | ), |
| 148 | ) |
| 149 | ); |
| 150 | |
| 151 | $element->add_control( |
| 152 | 'premium_eq_height_custom_target', |
| 153 | array( |
| 154 | 'label' => __( 'Selectors', 'premium-addons-for-elementor' ), |
| 155 | 'type' => Controls_Manager::TEXT, |
| 156 | 'label_block' => true, |
| 157 | 'placeholder' => __( '.class-name, .class-name2 .my-custom-class', 'premium-addons-for-elementor' ), |
| 158 | 'description' => __( 'Enter selectors separated with \' , \' ', 'premium-addons-for-elementor' ), |
| 159 | 'condition' => array( |
| 160 | 'premium_eq_height_switcher' => 'yes', |
| 161 | 'premium_eq_height_type' => 'custom', |
| 162 | ), |
| 163 | ) |
| 164 | ); |
| 165 | |
| 166 | $element->add_control( |
| 167 | 'premium_eq_height_trigger', |
| 168 | array( |
| 169 | 'label' => __( 'Trigger on', 'premium-addons-for-elementor' ), |
| 170 | 'type' => Controls_Manager::SELECT, |
| 171 | 'options' => array( |
| 172 | 'load' => __( 'Page Load', 'premium-addons-for-elementor' ), |
| 173 | 'scroll' => __( 'Scroll', 'premium-addons-for-elementor' ), |
| 174 | ), |
| 175 | 'default' => 'load', |
| 176 | 'condition' => array( |
| 177 | 'premium_eq_height_switcher' => 'yes', |
| 178 | ), |
| 179 | ) |
| 180 | ); |
| 181 | |
| 182 | $element->add_control( |
| 183 | 'premium_eq_height_enable_on', |
| 184 | array( |
| 185 | 'label' => __( 'Enable Equal Height on', 'premium-addons-for-elementor' ), |
| 186 | 'type' => Controls_Manager::SELECT2, |
| 187 | 'multiple' => true, |
| 188 | 'options' => Helper_Functions::get_all_breakpoints(), |
| 189 | 'label_block' => true, |
| 190 | 'default' => Helper_Functions::get_all_breakpoints( 'keys' ), |
| 191 | 'condition' => array( |
| 192 | 'premium_eq_height_switcher' => 'yes', |
| 193 | ), |
| 194 | ) |
| 195 | ); |
| 196 | |
| 197 | $docs = array( |
| 198 | 'https://premiumaddons.com/docs/elementor-column-equal-height/' => __( 'How to use Premium Equal Height feature »', 'premium-addons-for-elementor' ), |
| 199 | 'https://www.youtube.com/watch?v=ZaZ163p-saA' => __( 'Video tutorial »', 'premium-addons-for-elementor' ), |
| 200 | ); |
| 201 | |
| 202 | $doc_index = 1; |
| 203 | foreach ( $docs as $url => $title ) { |
| 204 | |
| 205 | $doc_url = Helper_Functions::get_campaign_link( $url, 'eq-height-addon', 'wp-editor', 'get-support' ); |
| 206 | |
| 207 | $element->add_control( |
| 208 | 'doc_' . $doc_index, |
| 209 | array( |
| 210 | 'type' => Controls_Manager::RAW_HTML, |
| 211 | 'raw' => sprintf( '<a href="%s" target="_blank">%s</a>', $doc_url, $title ), |
| 212 | 'content_classes' => 'editor-pa-doc', |
| 213 | ) |
| 214 | ); |
| 215 | |
| 216 | ++$doc_index; |
| 217 | |
| 218 | } |
| 219 | |
| 220 | $element->end_controls_section(); |
| 221 | } |
| 222 | |
| 223 | /** |
| 224 | * Render Premium Equal Height output in the editor. |
| 225 | * |
| 226 | * Written as a Backbone JavaScript template and used to generate the live preview. |
| 227 | * |
| 228 | * @since 4.2.5 |
| 229 | * @access public |
| 230 | * @param object $template for current template. |
| 231 | * @param object $element for current element. |
| 232 | */ |
| 233 | public function _print_template( $template, $element ) { |
| 234 | |
| 235 | $old_template = $template; |
| 236 | ob_start(); |
| 237 | |
| 238 | ?> |
| 239 | <# if( 'yes' === settings.premium_eq_height_switcher ) { |
| 240 | |
| 241 | var targetType = settings.premium_eq_height_type, |
| 242 | |
| 243 | target = 'custom' === targetType ? settings.premium_eq_height_custom_target.split(',') : settings.premium_eq_height_target, |
| 244 | |
| 245 | addonSettings = { |
| 246 | 'targetType': targetType, |
| 247 | 'target': target, |
| 248 | 'trigger':settings.premium_eq_height_trigger, |
| 249 | 'enableOn':settings.premium_eq_height_enable_on |
| 250 | }; |
| 251 | |
| 252 | view.addRenderAttribute( 'equal_height', { |
| 253 | 'id' : 'premium-temp-equal-height-' + view.getID(), |
| 254 | 'data-pa-eq-height': JSON.stringify( addonSettings ) |
| 255 | }); |
| 256 | |
| 257 | #> |
| 258 | <div {{{ view.getRenderAttributeString( 'equal_height' ) }}}></div> |
| 259 | <# } #> |
| 260 | <?php |
| 261 | |
| 262 | $element_content = ob_get_contents(); |
| 263 | |
| 264 | ob_end_clean(); |
| 265 | |
| 266 | $template = $element_content . $old_template; |
| 267 | return $template; |
| 268 | } |
| 269 | |
| 270 | /** |
| 271 | * Render Premium Equal Height output on the frontend. |
| 272 | * |
| 273 | * Written in PHP and used to generate the final HTML. |
| 274 | * |
| 275 | * @since 4.2.5 |
| 276 | * @access public |
| 277 | * |
| 278 | * @param object $element for current element. |
| 279 | */ |
| 280 | public function before_render( $element ) { |
| 281 | |
| 282 | $settings = $element->get_settings_for_display(); |
| 283 | |
| 284 | if ( 'yes' === $settings['premium_eq_height_switcher'] ) { |
| 285 | |
| 286 | $target_type = $settings['premium_eq_height_type']; |
| 287 | |
| 288 | $target = ( 'custom' === $target_type ) ? explode( ',', $settings['premium_eq_height_custom_target'] ) : $settings['premium_eq_height_target']; |
| 289 | |
| 290 | $addon_settings = array( |
| 291 | 'targetType' => $target_type, |
| 292 | 'target' => $target, |
| 293 | 'trigger' => $settings['premium_eq_height_trigger'], |
| 294 | 'enableOn' => $settings['premium_eq_height_enable_on'], |
| 295 | ); |
| 296 | |
| 297 | $element->add_render_attribute( '_wrapper', 'data-pa-eq-height', wp_json_encode( $addon_settings ) ); |
| 298 | } |
| 299 | } |
| 300 | |
| 301 | /** |
| 302 | * Check Script Enqueue |
| 303 | * |
| 304 | * Check if the script files should be loaded. |
| 305 | * |
| 306 | * @since 4.7.7 |
| 307 | * @access public |
| 308 | * |
| 309 | * @param object $element for current element. |
| 310 | */ |
| 311 | public function check_script_enqueue( $element ) { |
| 312 | |
| 313 | if ( self::$load_script ) { |
| 314 | return; |
| 315 | } |
| 316 | |
| 317 | if ( 'yes' === $element->get_settings_for_display( 'premium_eq_height_switcher' ) ) { |
| 318 | $this->enqueue_scripts(); |
| 319 | |
| 320 | self::$load_script = true; |
| 321 | |
| 322 | remove_action( 'elementor/frontend/section/before_render', array( $this, 'check_script_enqueue' ) ); |
| 323 | remove_action( 'elementor/frontend/container/before_render', array( $this, 'check_script_enqueue' ) ); |
| 324 | } |
| 325 | } |
| 326 | |
| 327 | /** |
| 328 | * Creates and returns an instance of the class |
| 329 | * |
| 330 | * @since 4.2.5 |
| 331 | * @access public |
| 332 | * |
| 333 | * @return object |
| 334 | */ |
| 335 | public static function get_instance() { |
| 336 | |
| 337 | if ( ! isset( self::$instance ) ) { |
| 338 | |
| 339 | self::$instance = new self(); |
| 340 | |
| 341 | } |
| 342 | |
| 343 | return self::$instance; |
| 344 | } |
| 345 | } |
| 346 |