symfony coding standard (solariumphp#846)

code style fixes implementing (most of) the rules advised by the
symfony coding standard as defined @
https://symfony.com/doc/current/contributing/code/standards.html

Author: wickedOne

.gitignore

@@ -3,4 +3,5 @@
 /vendor
 .idea
 /.phpunit.result.cache
-.php_cs.cache
+/.php_cs.cache
+/.phpcs-cache

.php_cs.dist

@@ -1,5 +1,12 @@
 <?php
 
+$header = <<<'EOF'
+This file is part of the Solarium package.
+
+For the full copyright and license information, please view the COPYING
+file that was distributed with this source code.
+EOF;
+
 return PhpCsFixer\Config::create()
     ->setRiskyAllowed(true)
     ->setRules([
@@ -9,9 +16,9 @@ return PhpCsFixer\Config::create()
        'array_syntax' => ['syntax' => 'short'],
        'class_attributes_separation' => ['elements' => ['const', 'method', 'property']],
        'combine_consecutive_unsets' => true,
-        // one should use PHPUnit methods to set up expected exception instead of annotations
        'general_phpdoc_annotation_remove' => ['expectedException', 'expectedExceptionMessage', 'expectedExceptionMessageRegExp'],
        'heredoc_to_nowdoc' => true,
+       'header_comment' => ['header' => $header],
        'list_syntax' => ['syntax' => 'long'],
        'method_argument_space' => ['keep_multiple_spaces_after_comma' => false],
        'no_extra_consecutive_blank_lines' => ['break', 'continue', 'extra', 'return', 'throw', 'use', 'parenthesis_brace_block', 'square_brace_block', 'curly_brace_block'],
@@ -21,12 +28,9 @@ return PhpCsFixer\Config::create()
        'no_useless_return' => true,
        'ordered_class_elements' => true,
        'ordered_imports' => true,
-       // 'php_unit_strict' => true,
-       // 'php_unit_test_class_requires_covers' => true,
        'phpdoc_add_missing_param_annotation' => true,
        'phpdoc_order' => true,
        'semicolon_after_instruction' => true,
-       // 'strict_comparison' => true,
        'strict_param' => true,
        'implode_call' => true,
        'no_superfluous_phpdoc_tags' => false,
@@ -35,6 +39,5 @@ return PhpCsFixer\Config::create()
         PhpCsFixer\Finder::create()
             ->exclude('vendor/')
             ->in('src')
-            ->in('tests')
     )
 ;

.styleci.yml

@@ -9,7 +9,6 @@ disabled:
     - blank_line_before_break
     - blank_line_before_continue
     - blank_line_before_declare
-    - blank_line_before_return
     - blank_line_before_throw
     - blank_line_before_try
 

composer.json

@@ -20,6 +20,7 @@
         "symfony/contracts": "^1.0 || ^2.0"
     },
     "require-dev": {
+        "escapestudios/symfony2-coding-standard": "^3.11",
         "guzzlehttp/guzzle": "^6.5",
         "nyholm/psr7": "^1.2",
         "php-http/guzzle6-adapter": "^2.0",

phpcs.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="vendor/squizlabs/php_codesniffer/phpcs.xsd">
+
+    <config name="installed_paths" value="vendor/escapestudios/symfony2-coding-standard" />
+
+    <arg name="basepath" value="."/>
+    <arg name="cache" value=".phpcs-cache"/>
+    <arg name="colors"/>
+    <arg name="extensions" value="php"/>
+
+    <rule ref="Symfony"/>
+
+    <file>src/</file>
+
+</ruleset>

src/Builder/AbstractExpressionVisitor.php

@@ -2,6 +2,13 @@
 
 declare(strict_types=1);
 
+/*
+ * This file is part of the Solarium package.
+ *
+ * For the full copyright and license information, please view the COPYING
+ * file that was distributed with this source code.
+ */
+
 namespace Solarium\Builder;
 
 use Solarium\Exception\RuntimeException;
@@ -57,7 +64,7 @@ public function dispatch(ExpressionInterface $expr)
             case $expr instanceof CompositeComparison:
                 return $this->walkCompositeExpression($expr);
             default:
-                throw new RuntimeException('Unknown Expression '.\get_class($expr));
+                throw new RuntimeException(sprintf('Unknown Expression %s', \get_class($expr)));
         }
     }
 }

src/Builder/Analytics/AnalyticsExpressionVisitor.php

@@ -2,6 +2,13 @@
 
 declare(strict_types=1);
 
+/*
+ * This file is part of the Solarium package.
+ *
+ * For the full copyright and license information, please view the COPYING
+ * file that was distributed with this source code.
+ */
+
 namespace Solarium\Builder\Analytics;
 
 use Solarium\Builder\AbstractExpressionVisitor;
@@ -30,7 +37,7 @@ public function dispatch(ExpressionInterface $expr)
             return $this->walkExpression($expr);
         }
 
-        throw new RuntimeException('Unknown Expression '.\get_class($expr));
+        throw new RuntimeException(sprintf('Unknown Expression %s', \get_class($expr)));
     }
 
     /**

src/Builder/Analytics/ExpressionBuilder.php

@@ -2,6 +2,13 @@
 
 declare(strict_types=1);
 
+/*
+ * This file is part of the Solarium package.
+ *
+ * For the full copyright and license information, please view the COPYING
+ * file that was distributed with this source code.
+ */
+
 namespace Solarium\Builder\Analytics;
 
 use Solarium\Builder\ExpressionInterface;

src/Builder/Analytics/FunctionBuilder.php

@@ -2,6 +2,13 @@
 
 declare(strict_types=1);
 
+/*
+ * This file is part of the Solarium package.
+ *
+ * For the full copyright and license information, please view the COPYING
+ * file that was distributed with this source code.
+ */
+
 namespace Solarium\Builder\Analytics;
 
 use Solarium\Builder\ExpressionInterface;

src/Builder/Analytics/MappingFunction.php

@@ -2,6 +2,13 @@
 
 declare(strict_types=1);
 
+/*
+ * This file is part of the Solarium package.
+ *
+ * For the full copyright and license information, please view the COPYING
+ * file that was distributed with this source code.
+ */
+
 namespace Solarium\Builder\Analytics;
 
 use Solarium\Builder\AbstractExpressionVisitor;

src/Builder/Analytics/ReductionFunction.php

@@ -2,6 +2,13 @@
 
 declare(strict_types=1);
 
+/*
+ * This file is part of the Solarium package.
+ *
+ * For the full copyright and license information, please view the COPYING
+ * file that was distributed with this source code.
+ */
+
 namespace Solarium\Builder\Analytics;
 
 use Solarium\Builder\AbstractExpressionVisitor;

src/Builder/Comparison.php

@@ -2,6 +2,13 @@
 
 declare(strict_types=1);
 
+/*
+ * This file is part of the Solarium package.
+ *
+ * For the full copyright and license information, please view the COPYING
+ * file that was distributed with this source code.
+ */
+
 namespace Solarium\Builder;
 
 /**

src/Builder/CompositeComparison.php

@@ -2,6 +2,13 @@
 
 declare(strict_types=1);
 
+/*
+ * This file is part of the Solarium package.
+ *
+ * For the full copyright and license information, please view the COPYING
+ * file that was distributed with this source code.
+ */
+
 namespace Solarium\Builder;
 
 use Solarium\Exception\RuntimeException;

src/Builder/ExpressionInterface.php

@@ -2,6 +2,13 @@
 
 declare(strict_types=1);
 
+/*
+ * This file is part of the Solarium package.
+ *
+ * For the full copyright and license information, please view the COPYING
+ * file that was distributed with this source code.
+ */
+
 namespace Solarium\Builder;
 
 /**

src/Builder/FunctionInterface.php

@@ -2,6 +2,13 @@
 
 declare(strict_types=1);
 
+/*
+ * This file is part of the Solarium package.
+ *
+ * For the full copyright and license information, please view the COPYING
+ * file that was distributed with this source code.
+ */
+
 namespace Solarium\Builder;
 
 /**

src/Builder/Value.php

@@ -2,6 +2,13 @@
 
 declare(strict_types=1);
 
+/*
+ * This file is part of the Solarium package.
+ *
+ * For the full copyright and license information, please view the COPYING
+ * file that was distributed with this source code.
+ */
+
 namespace Solarium\Builder;
 
 /**

src/Client.php

@@ -1,5 +1,12 @@
 <?php
 
+/*
+ * This file is part of the Solarium package.
+ *
+ * For the full copyright and license information, please view the COPYING
+ * file that was distributed with this source code.
+ */
+
 namespace Solarium;
 
 use Solarium\Core\Client\Client as CoreClient;
@@ -66,7 +73,7 @@ class Client extends CoreClient
      */
     public static function checkExact(string $version): bool
     {
-        return substr(self::VERSION, 0, strlen($version)) == $version;
+        return 0 === strpos(self::VERSION, $version);
     }
 
     /**

src/Component/AbstractComponent.php

@@ -1,5 +1,12 @@
 <?php
 
+/*
+ * This file is part of the Solarium package.
+ *
+ * For the full copyright and license information, please view the COPYING
+ * file that was distributed with this source code.
+ */
+
 namespace Solarium\Component;
 
 use Solarium\Component\RequestBuilder\ComponentRequestBuilderInterface;
@@ -34,6 +41,8 @@ abstract public function getRequestBuilder(): ComponentRequestBuilderInterface;
 
     /**
      * This component has no response parser...
+     *
+     * @return \Solarium\Component\ResponseParser\ComponentParserInterface|null
      */
     public function getResponseParser(): ?ComponentParserInterface
     {

src/Component/Analytics/Analytics.php

@@ -2,6 +2,13 @@
 
 declare(strict_types=1);
 
+/*
+ * This file is part of the Solarium package.
+ *
+ * For the full copyright and license information, please view the COPYING
+ * file that was distributed with this source code.
+ */
+
 namespace Solarium\Component\Analytics;
 
 use Solarium\Component\AbstractComponent;

src/Component/Analytics/Facet/AbstractFacet.php

@@ -2,6 +2,13 @@
 
 declare(strict_types=1);
 
+/*
+ * This file is part of the Solarium package.
+ *
+ * For the full copyright and license information, please view the COPYING
+ * file that was distributed with this source code.
+ */
+
 namespace Solarium\Component\Analytics\Facet;
 
 use Solarium\Core\Configurable;

src/Component/Analytics/Facet/ConfigurableInitTrait.php

@@ -2,6 +2,13 @@
 
 declare(strict_types=1);
 
+/*
+ * This file is part of the Solarium package.
+ *
+ * For the full copyright and license information, please view the COPYING
+ * file that was distributed with this source code.
+ */
+
 namespace Solarium\Component\Analytics\Facet;
 
 /**

src/Component/Analytics/Facet/ObjectTrait.php

@@ -2,6 +2,13 @@
 
 declare(strict_types=1);
 
+/*
+ * This file is part of the Solarium package.
+ *
+ * For the full copyright and license information, please view the COPYING
+ * file that was distributed with this source code.
+ */
+
 namespace Solarium\Component\Analytics\Facet;
 
 use Solarium\Core\Configurable;
@@ -47,7 +54,9 @@ public function ensureObject(string $class, $variable)
                 && (false !== $map = $refClass->getConstant('CLASSMAP'))
                 && (true === isset($map[$variable['type']]))
             ) {
-                return new $map[$variable['type']]($variable);
+                $class = $map[$variable['type']];
+
+                return new $class($variable);
             }
         }
 

src/Component/Analytics/Facet/Pivot.php

@@ -2,6 +2,13 @@
 
 declare(strict_types=1);
 
+/*
+ * This file is part of the Solarium package.
+ *
+ * For the full copyright and license information, please view the COPYING
+ * file that was distributed with this source code.
+ */
+
 namespace Solarium\Component\Analytics\Facet;
 
 use Solarium\Component\Analytics\Facet\Sort\Sort;

src/Component/Analytics/Facet/PivotFacet.php

@@ -2,6 +2,13 @@
 
 declare(strict_types=1);
 
+/*
+ * This file is part of the Solarium package.
+ *
+ * For the full copyright and license information, please view the COPYING
+ * file that was distributed with this source code.
+ */
+
 namespace Solarium\Component\Analytics\Facet;
 
 /**