\Gettext\ExtractorsCsv

Class to get gettext strings from csv.

Summary

Methods

Properties

Constants

convertString()
fromFile()
fromString()

$options

No constants found

getFiles()
readFile()

No protected properties found

N/A

extractHeaders()
isHeaderDefinition()
supportsCsvEscapeChar()
fgetcsv()
fputcsv()

$csvEscapeChar

N/A

Properties

$options

$options :

Type

$csvEscapeChar

$csvEscapeChar :

Type

Methods

convertString()

convertString(string  $value) : string

Normalize a string.

Parameters

string

$value

Returns

string

fromFile()

fromFile(array|string  $file, \Gettext\Translations  $translations, array  $options = array())

Extract the translations from a file.

Parameters

array\|string	$file	A path of a file or files
\Gettext\Translations	$translations	The translations instance to append the new translations.
array	$options

fromString()

fromString(string  $string, \Gettext\Translations  $translations, array  $options = array())

Parses a string and append the translations found in the Translations instance.

Parameters

string	$string
\Gettext\Translations	$translations
array	$options

getFiles()

getFiles(string|array  $file) : array

Checks and returns all files.

Parameters

string|array

$file

The file/s

Returns

array —

The file paths

readFile()

readFile(string  $file) : string

Reads and returns the content of a file.

Parameters

string

$file

Returns

string

extractHeaders()

extractHeaders(string  $headers, \Gettext\Translations  $translations) : array

Add the headers found to the translations instance.

Parameters

string	$headers
\Gettext\Translations	$translations

Returns

array

isHeaderDefinition()

isHeaderDefinition(string  $line) : boolean

Checks if it is a header definition line. Useful for distguishing between header definitions and possible continuations of a header entry.

Parameters

string

$line

Line to parse

Returns

boolean

supportsCsvEscapeChar()

supportsCsvEscapeChar() : boolean

Check whether support the escape_char argument to fgetcsv/fputcsv or not

Returns

boolean

fgetcsv()

fgetcsv(resource  $handle, array  $options) : array

Parameters

resource	$handle
array	$options

Returns

array

fputcsv()

fputcsv(resource  $handle, array  $fields, array  $options) : boolean|integer

Parameters

resource	$handle
array	$fields
array	$options

Returns

boolean|integer