MarkdownFormatter
extends AbstractFormatter
in package
Class MarkdownFormatter
Table of Contents
Properties
Methods
- __construct() : mixed
- IniFormatter constructor.
- __serialize() : array<string|int, mixed>
- __unserialize() : void
- decode() : mixed
- Decode a string into data.
- encode() : string
- Encode data into a string.
- getBodyField() : string
- Returns body field used in both encode() and decode().
- getDefaultFileExtension() : string
- Get default file extension from current formatter (with dot).
- getHeaderField() : string
- Returns header field used in both encode() and decode().
- getHeaderFormatter() : FileFormatterInterface
- Returns header formatter object used in both encode() and decode().
- getMimeType() : string
- getRawField() : string
- Returns raw field used in both encode() and decode().
- getSupportedFileExtensions() : array<string|int, string>
- Get file extensions supported by current formatter (with dot).
- serialize() : string
- unserialize() : void
- getConfig() : mixed
- Get either full configuration or a single option.
- getUnserializeAllowedClasses() : array<string|int, mixed>|bool
Properties
$headerFormatter
private
FileFormatterInterface
$headerFormatter
Methods
__construct()
IniFormatter constructor.
public
__construct([array<string|int, mixed> $config = [] ][, FileFormatterInterface $headerFormatter = null ]) : mixed
Parameters
- $config : array<string|int, mixed> = []
- $headerFormatter : FileFormatterInterface = null
__serialize()
public
__serialize() : array<string|int, mixed>
Return values
array<string|int, mixed>__unserialize()
public
__unserialize(array<string|int, mixed> $data) : void
Parameters
- $data : array<string|int, mixed>
decode()
Decode a string into data.
public
decode(mixed $data) : mixed
Parameters
- $data : mixed
-
String to be decoded.
Tags
Return values
mixed —Returns decoded data.
encode()
Encode data into a string.
public
encode(mixed $data) : string
Parameters
- $data : mixed
-
Data to be encoded.
Tags
Return values
string —Returns encoded data as a string.
getBodyField()
Returns body field used in both encode() and decode().
public
getBodyField() : string
Return values
stringgetDefaultFileExtension()
Get default file extension from current formatter (with dot).
public
getDefaultFileExtension() : string
Tags
Return values
string —Returns file extension (can be empty).
getHeaderField()
Returns header field used in both encode() and decode().
public
getHeaderField() : string
Return values
stringgetHeaderFormatter()
Returns header formatter object used in both encode() and decode().
public
getHeaderFormatter() : FileFormatterInterface
Return values
FileFormatterInterfacegetMimeType()
public
getMimeType() : string
Return values
stringgetRawField()
Returns raw field used in both encode() and decode().
public
getRawField() : string
Return values
stringgetSupportedFileExtensions()
Get file extensions supported by current formatter (with dot).
public
getSupportedFileExtensions() : array<string|int, string>
Tags
Return values
array<string|int, string> —Returns list of all supported file extensions.
serialize()
public
final serialize() : string
Return values
stringunserialize()
public
final unserialize(string $serialized) : void
Parameters
- $serialized : string
getConfig()
Get either full configuration or a single option.
protected
getConfig([string|null $name = null ]) : mixed
Parameters
- $name : string|null = null
-
Configuration option (optional)
getUnserializeAllowedClasses()
protected
getUnserializeAllowedClasses() : array<string|int, mixed>|bool