| @@ -1,9 +1,8 @@ | ||
| 1 | 1 | <?php |
| 2 | 2 | namespace Elementor\Core\Experiments; |
| 3 | 3 | |
| 4 | 4 | use Elementor\Core\Base\Base_Object; |
| 5 | -use Elementor\Core\Experiments\Exceptions\Dependency_Exception; | |
| 6 | 5 | use Elementor\Core\Upgrade\Manager as Upgrade_Manager; |
| 7 | 6 | use Elementor\Core\Utils\Collection; |
| 8 | 7 | use Elementor\Modules\System_Info\Module as System_Info; |
| 9 | 8 | use Elementor\Plugin; |
| @@ -11,9 +10,9 @@ | ||
| 11 | 10 | use Elementor\Tracker; |
| 12 | 11 | use Elementor\Utils; |
| 13 | 12 | |
| 14 | 13 | if ( ! defined( 'ABSPATH' ) ) { |
| 15 | - exit; // Exit if accessed directly. | |
| 14 | + exit; // Exit if accessed directly | |
| 16 | 15 | } |
| 17 | 16 | |
| 18 | 17 | class Manager extends Base_Object { |
| 19 | 18 | |
| @@ -22,8 +21,10 @@ | ||
| 22 | 21 | const RELEASE_STATUS_ALPHA = 'alpha'; |
| 23 | 22 | |
| 24 | 23 | const RELEASE_STATUS_BETA = 'beta'; |
| 25 | 24 | |
| 25 | + const RELEASE_STATUS_RC = 'rc'; | |
| 26 | + | |
| 26 | 27 | const RELEASE_STATUS_STABLE = 'stable'; |
| 27 | 28 | |
| 28 | 29 | const STATE_DEFAULT = 'default'; |
| 29 | 30 | |
| @@ -43,26 +44,24 @@ | ||
| 43 | 44 | |
| 44 | 45 | /** |
| 45 | 46 | * Add Feature |
| 46 | 47 | * |
| 47 | - * Each feature has to provide the following information: | |
| 48 | - * [ | |
| 49 | - * 'name' => string, | |
| 50 | - * 'title' => string, | |
| 51 | - * 'description' => string, | |
| 52 | - * 'tag' => string, | |
| 53 | - * 'release_status' => string, | |
| 54 | - * 'default' => string, | |
| 55 | - * 'new_site' => array, | |
| 56 | - * ] | |
| 57 | - * | |
| 58 | 48 | * @since 3.1.0 |
| 59 | 49 | * @access public |
| 60 | 50 | * |
| 61 | - * @param array $options Feature options. | |
| 51 | + * @param array $options { | |
| 52 | + * @type string $name | |
| 53 | + * @type string $title | |
| 54 | + * @type string $tag | |
| 55 | + * @type array $tags | |
| 56 | + * @type string $description | |
| 57 | + * @type string $release_status | |
| 58 | + * @type string $default | |
| 59 | + * @type callable $on_state_change | |
| 60 | + * } | |
| 61 | + * | |
| 62 | 62 | * @return array|null |
| 63 | - * | |
| 64 | - * @throws Dependency_Exception If can't change feature state. | |
| 63 | + * @throws \Exception | |
| 65 | 64 | */ |
| 66 | 65 | public function add_feature( array $options ) { |
| 67 | 66 | if ( isset( $this->features[ $options['name'] ] ) ) { |
| 68 | 67 | return null; |
| @@ -67,14 +66,48 @@ | ||
| 67 | 66 | if ( isset( $this->features[ $options['name'] ] ) ) { |
| 68 | 67 | return null; |
| 69 | 68 | } |
| 70 | 69 | |
| 71 | - $experimental_data = $this->set_feature_initial_options( $options ); | |
| 70 | + $default_experimental_data = [ | |
| 71 | + 'tag' => '', // Deprecated, use 'tags' instead. | |
| 72 | + 'tags' => [], | |
| 73 | + 'description' => '', | |
| 74 | + 'release_status' => self::RELEASE_STATUS_ALPHA, | |
| 75 | + 'default' => self::STATE_INACTIVE, | |
| 76 | + 'mutable' => true, | |
| 77 | + static::TYPE_HIDDEN => false, | |
| 78 | + 'new_site' => [ | |
| 79 | + 'always_active' => false, | |
| 80 | + 'default_active' => false, | |
| 81 | + 'default_inactive' => false, | |
| 82 | + 'minimum_installation_version' => null, | |
| 83 | + ], | |
| 84 | + 'on_state_change' => null, | |
| 85 | + 'generator_tag' => false, | |
| 86 | + ]; | |
| 72 | 87 | |
| 88 | + $allowed_options = [ 'name', 'title', 'tag', 'tags', 'description', 'release_status', 'default', 'mutable', static::TYPE_HIDDEN, 'new_site', 'on_state_change', 'dependencies', 'generator_tag', 'messages' ]; | |
| 89 | + | |
| 90 | + $experimental_data = $this->merge_properties( $default_experimental_data, $options, $allowed_options ); | |
| 91 | + | |
| 92 | + $experimental_data = $this->unify_feature_tags( $experimental_data ); | |
| 93 | + | |
| 73 | 94 | $new_site = $experimental_data['new_site']; |
| 74 | 95 | |
| 75 | 96 | if ( $new_site['default_active'] || $new_site['always_active'] || $new_site['default_inactive'] ) { |
| 76 | - $experimental_data = $this->set_new_site_default_state( $new_site, $experimental_data ); | |
| 97 | + $is_new_installation = $this->install_compare( $new_site['minimum_installation_version'] ); | |
| 98 | + | |
| 99 | + if ( $is_new_installation ) { | |
| 100 | + if ( $new_site['always_active'] ) { | |
| 101 | + $experimental_data['state'] = self::STATE_ACTIVE; | |
| 102 | + | |
| 103 | + $experimental_data['mutable'] = false; | |
| 104 | + } elseif ( $new_site['default_active'] ) { | |
| 105 | + $experimental_data['default'] = self::STATE_ACTIVE; | |
| 106 | + } elseif ( $new_site['default_inactive'] ) { | |
| 107 | + $experimental_data['default'] = self::STATE_INACTIVE; | |
| 108 | + } | |
| 109 | + } | |
| 77 | 110 | } |
| 78 | 111 | |
| 79 | 112 | if ( $experimental_data['mutable'] ) { |
| 80 | 113 | $experimental_data['state'] = $this->get_saved_feature_state( $options['name'] ); |
| @@ -84,9 +117,17 @@ | ||
| 84 | 117 | $experimental_data['state'] = self::STATE_DEFAULT; |
| 85 | 118 | } |
| 86 | 119 | |
| 87 | 120 | if ( ! empty( $experimental_data['dependencies'] ) ) { |
| 88 | - $experimental_data = $this->initialize_feature_dependencies( $experimental_data ); | |
| 121 | + foreach ( $experimental_data['dependencies'] as $key => $dependency ) { | |
| 122 | + $feature = $this->get_features( $dependency ); | |
| 123 | + | |
| 124 | + if ( ! empty( $feature[ static::TYPE_HIDDEN ] ) ) { | |
| 125 | + throw new Exceptions\Dependency_Exception( 'Depending on a hidden experiment is not allowed.' ); | |
| 126 | + } | |
| 127 | + | |
| 128 | + $experimental_data['dependencies'][ $key ] = $this->create_dependency_class( $dependency, $feature ); | |
| 129 | + } | |
| 89 | 130 | } |
| 90 | 131 | |
| 91 | 132 | $this->features[ $options['name'] ] = $experimental_data; |
| 92 | 133 | |
| @@ -120,11 +161,9 @@ | ||
| 120 | 161 | private function install_compare( $version ) { |
| 121 | 162 | $installs_history = Upgrade_Manager::get_installs_history(); |
| 122 | 163 | |
| 123 | 164 | if ( empty( $installs_history ) ) { |
| 124 | - // Fresh installation: upgrade manager hasn't written history yet on this first request. | |
| 125 | - // Use the current plugin version as the effective first-install version. | |
| 126 | - return version_compare( ELEMENTOR_VERSION, $version, '>=' ); | |
| 165 | + return false; | |
| 127 | 166 | } |
| 128 | 167 | |
| 129 | 168 | $cleaned_version = preg_replace( '/-(beta|cloud|dev)\d*$/', '', key( $installs_history ) ); |
| 130 | 169 | |
| @@ -141,9 +180,9 @@ | ||
| 141 | 180 | * @param array $experimental_data |
| 142 | 181 | * |
| 143 | 182 | * @return array |
| 144 | 183 | */ |
| 145 | - private function unify_feature_tags( array $experimental_data ): array { | |
| 184 | + private function unify_feature_tags( array $experimental_data ) : array { | |
| 146 | 185 | foreach ( [ 'tag', 'tags' ] as $key ) { |
| 147 | 186 | if ( empty( $experimental_data[ $key ] ) ) { |
| 148 | 187 | continue; |
| 149 | 188 | } |
| @@ -160,21 +199,18 @@ | ||
| 160 | 199 | |
| 161 | 200 | /** |
| 162 | 201 | * Format feature tags into the right format. |
| 163 | 202 | * |
| 164 | - * If an array of tags provided, each tag has to provide the following information: | |
| 165 | - * [ | |
| 166 | - * [ | |
| 167 | - * 'type' => string, | |
| 168 | - * 'label' => string, | |
| 169 | - * ] | |
| 170 | - * ] | |
| 203 | + * @param string|array[ | |
| 204 | + * [ | |
| 205 | + * 'type' => string, | |
| 206 | + * 'label' => string | |
| 207 | + * ] | |
| 208 | + * ] $tag | |
| 171 | 209 | * |
| 172 | - * @param string|array $tags A string of comma separated tags, or an array of tags. | |
| 173 | - * | |
| 174 | 210 | * @return array |
| 175 | 211 | */ |
| 176 | - private function format_feature_tags( $tags ): array { | |
| 212 | + private function format_feature_tags( $tags ) : array { | |
| 177 | 213 | if ( ! is_string( $tags ) && ! is_array( $tags ) ) { |
| 178 | 214 | return []; |
| 179 | 215 | } |
| 180 | 216 | |
| @@ -223,9 +259,9 @@ | ||
| 223 | 259 | * |
| 224 | 260 | * @since 3.1.0 |
| 225 | 261 | * @access public |
| 226 | 262 | * |
| 227 | - * @param string $feature_name Optional. Default is null. | |
| 263 | + * @param string $feature_name Optional. Default is null | |
| 228 | 264 | * |
| 229 | 265 | * @return array|null |
| 230 | 266 | */ |
| 231 | 267 | public function get_features( $feature_name = null ) { |
| @@ -342,9 +378,8 @@ | ||
| 342 | 378 | $this->add_feature( [ |
| 343 | 379 | 'name' => 'container', |
| 344 | 380 | 'title' => esc_html__( 'Container', 'elementor' ), |
| 345 | 381 | 'description' => sprintf( |
| 346 | - /* translators: 1: Link opening tag, 2: Link closing tag, 3: Link opening tag, 4: Link closing tag, 5: Link opening tag, 6: Link closing tag */ | |
| 347 | 382 | esc_html__( 'Create advanced layouts and responsive designs with %1$sFlexbox%2$s and %3$sGrid%4$s container elements. Give it a try using the %5$sContainer playground%6$s.', 'elementor' ), |
| 348 | 383 | '<a target="_blank" href="https://go.elementor.com/wp-dash-flex-container/">', |
| 349 | 384 | '</a>', |
| 350 | 385 | '<a target="_blank" href="https://go.elementor.com/wp-dash-grid-container/">', |
| @@ -366,20 +401,58 @@ | ||
| 366 | 401 | ), |
| 367 | 402 | ], |
| 368 | 403 | ] ); |
| 369 | 404 | |
| 405 | + // TODO: Remove this experiment in v3.28 [ED-15983]. | |
| 370 | 406 | $this->add_feature( [ |
| 407 | + 'name' => 'e_swiper_latest', | |
| 408 | + 'title' => esc_html__( 'Upgrade Swiper Library', 'elementor' ), | |
| 409 | + 'description' => esc_html__( 'Prepare your website for future improvements to carousel features by upgrading the Swiper library integrated into your site from v5.36 to v8.45. This experiment includes markup changes so it might require updating custom code and cause compatibility issues with third party plugins.', 'elementor' ), | |
| 410 | + 'default' => self::STATE_ACTIVE, | |
| 411 | + static::TYPE_HIDDEN => true, | |
| 412 | + 'mutable' => false, | |
| 413 | + ] ); | |
| 414 | + | |
| 415 | + $this->add_feature( [ | |
| 416 | + 'name' => 'e_nested_atomic_repeaters', | |
| 417 | + 'title' => esc_html__( 'Nested Elements Performance', 'elementor' ), | |
| 418 | + 'tag' => esc_html__( 'Performance', 'elementor' ), | |
| 419 | + 'description' => esc_html__( 'Improve the performance of the Nested widgets.', 'elementor' ), | |
| 420 | + static::TYPE_HIDDEN => true, | |
| 421 | + 'release_status' => self::RELEASE_STATUS_DEV, | |
| 422 | + 'default' => self::STATE_ACTIVE, | |
| 423 | + ] ); | |
| 424 | + | |
| 425 | + $this->add_feature( [ | |
| 371 | 426 | 'name' => 'e_optimized_markup', |
| 372 | 427 | 'title' => esc_html__( 'Optimized Markup', 'elementor' ), |
| 373 | 428 | 'tag' => esc_html__( 'Performance', 'elementor' ), |
| 374 | 429 | 'description' => esc_html__( 'Reduce the DOM size by eliminating HTML tags in various elements and widgets. This experiment includes markup changes so it might require updating custom CSS/JS code and cause compatibility issues with third party plugins.', 'elementor' ), |
| 375 | - 'release_status' => self::RELEASE_STATUS_STABLE, | |
| 430 | + 'release_status' => self::RELEASE_STATUS_ALPHA, | |
| 376 | 431 | 'default' => self::STATE_INACTIVE, |
| 377 | - 'new_site' => [ | |
| 378 | - 'default_active' => true, | |
| 379 | - 'minimum_installation_version' => '3.30.0', | |
| 380 | - ], | |
| 381 | 432 | ] ); |
| 433 | + | |
| 434 | + $this->add_feature( [ | |
| 435 | + 'name' => 'e_onboarding', | |
| 436 | + 'title' => esc_html__( 'Plugin Onboarding', 'elementor' ), | |
| 437 | + 'description' => esc_html__( 'New plugin onboarding.', 'elementor' ), | |
| 438 | + static::TYPE_HIDDEN => true, | |
| 439 | + 'release_status' => self::RELEASE_STATUS_ALPHA, | |
| 440 | + 'default' => self::STATE_ACTIVE, | |
| 441 | + ] ); | |
| 442 | + | |
| 443 | + // TODO: Possibly remove experiment in v3.27.0 [ED-15717]. | |
| 444 | + // Check this reference in Pro: 'sticky_anchor_link_offset'. | |
| 445 | + $this->add_feature( [ | |
| 446 | + 'name' => 'e_css_smooth_scroll', | |
| 447 | + 'title' => esc_html__( 'CSS Smooth Scroll', 'elementor' ), | |
| 448 | + 'tag' => esc_html__( 'Performance', 'elementor' ), | |
| 449 | + 'description' => esc_html__( 'Use CSS Smooth Scroll to improve the user experience on your site. This experiment replaces the default JavaScript-based smooth scroll with a CSS-based solution.', 'elementor' ), | |
| 450 | + 'release_status' => self::RELEASE_STATUS_DEV, | |
| 451 | + static::TYPE_HIDDEN => true, | |
| 452 | + 'default' => self::STATE_ACTIVE, | |
| 453 | + 'mutable' => false, | |
| 454 | + ] ); | |
| 382 | 455 | } |
| 383 | 456 | |
| 384 | 457 | /** |
| 385 | 458 | * Init States |
| @@ -405,8 +478,9 @@ | ||
| 405 | 478 | $this->release_statuses = [ |
| 406 | 479 | self::RELEASE_STATUS_DEV => esc_html__( 'Development', 'elementor' ), |
| 407 | 480 | self::RELEASE_STATUS_ALPHA => esc_html__( 'Alpha', 'elementor' ), |
| 408 | 481 | self::RELEASE_STATUS_BETA => esc_html__( 'Beta', 'elementor' ), |
| 482 | + self::RELEASE_STATUS_RC => esc_html__( 'Release Candidate', 'elementor' ), | |
| 409 | 483 | self::RELEASE_STATUS_STABLE => esc_html__( 'Stable', 'elementor' ), |
| 410 | 484 | ]; |
| 411 | 485 | } |
| 412 | 486 | |
| @@ -430,8 +504,9 @@ | ||
| 430 | 504 | * @param Settings $settings |
| 431 | 505 | * |
| 432 | 506 | * @since 3.1.0 |
| 433 | 507 | * @access private |
| 508 | + * | |
| 434 | 509 | */ |
| 435 | 510 | private function register_settings_fields( Settings $settings ) { |
| 436 | 511 | $features = $this->get_features(); |
| 437 | 512 | |
| @@ -519,9 +594,9 @@ | ||
| 519 | 594 | <?php echo esc_html__( 'Experiments and Features', 'elementor' ); ?> |
| 520 | 595 | </h2> |
| 521 | 596 | <p class="e-experiment__description"> |
| 522 | 597 | <?php |
| 523 | - printf( | |
| 598 | + echo sprintf( | |
| 524 | 599 | /* translators: %1$s Link open tag, %2$s: Link close tag. */ |
| 525 | 600 | esc_html__( 'Personalize your Elementor experience by controlling which features and experiments are active on your site. Help make Elementor better by %1$ssharing your experience and feedback with us%2$s.', 'elementor' ), |
| 526 | 601 | '<a href="https://go.elementor.com/wp-dash-experiments-report-an-issue/" target="_blank">', |
| 527 | 602 | '</a>' |
| @@ -529,9 +604,9 @@ | ||
| 529 | 604 | ?> |
| 530 | 605 | </p> |
| 531 | 606 | <p class="e-experiment__description"> |
| 532 | 607 | <?php |
| 533 | - printf( | |
| 608 | + echo sprintf( | |
| 534 | 609 | '%1$s <a href="https://go.elementor.com/wp-dash-experiments/" target="_blank">%2$s</a>', |
| 535 | 610 | esc_html__( 'To use an experiment or feature on your site, simply click on the dropdown next to it and switch to Active. You can always deactivate them at any time.', 'elementor' ), |
| 536 | 611 | esc_html__( 'Learn more', 'elementor' ), |
| 537 | 612 | ); |
| @@ -623,13 +698,13 @@ | ||
| 623 | 698 | ->find( function ( $dependency ) { |
| 624 | 699 | return $dependency instanceof Non_Existing_Dependency; |
| 625 | 700 | } ); |
| 626 | 701 | |
| 627 | - return (bool) $non_existing_dep; | |
| 702 | + return ! ! $non_existing_dep; | |
| 628 | 703 | } |
| 629 | 704 | |
| 630 | 705 | /** |
| 631 | - * Get Feature Settings Label HTML. | |
| 706 | + * Get Feature Settings Label HTML | |
| 632 | 707 | * |
| 633 | 708 | * @since 3.1.0 |
| 634 | 709 | * @access private |
| 635 | 710 | * |
| @@ -654,16 +729,10 @@ | ||
| 654 | 729 | <div class="e-experiment__title"> |
| 655 | 730 | <div class="<?php echo $indicator_classes; ?>" data-tooltip="<?php echo $indicator_tooltip; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?>"></div> |
| 656 | 731 | <label class="e-experiment__title__label" for="e-experiment-<?php echo $feature['name']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?>"><?php echo $feature['title']; ?></label> |
| 657 | 732 | <?php foreach ( $feature['tags'] as $tag ) { ?> |
| 658 | - <?php | |
| 659 | - $tag_classes = 'e-experiment__title__tag e-experiment__title__tag__' . $tag['type'] . ' e-editor-one'; | |
| 660 | - ?> | |
| 661 | - <span class="<?php echo esc_attr( $tag_classes ); ?>"><?php echo $tag['label']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?></span> | |
| 733 | + <span class="e-experiment__title__tag e-experiment__title__tag__<?php echo $tag['type']; ?>"><?php echo $tag['label']; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?></span> | |
| 662 | 734 | <?php } ?> |
| 663 | - <?php if ( $feature['deprecated'] ) { ?> | |
| 664 | - <span class="e-experiment__title__tag e-experiment__title__tag__deprecated"><?php echo esc_html__( 'Deprecated', 'elementor' ); ?></span> | |
| 665 | - <?php } ?> | |
| 666 | 735 | </div> |
| 667 | 736 | <?php |
| 668 | 737 | |
| 669 | 738 | return ob_get_clean(); |
| @@ -727,11 +796,12 @@ | ||
| 727 | 796 | * |
| 728 | 797 | * @since 3.1.0 |
| 729 | 798 | * @access private |
| 730 | 799 | * |
| 731 | - * @param array $old_feature_data | |
| 800 | + * @param array $old_feature_data | |
| 732 | 801 | * @param string $new_state |
| 733 | - * @param string $old_state | |
| 802 | + * | |
| 803 | + * @throws \Elementor\Core\Experiments\Exceptions\Dependency_Exception | |
| 734 | 804 | */ |
| 735 | 805 | private function on_feature_state_change( array $old_feature_data, $new_state, $old_state ) { |
| 736 | 806 | $new_feature_data = $this->get_features( $old_feature_data['name'] ); |
| 737 | 807 | $this->validate_dependency( $new_feature_data, $new_state ); |
| @@ -748,9 +818,9 @@ | ||
| 748 | 818 | do_action( 'elementor/experiments/feature-state-change/' . $old_feature_data['name'], $old_state, $new_state ); |
| 749 | 819 | } |
| 750 | 820 | |
| 751 | 821 | /** |
| 752 | - * @throws Exceptions\Dependency_Exception If the feature dependency is not available or not active. | |
| 822 | + * @throws \Elementor\Core\Experiments\Exceptions\Dependency_Exception | |
| 753 | 823 | */ |
| 754 | 824 | private function validate_dependency( array $feature, $new_state ) { |
| 755 | 825 | $rollback = function ( $feature_option_key, $state ) { |
| 756 | 826 | remove_all_actions( 'add_option_' . $feature_option_key ); |
| @@ -779,10 +849,10 @@ | ||
| 779 | 849 | |
| 780 | 850 | throw new Exceptions\Dependency_Exception( |
| 781 | 851 | sprintf( |
| 782 | 852 | 'The feature `%s` has a dependency `%s` that is not available.', |
| 783 | - esc_html( $feature['name'] ), | |
| 784 | - esc_html( $dependency->get_name() ) | |
| 853 | + $feature['name'], | |
| 854 | + $dependency->get_name() | |
| 785 | 855 | ) |
| 786 | 856 | ); |
| 787 | 857 | } |
| 788 | 858 | |
| @@ -794,10 +864,10 @@ | ||
| 794 | 864 | |
| 795 | 865 | throw new Exceptions\Dependency_Exception( |
| 796 | 866 | sprintf( |
| 797 | 867 | 'To turn on `%1$s`, Experiment: `%2$s` activity is required!', |
| 798 | - esc_html( $feature['name'] ), | |
| 799 | - esc_html( $dependency_feature['name'] ) | |
| 868 | + $feature['name'], | |
| 869 | + $dependency_feature['name'] | |
| 800 | 870 | ) |
| 801 | 871 | ); |
| 802 | 872 | } |
| 803 | 873 | } |
| @@ -842,9 +912,11 @@ | ||
| 842 | 912 | * This behavior interferes with the experiments dependency mechanism because the data that's being sent can be in any order, |
| 843 | 913 | * while the dependencies mechanism expects it to be in a specific order (dependencies should be activated before their dependents can). |
| 844 | 914 | * In order to solve this issue, we sort the experiments in the POST data based on their dependencies tree. |
| 845 | 915 | * |
| 846 | - * @param array $allowed_options | |
| 916 | + * @param $allowed_options | |
| 917 | + * | |
| 918 | + * @return mixed | |
| 847 | 919 | */ |
| 848 | 920 | private function sort_allowed_options_by_dependencies( $allowed_options ) { |
| 849 | 921 | if ( ! isset( $allowed_options['elementor'] ) ) { |
| 850 | 922 | return $allowed_options; |
| @@ -932,114 +1004,6 @@ | ||
| 932 | 1004 | // Register CLI commands. |
| 933 | 1005 | if ( Utils::is_wp_cli() ) { |
| 934 | 1006 | \WP_CLI::add_command( 'elementor experiments', WP_CLI::class ); |
| 935 | 1007 | } |
| 936 | - } | |
| 937 | - | |
| 938 | - /** | |
| 939 | - * @param array $experimental_data | |
| 940 | - * @return array | |
| 941 | - * | |
| 942 | - * @throws Exceptions\Dependency_Exception If the feature dependency is not initialized or depends on a hidden experiment. | |
| 943 | - */ | |
| 944 | - private function initialize_feature_dependencies( array $experimental_data ): array { | |
| 945 | - foreach ( $experimental_data['dependencies'] as $key => $dependency ) { | |
| 946 | - $feature = $this->get_features( $dependency ); | |
| 947 | - | |
| 948 | - if ( ! isset( $feature ) ) { | |
| 949 | - // since we must validate the state of each dependency, we have to make sure that dependencies are initialized in the correct order, otherwise, error. | |
| 950 | - throw new Exceptions\Dependency_Exception( | |
| 951 | - sprintf( | |
| 952 | - 'Feature %s cannot be initialized before dependency feature: %s.', | |
| 953 | - esc_html( $experimental_data['name'] ), | |
| 954 | - esc_html( $dependency ) | |
| 955 | - ) | |
| 956 | - ); | |
| 957 | - } | |
| 958 | - | |
| 959 | - if ( ! empty( $feature[ static::TYPE_HIDDEN ] ) ) { | |
| 960 | - throw new Exceptions\Dependency_Exception( 'Depending on a hidden experiment is not allowed.' ); | |
| 961 | - } | |
| 962 | - | |
| 963 | - $experimental_data['dependencies'][ $key ] = $this->create_dependency_class( $dependency, $feature ); | |
| 964 | - $experimental_data = $this->set_feature_default_state_to_match_dependencies( $feature, $experimental_data ); | |
| 965 | - } | |
| 966 | - | |
| 967 | - return $experimental_data; | |
| 968 | - } | |
| 969 | - | |
| 970 | - /** | |
| 971 | - * @param array $feature | |
| 972 | - * @param array $experimental_data | |
| 973 | - * @return array | |
| 974 | - * | |
| 975 | - * we must validate the state: | |
| 976 | - * * A user can set a dependant feature to inactive and in upgrade we don't change users settings. | |
| 977 | - * * A developer can set the default state to be invalid (e.g. dependant feature is inactive). | |
| 978 | - * if one of the dependencies is inactive, the main feature should be inactive as well. | |
| 979 | - */ | |
| 980 | - private function set_feature_default_state_to_match_dependencies( array $feature, array $experimental_data ): array { | |
| 981 | - if ( self::STATE_INACTIVE !== $this->get_feature_actual_state( $feature ) ) { | |
| 982 | - return $experimental_data; | |
| 983 | - } | |
| 984 | - | |
| 985 | - if ( self::STATE_ACTIVE === $experimental_data['state'] ) { | |
| 986 | - $experimental_data['state'] = self::STATE_INACTIVE; | |
| 987 | - } elseif ( self::STATE_DEFAULT === $experimental_data['state'] ) { | |
| 988 | - $experimental_data['default'] = self::STATE_INACTIVE; | |
| 989 | - } | |
| 990 | - | |
| 991 | - return $experimental_data; | |
| 992 | - } | |
| 993 | - | |
| 994 | - /** | |
| 995 | - * @param array $new_site | |
| 996 | - * @param array $experimental_data | |
| 997 | - * @return array | |
| 998 | - */ | |
| 999 | - private function set_new_site_default_state( $new_site, array $experimental_data ): array { | |
| 1000 | - if ( ! $this->install_compare( $new_site['minimum_installation_version'] ) ) { | |
| 1001 | - return $experimental_data; | |
| 1002 | - } | |
| 1003 | - | |
| 1004 | - if ( $new_site['always_active'] ) { | |
| 1005 | - $experimental_data['state'] = self::STATE_ACTIVE; | |
| 1006 | - $experimental_data['mutable'] = false; | |
| 1007 | - } elseif ( $new_site['default_active'] ) { | |
| 1008 | - $experimental_data['default'] = self::STATE_ACTIVE; | |
| 1009 | - } elseif ( $new_site['default_inactive'] ) { | |
| 1010 | - $experimental_data['default'] = self::STATE_INACTIVE; | |
| 1011 | - } | |
| 1012 | - | |
| 1013 | - return $experimental_data; | |
| 1014 | - } | |
| 1015 | - | |
| 1016 | - /** | |
| 1017 | - * @param array $options | |
| 1018 | - * @return array | |
| 1019 | - */ | |
| 1020 | - private function set_feature_initial_options( array $options ): array { | |
| 1021 | - $default_experimental_data = [ | |
| 1022 | - 'tag' => '', // Deprecated, use 'tags' instead. | |
| 1023 | - 'tags' => [], | |
| 1024 | - 'description' => '', | |
| 1025 | - 'release_status' => self::RELEASE_STATUS_ALPHA, | |
| 1026 | - 'default' => self::STATE_INACTIVE, | |
| 1027 | - 'mutable' => true, | |
| 1028 | - static::TYPE_HIDDEN => false, | |
| 1029 | - 'new_site' => [ | |
| 1030 | - 'always_active' => false, | |
| 1031 | - 'default_active' => false, | |
| 1032 | - 'default_inactive' => false, | |
| 1033 | - 'minimum_installation_version' => null, | |
| 1034 | - ], | |
| 1035 | - 'on_state_change' => null, | |
| 1036 | - 'generator_tag' => false, | |
| 1037 | - 'deprecated' => false, | |
| 1038 | - ]; | |
| 1039 | - | |
| 1040 | - $allowed_options = [ 'name', 'title', 'tag', 'tags', 'description', 'release_status', 'default', 'mutable', static::TYPE_HIDDEN, 'new_site', 'on_state_change', 'dependencies', 'generator_tag', 'messages', 'deprecated' ]; | |
| 1041 | - $experimental_data = $this->merge_properties( $default_experimental_data, $options, $allowed_options ); | |
| 1042 | - | |
| 1043 | - return $this->unify_feature_tags( $experimental_data ); | |
| 1044 | 1008 | } |
| 1045 | 1009 | } |
