EmailLog\Core\UI\Component\AddonController

Complexity

Total Complexity

13

Size/Duplication

Total Lines	151
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
B	render_addons()	0	17	5
A	render_addon()	0	23	1
A	render_addon_error()	0	10	1
A	render_page()	0	16	1
B	get_addons()	0	31	4

<?php namespace EmailLog\Core\UI\Component;

defined( 'ABSPATH' ) || exit; // Exit if accessed directly

/**
 * Create Addon list UI.
 *
 * Retrieve and render the Addons list.
 *
 * @since   2.0
 * @package EmailLog\Core\UI
 */
class AddonController {

	/**
	 * @var string Plugin basename.
	 */
	protected $plugin_dir_url;

	/**
	 * @var string Error message.
	 */
	protected $addon_error_message;

	/**
	 * @var const Cache expiration in hours.
	 */
	const CACHE_EXPIRE_IN_HRS = 12;

	/**
	 * Initialize the plugin.
	 */
	public function __construct( $file ) {
		$this->plugin_dir_url = plugin_dir_url( $file );
	}

	/**
	 * Retrieves and outputs the Addon list HTML.
	 *
	 * return array If API call fails, the array is empty, else contains the addons info.
	 */
	protected function get_addons() {
		$addons_result_array = array();

$addons_result_array is not used, you could remove the assignment.

		// Get Addons result array from Cache if available.
		if ( false === ( $addons_result_array =  get_transient( 'el_addons_result_array' ) ) ) {

			// The products endpoint does not need a key or token to render published products.
			// @todo: Change the API Url to get the actual addons.
			$response = wp_remote_get( 'http://local.wordpress.dev/edd-api/products/' );

			if ( is_wp_error( $response ) ) {
				/*
				 * @todo: The same error message is used twice in the class.
				 * Should we change this to a different one?
				 */
				$this->addon_error_message = __( 'We are not able to retrieve the add-on list now. Visit add-on page link to view the add-ons.', 'email-log' );
			} elseif ( is_array( $response ) ) {
				$body = wp_remote_retrieve_body( $response );
				// Convert the JSON response to array
				$addons_result_array = json_decode( $body, true );

				/*
				 * Cache Addons result for speed.
				 * Transient data other than string type are automatically serialized and deserialized.
				 * @link http://wordpress.stackexchange.com/a/123031/83739
				 */
				set_transient( 'el_addons_result_array', $addons_result_array, self::CACHE_EXPIRE_IN_HRS * HOUR_IN_SECONDS );
			}
		}
		return $addons_result_array;
	}

	/**
	 * Checks Addons result and handles errors.
	 *
	 * Invokes `render_addon()` if no errors.
	 *
	 * return void
	 */
	public function render_addons() {
		$addons_result_array = $this->get_addons();
		// Checks for any errors in the API call.
		if ( $this->addon_error_message != '' && empty( $addons_result_array ) ) {
			$this->render_addon_error();
		} elseif ( array_key_exists( 'products', $addons_result_array ) ) {
			// The array key is set by the EDD plugin
			$addons = $addons_result_array['products'];
			foreach ( $addons as $addon ) {
				$this->render_addon( $addon );
			}
		} else {
			// @todo: Include the addon page link
			$this->addon_error_message = __( 'We are not able to retrieve the add-on list now. Visit add-on page link to view the add-ons.', 'email-log' );
			$this->render_addon_error();
		}
	}

	/**
	 * Renders HTML of individual addon.
	 *
	 * return void
	 */
	public function render_addon( $addon ) {
		$addon_title       = __( $addon['info']['title'], 'email-log' );
		$addon_description = __( $addon['info']['excerpt'], 'email-log' );
		$addon_buy_button  = __( 'Gear up!', 'email-log');
		?>
		<div class="el-addon">
			<h3 class="el-addon-title">
				<?php echo $addon_title; ?>
			</h3>

			<a href="#" title="<?php echo $addon_title; ?>">
				<!-- @todo: Replace the thumbnail url from the $products array. -->
				<img src="<?php echo $addon['info']['thumbnail']; ?>" class="attachment-showcase wp-post-image" alt="<?php echo $addon_title; ?>" title="<?php echo $addon_title; ?>" />
			</a>

			<p>
				<?php echo $addon_description; ?>
			</p>

			<a href="#" class="button-secondary"><?php echo $addon_buy_button; ?></a>
		</div> <!-- .el-addon -->
		<?php
	}

	/**
	 * Render error in Addon page if any.
	 *
	 * return void
	 */
	public function render_addon_error() {
		?>
		<span class="el-addon-error">
			<?php
				// Error message set in render_addons() method.
				echo $this->addon_error_message;
			?>
		</span>
		<?php
	}

	/**
	 * Renders the HTML for the Addons page.
	 */
	public function render_page() {
		// Use Plugin version as CSS version to bust cache.
		$stylesheet_version = \EmailLog\Core\EmailLog::VERSION;

		// Enqueue the required styles
		wp_enqueue_style( 'el_addon_adm_pg', $this->plugin_dir_url . 'assets/css/admin/addon-list.css', array(), $stylesheet_version, 'all' );
	?>
		<p>
			<?php _e( 'These extensions <em><strong>add functionality</strong></em> to your existing Email logs.', 'email-log' ); ?>
		</p>
		<div class="el-container">
			<?php $this->render_addons(); ?>
			<div class="clear"></div>
		</div> <!-- .el-container -->
	<?php
	}
}