Index

  1. \SetaPDF
      1. Core
      2. Core
        1. Writer
        2. Writer
            1. AbstractWriter
            2. Binary
            3. Chain
            4. Echo
            5. Exception
            6. File
            7. FileInterface
            8. Http
            9. HttpStream
            10. String
            11. TempFile
            12. Var
            13. 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 null|resource SetaPDF_Core_Writer_File::$_handle

The file handle 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

cleanUp()

public SetaPDF_Core_Writer_File::cleanUp (
void
): void

Close the file handle if needed.

See

copy()

public SetaPDF_Core_Writer_File::copy (
resource $source
): void

Copies an existing file into the target file and resets the file handle to the end of the file.

Parameters
$source : resource
 

finish()

public SetaPDF_Core_Writer_File::finish (
void
): void

This method is called when the writing process is finished.

It closes the file handle.

getPath()

public SetaPDF_Core_Writer_File::getPath (
void
): string

Get the file path of the writer.

getPos()

public SetaPDF_Core_Writer_File::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_File::write (
string $s
): void

Write the content to the output file.

Parameters
$s : string