cs278/mktemp

Create temporary files and directories using PHP safely.

v1.3.0 2023-09-21 14:39 UTC

Requires

• php: ^5.3.3 || ^7 || ^8

Requires (Dev)

• bamarni/composer-bin-plugin: ^1.3.0
• symfony/phpunit-bridge: 5.2.* || ^6.3

MIT

• Chris Smith

README

Create temporary files and directories in PHP, safely.

Sadly PHP is deficient when it comes to creating temporary files and directories in a safe and secure manner. This library aims to address these short-comings.

Usage

Functions

• Cs278\Mktemp\temporaryFile(string|null $template, string|null $dir)

  Create a temporary file with a supplied template for the name.

  The template should be a string containing a sequence of at least 3 consecutive X characters, these characters will be replaced with a random component. The last valid sequence in the string will be used. If this argument is null a default tmp.XXXXXX template will be used.

  The directory should be a path that exists and the user can write to, if this argument is not supplied the default temporary directory will be used.

  A Cs278\Mktemp\Exception\CreateFailedException will be thrown if a file cannot be created.

  use function Cs278\Mktemp\temporaryFile;
  
  var_dump(temporaryFile());
  // /tmp/tmp.P9aLnd
  var_dump(temporaryFile('output.XXXX.pdf'));
  // /tmp/output.oI7b.pdf
  var_dump(temporaryFile(null, '/var/tmp'));
  // /var/tmp/tmp.8uJx
  var_dump(temporaryFile('test.XXX.html', '/var/tmp'));
  // /var/tmp/test.9h2.html

• Cs278\Mktemp\temporaryDir(string|null $template, string|null $dir)

  Create a temporary directory with a supplied template for the name.

  The template should be a string containing a sequence of at least 3 consecutive X characters, these characters will be replaced with a random component. The last valid sequence in the string will be used. If this argument is null a default tmp.XXXXXX template will be used.

  The directory should be a path that exists and the user can write to, if this argument is not supplied the default temporary directory will be used.

  A Cs278\Mktemp\Exception\CreateFailedException will be thrown if a directory cannot be created.

  use function Cs278\Mktemp\temporaryDir;
  
  var_dump(temporaryDir());
  // /tmp/tmp.P9aLnd
  var_dump(temporaryDir('output.XXXX.pdf'));
  // /tmp/output.oI7b.pdf
  var_dump(temporaryDir(null, '/var/tmp'));
  // /var/tmp/tmp.8uJx
  var_dump(temporaryDir('test.XXX.html', '/var/tmp'));
  // /var/tmp/test.9h2.html

Cs278\Mktemp\TempFile

• TempFile::__construct(string|null $template, string|null $dir)

  Create a temporary file object that manages the life cycle of the file system entity.

  Arguments are the same as those documented for temporaryFile().

• TempFile::getPath()

  Return the path to the temporary file, this is mainly intended to be used when interacting with the file outside of PHP.

• TempFile::open(string $mode)

  Open the file for reading/writing according to the supplied mode, defaults to r+. Returns an \SplFileObject that maybe used to manipulate the contents of the temporary file.

• TempFile::keep(string $newPath)

  Persist the temporary file into permanent file at the path specified, returns a new \SplFileInfo representing the new file.

• TempFile::copyTo(resource $stream)

  Copy the contents of the file into the supplied stream.

• TempFile::release()

  Removes the temporary file from disk.