1. sfI18nExtract.class.php
  2. /**
 * @package    symfony
 * @subpackage i18n
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfI18nExtract.class.php 9128 2008-05-21 00:58:19Z Carl.Vondrick $
 */
  3. abstract class sfI18nExtract
  4. {
  5.   protected
  6.     $currentMessages = array(),
  7.     $newMessages     = array(),
  8.     $allSeenMessages = array(),
  9.     $culture         = null,
  10.     $parameters      = array(),
  11.     $i18n            = null;
  13.   /**
  14.    * Class constructor.
  15.    *
  16.    * @see initialize()
  17.    */
  18.   public function __construct(sfI18N $i18n, $culture, $parameters = array())
  19.   {
  20.     $this->initialize($i18n, $culture, $parameters);
  21.   }
  23.   /**
  24.    * Initializes the current extract object.
  25.    *
  26.    * @param sfI18N $i18n        A sfI18N instance
  27.    * @param string $culture     The culture
  28.    * @param array  $parameters  An array of parameters
  29.    */
  30.   function initialize(sfI18N $i18n, $culture, $parameters = array())
  31.   {
  32.     $this->allSeenMessages = array();
  33.     $this->newMessages = array();
  34.     $this->currentMessages = array();
  36.     $this->culture = $culture;
  37.     $this->parameters = $parameters;
  39.     $this->i18n = $i18n;
  41.     $this->configure();
  43.     $this->loadMessageSources();
  44.     $this->loadCurrentMessages();
  45.   }
  47.   /**
  48.    * Configures the current extract object.
  49.    */
  50.   public function configure()
  51.   {
  52.   }
  54.   /**
  55.    * Extracts i18n strings.
  56.    *
  57.    * This class must be implemented by subclasses.
  58.    */
  59.   abstract public function extract();
  61.   /**
  62.    * Saves the new messages.
  63.    *
  64.    * Current limitations:
  65.    *  - For file backends (XLIFF and gettext), it only saves in the "most global" file
  66.    */
  67.   public function saveNewMessages()
  68.   {
  69.     $messageSource = $this->i18n->getMessageSource();
  70.     foreach ($this->getNewMessages() as $message)
  71.     {
  72.       $messageSource->append($message);
  73.     }
  75.     $messageSource->save();
  76.   }
  78.   /**
  79.    * Deletes old messages.
  80.    *
  81.    * Current limitations:
  82.    *  - For file backends (XLIFF and gettext), it only deletes in the "most global" file
  83.    */
  84.   public function deleteOldMessages()
  85.   {
  86.     $messageSource = $this->i18n->getMessageSource();
  87.     foreach ($this->getOldMessages() as $message)
  88.     {
  89.       $messageSource->delete($message);
  90.     }
  91.   }
  93.   /**
  94.    * Gets the new i18n strings.
  95.    *
  96.    * @return array An array of i18n strings
  97.    */
  98.   final public function getNewMessages()
  99.   {
  100.     return array_diff($this->getAllSeenMessages(), $this->getCurrentMessages());
  101.   }
  103.   /**
  104.    * Gets the current i18n strings.
  105.    *
  106.    * @return array An array of i18n strings
  107.    */
  108.   public function getCurrentMessages()
  109.   {
  110.     return $this->currentMessages;
  111.   }
  113.   /**
  114.    * Gets all i18n strings seen during the extraction process.
  115.    *
  116.    * @return array An array of i18n strings
  117.    */
  118.   public function getAllSeenMessages()
  119.   {
  120.     return $this->allSeenMessages;
  121.   }
  123.   /**
  124.    * Gets old i18n strings.
  125.    *
  126.    * This returns all strings that weren't seen during the extraction process
  127.    * and are in the current messages.
  128.    *
  129.    * @return array An array of i18n strings
  130.    */
  131.   final public function getOldMessages()
  132.   {
  133.     return array_diff($this->getCurrentMessages(), $this->getAllSeenMessages());
  134.   }
  136.   /**
  137.    * Loads message sources objects and sets the culture.
  138.    */
  139.   protected function loadMessageSources()
  140.   {
  141.     $this->i18n->getMessageSource()->setCulture($this->culture);
  142.     $this->i18n->getMessageSource()->load();
  143.   }
  145.   /**
  146.    * Loads messages already saved in the message sources.
  147.    */
  148.   protected function loadCurrentMessages()
  149.   {
  150.     $this->currentMessages = array();
  151.     foreach ($this->i18n->getMessageSource()->read() as $catalogue => $translations)
  152.     {
  153.       foreach ($translations as $key => $values)
  154.       {
  155.         $this->currentMessages[] = $key;
  156.       }
  157.     }
  158.   }
  160.   /**
  161.    * Extracts i18n strings from PHP files.
  162.    *
  163.    * @param string $dir The PHP full path name
  164.    */
  165.   protected function extractFromPhpFiles($dir)
  166.   {
  167.     $phpExtractor = new sfI18nPhpExtractor();
  169.     $files = sfFinder::type('file')->name('*.php');
  170.     $messages = array();
  171.     foreach ($files->in($dir) as $file)
  172.     {
  173.       $messages = array_merge($messages, $phpExtractor->extract(file_get_contents($file)));
  174.     }
  176.     $this->updateMessages($messages);
  177.   }
  179.   /**
  180.    * Updates the internal arrays with new messages.
  181.    *
  182.    * @param array $messages An array of new i18n strings
  183.    */
  184.   protected function updateMessages($messages)
  185.   {
  186.     $this->allSeenMessages = array_unique(array_merge($this->allSeenMessages, $messages));
  187.   }
  188. }
Debug toolbar