CsvFileLoader
extends FileLoader
in package
CsvFileLoader loads translations from CSV files.
Tags
Table of Contents
Properties
- $delimiter : string
- $enclosure : string
- $escape : string
Methods
- load() : MessageCatalogue
- Loads a locale.
- setCsvControl() : mixed
- Sets the delimiter, enclosure, and escape character for CSV.
- loadResource() : array<string|int, mixed>
- flatten() : array<string|int, mixed>
- Flattens an nested array of translations.
Properties
$delimiter
private
string
$delimiter
= ';'
$enclosure
private
string
$enclosure
= '"'
$escape
private
string
$escape
= '\\'
Methods
load()
Loads a locale.
public
load(mixed $resource, string $locale[, string $domain = 'messages' ]) : MessageCatalogue
Parameters
- $resource : mixed
- $locale : string
- $domain : string = 'messages'
Return values
MessageCataloguesetCsvControl()
Sets the delimiter, enclosure, and escape character for CSV.
public
setCsvControl([string $delimiter = ';' ][, string $enclosure = '"' ][, string $escape = '\' ]) : mixed
Parameters
- $delimiter : string = ';'
- $enclosure : string = '"'
- $escape : string = '\'
loadResource()
protected
loadResource(string $resource) : array<string|int, mixed>
Parameters
- $resource : string
Return values
array<string|int, mixed>flatten()
Flattens an nested array of translations.
private
flatten(array<string|int, mixed> $messages) : array<string|int, mixed>
The scheme used is: 'key' => ['key2' => ['key3' => 'value']] Becomes: 'key.key2.key3' => 'value'
Parameters
- $messages : array<string|int, mixed>