<?php
/**
 * Migrations: Bulk Migration
 *
 * Runs a migration against a predefined set of data one time.
 *
 * @package SimplePay\Core\Utils\Migrations
 * @copyright Copyright (c) 2021, Sandhills Development, LLC
 * @license http://opensource.org/licenses/gpl-2.0.php GNU Public License
 * @since 4.1.0
 */

namespace SimplePay\Core\Utils\Migrations;

use SimplePay\Core\Utils;

if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

/**
 * Bulk_Migration class.
 *
 * @since 4.1.0
 */
class Bulk_Migration extends Migration {

	/**
	 * Migration runs automatically.
	 *
	 * @since 4.1.0
	 * @var bool
	 */
	public $automatic;

	/**
	 * Constructs the migration.
	 *
	 * @since 4.1.0
	 *
	 * @param array $args {
	 *   Setting section configuration.
	 *
	 *   @type bool $automatic If the migration can run automatically. Default false.
	 * }
	 */
	public function __construct( $args ) {
		$defaults = array(
			'automatic' => false,
		);

		// Automatic.
		$this->automatic = (bool) $args['automatic'];

		parent::__construct( $args );
	}

	/**
	 * Runs the migration.
	 *
	 * @since 4.1.0
	 */
	public function run() {
		_doing_it_wrong(
			__METHOD__,
			__( 'Migrations must implement their own <code>run</code> task', 'simple-pay' ),
			''
		);
	}

	/**
	 * Determines if the migration has been previously completed.
	 *
	 * @since 4.1.0
	 *
	 * @return bool
	 */
	public function is_complete() {
		$completed_migrations = get_option( 'simpay_completed_migrations', array() );

		return isset( $completed_migrations[ $this->id ] );
	}

	/**
	 * Marks an upgrade as completed.
	 *
	 * @since 4.1.0
	 */
	public function complete() {
		$completed_upgrades = get_option( 'simpay_completed_migrations', array() );

		update_option(
			'simpay_completed_migrations',
			array_merge(
				array(
					$this->id => true,
				),
				$completed_upgrades
			)
		);
	}

}