File Editor

Directories:

Files:

Create New File

Edit File: experiments-reporter.php

<?php
namespace Elementor\Core\Experiments;

use Elementor\Modules\System_Info\Reporters\Base;
use Elementor\Plugin;

/**
 * Elementor experiments report.
 *
 * Elementor experiment report handler class responsible for generating a report for
 * the experiments included in Elementor and their status.
 */
class Experiments_Reporter extends Base {

/**
	 * Get experiments reporter title.
	 *
	 * @return string Reporter title.
	 */
	public function get_title() {
		return esc_html__( 'Elementor Experiments', 'elementor' );
	}

/**
	 * Get experiments report fields.
	 *
	 * @return array Required report fields with field ID and field label.
	 */
	public function get_fields() {
		return [
			'experiments' => '',
		];
	}

/**
	 * Get Experiments.
	 */
	public function get_experiments() {
		$result = [];

$experiments_manager = Plugin::$instance->experiments;

// TODO: Those keys should be at `$experiments_manager`.
		$tracking_keys = [
			'default',
			'state',
			'tags',
		];

foreach ( $experiments_manager->get_features() as $feature_name => $feature_data ) {
			$data_to_collect = [];

// Extract only tracking keys.
			foreach ( $tracking_keys as $tracking_key ) {
				if ( empty( $feature_data[ $tracking_key ] ) ) {
					continue;
				}

$data_to_collect[ $tracking_key ] = $feature_data[ $tracking_key ];
			}

$result[ $feature_name ] = $data_to_collect;
		}

return [
			'value' => $result,
		];
	}

/**
	 * Get Raw Experiments.
	 *
	 * Retrieve a string containing the list of Elementor experiments and each experiment's status (active/inactive).
	 * The string is formatted in a non-table structure, and it is meant for export/download of the system info reports.
	 *
	 * @return array
	 */
	public function get_raw_experiments() {
		$experiments = Plugin::$instance->experiments->get_features();

$output = '';

$is_first_item = true;

foreach ( $experiments as $experiment ) {
			// If the state is default, add the default state to the string.
			$state = Plugin::$instance->experiments->get_feature_state_label( $experiment );

// The first item automatically has a tab character before it. Add tabs only to the rest of the items.
			if ( ! $is_first_item ) {
				$output .= "\t";
			}

$title = isset( $experiment['title'] ) ? $experiment['title'] : $experiment['name'];

$output .= $title . ': ' . $state . PHP_EOL;

$is_first_item = false;
		}

return [
			'value' => $output,
		];
	}

/**
	 * Get HTML Experiments.
	 *
	 * Retrieve the list of Elementor experiments and each experiment's status (active/inactive), in HTML table format.
	 *
	 * @return array
	 */
	public function get_html_experiments() {
		$experiments = Plugin::$instance->experiments->get_features();