ContentEncoderInterface
extends
EncoderInterface
in
Tags
Table of Contents
- encodeByteStream() : iteratable<string|int, mixed>
- Encodes the stream to a Generator.
- encodeString() : string
- Encode a given string to produce an encoded string.
- getName() : string
- Gets the MIME name of this content encoding scheme.
Methods
encodeByteStream()
Encodes the stream to a Generator.
public
encodeByteStream(resource $stream, int $maxLineLength) : iteratable<string|int, mixed>
Parameters
- $stream : resource
- $maxLineLength : int
Return values
iteratable<string|int, mixed> —encodeString()
Encode a given string to produce an encoded string.
public
encodeString(string $string[, string|null $charset = 'utf-8' ], int $firstLineOffset, int $maxLineLength) : string
Parameters
- $string : string
- $charset : string|null = 'utf-8'
- $firstLineOffset : int
-
if first line needs to be shorter
- $maxLineLength : int
-
- 0 indicates the default length for this encoding
Return values
string —getName()
Gets the MIME name of this content encoding scheme.
public
getName() : string