Index

  1. \SetaPDF
    1. Core
    2. Core
      1. Writer
      2. Writer
        1. AbstractWriter
        2. Binary
        3. Chain
        4. CopyStreamInterface
        5. Echo
        6. Exception
        7. File
        8. FileInterface
        9. Http
        10. HttpStream
        11. Stream
        12. String
        13. TempFile
        14. TempStream
        15. Var
        16. WriterInterface

SetaPDF_Core_Writer_TempFile A writer class for temporary files

File: /SetaPDF v2/Core/Writer/TempFile.php

Class hierarchy

Implements

Summary

Static Methods

Static Properties

Methods

Properties

Static Properties

$_filePrefix

static protected string SetaPDF_Core_Writer_TempFile::$_filePrefix = '.htSetaPDF'

The file prefix for the temporary files

$_keepFile

static protected bool SetaPDF_Core_Writer_TempFile::$_keepFile = false

Defines if the temporary file should be deleted in the destruct method or not

$_tempDir

static protected string|null SetaPDF_Core_Writer_TempFile::$_tempDir

A temporary directory path

$tempWriters

static public array SetaPDF_Core_Writer_TempFile::$tempWriters = array()

Temporary file writers.


Properties

$_writer

protected SetaPDF_Core_Writer_File SetaPDF_Core_Writer_TempFile::$_writer

The internal file writer instance.


Static Methods

createTempFile()

public static SetaPDF_Core_Writer_TempFile::createTempFile (
string $content
): string

Creates a temporary file and returns the temporary path to it.

Parameters
$content : string
 

createTempPath()

public static SetaPDF_Core_Writer_TempFile::createTempPath (
[ null $tempDir = null [, null $filePrefix = null ]]
): string

Creates a temporary path.

If a parameters is left, the static class method (getTempDir() or getFilePrefix()) will be used to resolve the desired data.

Parameters
$tempDir : null
 
$filePrefix : null
 
Exceptions

Throws InvalidArgumentException

getFilePrefix()

public static SetaPDF_Core_Writer_TempFile::getFilePrefix (
void
): string

Get the file prefix for temporary files.

getKeepFile()

public static SetaPDF_Core_Writer_TempFile::getKeepFile (
void
): bool

Get whether files should be kept or deleted automatically when an instance is destructed.

getTempDir()

public static SetaPDF_Core_Writer_TempFile::getTempDir (
void
): null|string

Get the current temporary directory path.

setFilePrefix()

public static SetaPDF_Core_Writer_TempFile::setFilePrefix (
string $filePrefix
): void

Set the file prefix for temporary files.

Parameters
$filePrefix : string
 

setKeepFile()

public static SetaPDF_Core_Writer_TempFile::setKeepFile (
bool $keepFile
): void

Set whether files should be kept or deleted automatically when an instance is destructed.

Parameters
$keepFile : bool
 

setTempDir()

public static SetaPDF_Core_Writer_TempFile::setTempDir (
null|string $tempDir
): void

Set the temporary directory path.

Parameters
$tempDir : null|string
 
Exceptions

Throws InvalidArgumentException


Methods

__construct()

public SetaPDF_Core_Writer_TempFile::__construct (
[ null $tempDir = null [, null $filePrefix = null ]]
)

The constructor.

Parameters
$tempDir : null
 
$filePrefix : null
 

__destruct()

public SetaPDF_Core_Writer_TempFile::__destruct (
void
): void

The destructor.

This method deletes the temporary file. This behavior could be controlled by the setKeepFile()-method.

cleanUp()

public SetaPDF_Core_Writer_TempFile::cleanUp (
void
): void

Proxy method.

See

copyStream()

public SetaPDF_Core_Writer_TempFile::copyStream (
resource|SetaPDF_Core_Writer_Stream $source
): void

Copies an existing stream into the target stream.

Parameters
$source : resource|SetaPDF_Core_Writer_Stream
 

finish()

public SetaPDF_Core_Writer_TempFile::finish (
void
): void

Proxy method.

See

getPath()

public SetaPDF_Core_Writer_TempFile::getPath (
void
): string

Get the path of the temporary file.

getPos()

public SetaPDF_Core_Writer_TempFile::getPos (
void
): int

Proxy method.

See

getStatus()

public SetaPDF_Core_Writer_TempFile::getStatus (
void
): int|string

Proxy method.

See

start()

public SetaPDF_Core_Writer_TempFile::start (
void
): void

Proxy method.

See

write()

public SetaPDF_Core_Writer_TempFile::write (
string $s
): void

Proxy method.

Parameters
$s : string
 
See

© 2024 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)