nexendrie / translation

src/Loaders/FileLoader.php

<?php
declare(strict_types=1);

namespace Nexendrie\Translation\Loaders;

use Nette\Utils\Finder,
    Nette\Utils\Strings,
    Nexendrie\Translation\Resolvers\ILocaleResolver,
    Nexendrie\Translation\Resolvers\ManualLocaleResolver,
    Nexendrie\Translation\InvalidFolderException,
    Nexendrie\Translation\FolderNotSetException;

/**
 * Generic file translations loader
 * Loads texts from {$this->extension} files
 * You need to define method parseFile() which processes individual file
 *
 * @author Jakub Konečný
 * @property string $defaultLang
 * @property string $lang
 * @property array $texts
 * @property string[] $folders
 * @property-read array $resources
 */
abstract class FileLoader implements ILoader {
  use \Nette\SmartObject;
  
  /** @var string */
  protected $defaultLang = "en";
  /** @var string|NULL */
  protected $loadedLang = NULL;
  /** @var array */
  protected $texts = [];
  /** @var string[] */
  protected $folders = [];
  /** @var ILocaleResolver */
  protected $resolver;
  /** @var array */
  protected $resources = [];
  /** @var string */
  protected $extension;
  
  /**
   * @param ILocaleResolver $resolver
   * @param string[] $folders
   */
  function __construct(ILocaleResolver $resolver = NULL, array $folders = []) {

It is generally recommended to explicitly declare the visibility for methods.

    $this->setFolders($folders);
    $this->resolver = $resolver ?? new ManualLocaleResolver;
  }
  
  function getLang(): string {

It is generally recommended to explicitly declare the visibility for methods.

    return $this->resolver->resolve() ?? $this->defaultLang;
  }
  
  function setLang(string $lang) {

It is generally recommended to explicitly declare the visibility for methods.

    if(method_exists($this->resolver, "setLang")) {
      $this->resolver->setLang($lang);
    }
  }
  
  function getDefaultLang(): string {

It is generally recommended to explicitly declare the visibility for methods.

    return $this->defaultLang;
  }
  
  function setDefaultLang(string $defaultLang) {

It is generally recommended to explicitly declare the visibility for methods.

    $this->defaultLang = $defaultLang;
  }
  
  /**
   * @return string[]
   */
  function getFolders(): array {

It is generally recommended to explicitly declare the visibility for methods.

    return $this->folders;
  }
  
  /**
   * @param string[] $folders
   * @throws InvalidFolderException
   */
  function setFolders(array $folders) {

It is generally recommended to explicitly declare the visibility for methods.

    foreach($folders as $folder) {
      if(!is_dir($folder)) {
        throw new InvalidFolderException("Folder $folder does not exist.");
      }
      $this->folders[] = $folder;
    }
  }
  
  protected function addResource(string $filename, string $domain): void {
    if(!isset($this->resources[$domain]) OR !in_array($filename, $this->resources[$domain])) {
      $this->resources[$domain][] = $filename;
    }
  }
  
  function getResources(): array {

It is generally recommended to explicitly declare the visibility for methods.

    return $this->resources;
  }
  
  /**
   * Parse individual file
   */
  abstract protected function parseFile(string $filename): array;
  
  /**
   * Load texts from one text domain
   */
  protected function loadDomain(string $name): array {
    $return = [];
    $defaultLang = $this->defaultLang;
    $extension = $this->extension;
    $defaultFilename = "$name.$defaultLang.$extension";
    $files = Finder::findFiles($defaultFilename)
      ->from($this->folders);
    /** @var \SplFileInfo $file */
    foreach($files as $file) {
      $default = $this->parseFile($file->getPathname());
      $this->addResource($file->getPathname(), $name);
      $lang = [];
      $filename = "$name.$this->lang.$extension";
      $filename = str_replace($defaultFilename, $filename, $file->getPathname());
      if($this->lang != $defaultLang AND is_file($filename)) {
        $lang = $this->parseFile($filename);
        $this->addResource($filename, $name);
      }
      $return = array_merge($return, $default, $lang);
    }
    return $return;
  }
  
  /**
   * Load all texts
   *
   * @throws FolderNotSetException
   */
  protected function loadTexts(): void {
    if($this->lang === $this->loadedLang) {
      return;
    }
    if(!count($this->folders)) {
      throw new FolderNotSetException("Folder for translations was not set.");
    }
    $default = $this->defaultLang;
    $this->resources = $texts = [];
    $extension = $this->extension;
    $files = Finder::findFiles("*.$default.$extension")
      ->from($this->folders);
    /** @var \SplFileInfo $file */
    foreach($files as $file) {
      $domain = $file->getBasename(".$default.$extension");
      $texts[$domain] = $this->loadDomain($domain);
    }
    $this->texts = $texts;
    $this->loadedLang = $this->lang;
  }
  
  function getTexts(): array {

It is generally recommended to explicitly declare the visibility for methods.

    $this->loadTexts();
    return $this->texts;
  }
  
  function getResolverName(): string {

It is generally recommended to explicitly declare the visibility for methods.

    $class = get_class($this->resolver);
    return (string) Strings::after($class, '\\', -1);
  }
  
  protected function getLanguageFilenameMask(): string {
    return "*.$this->extension";
  }
  
  /**
   * @return string[]
   * @throws FolderNotSetException
   */
  function getAvailableLanguages(): array {

It is generally recommended to explicitly declare the visibility for methods.

    if(!count($this->folders)) {
      throw new FolderNotSetException("Folder for translations was not set.");
    }
    $languages = [];
    $extension = $this->extension;
    $files = Finder::findFiles($this->getLanguageFilenameMask())
      ->from($this->folders);
    /** @var \SplFileInfo $file */
    foreach($files as $file) {
      $filename = $file->getBasename(".$extension");
      $lang = Strings::after($filename, ".");
      if(!in_array($lang, $languages)) {
        $languages[] = $lang;
      }
    }
    return $languages;
  }
}
?>