<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Upgrade Registry

[2] Fix | Delete

*

[3] Fix | Delete

* @package PUM

[4] Fix | Delete

* @copyright Copyright (c) 2023, Code Atlantic LLC

[5] Fix | Delete

*/

[6] Fix | Delete

[7] Fix | Delete

if ( ! defined( 'ABSPATH' ) ) {

[8] Fix | Delete

exit;

[9] Fix | Delete

}

[10] Fix | Delete

[11] Fix | Delete

/**

[12] Fix | Delete

* Implements a registry for core upgrade routines.

[13] Fix | Delete

*

[14] Fix | Delete

* @since 1.7.0

[15] Fix | Delete

*

[16] Fix | Delete

* @see PUM_Batch_Process_Registry

[17] Fix | Delete

*/

[18] Fix | Delete

class PUM_Upgrade_Registry extends PUM_Batch_Process_Registry {

[19] Fix | Delete

[20] Fix | Delete

/**

[21] Fix | Delete

* @var string Currently installed version.

[22] Fix | Delete

*/

[23] Fix | Delete

public $version;

[24] Fix | Delete

[25] Fix | Delete

/**

[26] Fix | Delete

* @var string Upgraded from version.

[27] Fix | Delete

*/

[28] Fix | Delete

public $upgraded_from;

[29] Fix | Delete

[30] Fix | Delete

/**

[31] Fix | Delete

* @var string Initially installed version.

[32] Fix | Delete

*/

[33] Fix | Delete

public $initial_version;

[34] Fix | Delete

[35] Fix | Delete

/**

[36] Fix | Delete

* @var PUM_Upgrade_Registry

[37] Fix | Delete

*/

[38] Fix | Delete

public static $instance;

[39] Fix | Delete

[40] Fix | Delete

/**

[41] Fix | Delete

* @return PUM_Upgrade_Registry

[42] Fix | Delete

*/

[43] Fix | Delete

public static function instance() {

[44] Fix | Delete

if ( ! isset( self::$instance ) ) {

[45] Fix | Delete

self::$instance = new self();

[46] Fix | Delete

add_action( 'init', [ self::$instance, 'init' ], -9999 );

[47] Fix | Delete

}

[48] Fix | Delete

[49] Fix | Delete

return self::$instance;

[50] Fix | Delete

}

[51] Fix | Delete

[52] Fix | Delete

[53] Fix | Delete

/**

[54] Fix | Delete

* Initializes the upgrade registry.

[55] Fix | Delete

*/

[56] Fix | Delete

public function init() {

[57] Fix | Delete

$this->register_upgrades();

[58] Fix | Delete

[59] Fix | Delete

/**

[60] Fix | Delete

* Fires during instantiation of the batch processing registry.

[61] Fix | Delete

*

[62] Fix | Delete

* @param PUM_Upgrade_Registry $this PUM_Abstract_Registry instance.

[63] Fix | Delete

*/

[64] Fix | Delete

do_action( 'pum_upgrade_process_init', $this );

[65] Fix | Delete

}

[66] Fix | Delete

[67] Fix | Delete

/**

[68] Fix | Delete

* Registers upgrade routines.

[69] Fix | Delete

*

[70] Fix | Delete

* @see PUM_Utils_Upgrades::add_routine()

[71] Fix | Delete

*/

[72] Fix | Delete

private function register_upgrades() {

[73] Fix | Delete

/**

[74] Fix | Delete

* Fires during instantiation of the batch processing registry allowing proper registration of upgrades.

[75] Fix | Delete

*

[76] Fix | Delete

* @param PUM_Upgrade_Registry $this PUM_Abstract_Registry instance.

[77] Fix | Delete

*/

[78] Fix | Delete

do_action( 'pum_register_upgrades', $this );

[79] Fix | Delete

}

[80] Fix | Delete

[81] Fix | Delete

[82] Fix | Delete

/**

[83] Fix | Delete

* Adds an upgrade to the registry.

[84] Fix | Delete

*

[85] Fix | Delete

* @param int $upgrade_id upgrade ID.

[86] Fix | Delete

* @param array $attributes {

[87] Fix | Delete

* Upgrade attributes.

[88] Fix | Delete

*

[89] Fix | Delete

* @type string $class upgrade handler class.

[90] Fix | Delete

* @type string $file upgrade handler class file.

[91] Fix | Delete

* }

[92] Fix | Delete

*

[93] Fix | Delete

* @return true Always true.

[94] Fix | Delete

*/

[95] Fix | Delete

public function add_upgrade( $upgrade_id, $attributes ) {

[96] Fix | Delete

$attributes = wp_parse_args(

[97] Fix | Delete

$attributes,

[98] Fix | Delete

[

[99] Fix | Delete

'rules' => [],

[100] Fix | Delete

'class' => '',

[101] Fix | Delete

'file' => '',

[102] Fix | Delete

]

[103] Fix | Delete

);

[104] Fix | Delete

[105] Fix | Delete

// Log an error if it's too late to register the process.

[106] Fix | Delete

if ( did_action( 'pum_upgrade_process_init' ) ) {

[107] Fix | Delete

pum_log_message( sprintf( 'The %s upgrade process was registered too late. Registrations must occur while/before <code>pum_upgrade_process_init</code> fires.', esc_html( $upgrade_id ) ) );

[108] Fix | Delete

return false;

[109] Fix | Delete

}

[110] Fix | Delete

[111] Fix | Delete

return $this->register_process( $upgrade_id, $attributes );

[112] Fix | Delete

}

[113] Fix | Delete

[114] Fix | Delete

/**

[115] Fix | Delete

* Removes an upgrade from the registry by ID.

[116] Fix | Delete

*

[117] Fix | Delete

* @param string $upgrade_id upgrade ID.

[118] Fix | Delete

*/

[119] Fix | Delete

public function remove_upgrade( $upgrade_id ) {

[120] Fix | Delete

parent::remove_process( $upgrade_id );

[121] Fix | Delete

}

[122] Fix | Delete

[123] Fix | Delete

/**

[124] Fix | Delete

* Retrieves registered upgrades.

[125] Fix | Delete

*

[126] Fix | Delete

* @return array The list of registered upgrades.

[127] Fix | Delete

*/

[128] Fix | Delete

public function get_upgrades() {

[129] Fix | Delete

return parent::get_items();

[130] Fix | Delete

}

[131] Fix | Delete

[132] Fix | Delete

}

[133] Fix | Delete

[134] Fix | Delete