<?php
/**
 * Test data: which environment this site is.
 *
 * @package AdminPowerups
 */

namespace SmartWP\AdminPowerups\Modules\TestData;

defined( 'ABSPATH' ) || exit;

/**
 * The effective environment type decides how generating is confirmed: a typed word and an
 * Advanced user on production, a two-step button elsewhere.
 *
 * @since 1.0.0
 */
final class Environment {

	/**
	 * Known environment types.
	 */
	const TYPES = array( 'local', 'development', 'staging', 'production' );

	/**
	 * The effective environment type: wp_get_environment_type() (production when unset), then the
	 * `apwc_test_data_environment` filter. Anything unknown counts as production.
	 *
	 * @since 1.0.0
	 * @return string
	 */
	public static function type(): string {
		/**
		 * Filter the environment type Test data acts on. Works both ways (a mislabelled host can be
		 * marked production, or a test can mark a site staging); unknown values count as production.
		 * The Generate tab always shows the effective value.
		 *
		 * @since 1.0.0
		 * @param string $type wp_get_environment_type().
		 */
		$type = apply_filters( 'apwc_test_data_environment', wp_get_environment_type() );
		return is_string( $type ) && in_array( $type, self::TYPES, true ) ? $type : 'production';
	}

	/**
	 * Whether this site counts as production.
	 *
	 * @since 1.0.0
	 * @return bool
	 */
	public static function is_production(): bool {
		return 'production' === self::type();
	}

	/**
	 * Translated name of an environment type.
	 *
	 * @since 1.0.0
	 * @param string $type Type.
	 * @return string
	 */
	public static function label( string $type ): string {
		$labels = array(
			'local'       => __( 'local', 'admin-powerups-for-woocommerce' ),
			'development' => __( 'development', 'admin-powerups-for-woocommerce' ),
			'staging'     => __( 'staging', 'admin-powerups-for-woocommerce' ),
			'production'  => __( 'production', 'admin-powerups-for-woocommerce' ),
		);
		return $labels[ $type ] ?? $labels['production'];
	}
}