annotate vendor/symfony/translation/Dumper/YamlFileDumper.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 129ea1e6d783
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 /*
Chris@0 4 * This file is part of the Symfony package.
Chris@0 5 *
Chris@0 6 * (c) Fabien Potencier <fabien@symfony.com>
Chris@0 7 *
Chris@0 8 * For the full copyright and license information, please view the LICENSE
Chris@0 9 * file that was distributed with this source code.
Chris@0 10 */
Chris@0 11
Chris@0 12 namespace Symfony\Component\Translation\Dumper;
Chris@0 13
Chris@17 14 use Symfony\Component\Translation\Exception\LogicException;
Chris@0 15 use Symfony\Component\Translation\MessageCatalogue;
Chris@0 16 use Symfony\Component\Translation\Util\ArrayConverter;
Chris@0 17 use Symfony\Component\Yaml\Yaml;
Chris@0 18
Chris@0 19 /**
Chris@0 20 * YamlFileDumper generates yaml files from a message catalogue.
Chris@0 21 *
Chris@0 22 * @author Michel Salib <michelsalib@hotmail.com>
Chris@0 23 */
Chris@0 24 class YamlFileDumper extends FileDumper
Chris@0 25 {
Chris@14 26 private $extension;
Chris@14 27
Chris@14 28 public function __construct(/**string */$extension = 'yml')
Chris@14 29 {
Chris@14 30 $this->extension = $extension;
Chris@14 31 }
Chris@14 32
Chris@0 33 /**
Chris@0 34 * {@inheritdoc}
Chris@0 35 */
Chris@17 36 public function formatCatalogue(MessageCatalogue $messages, $domain, array $options = [])
Chris@0 37 {
Chris@0 38 if (!class_exists('Symfony\Component\Yaml\Yaml')) {
Chris@0 39 throw new LogicException('Dumping translations in the YAML format requires the Symfony Yaml component.');
Chris@0 40 }
Chris@0 41
Chris@0 42 $data = $messages->all($domain);
Chris@0 43
Chris@0 44 if (isset($options['as_tree']) && $options['as_tree']) {
Chris@0 45 $data = ArrayConverter::expandToTree($data);
Chris@0 46 }
Chris@0 47
Chris@0 48 if (isset($options['inline']) && ($inline = (int) $options['inline']) > 0) {
Chris@0 49 return Yaml::dump($data, $inline);
Chris@0 50 }
Chris@0 51
Chris@0 52 return Yaml::dump($data);
Chris@0 53 }
Chris@0 54
Chris@0 55 /**
Chris@0 56 * {@inheritdoc}
Chris@0 57 */
Chris@0 58 protected function getExtension()
Chris@0 59 {
Chris@14 60 return $this->extension;
Chris@0 61 }
Chris@0 62 }