asda2432es

✏️ Editing: class-recalibration-beta.php

<?php
/**
 * WPSEO plugin file.
 *
 * @package WPSEO\Admin
 * @since   9.3.0
 */

// Mark this file as deprecated.
_deprecated_file( __FILE__, 'WPSEO 10.0' );

/**
 * Holds the logic for the recalibration beta.
 *
 * @codeCoverageIgnore Ignore, because this class has been deprecated.
 *
 * @deprecated 10.0
 */
class WPSEO_Recalibration_Beta implements WPSEO_WordPress_Integration {

/**
	 * Name of the options.
	 *
	 * @var string
	 */
	protected $option_name = 'recalibration_beta';

/**
	 * The read more URL.
	 *
	 * @var string
	 */
	protected $read_more_url = 'https://yoa.st/recalibration-beta-explanation';

/**
	 * The class constructor.
	 *
	 * @deprecated 10.0
	 *
	 * @codeCoverageIgnore
	 */
	public function __construct() {
		_deprecated_function( __METHOD__, '10.0' );
	}

/**
	 * Shows the feature toggle.
	 *
	 * @codeCoverageIgnore Reason: most output is html.
	 *
	 * @return void
	 */
	public function show_feature_toggle() {
		// If the recalibration beta has been disabled you will no longer be able to enable it.
		// See https://github.com/Yoast/wordpress-seo/issues/12183.
		if ( ! self::is_enabled() ) {
			return;
		}

$values = [
			'on'  => __( 'On', 'wordpress-seo' ),
			'off' => __( 'Off', 'wordpress-seo' ),
		];

echo '<div class="switch-container">';
		echo '<fieldset id="', esc_attr( $this->option_name ), '" class="fieldset-switch-toggle">';
		echo '<legend><strong>', esc_html__( 'Get an even better analysis', 'wordpress-seo' ), '</strong></legend>';
		echo '<p class="clear">';
		printf(
			/* translators: 1: link opening tag, 2: link closing tag, 3: strong opening tag, 4: strong closing tag */
			esc_html__(
				'We have %1$srecalibrated our analysis%2$s. With the new analysis, we will get even closer to how Google sees your website. It would be %3$sawesome%4$s if you would like to %3$sbeta test this feature%4$s for us!',
				'wordpress-seo'
			),
			'<a href="' . esc_url( WPSEO_Shortlinker::get( $this->read_more_url ) ) . '" target="_blank">',
			'</a>',
			'<strong>',
			'</strong>'
		);
		echo '</p>';

echo '<div class="switch-toggle switch-candy switch-yoast-seo">';

foreach ( $values as $key => $value ) {
			printf(
				'<input type="radio" id="%1$s" name="%2$s" value="%3$s" %4$s /><label for="%1$s">%5$s</label>',
				esc_attr( $this->option_name . '-' . $key ),
				'wpseo[' . esc_attr( $this->option_name ) . ']',
				esc_attr( $key ),
				checked( $this->get_option_value( self::is_enabled() ), esc_attr( $key ), false ),
				esc_html( $value )
			);
		}
		echo '<a></a></div>';

echo '<p class="clear"><br/>';
		esc_html_e(
			'Simply switch the toggle to "on" and you\'ll be able to use the recalibrated analysis. At the same time, we\'ll add you to our specific mailing list. We\'ll only email you about your experiences with this recalibration!',
			'wordpress-seo'
		);
		echo '</p>';
		echo '</fieldset><div class="clear"></div></div>' . PHP_EOL . PHP_EOL;
	}

/**
	 * Registers the hook to catch option change.
	 *
	 * @codeCoverageIgnore Reason: because it calls a WordPress function.
	 *
	 * @return void
	 */
	public function register_hooks() {
		add_action( 'update_option_wpseo', [ $this, 'update_option' ], 10, 2 );
	}

/**
	 * Compares the logic between old and new option value and send the request.
	 *
	 * @param mixed $old_value The old option value.
	 * @param mixed $new_value The new option value.
	 *
	 * @return void
	 */
	public function update_option( $old_value, $new_value ) {
		$old_option_value = false;
		if ( isset( $old_value[ $this->option_name ] ) ) {
			$old_option_value = $old_value[ $this->option_name ];
		}

$new_option_value = false;
		if ( isset( $new_value[ $this->option_name ] ) ) {
			$new_option_value = $new_value[ $this->option_name ];
		}

if ( $old_option_value === $new_option_value ) {
			return;
		}

if ( $new_option_value === true ) {
			$this->subscribe_newsletter();
		}
	}

/**
	 * Checks if the recalibration beta has been enabled.
	 *
	 * @codeCoverageIgnore Reason: It calls a dependency.
	 *
	 * @return bool True whether the beta has been enabled.
	 */
	public static function is_enabled() {
		return WPSEO_Options::get( 'recalibration_beta' );
	}

/**
	 * Checks if the user has a mailinglist subscription.
	 *
	 * @codeCoverageIgnore Reason: because it calls a WordPress function.
	 *
	 * The mailinglist subscription value will set to true when the beta is set
	 * to enabled. This value stays true, so it's a good indicator that the user
	 * tried the beta.
	 *
	 * @return bool True whether the user has a subscription.
	 */
	public function has_mailinglist_subscription() {
		return (bool) get_option( 'wpseo_recalibration_beta_mailinglist_subscription', false );
	}

/**
	 * Retrieves the option value based on the current setting.
	 *
	 * @param bool $is_enabled Is the option enabled.
	 *
	 * @return string On when is enabled, off when not.
	 */
	protected function get_option_value( $is_enabled ) {
		if ( $is_enabled === true ) {
			return 'on';
		}

return 'off';
	}

/**
	 * Subscribes to the newsletter.
	 *
	 * @return void
	 */
	protected function subscribe_newsletter() {
		if ( $this->has_mailinglist_subscription() ) {
			return;
		}

try {
			$this->do_request(
				'https://my.yoast.com/api/customers/newsletter/recalibration/subscribe',
				[
					'email'     => get_option( 'admin_email' ),
					'firstName' => get_option( 'blogname' ),
					'lastName'  => '',
				]
			);

$this->set_mailinglist_subscription();
		}
		catch ( Requests_Exception_HTTP $e ) {
			// Intentionally left blank. @todo We should offer this to a logger.
			return;
		}
	}

/**
	 * Performs a request to the given url.
	 *
	 * @codeCoverageIgnore Reason: because it contains WordPress functions.
	 *
	 * @param string $url  The request url.
	 * @param array  $body The request body.
	 *
	 * @return void
	 *
	 * @throws Requests_Exception_HTTP When request has failed.
	 */
	protected function do_request( $url, $body ) {
		$response = wp_remote_post(
			$url,
			[
				'body' => $body,
			]
		);

if ( is_wp_error( $response ) ) {
			throw new Requests_Exception_HTTP( $response->get_error_message() );
		}
	}

/**
	 * Sets the mailing list subscription value to true.
	 *
	 * @codeCoverageIgnore Reason: because it calls a WordPress function.
	 *
	 * @return void
	 */
	protected function set_mailinglist_subscription() {
		update_option( 'wpseo_recalibration_beta_mailinglist_subscription', true );
	}
}

Ubuntu

Sid Gifari From Gifari Industries - BD Cyber Security Team