Classes List

Symfony\Component\Translation\Writer\TranslationWriter

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
 66 
 67 
 68 
 69 
 70 
 71 
 72 
 73 
 74 
 75 
 76 
 77 
 78 
 79 
 80 
 81 
 82 
 83 
 84 
 85 
 86 
 87 
 88 
 89 
 90 
 91 
 92 
 93 
 94 
 95 
 96 
 97 
 98 
 99 
 100 
 101 
 102 
 103 
 104 
<?php

/* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */


namespace Symfony\Component\Translation\Writer;

use Symfony\Component\Translation\MessageCatalogue;
use Symfony\Component\Translation\Dumper\DumperInterface;
use Symfony\Component\Translation\Exception\InvalidArgumentException;
use Symfony\Component\Translation\Exception\RuntimeException;

/** * TranslationWriter writes translation messages. * * @author Michel Salib <michelsalib@hotmail.com> */
class TranslationWriter implements TranslationWriterInterface
{
    private $dumpers = array();

    /** * Adds a dumper to the writer. * * @param string $format The format of the dumper * @param DumperInterface $dumper The dumper */
    public function addDumper($formatDumperInterface $dumper)
    {
        $this->dumpers[$format] = $dumper;
    }

    /** * Disables dumper backup. */
    public function disableBackup()
    {
        foreach ($this->dumpers as $dumper) {
            if (method_exists($dumper'setBackup')) {
                $dumper->setBackup(false);
            }
        }
    }

    /** * Obtains the list of supported formats. * * @return array */
    public function getFormats()
    {
        return array_keys($this->dumpers);
    }

    /** * Writes translation from the catalogue according to the selected format. * * @param MessageCatalogue $catalogue The message catalogue to write * @param string $format The format to use to dump the messages * @param array $options Options that are passed to the dumper * * @throws InvalidArgumentException */
    public function write(MessageCatalogue $catalogue$format$options = array())
    {
        if (!isset($this->dumpers[$format])) {
            throw new InvalidArgumentException(sprintf('There is no dumper associated with format "%s".'$format));
        }

        // get the right dumper
        $dumper = $this->dumpers[$format];

        if (isset($options['path']) && !is_dir($options['path']) && !@mkdir($options['path'], 0777true&& !is_dir($options['path'])) {
            throw new RuntimeException(sprintf('Translation Writer was not able to create directory "%s"'$options['path']));
        }

        // save
        $dumper->dump($catalogue$options);
    }

    /** * Writes translation from the catalogue according to the selected format. * * @param MessageCatalogue $catalogue The message catalogue to write * @param string $format The format to use to dump the messages * @param array $options Options that are passed to the dumper * * @throws InvalidArgumentException * * @deprecated since 3.4 will be removed in 4.0. Use write instead. */
    public function writeTranslations(MessageCatalogue $catalogue$format$options = array())
    {
        @trigger_error(sprintf('Method %s() is deprecated since Symfony 3.4 and will be removed in 4.0. Use write() instead.'__METHOD__), E_USER_DEPRECATED);
        $this->write($catalogue$format$options);
    }
}