Merge pull request #8 from dachcom-digital/coding-standard/refactor-master

solverat · web-flow · commit 65a911fcac1d · 2024-12-05T17:12:16.000+01:00
[CS] Refactor
diff --git a/src/Builder/SocialPostBuilder.php b/src/Builder/SocialPostBuilder.php
@@ -1,13 +1,24 @@
 <?php
 
+/*
+ * This source file is available under two different licenses:
+ *   - GNU General Public License version 3 (GPLv3)
+ *   - DACHCOM Commercial License (DCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ * @copyright  Copyright (c) DACHCOM.DIGITAL AG (https://www.dachcom-digital.com)
+ * @license    GPLv3 and DCL
+ */
+
 namespace SocialData\Connector\LinkedIn\Builder;
 
 use Carbon\Carbon;
 use SocialData\Connector\LinkedIn\Client\LinkedInClient;
-use SocialDataBundle\Dto\BuildConfig;
 use SocialData\Connector\LinkedIn\Model\EngineConfiguration;
 use SocialData\Connector\LinkedIn\Model\FeedConfiguration;
 use SocialDataBundle\Connector\SocialPostBuilderInterface;
+use SocialDataBundle\Dto\BuildConfig;
 use SocialDataBundle\Dto\FetchData;
 use SocialDataBundle\Dto\FilterData;
 use SocialDataBundle\Dto\TransformData;
@@ -192,7 +203,6 @@ protected function findThumbnail(mixed $media): ?string
         $thumbnail = null;
 
         foreach ($media as $shareMedia) {
-
             if (!isset($shareMedia['thumbnails']) || !is_array($shareMedia['thumbnails'])) {
                 continue;
             }
@@ -210,6 +220,7 @@ protected function findThumbnail(mixed $media): ?string
 
             if (isset($index[0], $validThumbs[$index[0]]['url'])) {
                 $thumbnail = $validThumbs[$index[0]]['url'];
+
                 break;
             }
         }
diff --git a/src/Client/LinkedInClient.php b/src/Client/LinkedInClient.php
@@ -1,5 +1,16 @@
 <?php
 
+/*
+ * This source file is available under two different licenses:
+ *   - GNU General Public License version 3 (GPLv3)
+ *   - DACHCOM Commercial License (DCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ * @copyright  Copyright (c) DACHCOM.DIGITAL AG (https://www.dachcom-digital.com)
+ * @license    GPLv3 and DCL
+ */
+
 namespace SocialData\Connector\LinkedIn\Client;
 
 use SocialData\Connector\LinkedIn\Model\EngineConfiguration;
diff --git a/src/Client/LinkedInSDK.php b/src/Client/LinkedInSDK.php
@@ -1,15 +1,25 @@
 <?php
 
+/*
+ * This source file is available under two different licenses:
+ *   - GNU General Public License version 3 (GPLv3)
+ *   - DACHCOM Commercial License (DCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ * @copyright  Copyright (c) DACHCOM.DIGITAL AG (https://www.dachcom-digital.com)
+ * @license    GPLv3 and DCL
+ */
+
 namespace SocialData\Connector\LinkedIn\Client;
 
 /**
- * Adapted from https://github.com/ashwinks/PHP-LinkedIn-SDK
+ * Adapted from https://github.com/ashwinks/PHP-LinkedIn-SDK.
  */
 class LinkedInSDK
 {
     protected const API_BASE = 'https://api.linkedin.com/v2';
     protected const OAUTH_BASE = 'https://www.linkedin.com/oauth/v2';
-
     public const R_AD_CAMPAIGNS = 'r_ad_campaigns';                        // View advertising campaigns you manage
     public const R_ADS = 'r_ads';                                          // Retrieve your advertising accounts
     public const R_ADS_LEADGEN_AUTOMATION = 'r_ads_leadgen_automation';    // Access your Lead Gen Forms and retrieve leads
@@ -26,7 +36,6 @@ class LinkedInSDK
     public const RW_ORGANIZATION = 'rw_organization';                      // Manage your organization's page and post updates
     public const W_MEMBER_SOCIAL = 'w_member_social';                      // Post, comment and like posts on your behalf
     public const W_ORGANIZATION_SOCIAL = 'w_organization_social';          // Post, comment and like posts on your organization's behalf
-
     protected const HTTP_METHOD_GET = 'GET';
     protected const HTTP_METHOD_POST = 'POST';
     protected const HTTP_METHOD_PUT = 'PUT';
@@ -67,7 +76,7 @@ public function __construct(array $config)
     }
 
     /**
-     * Get the login url, pass scope to request specific permissions
+     * Get the login url, pass scope to request specific permissions.
      *
      * @param array       $scope - an array of requested permissions (can use scope constants defined in this class)
      * @param string|null $state - a unique identifier for this user, if none is passed, one is generated via uniqid
@@ -89,7 +98,7 @@ public function getLoginUrl(array $scope = [], ?string $state = null): string
     }
 
     /**
-     * Exchange the authorization code for access token
+     * Exchange the authorization code for access token.
      *
      * @throws \RuntimeException
      * @throws \InvalidArgumentException
@@ -127,15 +136,15 @@ public function getAccessToken(?string $authorization_code = null): string|bool
     }
 
     /**
-     * This timestamp is "expires in". In other words, the token will expire in now() + expires_in
+     * This timestamp is "expires in". In other words, the token will expire in now() + expires_in.
      */
     public function getAccessTokenExpiration(): ?string
     {
         return $this->accessTokenExpires;
     }
 
     /**
-     * Set the access token manually
+     * Set the access token manually.
      *
      * @throws \InvalidArgumentException
      */
@@ -152,7 +161,7 @@ public function setAccessToken(string $token): self
     }
 
     /**
-     * Set the state manually. State is a unique identifier for the user
+     * Set the state manually. State is a unique identifier for the user.
      *
      * @throws \InvalidArgumentException
      */
@@ -169,31 +178,31 @@ public function setState(string $state): self
     }
 
     /**
-     * Get state
+     * Get state.
      */
     public function getState(): ?string
     {
         return $this->state;
     }
 
     /**
-     * GET an authenticated API endpoind w/ payload
+     * GET an authenticated API endpoind w/ payload.
      */
     public function get(string $endpoint, array $payload = [], array $headers = [], array $curlOptions = []): array
     {
         return $this->fetch($endpoint, $payload, self::HTTP_METHOD_GET, $headers, $curlOptions);
     }
 
     /**
-     * GET an authenticated API endpoind w/ payload
+     * GET an authenticated API endpoind w/ payload.
      */
     public function getEncoded(string $endpoint, array $payload = [], array $headers = [], array $curlOptions = []): array
     {
         return $this->fetch($endpoint, $payload, self::HTTP_METHOD_GET, $headers, $curlOptions, true);
     }
 
     /**
-     * POST to an authenticated API endpoint w/ payload
+     * POST to an authenticated API endpoint w/ payload.
      */
     public function post(string $endpoint, array $payload = [], array $headers = [], array $curlOptions = []): array
     {
@@ -203,7 +212,7 @@ public function post(string $endpoint, array $payload = [], array $headers = [],
     }
 
     /**
-     * PUT to an authenticated API endpoint w/ payload
+     * PUT to an authenticated API endpoint w/ payload.
      */
     public function put(string $endpoint, array $payload = [], array $headers = [], array $curlOptions = []): array
     {
@@ -230,15 +239,15 @@ public function fetchOAuth(string $endpoint, array $payload = [], string $method
     }
 
     /**
-     * Get debug info from the CURL request
+     * Get debug info from the CURL request.
      */
     public function getDebugInfo(): ?array
     {
         return $this->debugInfo;
     }
 
     /**
-     * Make a CURL request
+     * Make a CURL request.
      *
      * @throws \JsonException
      */
@@ -250,7 +259,6 @@ protected function _makeRequest(
         array $curlOptions = [],
         bool $useEncodedQuery = false
     ): array {
-
         $ch = $this->_getCurlHandle();
 
         $options = [
@@ -264,14 +272,12 @@ protected function _makeRequest(
 
         if (!empty($payload)) {
             if (in_array($options[CURLOPT_CUSTOMREQUEST], [self::HTTP_METHOD_POST, self::HTTP_METHOD_PUT], true)) {
-
                 $options[CURLOPT_POST] = true;
                 $options[CURLOPT_POSTFIELDS] = http_build_query($payload);
 
                 $headers[] = 'Content-Length: ' . strlen($options[CURLOPT_POSTFIELDS]);
 
                 $options[CURLOPT_HTTPHEADER] = $headers;
-
             } else {
                 $query = http_build_query($payload);
                 $options[CURLOPT_URL] = sprintf('%s&%s', $options[CURLOPT_URL], ($useEncodedQuery ? urldecode($query) : $query));
@@ -314,5 +320,4 @@ public function __destruct()
             curl_close($this->curlHandle);
         }
     }
-
-}
+}
diff --git a/src/Controller/Admin/LinkedInController.php b/src/Controller/Admin/LinkedInController.php
@@ -1,11 +1,22 @@
 <?php
 
+/*
+ * This source file is available under two different licenses:
+ *   - GNU General Public License version 3 (GPLv3)
+ *   - DACHCOM Commercial License (DCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ * @copyright  Copyright (c) DACHCOM.DIGITAL AG (https://www.dachcom-digital.com)
+ * @license    GPLv3 and DCL
+ */
+
 namespace SocialData\Connector\LinkedIn\Controller\Admin;
 
 use Carbon\Carbon;
 use Pimcore\Bundle\AdminBundle\Controller\AdminAbstractController;
-use SocialData\Connector\LinkedIn\Model\EngineConfiguration;
 use SocialData\Connector\LinkedIn\Client\LinkedInClient;
+use SocialData\Connector\LinkedIn\Model\EngineConfiguration;
 use SocialDataBundle\Connector\ConnectorDefinitionInterface;
 use SocialDataBundle\Controller\Admin\Traits\ConnectResponseTrait;
 use SocialDataBundle\Service\ConnectorServiceInterface;
@@ -95,7 +106,6 @@ public function debugTokenAction(Request $request): JsonResponse
         }
 
         try {
-
             $payload = [
                 'client_id'     => $connectorEngineConfig->getClientId(),
                 'client_secret' => $connectorEngineConfig->getClientSecret(),
diff --git a/src/Definition/ConnectorDefinition.php b/src/Definition/ConnectorDefinition.php
@@ -1,12 +1,23 @@
 <?php
 
+/*
+ * This source file is available under two different licenses:
+ *   - GNU General Public License version 3 (GPLv3)
+ *   - DACHCOM Commercial License (DCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ * @copyright  Copyright (c) DACHCOM.DIGITAL AG (https://www.dachcom-digital.com)
+ * @license    GPLv3 and DCL
+ */
+
 namespace SocialData\Connector\LinkedIn\Definition;
 
 use SocialData\Connector\LinkedIn\Client\LinkedInSDK;
 use SocialData\Connector\LinkedIn\Model\EngineConfiguration;
 use SocialData\Connector\LinkedIn\Model\FeedConfiguration;
-use SocialDataBundle\Connector\ConnectorEngineConfigurationInterface;
 use SocialDataBundle\Connector\ConnectorDefinitionInterface;
+use SocialDataBundle\Connector\ConnectorEngineConfigurationInterface;
 use SocialDataBundle\Connector\SocialPostBuilderInterface;
 use SocialDataBundle\Model\ConnectorEngineInterface;
 use Symfony\Component\OptionsResolver\OptionsResolver;
diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -1,5 +1,16 @@
 <?php
 
+/*
+ * This source file is available under two different licenses:
+ *   - GNU General Public License version 3 (GPLv3)
+ *   - DACHCOM Commercial License (DCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ * @copyright  Copyright (c) DACHCOM.DIGITAL AG (https://www.dachcom-digital.com)
+ * @license    GPLv3 and DCL
+ */
+
 namespace SocialData\Connector\LinkedIn\DependencyInjection;
 
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
diff --git a/src/DependencyInjection/SocialDataLinkedInConnectorExtension.php b/src/DependencyInjection/SocialDataLinkedInConnectorExtension.php
@@ -1,11 +1,22 @@
 <?php
 
+/*
+ * This source file is available under two different licenses:
+ *   - GNU General Public License version 3 (GPLv3)
+ *   - DACHCOM Commercial License (DCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ * @copyright  Copyright (c) DACHCOM.DIGITAL AG (https://www.dachcom-digital.com)
+ * @license    GPLv3 and DCL
+ */
+
 namespace SocialData\Connector\LinkedIn\DependencyInjection;
 
+use Symfony\Component\Config\FileLocator;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
-use Symfony\Component\DependencyInjection\ContainerBuilder;
-use Symfony\Component\Config\FileLocator;
 
 class SocialDataLinkedInConnectorExtension extends Extension
 {
diff --git a/src/EventListener/Admin/AssetListener.php b/src/EventListener/Admin/AssetListener.php
@@ -1,5 +1,16 @@
 <?php
 
+/*
+ * This source file is available under two different licenses:
+ *   - GNU General Public License version 3 (GPLv3)
+ *   - DACHCOM Commercial License (DCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ * @copyright  Copyright (c) DACHCOM.DIGITAL AG (https://www.dachcom-digital.com)
+ * @license    GPLv3 and DCL
+ */
+
 namespace SocialData\Connector\LinkedIn\EventListener\Admin;
 
 use Pimcore\Event\BundleManager\PathsEvent;
diff --git a/src/Form/Admin/Type/LinkedInEngineType.php b/src/Form/Admin/Type/LinkedInEngineType.php
@@ -1,5 +1,16 @@
 <?php
 
+/*
+ * This source file is available under two different licenses:
+ *   - GNU General Public License version 3 (GPLv3)
+ *   - DACHCOM Commercial License (DCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ * @copyright  Copyright (c) DACHCOM.DIGITAL AG (https://www.dachcom-digital.com)
+ * @license    GPLv3 and DCL
+ */
+
 namespace SocialData\Connector\LinkedIn\Form\Admin\Type;
 
 use SocialData\Connector\LinkedIn\Model\EngineConfiguration;
diff --git a/src/Form/Admin/Type/LinkedInFeedType.php b/src/Form/Admin/Type/LinkedInFeedType.php
@@ -1,5 +1,16 @@
 <?php
 
+/*
+ * This source file is available under two different licenses:
+ *   - GNU General Public License version 3 (GPLv3)
+ *   - DACHCOM Commercial License (DCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ * @copyright  Copyright (c) DACHCOM.DIGITAL AG (https://www.dachcom-digital.com)
+ * @license    GPLv3 and DCL
+ */
+
 namespace SocialData\Connector\LinkedIn\Form\Admin\Type;
 
 use SocialData\Connector\LinkedIn\Model\FeedConfiguration;
@@ -21,7 +32,7 @@ public function configureOptions(OptionsResolver $resolver): void
     {
         $resolver->setDefaults([
             'csrf_protection' => false,
-            'data_class' => FeedConfiguration::class
+            'data_class'      => FeedConfiguration::class
         ]);
     }
 }
diff --git a/src/Model/EngineConfiguration.php b/src/Model/EngineConfiguration.php
diff --git a/src/Model/FeedConfiguration.php b/src/Model/FeedConfiguration.php
diff --git a/src/SocialDataLinkedInConnectorBundle.php b/src/SocialDataLinkedInConnectorBundle.php
