Add installation adjustments

Author: DominikWolos

config/config.yml

@@ -1,2 +1,14 @@
+spinbits_sylius_google_analytics4:
+    id: '%env(TAG_MANAGER_ID)%'
+
+parameters:
+    user_com.frontend_api_key: '%env(USER_COM_FRONTEND_API_KEY)%'
+
+twig:
+    globals:
+        user_com_frontend_api_key: '%user_com.frontend_api_key%'
+
 imports: 
     - { resource: "state_machine/*" }
+    - { resource: "events.yaml" }
+

config/events.yaml

@@ -0,0 +1,12 @@
+sylius_ui:
+    events:
+        sylius.admin.channel.form.first_column_content:
+            blocks:
+                user_com_configuration:
+                    template: '@BitBagSyliusUserComPlugin/UserApiResource/_userComCredentials.html.twig'
+                    priority: 25
+        sylius.shop.layout.stylesheets:
+            blocks:
+                user_com:
+                    template: '@BitBagSyliusUserComPlugin/_userComScripts.html.twig'
+                    priority: 25

config/services/form.xml

@@ -9,5 +9,10 @@
             <argument type="service" id="sylius.context.customer"/>
             <tag name="form.type_extension" />
         </service>
+
+        <service id="bit_bag.sylius_user_com_plugin.form.extension.user_com_api_aware_type_extension" class="BitBag\SyliusUserComPlugin\Form\Extension\UserComApiAwareTypeExtension">
+            <argument type="service" id="bit_bag.sylius_user_com_plugin.provider.user_com_api_aware_resource_provider"/>
+            <tag name="form.type_extension" extended-type="Sylius\Bundle\ChannelBundle\Form\Type\ChannelType" priority="200" />
+        </service>
     </services>
 </container>

doc/installation.md

@@ -0,0 +1,60 @@
+# Installation
+1. Add package to your project via composer:
+    ```bash
+    composer require bitbag/user-com-plugin
+    ```
+   >If `bitbag/user-com-plugin` is not found by composer, try adding repository to your `composer.json` file:
+   > ```json
+   > "repositories": [
+   >    {
+   >       "type": "vcs",
+   >      "url": "https://github.com/BitBagCommerce/SyliusUserComPlugin.git"
+   >    }
+   > ]
+   > ```
+2. Add plugin dependencies to config/bundles.php file:
+    ```php
+    return [
+        ...
+        BitBag\SyliusUserComPlugin\BitBagSyliusUserComPlugin::class => ['all' => true],
+        Spinbits\SyliusGoogleAnalytics4Plugin\SpinbitsSyliusGoogleAnalytics4Plugin::class => ['all' => true],
+        ...
+    ];
+    ```
+3. Import required config in your `config/packages/_sylius.yaml` file:
+    ```yaml
+    imports:
+        ...
+        - { resource: "@BitBagSyliusUserComPlugin/config/config.yml" }
+        ...
+    ```
+4. Extend `Channel` entity `UserComApiAwareTrait` and implement `UserComApiAwareInterface` 
+    ```php
+    class Channel extends BaseChannel implements ChannelInterface
+    {
+        use UserComApiAwareTrait;
+    }
+    ```
+    
+    ```php
+    interface ChannelInterface extends BaseChannelInterface, UserComApiAwareInterface
+    {
+    }
+    ```
+    >`UserComApiAwareTrait` contains mapping for annotations and for attributes which are required by UserCom integration.
+    > If you're using xml mapping, you should add mapping for those properties in your `Channel.orm.xml` file.
+
+5. Add required environment variables to your `.env` file:
+    ```dotenv
+    USER_COM_FRONTEND_API_KEY=""
+    TAG_MANAGER_ID=""
+    ```
+
+6. *Optional* - take advantage of channel based configuration of Google Tag Manager ID:
+    ```yaml
+    spinbits_sylius_google_analytics4:
+        id: "%env(TAG_MANAGER_ID)%"
+        channels_ids:
+            FASHION_WEB: "G-DF1P3RRJ8S"
+            OTHER_CHANNEL: "G-WX1RJ8SP3R"
+    ```

src/Trait/UserComApiAwareTrait.php

@@ -11,10 +11,16 @@
 
 namespace BitBag\SyliusUserComPlugin\Trait;
 
+use Doctrine\ORM\Mapping as ORM;
+
 trait UserComApiAwareTrait
 {
+    #[ORM\Column(name: 'user_com_url', type: 'string', nullable: true)]
+    /** @ORM\Column(name="user_com_url", type="string", nullable=true) */
     private ?string $userComUrl;
 
+    #[ORM\Column(name: 'user_com_url', type: 'string', nullable: true)]
+    /** @ORM\Column(name="user_com_url", type="string", nullable=true) */
     private ?string $userComApiKey;
 
     public function getUserComUrl(): ?string

templates/_userComScripts.html.twig

@@ -1,4 +1,5 @@
 {% set channel = sylius.channel %}
+
 {% if null != channel.userComApiKey and null != channel.userComUrl%}
     {% set customer = sylius.customer|default(null) %}
     {% set genderMap =  constant('BitBag\\SyliusUserComPlugin\\Builder\\Payload\\CustomerPayloadBuilderInterface::GENDER_MAP')%}

tests/Application/.env

@@ -34,4 +34,5 @@ SYLIUS_MESSENGER_TRANSPORT_CATALOG_PROMOTION_REMOVAL_FAILED_DSN=doctrine://defau
 
 ###> UserCom
 USER_COM_FRONTEND_API_KEY=""
+TAG_MANAGER_ID=""
 ###< UserCom

tests/Application/config/services.yaml

@@ -6,6 +6,3 @@ spinbits_sylius_google_analytics4:
 
 parameters:
     locale: en_US
-
-imports:
-    - { resource: ./services/** }

tests/Application/config/services/form.xml

@@ -17,9 +17,4 @@
 class Channel extends BaseChannel implements ChannelInterface
 {
     use UserComApiAwareTrait;
-
-    public function getId(): ?int
-    {
-        return $this->id;
-    }
 }