BackupFileReadableInterface.php in Backup and Migrate 8.4

Namespace

BackupMigrate\Core\File

File

lib/backup_migrate_core/src/File/BackupFileReadableInterface.php

<?php

namespace BackupMigrate\Core\File;


/**
 * Provides a service to provision temp files in the correct place for the environment.
 */
interface BackupFileReadableInterface extends BackupFileInterface {

  /**
   * A path or stream that can be used in php file functions.
   *
   * @return string
   */
  public function realpath();

  /**
   * Read a given number of bytes from the file.
   *
   * @param int $size The number of bites to read
   *
   * @return string The data read from the file or NULL if the file can't be read or is at the end of the file.
   */
  public function readBytes($size = 0);

  /**
   * Read a single line from the file.
   *
   * @return string The data read from the file or NULL if the file can't be read or is at the end of the file.
   */
  public function readLine();

  /**
   * Read a line from the file.
   *
   * @return string The data read from the file or NULL if the file can't be read.
   */
  public function readAll();

  /**
   * Open a file for reading or writing.
   *
   * @param bool $binary If true open as a binary file
   */
  public function openForRead($binary = FALSE);

  /**
   * Close a file when we're done reading/writing.
   */
  public function close();

  /**
   * Move the file pointer forward a given number of bytes.
   *
   * @param int $bytes
   *
   * @return int
   *  The number of bytes moved or -1 if the operation failed.
   */
  public function seekBytes($bytes);

  /**
   * Rewind the file handle to the start of the file.
   */
  public function rewind();

}

Interfaces

Name	Description
BackupFileReadableInterface	Provides a service to provision temp files in the correct place for the environment.