Analytics.php
2 years ago
Assets.php
1 year ago
Filters.php
9 months ago
Functions.php
3 months ago
Handlebars.php
2 years ago
I18n.php
2 months ago
index.php
3 years ago
Functions.php
468 lines
| 1 | <?php // phpcs:ignore SlevomatCodingStandard.TypeHints.DeclareStrictTypes.DeclareStrictTypesMissing |
| 2 | |
| 3 | namespace MailPoet\Twig; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\DI\ContainerWrapper; |
| 9 | use MailPoet\Referrals\UrlDecorator; |
| 10 | use MailPoet\Settings\SettingsController; |
| 11 | use MailPoet\Util\FreeDomains; |
| 12 | use MailPoet\Util\Notices\PendingApprovalNotice; |
| 13 | use MailPoet\WooCommerce\Helper as WooCommerceHelper; |
| 14 | use MailPoet\WP\Functions as WPFunctions; |
| 15 | use MailPoet\WPCOM\DotcomHelperFunctions; |
| 16 | use MailPoetVendor\Carbon\Carbon; |
| 17 | use MailPoetVendor\Twig\Extension\AbstractExtension; |
| 18 | use MailPoetVendor\Twig\TwigFunction; |
| 19 | |
| 20 | class Functions extends AbstractExtension { |
| 21 | |
| 22 | /** @var SettingsController */ |
| 23 | private $settings = null; |
| 24 | |
| 25 | /** @var WooCommerceHelper */ |
| 26 | private $woocommerceHelper = null; |
| 27 | |
| 28 | /** @var WPFunctions */ |
| 29 | private $wp = null; |
| 30 | |
| 31 | /** @var UrlDecorator */ |
| 32 | private $referralUrlDecorator = null; |
| 33 | |
| 34 | /** @var PendingApprovalNotice */ |
| 35 | private $pendingApprovalNotice = null; |
| 36 | |
| 37 | private function getWooCommerceHelper(): WooCommerceHelper { |
| 38 | if ($this->woocommerceHelper === null) { |
| 39 | $this->woocommerceHelper = new WooCommerceHelper($this->getWp()); |
| 40 | } |
| 41 | return $this->woocommerceHelper; |
| 42 | } |
| 43 | |
| 44 | private function getreferralUrlDecorator(): UrlDecorator { |
| 45 | if ($this->referralUrlDecorator === null) { |
| 46 | $this->referralUrlDecorator = new UrlDecorator($this->getWp(), $this->getSettings()); |
| 47 | } |
| 48 | return $this->referralUrlDecorator; |
| 49 | } |
| 50 | |
| 51 | private function getSettings(): SettingsController { |
| 52 | if ($this->settings === null) { |
| 53 | $this->settings = SettingsController::getInstance(); |
| 54 | } |
| 55 | return $this->settings; |
| 56 | } |
| 57 | |
| 58 | private function getDotcomHelperFunctions(): DotcomHelperFunctions { |
| 59 | return ContainerWrapper::getInstance()->get(DotcomHelperFunctions::class); |
| 60 | } |
| 61 | |
| 62 | private function getWp(): WPFunctions { |
| 63 | if ($this->wp === null) { |
| 64 | $this->wp = WPFunctions::get(); |
| 65 | } |
| 66 | return $this->wp; |
| 67 | } |
| 68 | |
| 69 | private function getPendingApprovalNotice(): PendingApprovalNotice { |
| 70 | if ($this->pendingApprovalNotice === null) { |
| 71 | $this->pendingApprovalNotice = ContainerWrapper::getInstance()->get(PendingApprovalNotice::class); |
| 72 | } |
| 73 | return $this->pendingApprovalNotice; |
| 74 | } |
| 75 | |
| 76 | public function getFunctions() { |
| 77 | return [ |
| 78 | new TwigFunction( |
| 79 | 'json_encode', |
| 80 | [$this, 'jsonEncode'], |
| 81 | ['is_safe' => ['all']] |
| 82 | ), |
| 83 | new TwigFunction( |
| 84 | 'json_decode', |
| 85 | 'json_decode', |
| 86 | ['is_safe' => ['all']] |
| 87 | ), |
| 88 | new TwigFunction( |
| 89 | 'wp_nonce_field', |
| 90 | 'wp_nonce_field', |
| 91 | ['is_safe' => ['all']] |
| 92 | ), |
| 93 | new TwigFunction( |
| 94 | 'params', |
| 95 | [$this, 'params'], |
| 96 | ['is_safe' => ['all']] |
| 97 | ), |
| 98 | new TwigFunction( |
| 99 | 'admin_url', |
| 100 | 'admin_url', |
| 101 | ['is_safe' => ['all']] |
| 102 | ), |
| 103 | new TwigFunction( |
| 104 | 'get_option', |
| 105 | 'get_option', |
| 106 | ['is_safe' => ['all']] |
| 107 | ), |
| 108 | new TwigFunction( |
| 109 | 'sending_frequency', |
| 110 | [$this, 'getSendingFrequency'], |
| 111 | ['is_safe' => ['all']] |
| 112 | ), |
| 113 | new TwigFunction( |
| 114 | 'wp_date_format', |
| 115 | [$this, 'getWPDateFormat'], |
| 116 | ['is_safe' => ['all']] |
| 117 | ), |
| 118 | new TwigFunction( |
| 119 | 'mailpoet_version', |
| 120 | [$this, 'getMailPoetVersion'], |
| 121 | ['is_safe' => ['all']] |
| 122 | ), |
| 123 | new TwigFunction( |
| 124 | 'mailpoet_premium_version', |
| 125 | [$this, 'getMailPoetPremiumVersion'], |
| 126 | ['is_safe' => ['all']] |
| 127 | ), |
| 128 | new TwigFunction( |
| 129 | 'wp_date_format', |
| 130 | [$this, 'getWPDateFormat'], |
| 131 | ['is_safe' => ['all']] |
| 132 | ), |
| 133 | new TwigFunction( |
| 134 | 'wp_time_format', |
| 135 | [$this, 'getWPTimeFormat'], |
| 136 | ['is_safe' => ['all']] |
| 137 | ), |
| 138 | new TwigFunction( |
| 139 | 'wp_datetime_format', |
| 140 | [$this, 'getWPDateTimeFormat'], |
| 141 | ['is_safe' => ['all']] |
| 142 | ), |
| 143 | new TwigFunction( |
| 144 | 'do_action', |
| 145 | 'do_action', |
| 146 | ['is_safe' => ['all']] |
| 147 | ), |
| 148 | new TwigFunction( |
| 149 | 'is_rtl', |
| 150 | [$this, 'isRtl'], |
| 151 | ['is_safe' => ['all']] |
| 152 | ), |
| 153 | new TwigFunction( |
| 154 | 'number_format_i18n', |
| 155 | 'number_format_i18n', |
| 156 | ['is_safe' => ['all']] |
| 157 | ), |
| 158 | new TwigFunction( |
| 159 | 'mailpoet_locale', |
| 160 | [$this, 'getTwoLettersLocale'], |
| 161 | ['is_safe' => ['all']] |
| 162 | ), |
| 163 | new TwigFunction( |
| 164 | 'mailpoet_free_domains', |
| 165 | [$this, 'getFreeDomains'], |
| 166 | ['is_safe' => ['all']] |
| 167 | ), |
| 168 | new TwigFunction( |
| 169 | 'is_woocommerce_active', |
| 170 | [$this, 'isWoocommerceActive'], |
| 171 | ['is_safe' => ['all']] |
| 172 | ), |
| 173 | new TwigFunction( |
| 174 | 'is_woocommerce_email_improvements_enabled', |
| 175 | [$this, 'isWoocommerceEmailImprovementsEnabled'], |
| 176 | ['is_safe' => ['all']] |
| 177 | ), |
| 178 | new TwigFunction( |
| 179 | 'get_woocommerce_version', |
| 180 | [$this, 'getWooCommerceVersion'], |
| 181 | ['is_safe' => ['all']] |
| 182 | ), |
| 183 | new TwigFunction( |
| 184 | 'wp_start_of_week', |
| 185 | [$this, 'getWPStartOfWeek'], |
| 186 | ['is_safe' => ['all']] |
| 187 | ), |
| 188 | new TwigFunction( |
| 189 | 'stats_color', |
| 190 | [$this, 'statsColor'], |
| 191 | ['is_safe' => ['all']] |
| 192 | ), |
| 193 | new TwigFunction( |
| 194 | 'clicked_stats_text', |
| 195 | [$this, 'clickedStatsText'], |
| 196 | ['is_safe' => ['all']] |
| 197 | ), |
| 198 | new TwigFunction( |
| 199 | 'stats_number_format_i18n', |
| 200 | [$this, 'statsNumberFormatI18n'], |
| 201 | ['is_safe' => ['all']] |
| 202 | ), |
| 203 | new TwigFunction( |
| 204 | 'clicked_stats_text_garden', |
| 205 | [$this, 'clickedStatsTextGarden'], |
| 206 | ['is_safe' => ['all']] |
| 207 | ), |
| 208 | new TwigFunction( |
| 209 | 'clicked_stats_badge_color', |
| 210 | [$this, 'clickedStatsBadgeColor'], |
| 211 | ['is_safe' => ['all']] |
| 212 | ), |
| 213 | new TwigFunction( |
| 214 | 'add_referral_id', |
| 215 | [$this, 'addReferralId'], |
| 216 | ['is_safe' => ['all']] |
| 217 | ), |
| 218 | new TwigFunction( |
| 219 | 'is_loading_3rd_party_enabled', |
| 220 | [$this, 'libs3rdPartyEnabled'], |
| 221 | ['is_safe' => ['all']] |
| 222 | ), |
| 223 | new TwigFunction( |
| 224 | 'is_dotcom_ecommerce_plan', |
| 225 | [$this, 'isDotcomEcommercePlan'], |
| 226 | ['is_safe' => ['all']] |
| 227 | ), |
| 228 | new TwigFunction( |
| 229 | 'is_dotcom', |
| 230 | [$this, 'isDotcom'], |
| 231 | ['is_safe' => ['all']] |
| 232 | ), |
| 233 | new TwigFunction( |
| 234 | 'is_garden', |
| 235 | [$this, 'isGarden'], |
| 236 | ['is_safe' => ['all']] |
| 237 | ), |
| 238 | new TwigFunction( |
| 239 | 'pending_approval_message', |
| 240 | [$this, 'pendingApprovalMessage'], |
| 241 | ['is_safe' => ['html']] |
| 242 | ), |
| 243 | new TwigFunction( |
| 244 | 'get_product_placeholder_img', |
| 245 | [$this, 'wcPlaceholderImgSrc'], |
| 246 | ['is_safe' => ['all']] |
| 247 | ), |
| 248 | new TwigFunction( |
| 249 | 'get_wc_page_url', |
| 250 | [$this, 'wcPageUrl'], |
| 251 | ['is_safe' => ['all']] |
| 252 | ), |
| 253 | ]; |
| 254 | } |
| 255 | |
| 256 | public function getSendingFrequency() { |
| 257 | /** @var string[] $args */ |
| 258 | $args = func_get_args(); |
| 259 | $value = (int)array_shift($args); |
| 260 | |
| 261 | $label = null; |
| 262 | $labels = [ |
| 263 | 'minute' => __('every minute', 'mailpoet'), |
| 264 | // translators: %1$d is the amount of minutes. |
| 265 | 'minutes' => __('every %1$d minutes', 'mailpoet'), |
| 266 | 'hour' => __('every hour', 'mailpoet'), |
| 267 | // translators: %1$d is the amount of hours. |
| 268 | 'hours' => __('every %1$d hours', 'mailpoet'), |
| 269 | ]; |
| 270 | |
| 271 | if ($value >= 60) { |
| 272 | // we're dealing with hours |
| 273 | if ($value === 60) { |
| 274 | $label = $labels['hour']; |
| 275 | } else { |
| 276 | $label = $labels['hours']; |
| 277 | } |
| 278 | $value /= 60; |
| 279 | } else { |
| 280 | // we're dealing with minutes |
| 281 | if ($value === 1) { |
| 282 | $label = $labels['minute']; |
| 283 | } else { |
| 284 | $label = $labels['minutes']; |
| 285 | } |
| 286 | } |
| 287 | |
| 288 | return sprintf($label, $value); |
| 289 | } |
| 290 | |
| 291 | public function getWPDateFormat() { |
| 292 | return $this->getWp()->getOption('date_format') ?: 'F j, Y'; |
| 293 | } |
| 294 | |
| 295 | public function getWPStartOfWeek() { |
| 296 | return $this->getWp()->getOption('start_of_week') ?: 0; |
| 297 | } |
| 298 | |
| 299 | public function getMailPoetVersion() { |
| 300 | return MAILPOET_VERSION; |
| 301 | } |
| 302 | |
| 303 | public function getMailPoetPremiumVersion() { |
| 304 | return (defined('MAILPOET_PREMIUM_VERSION')) ? MAILPOET_PREMIUM_VERSION : false; |
| 305 | } |
| 306 | |
| 307 | public function getWPTimeFormat() { |
| 308 | return $this->getWp()->getOption('time_format') ?: 'g:i a'; |
| 309 | } |
| 310 | |
| 311 | public function getWPDateTimeFormat() { |
| 312 | return sprintf('%s %s', $this->getWPDateFormat(), $this->getWPTimeFormat()); |
| 313 | } |
| 314 | |
| 315 | public function params($key = null) { |
| 316 | $args = $this->getWp()->stripslashesDeep($_GET); |
| 317 | if (array_key_exists($key, $args)) { |
| 318 | return $args[$key]; |
| 319 | } |
| 320 | return null; |
| 321 | } |
| 322 | |
| 323 | public function installedInLastTwoWeeks() { |
| 324 | $maxNumberOfWeeks = 2; |
| 325 | $installedAt = Carbon::createFromFormat('Y-m-d H:i:s', $this->getSettings()->get('installed_at')); |
| 326 | if ($installedAt === false) { |
| 327 | return false; |
| 328 | } |
| 329 | return $installedAt->diffInWeeks(Carbon::now()) < $maxNumberOfWeeks; |
| 330 | } |
| 331 | |
| 332 | public function isRtl() { |
| 333 | return $this->getWp()->isRtl(); |
| 334 | } |
| 335 | |
| 336 | public function getTwoLettersLocale() { |
| 337 | return explode('_', $this->getWp()->getLocale())[0]; |
| 338 | } |
| 339 | |
| 340 | public function getFreeDomains() { |
| 341 | return FreeDomains::FREE_DOMAINS; |
| 342 | } |
| 343 | |
| 344 | public function isWoocommerceActive() { |
| 345 | return $this->getWooCommerceHelper()->isWooCommerceActive(); |
| 346 | } |
| 347 | |
| 348 | public function isWoocommerceEmailImprovementsEnabled() { |
| 349 | return $this->getWooCommerceHelper()->isWooCommerceEmailImprovementsEnabled(); |
| 350 | } |
| 351 | |
| 352 | public function getWooCommerceVersion() { |
| 353 | return $this->getWooCommerceHelper()->getWooCommerceVersion(); |
| 354 | } |
| 355 | |
| 356 | public function statsColor($percentage) { |
| 357 | if ($percentage > 3) { |
| 358 | return '#7ed321'; |
| 359 | } elseif ($percentage > 1) { |
| 360 | return '#ff9f00'; |
| 361 | } else { |
| 362 | return '#f559c3'; |
| 363 | } |
| 364 | } |
| 365 | |
| 366 | public function clickedStatsText($clicked) { |
| 367 | if ($clicked > 3) { |
| 368 | return __('Excellent', 'mailpoet'); |
| 369 | } elseif ($clicked > 1) { |
| 370 | return __('Good', 'mailpoet'); |
| 371 | } else { |
| 372 | return __('Average', 'mailpoet'); |
| 373 | } |
| 374 | } |
| 375 | |
| 376 | public function clickedStatsTextGarden($clicked) { |
| 377 | if ($clicked > 3) { |
| 378 | return __('Excellent', 'mailpoet'); |
| 379 | } elseif ($clicked > 1) { |
| 380 | return __('Good', 'mailpoet'); |
| 381 | } elseif ($clicked > 0) { |
| 382 | return __('Average', 'mailpoet'); |
| 383 | } else { |
| 384 | return __('Poor', 'mailpoet'); |
| 385 | } |
| 386 | } |
| 387 | |
| 388 | public function clickedStatsBadgeColor($clicked) { |
| 389 | if ($clicked > 3) { |
| 390 | return '#C6E1C6'; // Stable (green) — Excellent |
| 391 | } elseif ($clicked > 1) { |
| 392 | return '#B5D4EF'; // Informational (blue) — Good |
| 393 | } elseif ($clicked > 0) { |
| 394 | return '#DCDCDE'; // Draft (gray) — Average |
| 395 | } else { |
| 396 | return '#F5E6AB'; // Medium (yellow) — Poor |
| 397 | } |
| 398 | } |
| 399 | |
| 400 | /** |
| 401 | * Wrapper around number_format_i18n() to return two decimals digits if the number |
| 402 | * is smaller than 0.1 and one decimal digit if the number is equal or greater |
| 403 | * than 0.1. |
| 404 | * |
| 405 | * @param int|float $number |
| 406 | * |
| 407 | * @return string |
| 408 | */ |
| 409 | public function statsNumberFormatI18n($number) { |
| 410 | if ($number < 0.1) { |
| 411 | $decimals = 2; |
| 412 | } else { |
| 413 | $decimals = 1; |
| 414 | } |
| 415 | |
| 416 | return number_format_i18n($number, $decimals); |
| 417 | } |
| 418 | |
| 419 | public function addReferralId($url) { |
| 420 | return $this->getreferralUrlDecorator()->decorate($url); |
| 421 | } |
| 422 | |
| 423 | public function libs3rdPartyEnabled(): bool { |
| 424 | return $this->getSettings()->get('3rd_party_libs.enabled') === '1'; |
| 425 | } |
| 426 | |
| 427 | public function isDotcomEcommercePlan(): bool { |
| 428 | if (function_exists('wc_calypso_bridge_is_ecommerce_plan')) { |
| 429 | return wc_calypso_bridge_is_ecommerce_plan(); |
| 430 | } |
| 431 | return false; |
| 432 | } |
| 433 | |
| 434 | public function isDotcom(): bool { |
| 435 | return $this->getDotcomHelperFunctions()->isDotcom(); |
| 436 | } |
| 437 | |
| 438 | public function isGarden(): bool { |
| 439 | return $this->getDotcomHelperFunctions()->isGarden(); |
| 440 | } |
| 441 | |
| 442 | public function pendingApprovalMessage(): string { |
| 443 | return $this->getPendingApprovalNotice()->getPendingApprovalMessage(); |
| 444 | } |
| 445 | |
| 446 | public function wcPlaceholderImgSrc(string $size = 'woocommerce_thumbnail'): string { |
| 447 | return esc_url($this->getWooCommerceHelper()->wcPlaceholderImgSrc($size)); |
| 448 | } |
| 449 | |
| 450 | public function wcPageUrl(string $page): string { |
| 451 | return esc_url($this->getWooCommerceHelper()->wcGetPagePermalink($page)); |
| 452 | } |
| 453 | |
| 454 | /** |
| 455 | * Safely encodes data to JSON for use in script tags. |
| 456 | * Always includes JSON_HEX_TAG to prevent breaking out of script context |
| 457 | * and JSON_UNESCAPED_SLASHES for better readability. |
| 458 | * |
| 459 | * @param mixed $data |
| 460 | * @param int $flags |
| 461 | * @return string|false |
| 462 | */ |
| 463 | public function jsonEncode($data, $flags = 0) { |
| 464 | $flags = $flags | JSON_HEX_TAG | JSON_UNESCAPED_SLASHES; |
| 465 | return json_encode($data, $flags); |
| 466 | } |
| 467 | } |
| 468 |