Accomodate code review comments.

SurferJeffAtGoogle · SurferJeffAtGoogle · commit 44f93b8e2634 · 2016-11-02T11:18:56.000-07:00
diff --git a/translate/api/README.md b/translate/api/README.md
@@ -12,10 +12,7 @@ Translate API.
 2. Click `Credentials` -> `Create Credentials` -> `API key`.  Copy the
 API key.
 
-3. Replace `YOUR-API-KEY` in `translate.php` with your api key copied
-in step 2.
-
-4. Run:
+3. Run:
 ```
 $ php translate.php 
 Console Tool
diff --git a/translate/api/src/DetectLanguageCommand.php b/translate/api/src/DetectLanguageCommand.php
@@ -18,9 +18,12 @@
 
 namespace Google\Cloud\Samples\Translate;
 
+// [START translate_detect_language]
 use Google\Cloud\Translate\TranslateClient;
+// [END translate_detect_language]
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
@@ -29,21 +32,16 @@
  */
 class DetectLanguageCommand extends Command
 {
-    public function __construct($apiKey)
-    {
-        parent::__construct();
-        $this->apiKey = $apiKey;
-    }
     protected function configure()
     {
         $this
             ->setName('detect')
             ->setDescription('Detect which language text was written in using '
                 . 'Google Cloud Translate API')
-            ->setHelp(<<<'EOF'
+            ->setHelp(<<<EOF
 The <info>%command.name%</info> command detects which language text was written in using the Google Cloud Translate API.
 
-    <info>php %command.full_name% "Your text here"</info>
+    <info>php %command.full_name% -k YOUR-API-KEY "Your text here"</info>
 
 EOF
             )
@@ -52,23 +50,36 @@ protected function configure()
                 InputArgument::REQUIRED,
                 'The text to examine.'
             )
+            ->addOption(
+                'api-key',
+                'k',
+                InputOption::VALUE_REQUIRED,
+                'Your API key.'
+            )
         ;
     }
 
     protected function execute(InputInterface $input, OutputInterface $output)
     {
-        $this->detectLanguage($input->getArgument('text'), $output);
+        $this->detectLanguage(
+            $input->getOption('api-key'),
+            $input->getArgument('text')
+        );
     }
 
     // [START translate_detect_language]
-    protected function detectLanguage($text, OutputInterface $output)
+    /***
+     * @param $apiKey string Your API key.
+     * @param $text string The text for which to detect the language.
+     */
+    protected function detectLanguage($apiKey, $text)
     {
         $translate = new TranslateClient([
-            'key' => $this->apiKey,
+            'key' => $apiKey,
         ]);
         $result = $translate->detectLanguage($text);
-        $output->writeln("Language code: $result[languageCode]");
-        $output->writeln("Confidence: $result[confidence]");
+        print("Language code: $result[languageCode]\n");
+        print("Confidence: $result[confidence]\n");
     }
     // [END translate_detect_language]
 }
diff --git a/translate/api/src/ListCodesCommand.php b/translate/api/src/ListCodesCommand.php
@@ -18,50 +18,57 @@
 
 namespace Google\Cloud\Samples\Translate;
 
+// [START translate_list_codes]
 use Google\Cloud\Translate\TranslateClient;
+// [END translate_list_codes]
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
 /**
  * Command line utility to translate.
  */
 class ListCodesCommand extends Command
 {
-    public function __construct($apiKey)
-    {
-        parent::__construct();
-        $this->apiKey = $apiKey;
-    }
     protected function configure()
     {
         $this
             ->setName('list-codes')
             ->setDescription('List all the language codes in the ' .
                 'Google Cloud Translate API')
-            ->setHelp(<<<'EOF'
+            ->setHelp(<<<EOF
 The <info>%command.name%</info> command lists all the language codes in the Google Cloud Translate API.
 
-    <info>php %command.full_name%</info>
+    <info>php %command.full_name% -k YOUR-API-KEY</info>
 
 EOF
             )
+            ->addOption(
+                'api-key',
+                'k',
+                InputOption::VALUE_REQUIRED,
+                'Your API key.'
+            )
         ;
     }
 
     protected function execute(InputInterface $input, OutputInterface $output)
     {
-        $this->listCodes($output);
+        $this->listCodes($input->getOption('api-key'));
     }
 
     // [START translate_list_codes]
-    protected function listCodes(OutputInterface $output)
+    /**
+     * @param $apiKey string Your API key.
+     */
+    protected function listCodes($apiKey)
     {
         $translate = new TranslateClient([
-            'key' => $this->apiKey,
+            'key' => $apiKey,
         ]);
         foreach ($translate->languages() as $code) {
-            $output->writeln($code);
+            print("$code\n");
         }
     }
     // [END translate_list_codes]
diff --git a/translate/api/src/ListLanguagesCommand.php b/translate/api/src/ListLanguagesCommand.php
@@ -18,7 +18,9 @@
 
 namespace Google\Cloud\Samples\Translate;
 
+// [START translate_list_language_names]
 use Google\Cloud\Translate\TranslateClient;
+// [END translate_list_language_names]
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
@@ -29,24 +31,25 @@
  */
 class ListLanguagesCommand extends Command
 {
-    public function __construct($apiKey)
-    {
-        parent::__construct();
-        $this->apiKey = $apiKey;
-    }
     protected function configure()
     {
         $this
             ->setName('list-langs')
             ->setDescription('List language codes and names in the '
                 . 'Google Cloud Translate API')
-            ->setHelp(<<<'EOF'
+            ->setHelp(<<<EOF
 The <info>%command.name%</info> lists language codes and names in the Google Cloud Translate API.
 
-    <info>php %command.full_name% -t en</info>
+    <info>php %command.full_name% -k YOUR-API-KEY -t en</info>
 
 EOF
             )
+            ->addOption(
+                'api-key',
+                'k',
+                InputOption::VALUE_REQUIRED,
+                'Your API key.'
+            )
             ->addOption(
                 'target-language',
                 't',
@@ -58,20 +61,28 @@ protected function configure()
 
     protected function execute(InputInterface $input, OutputInterface $output)
     {
-        $this->listLanguage($input->getOption('target-language'), $output);
+        $this->listLanguage(
+            $input->getOption('api-key'),
+            $input->getOption('target-language')
+        );
     }
 
     // [START translate_list_language_names]
-    protected function listLanguage($targetLanguage, OutputInterface $output)
+    /**
+     * @param $apiKey string Your API key.
+     * @param $targetLanguage string Language code: Print the names of the
+     *   language in which language?
+     */
+    protected function listLanguage($apiKey, $targetLanguage)
     {
         $translate = new TranslateClient([
-            'key' => $this->apiKey,
+            'key' => $apiKey,
         ]);
         $result = $translate->localizedLanguages([
             'target' => $targetLanguage,
         ]);
         foreach ($result as $lang) {
-            $output->writeln("$lang[code]: $lang[name]");
+            print("$lang[code]: $lang[name]\n");
         }
     }
     // [END translate_list_language_names]
diff --git a/translate/api/src/TranslateCommand.php b/translate/api/src/TranslateCommand.php
@@ -18,7 +18,9 @@
 
 namespace Google\Cloud\Samples\Translate;
 
+// [START translate_translate_text]
 use Google\Cloud\Translate\TranslateClient;
+// [END translate_translate_text]
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
@@ -30,23 +32,24 @@
  */
 class TranslateCommand extends Command
 {
-    public function __construct($apiKey)
-    {
-        parent::__construct();
-        $this->apiKey = $apiKey;
-    }
     protected function configure()
     {
         $this
             ->setName('translate')
             ->setDescription('Translate text using Google Cloud Translate API')
-            ->setHelp(<<<'EOF'
+            ->setHelp(<<<EOF
 The <info>%command.name%</info> command transcribes audio using the Google Cloud Translate API.
 
-    <info>php %command.full_name% -t ja "Hello World."</info>
+    <info>php %command.full_name% -k YOUR-API-KEY -t ja "Hello World."</info>
 
 EOF
             )
+            ->addOption(
+                'api-key',
+                'k',
+                InputOption::VALUE_REQUIRED,
+                'Your API key.'
+            )
             ->addArgument(
                 'text',
                 InputArgument::REQUIRED,
@@ -64,23 +67,29 @@ protected function configure()
     protected function execute(InputInterface $input, OutputInterface $output)
     {
         $this->translate(
+            $input->getOption('api-key'),
             $input->getArgument('text'),
             $input->getOption('target-language'),
             $output
         );
     }
 
     // [START translate_translate_text]
-    protected function translate($text, $targetLanguage, OutputInterface $output)
+    /**
+     * @param $apiKey string Your API key.
+     * @param $text string The text to translate.
+     * @param $targetLanguage string The target language code.
+     */
+    protected function translate($apiKey, $text, $targetLanguage)
     {
         $translate = new TranslateClient([
-            'key' => $this->apiKey,
+            'key' => $apiKey
         ]);
         $result = $translate->translate($text, [
             'target' => $targetLanguage,
         ]);
-        $output->writeln("Source language: $result[source]");
-        $output->writeln("Translation: $result[text]");
+        print("Source language: $result[source]\n");
+        print("Translation: $result[text]\n");
     }
     // [END translate_translate_text]
 }
diff --git a/translate/api/test/CommandTest.php b/translate/api/test/CommandTest.php
diff --git a/translate/api/translate.php b/translate/api/translate.php
