Conditions
1 year ago
Documents
1 year ago
DynamicTags
4 months ago
Widgets
2 months ago
assets
4 months ago
ElementorBlockAdapterService.php
4 months ago
ElementorCoreBlockStylesService.php
1 year ago
ElementorDocumentsService.php
1 year ago
ElementorDynamicTagsService.php
1 year ago
ElementorEditorService.php
1 year ago
ElementorFseScriptLoaderService.php
1 year ago
ElementorServiceProvider.php
8 months ago
ElementorShortcodeService.php
1 year ago
ElementorTemplatesService.php
4 months ago
ElementorWidgetsService.php
8 months ago
ElementorTemplatesService.php
222 lines
| 1 | <?php |
| 2 | |
| 3 | namespace SureCart\Integrations\Elementor; |
| 4 | |
| 5 | /** |
| 6 | * Class to handle elementor templates. |
| 7 | */ |
| 8 | class ElementorTemplatesService { |
| 9 | /** |
| 10 | * Templates directory path. |
| 11 | * |
| 12 | * @var string |
| 13 | */ |
| 14 | private $templates_dir; |
| 15 | |
| 16 | /** |
| 17 | * Constructor. |
| 18 | */ |
| 19 | public function __construct() { |
| 20 | $this->templates_dir = SURECART_PLUGIN_DIR . '/templates/elementor/'; |
| 21 | } |
| 22 | |
| 23 | /** |
| 24 | * Get template configuration data by filename. |
| 25 | * |
| 26 | * @param string $filename Template filename without extension. |
| 27 | * @return array Template configuration including name, image, and any other properties. |
| 28 | */ |
| 29 | private function get_template_config( $filename ): array { |
| 30 | $templates_config = [ |
| 31 | 'surecart-single-product-left' => [ |
| 32 | 'name' => __( 'Product Form (Left)', 'surecart' ), |
| 33 | 'image' => 'single-product-template-left.png', |
| 34 | 'type' => 'product-form', |
| 35 | 'widget_name' => 'surecart-product', |
| 36 | 'priority' => 10, |
| 37 | 'hidden' => false, |
| 38 | ], |
| 39 | 'surecart-single-product-right' => [ |
| 40 | 'name' => __( 'Product Form (Right)', 'surecart' ), |
| 41 | 'image' => 'single-product-template-right.png', |
| 42 | 'type' => 'product-form', |
| 43 | 'widget_name' => '', // No widget will be registered for this template. |
| 44 | 'priority' => 20, |
| 45 | 'hidden' => false, |
| 46 | ], |
| 47 | 'surecart-product-card' => [ |
| 48 | 'name' => __( 'Product Card', 'surecart' ), |
| 49 | 'image' => 'product-card-template.png', |
| 50 | 'type' => 'product-card', |
| 51 | 'widget_name' => 'surecart-product-card', |
| 52 | 'priority' => 30, |
| 53 | 'hidden' => false, |
| 54 | ], |
| 55 | 'surecart-product-pricing' => [ |
| 56 | 'name' => __( 'Product Pricing', 'surecart' ), |
| 57 | 'image' => '', |
| 58 | 'type' => 'others', |
| 59 | 'widget_name' => 'surecart-product-pricing', |
| 60 | 'priority' => 40, |
| 61 | 'hidden' => true, |
| 62 | ], |
| 63 | 'surecart-product-reviews' => [ |
| 64 | 'name' => __( 'Product Reviews', 'surecart' ), |
| 65 | 'image' => '', |
| 66 | 'type' => 'others', |
| 67 | 'widget_name' => 'surecart-product-reviews', |
| 68 | 'priority' => 50, |
| 69 | 'hidden' => true, |
| 70 | ], |
| 71 | 'surecart-product-rating' => [ |
| 72 | 'name' => __( 'Product Rating', 'surecart' ), |
| 73 | 'image' => '', |
| 74 | 'type' => 'others', |
| 75 | 'widget_name' => 'surecart-product-rating', |
| 76 | 'priority' => 60, |
| 77 | 'hidden' => true, |
| 78 | ], |
| 79 | ]; |
| 80 | |
| 81 | // Get config or create default. |
| 82 | $config = $templates_config[ $filename ] ?? [ |
| 83 | 'name' => ucwords( str_replace( [ 'surecart-', '-' ], [ '', ' ' ], $filename ) ), |
| 84 | 'image' => '', |
| 85 | 'type' => 'others', |
| 86 | 'priority' => 999, |
| 87 | 'hidden' => false, |
| 88 | ]; |
| 89 | |
| 90 | // Process the image URL. |
| 91 | $config['image'] = esc_url_raw( |
| 92 | trailingslashit( \SureCart::core()->assets()->getUrl() ) . |
| 93 | 'images/elementor/' . $config['image'] |
| 94 | ); |
| 95 | |
| 96 | return $config; |
| 97 | } |
| 98 | |
| 99 | /** |
| 100 | * Get all templates from the templates directory. |
| 101 | * |
| 102 | * @return array |
| 103 | */ |
| 104 | public function get_templates(): array { |
| 105 | $templates = []; |
| 106 | $files = glob( $this->templates_dir . '*.json' ); |
| 107 | |
| 108 | if ( ! $files ) { |
| 109 | return $templates; |
| 110 | } |
| 111 | |
| 112 | foreach ( $files as $file ) { |
| 113 | $filename = basename( $file, '.json' ); |
| 114 | |
| 115 | // Skip files that aren't templates. |
| 116 | if ( strpos( $filename, 'surecart-' ) !== 0 ) { |
| 117 | continue; |
| 118 | } |
| 119 | |
| 120 | // Get template key. |
| 121 | $template_key = $filename; |
| 122 | |
| 123 | // Get template configuration. |
| 124 | $config = $this->get_template_config( $filename ); |
| 125 | |
| 126 | // Get the template content. |
| 127 | $template_content = $this->get_template_from_file( $filename . '.json' ); |
| 128 | |
| 129 | if ( ! empty( $template_content ) ) { |
| 130 | $templates[ $template_key ] = array_merge( |
| 131 | $config, |
| 132 | [ 'content' => $template_content ] |
| 133 | ); |
| 134 | } |
| 135 | } |
| 136 | |
| 137 | $templates = $this->sort_templates_by_priority( $templates ); |
| 138 | |
| 139 | return apply_filters( 'sc_elementor_templates', $templates ); |
| 140 | } |
| 141 | |
| 142 | /** |
| 143 | * Sort templates by priority. |
| 144 | * |
| 145 | * @param array $templates The templates to sort. |
| 146 | * @return array Sorted templates. |
| 147 | */ |
| 148 | private function sort_templates_by_priority( array $templates ): array { |
| 149 | uasort( |
| 150 | $templates, |
| 151 | function ( $a, $b ) { |
| 152 | return ( $a['priority'] ?? 999 ) <=> ( $b['priority'] ?? 999 ); |
| 153 | } |
| 154 | ); |
| 155 | |
| 156 | return $templates; |
| 157 | } |
| 158 | |
| 159 | /** |
| 160 | * Get Elementor template from file. |
| 161 | * |
| 162 | * @param string $file_name The file name. |
| 163 | * |
| 164 | * @return array |
| 165 | */ |
| 166 | public function get_template_from_file( string $file_name ) { |
| 167 | try { |
| 168 | $template_path = $this->templates_dir . $file_name; |
| 169 | $template_content = file_get_contents( $template_path ); // phpcs:ignore |
| 170 | |
| 171 | return isset( $template_content ) ? json_decode( $template_content, true ) : []; |
| 172 | } catch ( \Throwable $th ) { |
| 173 | error_log( 'Error while reading the template file: ' . $th->getMessage() ); |
| 174 | return []; |
| 175 | } |
| 176 | } |
| 177 | |
| 178 | /** |
| 179 | * Check if the current page/template is rendered by Elementor and contains SureCart product template. |
| 180 | * |
| 181 | * @return bool |
| 182 | */ |
| 183 | public function isRenderedWithElementor(): bool { |
| 184 | if ( ! class_exists( 'Elementor\Plugin' ) ) { |
| 185 | return false; |
| 186 | } |
| 187 | |
| 188 | // If has custom page template, means its rendering from SureCart template, not with Elementor. |
| 189 | if ( ! empty( get_post_meta( get_the_ID(), '_wp_page_template', true ) ) ) { |
| 190 | return false; |
| 191 | } |
| 192 | |
| 193 | return $this->hasActiveSureCartElementorTemplate(); |
| 194 | } |
| 195 | |
| 196 | /** |
| 197 | * Check if surecart-product Elementor template is active. |
| 198 | * |
| 199 | * @return bool |
| 200 | */ |
| 201 | public function hasActiveSureCartElementorTemplate(): bool { |
| 202 | $templates = get_posts( |
| 203 | [ |
| 204 | 'post_type' => 'elementor_library', |
| 205 | 'meta_query' => [ |
| 206 | [ |
| 207 | 'key' => '_elementor_template_type', |
| 208 | 'value' => 'surecart-product', |
| 209 | ], |
| 210 | [ |
| 211 | 'key' => '_elementor_edit_mode', |
| 212 | 'value' => 'builder', |
| 213 | ], |
| 214 | ], |
| 215 | 'posts_per_page' => 1, |
| 216 | ] |
| 217 | ); |
| 218 | |
| 219 | return ! empty( $templates ); |
| 220 | } |
| 221 | } |
| 222 |