DebugDestination.php in Backup and Migrate 8.4

Namespace

BackupMigrate\Core\Destination

File

lib/backup_migrate_core/src/Destination/DebugDestination.php

<?php

namespace BackupMigrate\Core\Destination;

use BackupMigrate\Core\Config\Config;
use BackupMigrate\Core\File\BackupFileReadableInterface;
use BackupMigrate\Core\Plugin\PluginCallerInterface;

/**
 * Class DebugDestination.
 *
 * @package BackupMigrate\Core\Destination
 */
class DebugDestination extends StreamDestination implements WritableDestinationInterface {

  /**
   * {@inheritdoc}
   */
  function saveFile(BackupFileReadableInterface $file) {

    // Quick and dirty way to html format this output.
    if ($this
      ->confGet('format') == 'html') {
      print '<pre>';
    }

    // Output the metadata.
    if ($this
      ->confGet('showmeta')) {
      print "---------------------\n";
      print "Metadata: \n";
      print_r($file
        ->getMetaAll());
      print "---------------------\n";
    }

    // Output the body.
    if ($this
      ->confGet('showbody')) {
      print "---------------------\n";
      print "Body: \n";
      $max = $this
        ->confGet('maxbody');
      $chunk = min($max, 1024);
      if ($file
        ->openForRead()) {

        // Transfer file in 1024 byte chunks to save memory usage.
        while ($max > 0 && ($data = $file
          ->readBytes($chunk))) {
          print $data;
          $max -= $chunk;
        }
        $file
          ->close();
      }
      print "---------------------\n";
    }

    // Quick and dirty way to html format this output.
    if ($this
      ->confGet('format') == 'html') {
      print '</pre>';
    }
    exit;
  }

  /**
   * Get the default values for the plugin.
   *
   * @return \BackupMigrate\Core\Config\Config
   */
  public function configDefaults() {
    return new Config([
      'showmeta' => TRUE,
      'showbody' => TRUE,
      'maxbody' => 1024 * 16,
      'format' => 'text',
    ]);
  }

}

Classes

Name	Description
DebugDestination	Class DebugDestination.