MAGETWO-33062: Update dictionary search tool to support \Magento\Framework\Phrase

Author: Yuri Kovsher

dev/tests/integration/testsuite/Magento/Test/Tools/I18n/Parser/Adapter/Php/Tokenizer/PhraseCollectorTest.php

@@ -38,7 +38,8 @@ protected function setUp()
     public function testParse()
     {
         $file = __DIR__.'/_files/objectsCode.php.txt';
-        $this->phraseCollector->parse($file, true);
+        $this->phraseCollector->setIncludeObjects();
+        $this->phraseCollector->parse($file);
         $expectation = [
             [
                 'phrase' => '\'Testing\'',

dev/tests/unit/testsuite/Magento/Tools/I18n/Parser/Adapter/Php/Tokenizer/PhraseCollectorTest.php

@@ -92,7 +92,8 @@ public function testParse(
                 $isMatchingClassReturnValues
             ));
 
-        $this->phraseCollector->parse($file, true);
+        $this->phraseCollector->setIncludeObjects();
+        $this->phraseCollector->parse($file);
         $this->assertEquals($result, $this->phraseCollector->getPhrases());
     }
 

dev/tools/Magento/Tools/I18n/Parser/Adapter/Php.php

@@ -34,7 +34,8 @@ public function __construct(PhraseCollector $phraseCollector)
      */
     protected function _parse()
     {
-        $this->_phraseCollector->parse($this->_file, true);
+        $this->_phraseCollector->setIncludeObjects();
+        $this->_phraseCollector->parse($this->_file);
 
         foreach ($this->_phraseCollector->getPhrases() as $phrase) {
             $this->_addPhrase($phrase['phrase'], $phrase['line']);

dev/tools/Magento/Tools/I18n/Parser/Adapter/Php/Tokenizer/PhraseCollector.php

@@ -31,14 +31,23 @@ class PhraseCollector
      */
     protected $_file;
 
+    /**
+     * Are the Phrase objects are parsed as well
+     *
+     * @var bool
+     */
+    protected $includeObjects = false;
+
     /**
      * Construct
      *
      * @param Tokenizer $tokenizer
+     * @param bool $includeObjects
      */
-    public function __construct(Tokenizer $tokenizer)
+    public function __construct(Tokenizer $tokenizer, $includeObjects = false)
     {
         $this->_tokenizer = $tokenizer;
+        $this->includeObjects = $includeObjects;
     }
 
     /**
@@ -55,29 +64,27 @@ public function getPhrases()
      * Parse given files for phrase
      *
      * @param string $file
-     * @param bool $searchObjects
      * @return void
      */
-    public function parse($file, $searchObjects = false)
+    public function parse($file)
     {
         $this->_phrases = [];
         $this->_file = $file;
         $this->_tokenizer->parse($file);
         while (!$this->_tokenizer->isEndOfLoop()) {
-            $this->_extractPhrases($searchObjects);
+            $this->_extractPhrases();
         }
     }
 
     /**
      * Extract phrases from given tokens. e.g.: __('phrase', ...)
      *
-     * @param bool $searchObjects
      * @return void
      */
-    protected function _extractPhrases($searchObjects)
+    protected function _extractPhrases()
     {
         if ($firstToken = $this->_tokenizer->getNextRealToken()) {
-            if (!$this->extractMethodPhrase($firstToken) && $searchObjects) {
+            if (!$this->extractMethodPhrase($firstToken) && $this->includeObjects) {
                 $this->extractObjectPhrase($firstToken);
             }
         }
@@ -161,4 +168,14 @@ protected function _addPhrase($phrase, $argumentsAmount, $file, $line)
             'line' => $line,
         ];
     }
+
+    /**
+     * @param bool $includeObjects
+     * @return $this
+     */
+    public function setIncludeObjects($includeObjects = true)
+    {
+        $this->includeObjects = (bool)$includeObjects;
+        return $this;
+    }
 }