FileWriterStreamBuilder
in package
implements
FileWriterInterface, StreamBuilderStrategyInterface
FinalYes
Stream builder strategy for file writer result streams.
Tags
Table of Contents
Interfaces
- FileWriterInterface
- StreamBuilderStrategyInterface
Methods
- __construct() : mixed
- buildChunkWriter() : ChunkWriterInterface
- Create a chunk writer for this result.
- buildDOMWriter() : DOMWriterInterface
- Create a DOM writer for this result.
- buildFileWriter() : FileWriterInterface
- Create a file writer for this result.
- buildStreamCharset() : string
- Determine the character set of this result Returns a valid character set, or the empty string if not applicable.
- buildStreamFileName() : string
- Determine the filename of this result.
- buildStreamFileStatistics() : array<string|int, mixed>
- Determine all available stats of this resource, as a call to stat() would.
- buildStreamHash() : string
- Determine a hash for this resource, or the empty string if undeterminable
- buildStreamIsBufferable() : bool
- Determine whether or not intermediate filters are allowed to buffer this result, or should always flush immediately.
- buildStreamMimeType() : string
- Determine the mime type of this result.
- buildStreamWriter() : StreamWriterInterface
- Create a stream writer for this result.
- buildStringWriter() : StringWriterInterface
- toFile() : SplFileInfo
Methods
__construct()
public
__construct(FileWriterInterface $writer, string $fileName) : mixed
Parameters
- $writer : FileWriterInterface
- $fileName : string
buildChunkWriter()
Create a chunk writer for this result.
public
buildChunkWriter(ResultInterface $context) : ChunkWriterInterface
Parameters
- $context : ResultInterface
Return values
ChunkWriterInterfacebuildDOMWriter()
Create a DOM writer for this result.
public
buildDOMWriter(ResultInterface $context) : DOMWriterInterface
Parameters
- $context : ResultInterface
Return values
DOMWriterInterfacebuildFileWriter()
Create a file writer for this result.
public
buildFileWriter(ResultInterface $context) : FileWriterInterface
Parameters
- $context : ResultInterface
Return values
FileWriterInterfacebuildStreamCharset()
Determine the character set of this result Returns a valid character set, or the empty string if not applicable.
public
buildStreamCharset(ResultInterface $context) : string
Parameters
- $context : ResultInterface
Return values
stringbuildStreamFileName()
Determine the filename of this result.
public
buildStreamFileName(ResultInterface $context) : string
Parameters
- $context : ResultInterface
Return values
stringbuildStreamFileStatistics()
Determine all available stats of this resource, as a call to stat() would.
public
buildStreamFileStatistics(ResultInterface $context) : array<string|int, mixed>
Parameters
- $context : ResultInterface
Return values
array<string|int, mixed>buildStreamHash()
Determine a hash for this resource, or the empty string if undeterminable
public
buildStreamHash(ResultInterface $context) : string
Parameters
- $context : ResultInterface
Return values
stringbuildStreamIsBufferable()
Determine whether or not intermediate filters are allowed to buffer this result, or should always flush immediately.
public
buildStreamIsBufferable(ResultInterface $context) : bool
Parameters
- $context : ResultInterface
Return values
boolbuildStreamMimeType()
Determine the mime type of this result.
public
buildStreamMimeType(ResultInterface $context) : string
Parameters
- $context : ResultInterface
Return values
stringbuildStreamWriter()
Create a stream writer for this result.
public
buildStreamWriter(ResultInterface $context) : StreamWriterInterface
Parameters
- $context : ResultInterface
Return values
StreamWriterInterfacebuildStringWriter()
public
buildStringWriter(ResultInterface $context) : StringWriterInterface
Parameters
- $context : ResultInterface
Return values
StringWriterInterfacetoFile()
public
toFile() : SplFileInfo