BackupFile.php in Backup and Migrate 8.4

Namespace

BackupMigrate\Core\File

File

lib/backup_migrate_core/src/File/BackupFile.php

<?php

namespace BackupMigrate\Core\File;

use BackupMigrate\Core\File\BackupFileInterface;

/**
 * Class BackupFile.
 *
 * @package BackupMigrate\Core\File
 */
class BackupFile implements BackupFileInterface {

  /**
   * The file info (size, timestamp, etc.).
   *
   * @var array
   */
  protected $file_info;

  /**
   * The file path.
   *
   * @var string
   */
  protected $path;

  /**
   * The file name without extension.
   *
   * @var string
   */
  protected $name;

  /**
   * The file extension(s).
   *
   * @var array
   */
  protected $ext;

  /**
   * The file's metadata.
   *
   * @var array A key/value associative array of metadata.
   */
  protected $metadata;

  /**
   * Get a metadata value.
   *
   * @param string $key The key for the metadata item.
   *
   * @return mixed The value of the metadata for this file.
   */
  public function getMeta($key) {
    return isset($this->metadata[$key]) ? $this->metadata[$key] : NULL;
  }

  /**
   * Set a metadata value.
   *
   * @param string $key The key for the metadata item.
   * @param mixed $value The value for the metadata item.
   */
  public function setMeta($key, $value) {
    $this->metadata[$key] = $value;
  }

  /**
   * Set a metadata value.
   *
   * @param array $values An array of key-value pairs for the file metadata.
   */
  public function setMetaMultiple($values) {
    foreach ((array) $values as $key => $value) {
      $this
        ->setMeta($key, $value);
    }
  }

  /**
   * Get all metadata.
   *
   * @param array $values An array of key-value pairs for the file metadata.
   *
   * @return array
   */
  public function getMetaAll() {
    return $this->metadata;
  }

  /**
   * {@inheritdoc}
   */
  public function setName($name) {
    $this->name = $name;
  }

  /**
   * {@inheritdoc}
   */
  public function getName() {
    return $this->name;
  }

  /**
   * {@inheritdoc}
   */
  public function getFullName() {
    return rtrim($this->name . '.' . implode('.', $this
      ->getExtList()));
  }

  /**
   * {@inheritdoc}
   */
  public function setFullName($fullname) {

    // Break the file name into name and extension array.
    $parts = explode('.', $fullname);
    $this
      ->setName(array_shift($parts));
    $this
      ->setExtList($parts);
  }

  /**
   * {@inheritdoc}
   */
  public function getExtList() {
    return $this->ext;
  }

  /**
   * {@inheritdoc}
   */
  public function getExtLast() {
    return end($this->ext);
  }

  /**
   * {@inheritdoc}
   */
  public function getExt() {
    return implode('.', $this
      ->getExtList());
  }

  /**
   * @param array $ext
   *  The list of file extensions for the file*  The list of file extensions for the file
   */
  public function setExtList($ext) {
    $this->ext = array_filter($ext);
  }

}

Classes

Name	Description
BackupFile	Class BackupFile.