1. sfMessageSource_File.class.php
  2. /**
 * sfMessageSource_File class.
 *
 * This is the base class for file based message sources like XLIFF or gettext.
 *
 * @author Xiang Wei Zhuo 
 * @version v1.0, last update on Fri Dec 24 16:18:44 EST 2004
 * @package    symfony
 * @subpackage i18n
 */
  3. abstract class sfMessageSource_File extends sfMessageSource
  4. {
  5.   /**
  6.    * Separator between culture name and source.
  7.    * @var string
  8.    */
  9.   protected $dataSeparator = '.';
  11.   /**
  12.    * Constructor.
  13.    *
  14.    * @param string $source the directory where the messages are stored.
  15.    * @see MessageSource::factory();
  16.    */
  17.   function __construct($source)
  18.   {
  19.     $this->source = (string) $source;
  20.   }
  22.   /**
  23.    * Gets the last modified unix-time for this particular catalogue+variant.
  24.    * Just use the file modified time.
  25.    *
  26.    * @param string $source catalogue+variant
  27.    * @return int last modified in unix-time format.
  28.    */
  29.   public function getLastModified($source)
  30.   {
  31.     return is_file($source) ? filemtime($source) : 0;
  32.   }
  34.   /**
  35.    * Gets the message file for a specific message catalogue and cultural variant.
  36.    *
  37.    * @param string $variant message catalogue
  38.    * @return string full path to the message file.
  39.    */
  40.   public function getSource($variant)
  41.   {
  42.     return $this->source.'/'.$variant;
  43.   }
  45.   /**
  46.    * Determines if the message file source is valid.
  47.    *
  48.    * @param string $source message file
  49.    * @return boolean true if valid, false otherwise.
  50.    */
  51.   public function isValidSource($source)
  52.   {
  53.     return is_file($source);
  54.   }
  56.   /**
  57.    * Gets all the variants of a particular catalogue.
  58.    *
  59.    * @param string $catalogue catalogue name
  60.    * @return array list of all variants for this catalogue.
  61.    */
  62.   public function getCatalogueList($catalogue)
  63.   {
  64.     $variants = explode('_', $this->culture);
  65.     $source = $catalogue.$this->dataExt;
  67.     $catalogues = array($source);
  69.     $variant = null;
  71.     for ($i = 0, $max = count($variants); $i < $max; $i++)
  72.     {
  73.       if (strlen($variants[$i]) > 0)
  74.       {
  75.         $variant .= $variant ? '_'.$variants[$i] : $variants[$i];
  76.         $catalogues[] = $catalogue.$this->dataSeparator.$variant.$this->dataExt;
  77.       }
  78.     }
  80.     $byDir = $this->getCatalogueByDir($catalogue);
  81.     $catalogues = array_merge($byDir, array_reverse($catalogues));
  83.     return $catalogues;
  84.   }
  86.   /**
  87.    * Traverses through the directory structure to find the catalogues.
  88.    * This should only be called by getCatalogueList()
  89.    *
  90.    * @param string $catalogue a particular catalogue.
  91.    * @return array a list of catalogues.
  92.    * @see getCatalogueList()
  93.    */
  94.   protected function getCatalogueByDir($catalogue)
  95.   {
  96.     $variants = explode('_', $this->culture);
  97.     $catalogues = array();
  99.     $variant = null;
  101.     for ($i = 0, $max = count($variants); $i < $max; $i++)
  102.     {
  103.       if (strlen($variants[$i]) > 0)
  104.       {
  105.         $variant .= $variant ? '_'.$variants[$i] : $variants[$i];
  106.         $catalogues[] = $variant.'/'.$catalogue.$this->dataExt;
  107.       }
  108.     }
  110.     return array_reverse($catalogues);
  111.   }
  113.   /**
  114.    * Returns a list of catalogue and its culture ID.
  115.    * E.g. array('messages', 'en_AU')
  116.    *
  117.    * @return array list of catalogues
  118.    * @see getCatalogues()
  119.    */
  120.   public function catalogues()
  121.   {
  122.     return $this->getCatalogues();
  123.   }
  125.   /**
  126.    * Returns a list of catalogue and its culture ID. This takes care
  127.    * of directory structures.
  128.    * E.g. array('messages', 'en_AU')
  129.    *
  130.    * @return array list of catalogues
  131.    */
  132.   protected function getCatalogues($dir = null, $variant = null)
  133.   {
  134.     $dir = $dir ? $dir : $this->getSource($variant);
  135.     $files = scandir($dir);
  137.     $catalogue = array();
  139.     foreach ($files as $file)
  140.     {
  141.       if (is_dir($dir.'/'.$file) && preg_match('/^[a-z]{2}(_[A-Z]{2,3})?$/', $file))
  142.       {
  143.         $catalogue = array_merge($catalogue, $this->getCatalogues($dir.'/'.$file, $file));
  144.       }
  146.       $pos = strpos($file, $this->dataExt);
  147.       if ($pos > 0 && substr($file, -1 * strlen($this->dataExt)) == $this->dataExt)
  148.       {
  149.         $name = substr($file, 0, $pos);
  150.         $dot = strrpos($name, $this->dataSeparator);
  151.         $culture = $variant;
  152.         $cat = $name;
  153.         if (is_int($dot))
  154.         {
  155.           $culture = substr($name, $dot + 1,strlen($name));
  156.           $cat = substr($name, 0, $dot);
  157.         }
  158.         $details[0] = $cat;
  159.         $details[1] = $culture;
  161.         $catalogue[] = $details;
  162.       }
  163.     }
  164.     sort($catalogue);
  166.     return $catalogue;
  167.   }
  169.   public function getId()
  170.   {
  171.     return md5($this->source);
  172.   }
  173. }
Debug toolbar