Wordlift\Tasks\Task_Ajax_Progress

Complexity

Total Complexity

4

Size/Duplication

Total Lines	83
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	set_count()	0	7	1
A	set_progress()	0	3	1
A	finish()	0	9	1

<?php
/**
 * This file defines a class which implements a progress tracker for ajax calls, i.e. the ajax client
 * receives the updates and sends new calls to proceed forward.
 *
 * @since 1.0.0
 * @package Wordlift_Framework\Tasks
 */

namespace Wordlift\Tasks;

use Wordlift_Log_Service;

/**
 * Define the Task_Ajax_Progress class.
 *
 * @since 1.0.0
 */
class Task_Ajax_Progress implements Task_Progress {

	/**
	 * The AJAX action, used to generate new nonces.
	 *
	 * @since 1.0.0
	 * @access private
	 * @var string $action The AJAX action.
	 */
	private $action;

	/**
	 * The total number of items to process.
	 *
	 * @since 1.0.0
	 * @access private
	 * @var int The total number of items to process.
	 */
	private $count;

	/**
	 * The current item index.
	 *
	 * @since 1.0.0
	 * @access private
	 * @var int $index The current item index.
	 */
	private $index;

	/**
	 * @var Wordlift_Log_Service
	 */
	private $log;

	/**
	 * Create a Task_Ajax_Progress instance with the specified
	 * AJAX action.
	 *
	 * @param string $action The AJAX action.
	 *
	 * @since 1.0.0
	 *
	 */
	public function __construct( $action ) {

		$this->log = Wordlift_Log_Service::get_logger( get_class() );

		$this->action = $action;

	}

	/**
	 * {@inheritDoc}
	 */
	function set_count( $value ) {

It is generally recommended to explicitly declare the visibility for methods.

		$this->log->debug( "New count $value for action $this->action..." );

		$this->count = $value;

	}

	/**
	 * {@inheritDoc}
	 */
	function set_progress( $index, $item ) {

It is generally recommended to explicitly declare the visibility for methods.

		$this->index = $index;
	}

	/**
	 * {@inheritDoc}
	 */
	function finish() {

It is generally recommended to explicitly declare the visibility for methods.

		wp_send_json_success( array(
			'count'    => $this->count,
			'index'    => $this->index,
			// $this->index is zero based.
			'complete' => $this->index >= $this->count - 1,
			'nonce'    => wp_create_nonce( $this->action ),
		) );
	}

}