Printing out option info in the config

knpuniversity · Feb 2, 2016 · 0baf522 · 0baf522
1 parent c8cc109
commit 0baf522
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 4 deletions.
diff --git a/DependencyInjection/Providers/GoogleProviderConfigurator.php b/DependencyInjection/Providers/GoogleProviderConfigurator.php
@@ -10,10 +10,12 @@ public function buildConfiguration(NodeBuilder $node)
     {
         // todo - add the comments as help text, and render in README
         $node
-            // Optional value for sending hd parameter. More detail: https://developers.google.com/accounts/docs/OAuth2Login#hd-param
-            ->scalarNode('access_type')->end()
-            // #Optional value for sending access_type parameter. More detail: https://developers.google.com/identity/protocols/OAuth2WebServer#offline
-            ->scalarNode('hosted_domain')->end()
+            ->scalarNode('access_type')
+                ->info('Optional value for sending hd parameter. More detail: https://developers.google.com/accounts/docs/OAuth2Login#hd-param')
+            ->end()
+            ->scalarNode('hosted_domain')
+                ->info('Optional value for sending access_type parameter. More detail: https://developers.google.com/identity/protocols/OAuth2WebServer#offline')
+            ->end()
         ;
     }
 

diff --git a/README.md b/README.md
@@ -235,7 +235,9 @@ knpu_oauth2_client:
             # a route name you'll create
             redirect_route: connect_google_check
             redirect_params: {}
+            # Optional value for sending hd parameter. More detail: https://developers.google.com/accounts/docs/OAuth2Login#hd-param
             # access_type: ''
+            # Optional value for sending access_type parameter. More detail: https://developers.google.com/identity/protocols/OAuth2WebServer#offline
             # hosted_domain: ''
             # whether to check OAuth2 "state": defaults to true
             # use_state: true

diff --git a/bin/update_readme b/bin/update_readme
@@ -92,6 +92,10 @@ foreach (KnpUOAuth2ClientExtension::getAllSupportedTypes() as $type) {
                 : "''";
         }
 
+        if ($child->getInfo()) {
+            $customKeys[] = '# '.$child->getInfo();
+        }
+
         // if not required, comment out, it's extra
         $keyString = $child->isRequired() ? '' : '# ';
         $customKeys[] = $keyString . sprintf(