Interface FileInterface in namespace setasign\SetaPDF2\Core\Writer in SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Core
  1. Writer

setasign\SetaPDF2\Core\Writer

FileInterface An interface for writer classes which work with files.

File: /SetaPDF v2/Core/Writer/FileInterface.php
Old class name (alias): \SetaPDF_Core_Writer_FileInterface

Implemented in

Implements

Summary

Methods

cleanUp()

abstract public WriterInterface::cleanUp (

void

): void

Method called if a documents cleanUp-method is called.

finish()

abstract public WriterInterface::finish (

void

): void

This method is called when the writing process is finished.

It could close a file handle for example or send headers and flush a buffer.

getPath()

abstract public FileInterface::getPath (

void

): string

Get the path of the file.

getPos()

abstract public WriterInterface::getPos (

void

): int

Gets the current position/offset.

getStatus()

abstract public WriterInterface::getStatus (

void

): int

Get the current writer status.

See

Writer

start()

abstract public WriterInterface::start (

void

): void

Method called when the writing process starts.

This method could send for example headers.

write()

abstract public WriteInterface::write (

string $bytes

): void

Writes bytes to the output.

Parameters

$bytes : string