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_File A writer class for files or writable streams

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

Class hierarchy

Implements

Summary

Methods

Properties

Properties

$_handle

protected resource SetaPDF_Core_Writer_Stream::$_handle

The file stream resource

$_path

protected string SetaPDF_Core_Writer_File::$_path

Path to the output file

$_status

protected string SetaPDF_Core_Writer_AbstractWriter::$_status = 0

Status property


Methods

__construct()

public SetaPDF_Core_Writer_File::__construct (
string $path
)

The constructor.

Parameters
$path : string

The path to the output file

_setHandle()

protected SetaPDF_Core_Writer_Stream::_setHandle (
resource $handle
): void

Set the stream handle.

Parameters
$handle : resource
 

cleanUp()

public SetaPDF_Core_Writer_File::cleanUp (
void
): void

Close the file handle if needed.

See

copy()

WARNING: This method is marked as deprecated!

Use copyStream() instead.

public SetaPDF_Core_Writer_Stream::copy (
resource|SetaPDF_Core_Writer_Stream $source
): void
Parameters
$source : resource|SetaPDF_Core_Writer_Stream
 

copyStream()

public SetaPDF_Core_Writer_Stream::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_File::finish (
void
): void

This method is called when the writing process is finished.

It closes the file handle.

getHandle()

public SetaPDF_Core_Writer_File::getHandle (
void
): resource|null

Get the stream handle.

getPath()

public SetaPDF_Core_Writer_File::getPath (
void
): string

Get the file path of the writer.

getPos()

public SetaPDF_Core_Writer_Stream::getPos (
void
): integer

Returns the current position of the output file.

getStatus()

public SetaPDF_Core_Writer_AbstractWriter::getStatus (
void
): string

Get the current status of the writer object.

start()

public SetaPDF_Core_Writer_File::start (
void
): void

Method called when the writing process starts.

It setups the file handle for this writer.

write()

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

Write the content to the output file.

Parameters
$s : string
 

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