- File: UpgradeBase.php
- Full Path: /home/matthif/www/wp-content/plugins/wpforms-lite/src/Migrations/UpgradeBase.php
- Date Modified: 02/16/2024 11:45 AM
- File size: 2.43 KB
- MIME-type: text/x-php
- Charset: utf-8
<?php
// phpcs:disable Generic.Commenting.DocComment.MissingShort
/** @noinspection PhpExpressionResultUnusedInspection */
/** @noinspection PhpPropertyOnlyWrittenInspection */
/** @noinspection UnusedConstructorDependenciesInspection */
/** @noinspection PhpUnusedAliasInspection */
// phpcs:enable Generic.Commenting.DocComment.MissingShort
namespace WPForms\Migrations;
// phpcs:disable WPForms.PHP.UseStatement.UnusedUseStatement
use WPForms\Migrations\Migrations;
use WPForms\Pro\Migrations\Migrations as MigrationsPro;
// phpcs:enable WPForms.PHP.UseStatement.UnusedUseStatement
/**
* Class UpgradeBase contains both Lite and Pro plugin upgrade methods.
*
* @since 1.7.5
*/
abstract class UpgradeBase {
/**
* Migration class instance.
*
* @since 1.7.5
*
* @var Migrations|MigrationsPro
*/
protected $migrations;
/**
* Primary class constructor.
*
* @since 1.7.5
*
* @param Migrations|MigrationsPro $migrations Instance of Migrations class.
*/
public function __construct( $migrations ) {
$this->migrations = $migrations;
}
/**
* Run upgrade.
*
* @since 1.7.5
*
* @return bool|null Upgrade result:
* true - the upgrade completed successfully,
* false - in the case of failure,
* null - upgrade started but not yet finished (background task).
*/
abstract public function run();
/**
* Run the async upgrade via Action Scheduler (AS) task.
* The AS task has to support STATUS option with START, IN_PROGRESS, and COMPLETED values.
* Also, the AS task must have the init() method.
*
* @since 1.7.5
*
* @param string $class Classname of async AS task.
*
* @return bool|null Upgrade result:
* true - the upgrade completed successfully,
* false - in the case of failure,
* null - upgrade started but not yet finished (background task).
*/
protected function run_async( $class ) { // phpcs:ignore WPForms.PHP.HooksMethod.InvalidPlaceForAddingHooks
$status = get_option( $class::STATUS );
if ( $status === $class::COMPLETED ) {
delete_option( $class::STATUS );
return true;
}
if ( ! $status ) {
update_option( $class::STATUS, $class::START );
}
// Class Tasks does not exist at this point, so we have to add an action on init.
add_action(
'init',
static function () use ( $class ) {
( new $class() )->init();
},
PHP_INT_MAX
);
return null;
}
}