1. sfI18nExtractTask.class.php
  2. /**
 * Extracts i18n strings from php files.
 *
 * @package    symfony
 * @subpackage task
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfI18nExtractTask.class.php 9883 2008-06-26 09:04:13Z FabianLange $
 */
  3. class sfI18nExtractTask extends sfBaseTask
  4. {
  5.   /**
  6.    * @see sfTask
  7.    */
  8.   protected function configure()
  9.   {
  10.     $this->addArguments(array(
  11.       new sfCommandArgument('application', sfCommandArgument::REQUIRED, 'The application name'),
  12.       new sfCommandArgument('culture', sfCommandArgument::REQUIRED, 'The target culture'),
  13.     ));
  15.     $this->addOptions(array(
  16.       new sfCommandOption('display-new', null, sfCommandOption::PARAMETER_NONE, 'Output all new found strings'),
  17.       new sfCommandOption('display-old', null, sfCommandOption::PARAMETER_NONE, 'Output all old strings'),
  18.       new sfCommandOption('auto-save', null, sfCommandOption::PARAMETER_NONE, 'Save the new strings'),
  19.       new sfCommandOption('auto-delete', null, sfCommandOption::PARAMETER_NONE, 'Delete old strings'),
  20.     ));
  22.     $this->namespace = 'i18n';
  23.     $this->name = 'extract';
  24.     $this->briefDescription = 'Extracts i18n strings from php files';
  26.     $this->detailedDescription = <<<EOF
  27. The [i18n:extract|INFO] task extracts i18n strings from your project files
  28. for the given application and target culture:
  30.   [./symfony i18n:extract frontend fr|INFO]
  32. By default, the task only displays the number of new and old strings
  33. it found in the current project.
  35. If you want to display the new strings, use the [--display-new|COMMENT] option:
  37.   [./symfony i18n:extract --display-new frontend fr|INFO]
  39. To save them in the i18n message catalogue, use the [--auto-save|COMMENT] option:
  41.   [./symfony i18n:extract --auto-save frontend fr|INFO]
  43. If you want to display strings that are present in the i18n messages
  44. catalogue but are not found in the application, use the 
  45. [--display-old|COMMENT] option:
  47.   [./symfony i18n:extract --display-old frontend fr|INFO]
  49. To automatically delete old strings, use the [--auto-delete|COMMENT] but
  50. be careful, especially if you have translations for plugins as they will
  51. appear as old strings but they are not:
  53.   [./symfony i18n:extract --auto-delete frontend fr|INFO]
  54. EOF;
  55.   }
  57.   /**
  58.    * @see sfTask
  59.    */
  60.   public function execute($arguments = array(), $options = array())
  61.   {
  62.     $this->logSection('i18n', sprintf('extracting i18n strings for the "%s" application', $arguments['application']));
  64.     // get i18n configuration from factories.yml
  65.     $config = sfFactoryConfigHandler::getConfiguration($this->configuration->getConfigPaths('config/factories.yml'));
  67.     $class = $config['i18n']['class'];
  68.     $params = $config['i18n']['param'];
  69.     unset($params['cache']);
  71.     $extract = new sfI18nApplicationExtract(new $class($this->configuration, new sfNoCache(), $params), $arguments['culture']);
  72.     $extract->extract();
  74.     $this->logSection('i18n', sprintf('found "%d" new i18n strings', count($extract->getNewMessages())));
  75.     $this->logSection('i18n', sprintf('found "%d" old i18n strings', count($extract->getOldMessages())));
  77.     if ($options['display-new'])
  78.     {
  79.       $this->logSection('i18n', sprintf('display new i18n strings', count($extract->getOldMessages())));
  80.       foreach ($extract->getNewMessages() as $message)
  81.       {
  82.         $this->log('               '.$message."\n");
  83.       }
  84.     }
  86.     if ($options['auto-save'])
  87.     {
  88.       $this->logSection('i18n', 'saving new i18n strings');
  90.       $extract->saveNewMessages();
  91.     }
  93.     if ($options['display-old'])
  94.     {
  95.       $this->logSection('i18n', sprintf('display old i18n strings', count($extract->getOldMessages())));
  96.       foreach ($extract->getOldMessages() as $message)
  97.       {
  98.         $this->log('               '.$message."\n");
  99.       }
  100.     }
  102.     if ($options['auto-delete'])
  103.     {
  104.       $this->logSection('i18n', 'deleting old i18n strings');
  106.       $extract->deleteOldMessages();
  107.     }
  108.   }
  109. }
Debug toolbar