class CsvFileLoader in Plug 7

CsvFileLoader loads translations from CSV files.

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

@api

Hierarchy

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

1 file declares its use of CsvFileLoader

CsvFileLoaderTest.php in lib/Symfony/translation/Tests/Loader/CsvFileLoaderTest.php

1 string reference to 'CsvFileLoader'

TranslatorTest::getTransFileTests in lib/Symfony/translation/Tests/TranslatorTest.php

File

lib/Symfony/translation/Loader/CsvFileLoader.php, line 23

Namespace

Symfony\Component\Translation\Loader

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

  /**
   * {@inheritdoc}
   */
  protected function loadResource($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) === '#') {
        continue;
      }
      if (!isset($data[1])) {
        continue;
      }
      if (count($data) == 2) {
        $messages[$data[0]] = $data[1];
      }
      else {
        continue;
      }
    }
    return $messages;
  }

  /**
   * 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::loadResource	protected	function	Overrides FileLoader::loadResource
CsvFileLoader::setCsvControl	public	function	Sets the delimiter, enclosure, and escape character for CSV.
FileLoader::load	public	function	@api Overrides ArrayLoader::load