Merge pull request #28 from michalpipa/cs

Switch coding standards to PSR-2
ezsystems · Aug 25, 2015 · 03c2da4 · 03c2da4
2 parents fbb455c + f676d17
commit 03c2da4
Show file tree

Hide file tree

Showing 32 changed files with 91 additions and 97 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,3 +2,4 @@
 /.idea/
 composer.lock
 /components/
+.php_cs.cache
diff --git a/.php_cs b/.php_cs
@@ -0,0 +1,25 @@
+<?php
+
+return Symfony\CS\Config\Config::create()
+    ->setUsingLinter(false)
+    ->setUsingCache(true)
+    ->level(Symfony\CS\FixerInterface::SYMFONY_LEVEL)
+    ->fixers([
+        'concat_with_spaces',
+        '-concat_without_spaces',
+        '-empty_return',
+        '-phpdoc_params',
+        '-phpdoc_separation',
+        '-phpdoc_to_comment',
+        '-spaces_cast',
+        '-blankline_after_open_tag',
+        '-single_blank_line_before_namespace',
+    ])
+    ->finder(
+        Symfony\CS\Finder\DefaultFinder::create()
+            ->in(__DIR__)
+            ->exclude([
+                'vendor',
+            ])
+    )
+;
diff --git a/Client/RecommendationClient.php b/Client/RecommendationClient.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * This file is part of the EzSystemsRecommendationBundle package
+ * This file is part of the EzSystemsRecommendationBundle package.
  *
  * @copyright Copyright (C) eZ Systems AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributd with this source code.
@@ -12,14 +12,12 @@ interface RecommendationClient
     /**
      * @param mixed $contentId
      * @throws \EzSystems\RecommendationBundle\Client\RecommendationClientException If an error occurs with the client
-     * @return void
      */
     public function updateContent($contentId);
 
     /**
      * @param mixed $contentId
      * @throws \EzSystems\RecommendationBundle\Client\RecommendationClientException If an error occurs with the client
-     * @return void
      */
     public function deleteContent($contentId);
 }
diff --git a/Client/YooChooseNotifier.php b/Client/YooChooseNotifier.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * This file is part of the EzSystemsRecommendationBundle package
+ * This file is part of the EzSystemsRecommendationBundle package.
  *
  * @copyright Copyright (C) eZ Systems AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributd with this source code.
@@ -105,11 +105,11 @@ public function updateContent($contentId)
             $this->notify(array(array(
                 'action' => 'update',
                 'uri' => $this->getContentUri($contentId),
-                'contentTypeId' => $this->getContentTypeId($contentId)
+                'contentTypeId' => $this->getContentTypeId($contentId),
             )));
         } catch (RequestException $e) {
             if (isset($this->logger)) {
-                $this->logger->error("YooChoose Post notification error: ".$e->getMessage());
+                $this->logger->error('YooChoose Post notification error: ' . $e->getMessage());
             }
         }
     }
@@ -127,11 +127,11 @@ public function deleteContent($contentId)
             $this->notify(array(array(
                 'action' => 'delete',
                 'uri' => $this->getContentUri($contentId),
-                'contentTypeId' => $this->getContentTypeId($contentId)
+                'contentTypeId' => $this->getContentTypeId($contentId),
             )));
         } catch (RequestException $e) {
             if (isset($this->logger)) {
-                $this->logger->error("YooChoose Post notification error: ".$e->getMessage());
+                $this->logger->error('YooChoose Post notification error: ' . $e->getMessage());
             }
         }
     }
@@ -155,7 +155,7 @@ private function getContentIdentifier($contentId)
     }
 
     /**
-     * Gets ContentType ID based on $contentId
+     * Gets ContentType ID based on $contentId.
      *
      * @param mixed $contentId
      *
@@ -174,7 +174,7 @@ protected function getContentTypeId($contentId)
     }
 
     /**
-     * Generates the REST URI of content $contentId
+     * Generates the REST URI of content $contentId.
      *
      * @param $contentId
      *
@@ -205,31 +205,31 @@ protected function getContentUri($contentId)
     protected function notify(array $events)
     {
         foreach ($events as $event) {
-            if (array_keys($event) != array( 'action', 'uri', 'contentTypeId' )) {
+            if (array_keys($event) != array('action', 'uri', 'contentTypeId')) {
                 throw new InvalidArgumentException('Invalid action keys');
             }
         }
 
         if (isset($this->logger)) {
-            $this->logger->debug("POST notification to YooChoose:".json_encode($events, true));
+            $this->logger->debug('POST notification to YooChoose:' . json_encode($events, true));
         }
 
         $response = $this->guzzle->post(
             $this->getNotificationEndpoint(),
             array(
                 'json' => array(
                     'transaction' => null,
-                    'events' => $events
+                    'events' => $events,
                 ),
                 'auth' => array(
                     $this->options['customer-id'],
-                    $this->options['license-key']
-                )
+                    $this->options['license-key'],
+                ),
             )
         );
 
         if (isset($this->logger)) {
-            $this->logger->debug("Got ".$response->getStatusCode()." from YooChoose notification POST");
+            $this->logger->debug('Got ' . $response->getStatusCode() . ' from YooChoose notification POST');
         }
     }
 
@@ -238,21 +238,21 @@ protected function notify(array $events)
      */
     protected function configureOptions(OptionsResolver $resolver)
     {
-        $options = array( 'customer-id', 'license-key', 'api-endpoint', 'server-uri' );
+        $options = array('customer-id', 'license-key', 'api-endpoint', 'server-uri');
         // Could use setDefined() with symfony ~2.6
         $resolver->setOptional($options);
         $resolver->setDefaults(
             array(
                 'customer-id' => null,
                 'license-key' => null,
                 'server-uri' => null,
-                'api-endpoint' => null
+                'api-endpoint' => null,
             )
         );
     }
 
     /**
-     * Returns the yoochoose notification endpoint
+     * Returns the yoochoose notification endpoint.
      *
      * @return string
      */

diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -17,13 +17,13 @@ public function getConfigTreeBuilder()
             ->arrayNode('yoochoose')
                 ->children()
                     ->scalarNode('customer_id')
-                        ->info("YooChoose customer ID")
-                        ->example("12345")
+                        ->info('YooChoose customer ID')
+                        ->example('12345')
                         ->isRequired()
                     ->end()
                     ->scalarNode('license_key')
-                        ->info("YooChoose license key")
-                        ->example("1234-5678-9012-3456-7890")
+                        ->info('YooChoose license key')
+                        ->example('1234-5678-9012-3456-7890')
                         ->isRequired()
                     ->end()
                 ->end()
@@ -39,8 +39,8 @@ public function getConfigTreeBuilder()
                 ->end()
             ->end()
             ->scalarNode('server_uri')
-                ->info("HTTP base URI of the eZ Publish server")
-                ->example("http://site.com")
+                ->info('HTTP base URI of the eZ Publish server')
+                ->example('http://site.com')
                 ->isRequired()
             ->end();
 

diff --git a/DependencyInjection/ConfigurationMapper.php b/DependencyInjection/ConfigurationMapper.php
@@ -6,7 +6,6 @@
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  * @version //autogentag//
  */
-
 namespace EzSystems\RecommendationBundle\DependencyInjection;
 
 use eZ\Bundle\EzPublishCoreBundle\DependencyInjection\Configuration\SiteAccessAware\ContextualizerInterface;

diff --git a/DependencyInjection/EzSystemsRecommendationExtension.php b/DependencyInjection/EzSystemsRecommendationExtension.php
@@ -7,10 +7,9 @@
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 use Symfony\Component\DependencyInjection\Loader;
-use EzSystems\RecommendationBundle\DependencyInjection;
 
 /**
- * This is the class that loads and manages your bundle configuration
+ * This is the class that loads and manages your bundle configuration.
  *
  * To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/extension.html}
  */
@@ -21,7 +20,7 @@ public function load(array $configs, ContainerBuilder $container)
         $configuration = $this->getConfiguration($configs, $container);
         $config = $this->processConfiguration($configuration, $configs);
 
-        $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
+        $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
         $loader->load('services.yml');
         $loader->load('slots.yml');
         $loader->load('default_settings.yml');

diff --git a/EventListener/Login.php b/EventListener/Login.php
@@ -1,7 +1,7 @@
 <?php
 
 /**
- * This file is part of the EzSystemsRecommendationBundle package
+ * This file is part of the EzSystemsRecommendationBundle package.
  *
  * @copyright Copyright (C) eZ Systems AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
@@ -50,8 +50,7 @@ public function __construct(
         GuzzleClient $guzzleClient,
         $options = array(),
         LoggerInterface $logger = null
-    )
-    {
+    ) {
         $this->authorizationChecker = $authorizationChecker;
         $this->session = $session;
         $this->guzzleClient = $guzzleClient;
@@ -69,7 +68,7 @@ public function onSecurityInteractiveLogin(InteractiveLoginEvent $event)
         if ($this->authorizationChecker->isGranted('IS_AUTHENTICATED_FULLY') | // user has just logged in
             $this->authorizationChecker->isGranted('IS_AUTHENTICATED_REMEMBERED')) { // user has logged in using remember_me cookie
 
-            $notificationUri = sprintf($this->getNotificationEndpoint().'%s/%s/%s',
+            $notificationUri = sprintf($this->getNotificationEndpoint() . '%s/%s/%s',
                 'login',
                 $this->session->get('yc-session-id'),
                 $event->getAuthenticationToken()->getUser()->getAPIUser()->id

diff --git a/EventListener/SessionBackup.php b/EventListener/SessionBackup.php
@@ -1,7 +1,7 @@
 <?php
 
 /**
- * This file is part of the EzSystemsRecommendationBundle package
+ * This file is part of the EzSystemsRecommendationBundle package.
  *
  * @copyright Copyright (C) eZ Systems AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.

diff --git a/Exception/InvalidArgumentException.php b/Exception/InvalidArgumentException.php
@@ -1,7 +1,7 @@
 <?php
 
 /**
- * This file is part of the EzSystemsRecommendationBundle package
+ * This file is part of the EzSystemsRecommendationBundle package.
  *
  * @copyright Copyright (C) eZ Systems AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.

diff --git a/EzSystemsRecommendationBundle.php b/EzSystemsRecommendationBundle.php
@@ -1,11 +1,10 @@
 <?php
 /**
- * This file is part of the EzSystemRecommendationBundle package
+ * This file is part of the EzSystemRecommendationBundle package.
  *
  * @copyright Copyright (C) eZ Systems AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributd with this source code.
  */
-
 namespace EzSystems\RecommendationBundle;
 
 use EzSystems\RecommendationBundle\DependencyInjection\EzSystemsRecommendationExtension;

diff --git a/Tests/Client/YooChooseNotifierTest.php b/Tests/Client/YooChooseNotifierTest.php
@@ -1,16 +1,14 @@
 <?php
 /**
- * This file is part of the eZ Publish Kernel package
+ * This file is part of the eZ Publish Kernel package.
  *
  * @copyright Copyright (C) eZ Systems AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributd with this source code.
  */
-
 namespace EzSystems\RecommendationBundle\Tests\Client;
 
 use EzSystems\RecommendationBundle\Client\YooChooseNotifier;
 use Guzzle\Http\Message\Response;
-use GuzzleHttp\ClientInterface;
 use PHPUnit_Framework_TestCase;
 
 class YooChooseNotifierTest extends PHPUnit_Framework_TestCase
@@ -54,15 +52,15 @@ protected function getNotificationBody($action, $contentId)
                 'events' => array(
                     array(
                         'action' => $action,
-                        'uri' => 'http://example.com/api/ezp/v2/content/objects/'.$contentId,
+                        'uri' => 'http://example.com/api/ezp/v2/content/objects/' . $contentId,
                     ),
                 ),
             ),
         );
     }
 
     /**
-     * Returns the expected API endpoint for notifications
+     * Returns the expected API endpoint for notifications.
      * @return string
      */
     protected function getExpectedEndpoint()

diff --git a/Twig/RecommendationTwigExtension.php b/Twig/RecommendationTwigExtension.php
@@ -1,7 +1,7 @@
 <?php
 
 /**
- * This file is part of the EzSystemsRecommendationBundle package
+ * This file is part of the EzSystemsRecommendationBundle package.
  *
  * @copyright Copyright (C) eZ Systems AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
@@ -130,13 +130,13 @@ public function getFunctions()
         return array(
             new Twig_SimpleFunction('yc_show_recommendations', array($this, 'showRecommendations'), array(
                 'is_safe' => array('html'),
-                'needs_environment' => true
+                'needs_environment' => true,
             )),
 
             new Twig_SimpleFunction('yc_track_user', array($this, 'trackUser'), array(
                 'is_safe' => array('html'),
-                'needs_environment' => true
-            ))
+                'needs_environment' => true,
+            )),
         );
     }
 
@@ -149,8 +149,7 @@ public function getFunctions()
      */
     public function trackUser(Twig_Environment $twigEnvironment, $contentId)
     {
-        if (!in_array($this->getContentIdentifier($contentId), $this->options['includedContentTypes']))
-        {
+        if (!in_array($this->getContentIdentifier($contentId), $this->options['includedContentTypes'])) {
             return '';
         }
 
@@ -163,7 +162,7 @@ public function trackUser(Twig_Environment $twigEnvironment, $contentId)
                 'userId' => $this->getCurrentUserId(),
                 'customerId' => $this->options['customerId'],
                 'consumeTimeout' => ($this->options['consumeTimeout'] * 1000),
-                'trackingScriptUrl' => $this->options['trackingScriptUrl']
+                'trackingScriptUrl' => $this->options['trackingScriptUrl'],
             )
         );
     }
@@ -241,7 +240,7 @@ public function showRecommendations(
                 'feedbackUrl' => $this->getFeedbackUrl($this->getContentTypeId($contentType)),
                 'contentType' => $this->getContentTypeId($this->getContentIdentifier($contentId)),
                 'outputTypeId' => $this->getContentTypeId($contentType),
-                'categoryPath' => $this->getLocationPathString($contentId)
+                'categoryPath' => $this->getLocationPathString($contentId),
             )
         );
     }