class CsvFileLoader in Zircon Profile 8

CsvFileLoader loads translations from CSV files.

@author Saša Stamenković <[e-mail]>

Hierarchy

• class \Symfony\Component\Translation\Loader\ArrayLoader implements LoaderInterface
  • class \Symfony\Component\Translation\Loader\CsvFileLoader

1 file declares its use of CsvFileLoader

CsvFileLoaderTest.php in vendor/symfony/translation/Tests/Loader/CsvFileLoaderTest.php

1 string reference to 'CsvFileLoader'

TranslatorTest::getTransFileTests in vendor/symfony/translation/Tests/TranslatorTest.php

File

vendor/symfony/translation/Loader/CsvFileLoader.php, line 23

Namespace

Symfony\Component\Translation\Loader

class CsvFileLoader extends ArrayLoader {
  private $delimiter = ';';
  private $enclosure = '"';
  private $escape = '\\';

  /**
   * {@inheritdoc}
   */
  public function load($resource, $locale, $domain = 'messages') {
    if (!stream_is_local($resource)) {
      throw new InvalidResourceException(sprintf('This is not a local file "%s".', $resource));
    }
    if (!file_exists($resource)) {
      throw new NotFoundResourceException(sprintf('File "%s" not found.', $resource));
    }
    $messages = array();
    try {
      $file = new \SplFileObject($resource, 'rb');
    } catch (\RuntimeException $e) {
      throw new NotFoundResourceException(sprintf('Error opening file "%s".', $resource), 0, $e);
    }
    $file
      ->setFlags(\SplFileObject::READ_CSV | \SplFileObject::SKIP_EMPTY);
    $file
      ->setCsvControl($this->delimiter, $this->enclosure, $this->escape);
    foreach ($file as $data) {
      if ('#' !== substr($data[0], 0, 1) && isset($data[1]) && 2 === count($data)) {
        $messages[$data[0]] = $data[1];
      }
    }
    $catalogue = parent::load($messages, $locale, $domain);
    if (class_exists('Symfony\\Component\\Config\\Resource\\FileResource')) {
      $catalogue
        ->addResource(new FileResource($resource));
    }
    return $catalogue;
  }

  /**
   * Sets the delimiter, enclosure, and escape character for CSV.
   *
   * @param string $delimiter delimiter character
   * @param string $enclosure enclosure character
   * @param string $escape    escape character
   */
  public function setCsvControl($delimiter = ';', $enclosure = '"', $escape = '\\') {
    $this->delimiter = $delimiter;
    $this->enclosure = $enclosure;
    $this->escape = $escape;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ArrayLoader::flatten	private	function	Flattens an nested array of translations.
CsvFileLoader::$delimiter	private	property
CsvFileLoader::$enclosure	private	property
CsvFileLoader::$escape	private	property
CsvFileLoader::load	public	function	Loads a locale. Overrides ArrayLoader::load
CsvFileLoader::setCsvControl	public	function	Sets the delimiter, enclosure, and escape character for CSV.