Class ChainWriter in namespace setasign\SetaPDF2\Core\Writer in SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Core
  1. Writer

setasign\SetaPDF2\Core\Writer

ChainWriter A writer class which chains different writer objects

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

Class hierarchy

AbstractWriter
- ChainWriter

Implements

Summary

Properties

$_status
$_writers

Properties

$_status

protected string AbstractWriter::$_status = 0

Status property

$_writers

protected WriterInterface[] ChainWriter::$_writers = array()

Writer instances

Methods

__construct()

public ChainWriter::__construct (

WriterInterface[] $writers = array ( )

)

The constructor.

Parameters

$writers : WriterInterface[]: An array of writer instances

addWriter()

public ChainWriter::addWriter (

WriterInterface $writer

): void

Add a writer object to the chain.

Parameters

$writer : WriterInterface

cleanUp()

public ChainWriter::cleanUp (

void

): void

Forwards the cleanUp() call to the registered writer objects.

See

AbstractWriter::cleanUp()

finish()

public ChainWriter::finish (

void

): void

Forward the finish() call to the registered writer objects.

getPos()

public ChainWriter::getPos (

void

): int

Proxy method for the getPos() method.

See

WriterInterface::getPos()

getStatus()

public AbstractWriter::getStatus (

void

): string

Get the current status of the writer object.

start()

public ChainWriter::start (

void

): void

Method which should/will be called when the writing process starts.

Exceptions

Throws Exception

write()

public ChainWriter::write (

string $s

): void

Forward the string to the registered writer objects.

Parameters

$s : string