class TempFileManager in Backup and Migrate 5.0.x

@package Drupal\backup_migrate\Core\Services

Hierarchy

• class \Drupal\backup_migrate\Core\File\TempFileManager implements TempFileManagerInterface

2 files declare their use of TempFileManager

backup_migrate.module in ./backup_migrate.module

Primary hook implementations for Backup Migrate.

MySQLiSource.php in src/Core/Source/MySQLiSource.php

1 string reference to 'TempFileManager'

backup_migrate_backup_migrate_service_object_alter in ./backup_migrate.module

Implements hook_backup_migrate_service_object_alter().

File

src/Core/File/TempFileManager.php, line 10

Namespace

Drupal\backup_migrate\Core\File

class TempFileManager implements TempFileManagerInterface {

  /**
   * @var \Drupal\backup_migrate\Core\File\TempFileAdapterInterface
   */
  protected $adapter;

  /**
   * Build the manager with the given adapter.
   *
   * This manager needs the adapter to create the actual temp files.
   *
   * @param \Drupal\backup_migrate\Core\File\TempFileAdapterInterface $adapter
   */
  public function __construct(TempFileAdapterInterface $adapter) {
    $this->adapter = $adapter;
  }

  /**
   * Create a brand new temp file with the given extension (if specified).
   *
   * The new file should be writable.
   *
   * @param string $ext
   *   The file extension for this file (optional)
   *
   * @return BackupFileWritableInterface
   */
  public function create($ext = '') {
    $file = new WritableStreamBackupFile($this->adapter
      ->createTempFile($ext));
    $file
      ->setExtList(explode('.', $ext));
    return $file;
  }

  /**
   * Return a new file based on the passed in file with the given file ext.
   *
   * This should maintain the metadata of the file passed in with the new file
   * extension added after the old one.
   *
   * For example: xxx.mysql would become xxx.mysql.gz.
   *
   * @param \Drupal\backup_migrate\Core\File\BackupFileInterface $file
   *   The file to add the extension to.
   * @param $ext
   *   The new file extension.
   *
   * @return \Drupal\backup_migrate\Core\File\BackupFileWritableInterface
   *   A new writable backup file with the new extension and all of the metadata
   *   from the previous file.
   */
  public function pushExt(BackupFileInterface $file, $ext) {

    // Push the new extension on to the new file.
    $parts = $file
      ->getExtList();
    array_push($parts, $ext);
    $new_ext = implode('.', $parts);

    // Copy the file metadata to a new TempFile.
    $out = new WritableStreamBackupFile($this->adapter
      ->createTempFile($new_ext));

    // Copy the file metadata to a new TempFile.
    $out
      ->setMetaMultiple($file
      ->getMetaAll());
    $out
      ->setName($file
      ->getName());
    $out
      ->setExtList($parts);
    return $out;
  }

  /**
   * Return a new file based on the one passed in.
   *
   * Has the last part of the file extension removed.
   *
   * For example: xxx.mysql.gz would become xxx.mysql.
   *
   * @param \Drupal\backup_migrate\Core\File\BackupFileInterface $file
   *
   * @return \Drupal\backup_migrate\Core\File\BackupFileWritableInterface
   *   A new writable backup file with the last extension removed and
   *   all of the metadata from the previous file.
   */
  public function popExt(BackupFileInterface $file) {

    // Pop the last extension from the last of the file.
    $parts = $file
      ->getExtList();
    array_pop($parts);
    $new_ext = implode('.', $parts);

    // Create a new temp file with the new extension.
    $out = new WritableStreamBackupFile($this->adapter
      ->createTempFile($new_ext));

    // Copy the file metadata to a new TempFile.
    $out
      ->setMetaMultiple($file
      ->getMetaAll());
    $out
      ->setName($file
      ->getName());
    $out
      ->setExtList($parts);
    return $out;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
TempFileManager::$adapter	protected	property
TempFileManager::create	public	function	Create a brand new temp file with the given extension (if specified). Overrides TempFileManagerInterface::create
TempFileManager::popExt	public	function	Return a new file based on the one passed in. Overrides TempFileManagerInterface::popExt
TempFileManager::pushExt	public	function	Return a new file based on the passed in file with the given file ext. Overrides TempFileManagerInterface::pushExt
TempFileManager::__construct	public	function	Build the manager with the given adapter.