W3cubDocs

/Symfony 3.0

Symfony\Component\Translation\Dumper\FileDumper

abstract class FileDumper implements DumperInterface

FileDumper is an implementation of DumperInterface that dump a message catalogue to file(s).

Performs backup of already existing files.

Options: - path (mandatory): the directory where the files should be saved

Methods

setRelativePathTemplate(string $relativePathTemplate)

Sets the template for the relative paths to files.
setBackup(bool $backup)

Sets backup flag.
dump(MessageCatalogue $messages, array $options = array())

Dumps the message catalogue.
string formatCatalogue(MessageCatalogue $messages, string $domain, array $options = array())

Transforms a domain of a message catalogue to its string representation.

Details

public setRelativePathTemplate(string $relativePathTemplate)

Sets the template for the relative paths to files.

Parameters

string $relativePathTemplate A template for the relative paths to files

public setBackup(bool $backup)

Sets backup flag.

Parameters

bool $backup

public dump(MessageCatalogue $messages, array $options = array())

Dumps the message catalogue.

Parameters

MessageCatalogue $messages The message catalogue
array $options Options that are used by the dumper

abstract public string formatCatalogue(MessageCatalogue $messages, string $domain, array $options = array())

Transforms a domain of a message catalogue to its string representation.

Parameters

MessageCatalogue $messages
string $domain
array $options

Return Value

string representation

© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Translation/Dumper/FileDumper.html