<?php if ( ! defined( 'ABSPATH' ) ) exit;
* Class NF_Updates_CacheCollateActions
* This class manages the step process of running through the CacheCollateActions required update.
* It will define an object to pull data from (if necessary) to pick back up if exited early.
* It will run an upgrade function to alter the nf3_actions and nf3_action_meta tables.
* Then, it will step over each form on the site, following this process:
* - Actions that exist in the data tables but not in the cache will be deleted.
* - Actions that exist in the cache but not in the data tables will be inserted.
* - Actions that exist in the data tables but have an incorrect form ID will be inserted as a new ID and referenced from the cache.
* - Actions that exist in both will be updated from the cache to ensure the data is correct.
* After completing the above for every form on the site, it will remove the data object that manages its location.
class NF_Updates_CacheCollateActions extends NF_Abstracts_RequiredUpdate
private $running = array();
* Stores information about the current form being processed.
* Stores the actions for the current form being processed.
* Associative array of actions keyed by action id.
private $actions_by_id = array();
* Non-associative array of action ids.
private $action_ids = array();
* Hard limit for the number of querys we run during a single step.
* Array of action ids that need an update.
private $update = array();
* List of setting keys we don't want to save in the database.
private $blacklist = array(
* The table names for our database queries.
* @param $data (Array) The data object passed in by the AJAX call.
* @param $running (Array) The array of required updates being run.
public function __construct( $data = array(), $running )
// Build our arguments array.
'slug' => 'CacheCollateActions',
'class_name' => 'NF_Updates_CacheCollateActions',
$this->running = $running;
// Call the parent constructor.
parent::__construct( $args );
$this->table = $this->db->prefix . 'nf3_actions';
$this->meta_table = $this->db->prefix . 'nf3_action_meta';
* Function to loop over the batch.
public function process()
// If we've not already started...
if ( ! isset( $this->running[ 0 ][ 'running' ] ) ) {
// Run our startup method.
* Get all of our database variables up and running.
* Sets up class vars that are used in subsequent methods.
* Update action values and meta if necessary.
$this->maybe_update_actions();
* Saves our current location, along with any processing data we may need for the next step.
* If we're done with our step, runs cleanup instead.
// Respond to the AJAX call.
* Function to run any setup steps necessary to begin processing.
public function startup()
// Record that we're processing the update.
$this->running[ 0 ][ 'running' ] = true;
// If we're not debugging...
// Ensure that our data tables are updated.
$this->migrate( 'cache_collate_actions' );
// Set out new db version.
update_option( 'ninja_forms_db_version', '1.2' );
// Get a list of our forms...
$sql = "SELECT ID FROM `{$this->db->prefix}nf3_forms`";
$forms = $this->db->get_results( $sql, 'ARRAY_A' );
$this->running[ 0 ][ 'forms' ] = $forms;
// Record the total number of steps in this batch.
$this->running[ 0 ][ 'steps' ] = count( $forms );
// Record our current step (defaulted to 0 here).
$this->running[ 0 ][ 'current' ] = 0;
* Setup our global variables used in other methods.
private function setup_vars()
// See which form we're currently working with.
$this->form = array_pop( $this->running[ 0 ][ 'forms' ] );
// Get the actions for that form.
$this->actions = Ninja_Forms()->form( $this->form[ 'ID' ] )->get_actions();
foreach ( $this->actions as $action ) {
// Add the ID to the list.
array_push( $this->action_ids, $action->get_id() );
$this->actions_by_id[ $action->get_id() ] = $action->get_settings();
// If we're continuing an old process...
if ( isset( $this->form[ 'update' ] ) ) {
// Fetch our remaining udpates.
$this->update = $this->form[ 'update' ];
} // Otherwise... (We're beginning a new process.)
// Copy all IDs to our update list.
$this->update = $this->action_ids;
* Function to cleanup any lingering temporary elements of a required update after completion.
public function cleanup()
// Remove the current process from the array.
array_shift( $this->running );
// Record to our updates setting that this update is complete.
$this->confirm_complete();
// If we have no updates left to process...
if ( empty( $this->running ) ) {
// Call the parent cleanup method.
* Check to see if we've locked processing.
* If we have, then we need to run this process again.
* If we haven't locked processing, prepare to end this process.
private function end_of_step()
// If we have locked processing...
if ( $this->lock_process ) {
// Record that we have more to do.
$this->form[ 'update' ] = $this->update;
array_push( $this->running[ 0 ][ 'forms' ], $this->form );
} // Otherwise... (Processing isn't locked.)
if ( ! empty( $this->action_ids ) ) {
$sql = "UPDATE `{$this->meta_table}` SET `meta_key` = `key` WHERE `parent_id` IN(" . implode( ',', $this->action_ids ) . ")";
* Update our form cache with any action changes.
$this->update_form_cache();
// Increment our step count.
$this->running[ 0 ][ 'current' ] = intval( $this->running[ 0 ][ 'current' ] ) +1;
// Prepare to output our number of steps and current step.
$this->response[ 'stepsTotal' ] = $this->running[ 0 ][ 'steps' ];
$this->response[ 'currentStep' ] = $this->running[ 0 ][ 'current' ];
// If we do not have locked processing...
if ( ! $this->lock_process ) {
// If all steps have been completed...
if ( empty( $this->running[ 0 ] [ 'forms' ] ) ) {
// Run our cleanup method.
// Record our current location in the process.
update_option( 'ninja_forms_doing_required_updates', $this->running );
// Prepare to output the number of updates remaining.
$this->response[ 'updatesRemaining' ] = count( $this->running );
* If we've made any changes to our form actions, update our form cache to match.
private function update_form_cache()
// Get the cache for that form.
$cache = WPN_Helper::get_nf_cache( $this->form[ 'ID' ] );
$cache[ 'actions' ] = array();
foreach ( $this->actions_by_id as $id => $settings ) {
// Append the settings for that action to the cache.
$action[ 'settings' ] = $settings;
array_push( $cache[ 'actions' ], $action );
// Save the cache, passing 2 as the current stage.
WPN_Helper::update_nf_cache( $this->form[ 'ID' ], $cache, 2 );
* Loop over all of our actions and update our database if necessary.
* Check each setting against $this->blacklist to make sure we want to insert that value.
private function maybe_update_actions()
// Declare placeholder values.
// While we have actions to update...
while ( 0 < count( $this->update ) ) {
// If we have hit our limit...
if ( 1 > $this->limit ) {
$this->lock_process = true;
// Get our action to be updated.
$action = array_pop( $this->update );
$settings = $this->actions_by_id[ $action ];
// Update the new label column.
array_push( $sub_sql, "WHEN `id` = " . intval( $action ) . " THEN '" . $this->prepare( $settings[ 'label' ] ) . "'" );
foreach ( $settings as $key => $setting ) {
// If the key is not blacklisted...
if ( ! in_array( $key, $this->blacklist ) ) {
// Add the value to be updated.
$action = intval( $action );
array_push( $meta_values, "WHEN `key` = '{$key}' AND `parent_id` = {$action} THEN '" . $this->prepare( $setting ) . "'" );
// If we've got updates to run...
if ( ! empty( $sub_sql ) ) {
// Update our actions table.
$sql = "UPDATE `{$this->table}` SET `label` = CASE " . implode ( ' ', $sub_sql ) . " ELSE `label` END;";
// Update our meta values.
$sql = "UPDATE `{$this->meta_table}` SET `meta_value` = CASE " . implode( ' ', $meta_values ) . " ELSE `meta_value` END;";
It is recommended that you Edit text format, this type of Fix handles quite a lot in one request
