improve google maps key fetch and docs (#133)

Author: solverat

UPGRADE.md

@@ -9,6 +9,7 @@ Just click the "update" button or execute the migration command to finish the bu
 #### Update from Version 3.1.x to Version 3.2.0
 - **[NEW FEATURE]**: Pimcore 6.4.0 and Pimcore 6.5.0 ready
 - **[NEW FEATURE]**: Store Provider added (https://github.com/dachcom-digital/pimcore-toolbox/pull/128)
+- **[IMPROVEMENT]**: Better Google API Key Fetching: Introduces `toolbox.google_maps.browser_api_key` and `toolbox.google_maps.simple_api_key`. Read more about it [here](./docs/11_ElementsOverview.md#google-map)
 - **[BUG FIX]**: Video Autoplay Fix (https://github.com/dachcom-digital/pimcore-toolbox/issues/129)
 
 #### Update from Version 3.x to Version 3.1.0

docs/11_ElementsOverview.md

@@ -179,26 +179,54 @@ If you want to use a different extension to generate your galleries, just overri
 
 ## Google Map
 Create a Google Map Element. You're able to define one or multiple markers. Toolbox will automatically generate the long/lat information after saving the document.
-Please make sure that you've included a valid google maps api key. Include the script tag in your footer:
 
-```html
-<script type="text/javascript" src="//maps.googleapis.com/maps/api/js?libraries=places&amp;key={{ toolbox_google_map_api_key() }}"></script>
-```
+### Get & set your API Key
+To get a valid API Key you need to follow those steps:
+- Create [a valid google maps api key](https://developers.google.com/maps/documentation/javascript/get-api-key)
+- Enable two APIs: Geocoding API, Maps Javascript API
+- Generate an API Key
+- Copy API Key
+
+### Key Integration
+You have three ways to integrate your Keys.
 
-Now head into the pimcore-backend, open systemsettings, navigate to Google Credentials & API Keys and insert the api key for google maps into the browser-api-key-field:
+#### I. Pimcore Configuration
+
+> Note: This is the recommended way to integrate GM Keys!
+
+Head into the pimcore backend, open system settings, navigate to Google Credentials & API Keys and insert the api key for google maps into the browser-api-key-field: 
 
 ![2_7_1_google_api_keys.png](./img/2_7_1_google_api_keys.png)
 
-If you made your own toolbox-/googleMap-config, please make sure to add the last line to it:
+#### II. Using a Parameter
+If you want to define them via parameters, you're able to define them like this:
+
+```yaml
+# app/config/parameters.yml
+parameters:
+    toolbox_google_service_browser_api_key: YOUR_BROWSER_KEY
+    toolbox_google_service_simple_api_key: YOUR_SIMPLE_KEY
+```
+
+#### III. Direct Element Configuration
+If you don't want do define them via parameters, you need to override the default parameters
+on configuration layer:
+
 ```yaml
 toolbox:
     areas:
         googleMap:
             config_parameter:
-                map_api_key: '%pimcore_system_config.services.google.browserapikey%'
+                map_api_key: '%toolbox.google_maps.browser_api_key%' # replace here
+                simple_api_key: '%toolbox.google_maps.simple_api_key%' # replace here
 ```
 
-> Note: like all other systemsettings, this one is also stored in system.php for versioning
+### Script Integration
+Now you can include the script tag in your footer:
+
+```html
+<script type="text/javascript" src="//maps.googleapis.com/maps/api/js?libraries=places&amp;key={{ toolbox_google_map_api_key() }}"></script>
+```
 
 > Note: This is a [custom toolbox element](22_GoogleMapsElement.md).
 

src/ToolboxBundle/DependencyInjection/ToolboxExtension.php

@@ -27,13 +27,8 @@ class ToolboxExtension extends Extension implements PrependExtensionInterface
      */
     public function prepend(ContainerBuilder $container)
     {
-        // prevent throwing exception if no gm key has been defined.
-        if ($container->hasParameter('pimcore_system_config.services.google.browserapikey') === false) {
-            $container->setParameter('pimcore_system_config.services.google.browserapikey', null);
-        }
-        if ($container->hasParameter('pimcore_system_config.services.google.simpleapikey') === false) {
-            $container->setParameter('pimcore_system_config.services.google.simpleapikey', null);
-        }
+        $container->setParameter('toolbox.google_maps.browser_api_key', null);
+        $container->setParameter('toolbox.google_maps.simple_api_key', null);
 
         $selfConfigs = $container->getExtensionConfig($this->getAlias());
 
@@ -118,6 +113,8 @@ public function load(array $configs, ContainerBuilder $container)
 
         $this->validateToolboxContextConfig($config);
 
+        $this->allocateGoogleMapsApiKey($container);
+
         $contextResolver = $config['context_resolver'];
         unset($config['context_resolver']);
 
@@ -136,6 +133,39 @@ public function load(array $configs, ContainerBuilder $container)
         $definition->setClass($contextResolver);
     }
 
+    /**
+     * @param ContainerBuilder $container
+     */
+    private function allocateGoogleMapsApiKey(ContainerBuilder $container)
+    {
+        $googleBrowserApiKey = null;
+        $googleSimpleApiKey = null;
+
+        $pimcoreCoreConfig = $container->hasParameter('pimcore.config') ? $container->getParameter('pimcore.config') : [];
+        $pimcoreGoogleServiceConfig = isset($pimcoreCoreConfig['services']) && isset($pimcoreCoreConfig['services']['google']) ? $pimcoreCoreConfig['services']['google'] : [];
+
+        // browser api key
+        if ($container->hasParameter('pimcore_system_config.services.google.browserapikey') === true) {
+            $googleBrowserApiKey = $container->getParameter('pimcore_system_config.services.google.browserapikey');
+        } elseif ($container->hasParameter('toolbox_google_service_browser_api_key') === true) {
+            $googleBrowserApiKey = $container->getParameter('toolbox_google_service_browser_api_key');
+        } elseif (isset($pimcoreGoogleServiceConfig['browser_api_key'])) {
+            $googleBrowserApiKey = $pimcoreGoogleServiceConfig['browser_api_key'];
+        }
+
+        //simple api key
+        if ($container->hasParameter('pimcore_system_config.services.google.simpleapikey') === true) {
+            $googleSimpleApiKey = $container->getParameter('pimcore_system_config.services.google.simpleapikey');
+        } elseif ($container->hasParameter('toolbox_google_service_simple_api_key') === true) {
+            $googleSimpleApiKey = $container->getParameter('toolbox_google_service_simple_api_key');
+        } elseif (isset($pimcoreGoogleServiceConfig['simple_api_key'])) {
+            $googleSimpleApiKey = $pimcoreGoogleServiceConfig['simple_api_key'];
+        }
+
+        $container->setParameter('toolbox.google_maps.browser_api_key', $googleBrowserApiKey);
+        $container->setParameter('toolbox.google_maps.simple_api_key', $googleSimpleApiKey);
+    }
+
     /**
      * @param array $config
      */
@@ -155,12 +185,12 @@ private function validateToolboxContextConfig($config)
     }
 
     /**
-     * @deprecated since 2.3. gets removed in 4.0
-     *
      * @param array            $config
      * @param ContainerBuilder $container
      *
      * @return mixed
+     * @deprecated since 2.3. gets removed in 4.0
+     *
      */
     private function handleCalculatorDeprecation($config, ContainerBuilder $container)
     {

src/ToolboxBundle/Resources/config/pimcore/areas/googleMap.yml

@@ -50,5 +50,5 @@ toolbox:
                     scrollwheel: false
                 map_style_url: false
                 marker_icon: false
-                map_api_key: '%pimcore_system_config.services.google.browserapikey%'
-                simple_api_key: '%pimcore_system_config.services.google.simpleapikey%'
+                map_api_key: '%toolbox.google_maps.browser_api_key%'
+                simple_api_key: '%toolbox.google_maps.simple_api_key%'