[UC-3] Add possibility to set configuration values to resource in admin panel

Author: DominikWolos

src/Api/AbstractClient.php

@@ -71,6 +71,10 @@ protected function getApiEndpointUrl(
         string $endpoint,
         string $query = null,
     ): string {
+        if (null === $resource->getUserComUrl()) {
+            throw new \InvalidArgumentException('User.com API key is missing.');
+        }
+
         $url = sprintf(
             '%s/%s/%s/',
             trim($resource->getUserComUrl(), '/'),
@@ -98,6 +102,10 @@ protected function buildOptions(
     protected function authorizeRequest(
         UserComApiAwareInterface $resource,
     ): string {
+        if (null === $resource->getUserComApiKey()) {
+            throw new \InvalidArgumentException('User.com API key is missing.');
+        }
+
         return sprintf(
             'Token %s',
             $resource->getUserComApiKey(),

src/Form/Extension/UserComApiAwareTypeExtension.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BitBag\SyliusUserComPlugin\Form\Extension;
+
+use Sylius\Bundle\ChannelBundle\Form\Type\ChannelType;
+use Symfony\Component\Form\AbstractTypeExtension;
+use Symfony\Component\Form\Extension\Core\Type\PasswordType;
+use Symfony\Component\Form\Extension\Core\Type\TextType;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\Validator\Constraints\NotBlank;
+use Symfony\Component\Validator\Constraints\Url;
+
+final class UserComApiAwareTypeExtension extends AbstractTypeExtension
+{
+    public function buildForm(FormBuilderInterface $builder, array $options)
+    {
+        $builder
+            ->add(
+                'userComApiKey',
+                PasswordType::class,
+                [
+                    'label' => 'bitbag_sylius_user_com_plugin.ui.user_com_api_key',
+                    'required' => false,
+                    'constraints' => [
+                        new NotBlank(['groups' => ['sylius']]),
+                    ],
+                ],
+            )
+            ->add(
+                'userComUrl',
+                TextType::class,
+                [
+                    'label' => 'bitbag_sylius_user_com_plugin.ui.user_com_url',
+                    'required' => false,
+                    'constraints' => [
+                        new NotBlank(['groups' => ['sylius']]),
+                        new Url(['groups' => ['sylius']]),
+                    ],
+                ],
+            );
+    }
+
+    public static function getExtendedTypes(): iterable
+    {
+        return [
+            ChannelType::class,
+        ];
+    }
+}

src/Trait/UserComApiAwareInterface.php

@@ -13,11 +13,11 @@
 
 interface UserComApiAwareInterface
 {
-    public function getUserComUrl(): string;
+    public function getUserComUrl(): ?string;
 
     public function setUserComUrl(string $userComUrl): void;
 
-    public function getUserComApiKey(): string;
+    public function getUserComApiKey(): ?string;
 
     public function setUserComApiKey(string $userComApiKey): void;
 }

src/Trait/UserComApiAwareTrait.php

@@ -13,11 +13,11 @@
 
 trait UserComApiAwareTrait
 {
-    private string $userComUrl;
+    private ?string $userComUrl;
 
-    private string $userComApiKey;
+    private ?string $userComApiKey;
 
-    public function getUserComUrl(): string
+    public function getUserComUrl(): ?string
     {
         return $this->userComUrl;
     }
@@ -27,7 +27,7 @@ public function setUserComUrl(string $userComUrl): void
         $this->userComUrl = $userComUrl;
     }
 
-    public function getUserComApiKey(): string
+    public function getUserComApiKey(): ?string
     {
         return $this->userComApiKey;
     }

templates/UserApiResource/_userComCredentials.html.twig

@@ -0,0 +1,4 @@
+<div class="ui attached segment">
+    {{ form_row(form.userComApiKey) }}
+    {{ form_row(form.userComUrl) }}
+</div>

tests/Application/config/packages/events.yaml

@@ -0,0 +1,7 @@
+sylius_ui:
+    events:
+        sylius.admin.channel.form.first_column_content:
+            blocks:
+                user_com_configuration:
+                    template: '@BitBagSyliusUserComPlugin/UserApiResource/_userComCredentials.html.twig'
+                    priority: 25

tests/Application/config/services.yaml

@@ -2,3 +2,6 @@
 # https://symfony.com/doc/current/best_practices/configuration.html#application-related-configuration
 parameters:
     locale: en_US
+
+imports:
+    - { resource: ./services/** }

tests/Application/config/services/form.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<container xmlns="http://symfony.com/schema/dic/services" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+           xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd"
+>
+    <services>
+        <defaults public="true"/>
+        <service id="bit_bag.sylius_user_com_plugin.form.extension.user_com_api_aware_type_extension" class="BitBag\SyliusUserComPlugin\Form\Extension\UserComApiAwareTypeExtension">
+            <tag name="form.type_extension" extended-type="Sylius\Bundle\ChannelBundle\Form\Type\ChannelType" priority="200" />
+        </service>
+    </services>
+</container>

translations/messages.en.yaml

@@ -0,0 +1,4 @@
+bitbag_sylius_user_com_plugin:
+    ui:
+        user_com_api_key: 'User.com API Key'
+        user_com_url: 'User.com Instance URL'

translations/messages.pl.yaml

@@ -0,0 +1,4 @@
+bitbag_sylius_user_com_plugin:
+    ui:
+        user_com_api_key: 'Klucz API User.com'
+        user_com_url: 'Adres URL instancjiUser.com'