public function EntityUpdatesCommands::entityUpdates in Entity Update 2.0.x

Apply pending entity schema updates.

@command entity-update @aliases upe

@option show Show entities to update @option basic Update all entities as basic way @option force Try force update @option all Update all Entities @option nobackup Disable automatic full database backup (Not recommended) @option clean Cleanup entity backup database @option bkpdel Copy entities to update in to backup database and delete entities @option rescue Create entities from entity backup database @option cache-clear Set to 0 to suppress normal cache clearing; the caller should then clear if needed.

@usage drush upe --show Show entities to update @usage drush upe --basic Update entities.Run this command if all entities to update are empty. Else Exception @usage drush upe --all Update entities with data. Run this command if any entity (to update) has data @usage drush upe --basic --nobackup Update all without automatic database backup @usage drush upe --basic --force --nobackup Try to update using basic method even having data @usage drush upe --all --nobackup Update all without automatic database backup (Not recommended) @usage drush upe --clean Cleanup entity backup database @usage drush upe --bkpdel Copy entities to update in to backup database and delete entities @usage drush upe --rescue If entity recreation failed, You can you this option to create entities from entity backup database @usage drush upe ENTITY_TYPE_ID --nobackup Update entity type ENTITY_TYPE_ID

@bootstrap full

Parameters

string $type: The entity type ID to update.

array $options: Array of options.

Throws

\Exception

File

src/Commands/EntityUpdatesCommands.php, line 102

Class

EntityUpdatesCommands

Drush9 commands definitions.

Namespace

Drupal\entity_update\Commands

Code

public function entityUpdates($type = NULL, array $options = [
  'cache-clear' => TRUE,
]) {

  // Show entities to update.
  if (!empty($options['show'])) {
    EntityCheck::showEntityStatusCli();
    return;
  }

  // Clean entity backup database.
  if (!empty($options['clean'])) {
    EntityUpdate::cleanupEntityBackup();
    $this
      ->say("Entity backup data removed.");
    return;
  }

  // Restore all entities from database.
  if (!empty($options['rescue'])) {
    if (drush_confirm('Are you sure you want create entities from backup database ? ')) {
      $res = EntityUpdate::entityUpdateDataRestore();
      $this
        ->say('End of entities recreate process : ' . ($res ? 'ok' : 'error'));
    }
    return;
  }

  // Check mandatory options.
  $options_mandatory = [
    'basic',
    'all',
    'bkpdel',
  ];
  if (!$type && !_drush_entity_update_checkoptions($options_mandatory)) {
    $this
      ->say('No option specified, please type "drush help upe" for help or refer to the documentation.: ' . 'cancel');
    return;
  }
  $this
    ->say(' - If you use this module, you are conscience what you are doing. You are the responsible of your work');
  $this
    ->say(' - Please backup your database before any action');
  $this
    ->say(' - Please Read the documentation before any action');
  $this
    ->say(' - Do not use this module on multi sites.');
  $this
    ->say(' - Before a new update, Remove old backuped data if any (Using : drush upe --clean).');

  // Backup database.
  if (!!empty($options['nobackup'])) {
    $db_backup_file = "backup_" . date("ymd-his") . ".sql.gz";
    $this
      ->say("Backup database to : {$db_backup_file}");
    $this
      ->say("To restore, run : gunzip < {$db_backup_file} | drush sqlc ");
    @exec('drush cr');
    @exec('drush sql-dump --gzip > ' . $db_backup_file);
  }

  // Basic entity update.
  if (!empty($options['basic'])) {
    if (drush_confirm('Are you sure you want update entities ?')) {
      $res = EntityUpdate::basicUpdate(!empty($options['force']));
      $this
        ->say('Basic entities update : ' . ($res ? 'ok' : 'error'));
    }
    return;
  }

  // Copy and delete entities.
  if (!empty($options['bkpdel'])) {
    if (drush_confirm('Are you sure you want copy entities to update in to backup database and delete entities ?')) {
      $res = EntityUpdate::entityUpdateDataBackupDel(EntityUpdate::getEntityTypesToUpdate($type), $type);
      $this
        ->say('End of entities copy and delete process : ' . ($res ? 'ok' : 'error'));
    }
    return;
  }

  // Update all entities.
  if (!empty($options['all'])) {
    if ($type) {
      $this
        ->say("The option --all and a type has specified, please remove a one. : " . 'cancel');
      return;
    }
    if (drush_confirm('Are you sure you want update all entities ?')) {
      $res = EntityUpdate::safeUpdateMain();
      $this
        ->say('End of entities update process', $res ? 'ok' : 'error');
    }

    // cache-clear.
    if (!empty($options['cache-clear'])) {
      $process = Drush::drush($this
        ->siteAliasManager()
        ->getSelf(), 'cache-rebuild');
      $process
        ->mustrun();
    }
    $this
      ->logger()
      ->success(dt('Finished performing updates.'));
    return;
  }
  elseif ($type) {

    // Update a selected entity type.
    try {
      if ($entity_type = entity_update_get_entity_type($type)) {

        // Update the entity type.
        $res = EntityUpdate::safeUpdateMain($entity_type);
        $this
          ->say('End of entities update process for : ' . $type . ' : ' . ($res ? 'ok' : 'error'));
        return;
      }
    } catch (Exception $e) {
      $this
        ->logger()
        ->error($e
        ->getMessage());
    }
    $this
      ->logger()
      ->error("Entity type update Error : {$type}");
    return;
  }
}