1. sfI18nFindTask.class.php
  2. /**
 * Finds non "i18n ready" strings in an application.
 *
 * @package    symfony
 * @subpackage task
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfI18nFindTask.class.php 8453 2008-04-14 16:39:14Z fabien $
 */
  3. class sfI18nFindTask 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.     ));
  14.     $this->addOptions(array(
  15.       new sfCommandOption('env', null, sfCommandOption::PARAMETER_REQUIRED, 'The environment', 'dev'),
  16.     ));
  18.     $this->namespace = 'i18n';
  19.     $this->name = 'find';
  20.     $this->briefDescription = 'Finds non "i18n ready" strings in an application';
  22.     $this->detailedDescription = <<<EOF
  23. The [i18n:find|INFO] task finds non internationalized strings embedded in templates:
  25.   [./symfony i18n:find frontend|INFO]
  27. This task is able to find non internationalized strings in pure HTML and in PHP code:
  29.   <p>Non i18n text</p>
  30.   <p><?php echo 'Test' ?></p>
  32. As the task returns all strings embedded in PHP, you can have some false positive (especially
  33. if you use the string syntax for helper arguments).
  34. EOF;
  35.   }
  37.   /**
  38.    * @see sfTask
  39.    */
  40.   public function execute($arguments = array(), $options = array())
  41.   {
  42.     $this->logSection('i18n', sprintf('find non "i18n ready" strings in the "%s" application', $arguments['application']));
  44.     // Look in templates
  45.     $dirs = array();
  46.     $moduleNames = sfFinder::type('dir')->maxdepth(0)->relative()->in(sfConfig::get('sf_app_module_dir'));
  47.     foreach ($moduleNames as $moduleName)
  48.     {
  49.       $dirs[] = sfConfig::get('sf_app_module_dir').'/'.$moduleName.'/templates';
  50.     }
  51.     $dirs[] = sfConfig::get('sf_app_dir').'/templates';
  53.     $strings = array();
  54.     foreach ($dirs as $dir)
  55.     {
  56.       $templates = sfFinder::type('file')->name('*.php')->in($dir);
  57.       foreach ($templates as $template)
  58.       {
  59.         if (!isset($strings[$template]))
  60.         {
  61.           $strings[$template] = array();
  62.         }
  64.         $dom = new DomDocument('1.0', sfConfig::get('sf_charset', 'UTF-8'));
  65.         $content = file_get_contents($template);
  67.         // remove doctype
  68.         $content = preg_replace('/<!DOCTYPE.*?>/', '', $content);
  70.         @$dom->loadXML('<doc>'.$content.'</doc>');
  72.         $nodes = array($dom);
  73.         while ($nodes)
  74.         {
  75.           $node = array_shift($nodes);
  77.           if (XML_TEXT_NODE === $node->nodeType)
  78.           {
  79.             if (!$node->isWhitespaceInElementContent())
  80.             {
  81.               $strings[$template][] = $node->nodeValue;
  82.             }
  83.           }
  84.           else if ($node->childNodes)
  85.           {
  86.             for ($i = 0, $max = $node->childNodes->length; $i < $max; $i++)
  87.             {
  88.               $nodes[] = $node->childNodes->item($i);
  89.             }
  90.           }
  91.           else if ('DOMProcessingInstruction' == get_class($node) && 'php' == $node->target)
  92.           {
  93.             // processing instruction node
  94.             $tokens = token_get_all('<?php '.$node->nodeValue);
  95.             foreach ($tokens as $token)
  96.             {
  97.               if (is_array($token))
  98.               {
  99.                 list($id, $text) = $token;
  101.                 if (T_CONSTANT_ENCAPSED_STRING === $id)
  102.                 {
  103.                   $strings[$template][] = substr($text, 1, -1);
  104.                 }
  105.               }
  106.             }
  107.           }
  108.         }
  109.       }
  110.     }
  112.     foreach ($strings as $template => $messages)
  113.     {
  114.       if (!$messages)
  115.       {
  116.         continue;
  117.       }
  119.       $this->logSection('i18n', sprintf('strings in "%s"', str_replace(sfConfig::get('sf_root_dir'), '', $template)), 1000);
  120.       foreach ($messages as $message)
  121.       {
  122.         $this->log("  $message\n");
  123.       }
  124.     }
  125.   }
  126. }
Debug toolbar