5.x (solariumphp#662)

### Added - Solr 8 support ### Changed - Updated dev and test environments to newer package versions, for example PHPUnit 8.0 - Use PHP 7.1 style argument and return type declarations - PHP 7.1 or higher required - Renamed the two variants of DocumentInterface to ResultDocumentInterface and UpdateDocumentInterface to reduce confusion ### Removed - PHP 7.0 support ### Fixed - Status codes of the HTTPAdapter
taligentia · Apr 5, 2019 · 940bb85 · 940bb85
1 parent 5d4ee73
commit 940bb85
Show file tree

Hide file tree

Showing 501 changed files with 4,180 additions and 3,600 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -5,10 +5,11 @@ dist: trusty
 php:
   - 7.3
   - 7.2
-  - 7.1
   - nightly
 
 env:
+  - SYMFONY_VERSION=4.2.* SOLR_VERSION=8.0.0 SOLR_CLOUD=true
+  - SYMFONY_VERSION=4.2.* SOLR_VERSION=8.0.0 SOLR_CLOUD=false
   - SYMFONY_VERSION=4.2.* SOLR_VERSION=7.7.1 SOLR_CLOUD=true
   - SYMFONY_VERSION=4.2.* SOLR_VERSION=7.7.1 SOLR_CLOUD=false
   - SYMFONY_VERSION=4.2.* SOLR_VERSION=6.6.5 SOLR_CLOUD=false

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,10 +4,22 @@ All notable changes to the solarium library will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## [4.3.0-beta.1]
+## [5.0.0-alpha.1]
+### Added
+- Solr 8 support
+
 ### Changed
-- Updated dev and test environments to newer package versions, for example PHPUnit 7.5
-- Increased the number of PHP 7.1 style argument and return type declarations (transition not completed yet)
+- Updated dev and test environments to newer package versions, for example PHPUnit 8.0
+- Use PHP 7.1 style argument and return type declarations
+- PHP 7.1 or higher required
+- Renamed the two variants of DocumentInterface to ResultDocumentInterface and UpdateDocumentInterface to reduce confusion
+
+### Removed
+- PHP 7.0 support
+
+### Fixed
+- Status codes of the HTTPAdapter
+
 
 ## [4.3.0-alpha.2]
 ### Added

diff --git a/composer.json b/composer.json
@@ -19,7 +19,7 @@
     },
     "require-dev": {
         "guzzlehttp/guzzle": "^3.8 || ^6.2",
-        "phpunit/phpunit": "^7.5",
+        "phpunit/phpunit": "^8.0",
         "php-coveralls/php-coveralls": "^2.1",
         "squizlabs/php_codesniffer": "^3.4",
         "zendframework/zend-http": "^2.8"

diff --git a/src/Client.php b/src/Client.php
@@ -34,7 +34,7 @@ class Client extends CoreClient
      *
      * @var string
      */
-    const VERSION = '4.0.0';
+    const VERSION = '5.0.0';
 
     /**
      * Check for an exact version.
@@ -64,7 +64,7 @@ class Client extends CoreClient
      *
      * @return bool
      */
-    public static function checkExact($version)
+    public static function checkExact(string $version): bool
     {
         return substr(self::VERSION, 0, strlen($version)) == $version;
     }
@@ -92,7 +92,7 @@ public static function checkExact($version)
      *
      * @return bool
      */
-    public static function checkMinimal($version)
+    public static function checkMinimal(string $version): bool
     {
         return version_compare(self::VERSION, $version, '>=');
     }

diff --git a/src/Component/AbstractComponent.php b/src/Component/AbstractComponent.php
@@ -3,6 +3,7 @@
 namespace Solarium\Component;
 
 use Solarium\Component\RequestBuilder\ComponentRequestBuilderInterface;
+use Solarium\Component\ResponseParser\ComponentParserInterface;
 use Solarium\Core\Configurable;
 use Solarium\Core\Query\AbstractQuery;
 use Solarium\Core\Query\Helper;
@@ -29,13 +30,14 @@ abstract public function getType(): string;
      *
      * @return ComponentRequestBuilderInterface
      */
-    abstract public function getRequestBuilder();
+    abstract public function getRequestBuilder(): ComponentRequestBuilderInterface;
 
     /**
      * This component has no response parser...
      */
-    public function getResponseParser()
+    public function getResponseParser(): ?ComponentParserInterface
     {
+        return null;
     }
 
     /**
@@ -45,7 +47,7 @@ public function getResponseParser()
      *
      * @return self Provides fluent interface
      */
-    public function setQueryInstance(AbstractQuery $instance)
+    public function setQueryInstance(AbstractQuery $instance): self
     {
         $this->queryInstance = $instance;
 
@@ -55,9 +57,9 @@ public function setQueryInstance(AbstractQuery $instance)
     /**
      * Get parent query instance.
      *
-     * @return AbstractQuery
+     * @return AbstractQuery|null
      */
-    public function getQueryInstance()
+    public function getQueryInstance(): ?AbstractQuery
     {
         return $this->queryInstance;
     }
@@ -67,12 +69,12 @@ public function getQueryInstance()
      *
      * @return \Solarium\Core\Query\Helper
      */
-    public function getHelper()
+    public function getHelper(): Helper
     {
         if ($queryInstance = $this->getQueryInstance()) {
-            return $this->getQueryInstance()->getHelper();
-        } else {
-            return new Helper();
+            return $queryInstance->getHelper();
         }
+
+        return new Helper();
     }
 }
diff --git a/src/Component/ComponentAwareQueryInterface.php b/src/Component/ComponentAwareQueryInterface.php
@@ -97,14 +97,14 @@ public function getComponentTypes();
      *
      * @return self Provides fluent interface
      */
-    public function registerComponentType($key, $component);
+    public function registerComponentType(string $key, string $component);
 
     /**
      * Get all registered components.
      *
      * @return AbstractComponent[]
      */
-    public function getComponents();
+    public function getComponents(): array;
 
     /**
      * Get a component instance by key.
@@ -121,7 +121,7 @@ public function getComponents();
      *
      * @return object|null
      */
-    public function getComponent($key, $autoload = false, $config = null);
+    public function getComponent(string $key, $autoload = false, array $config = null);
 
     /**
      * Set a component instance.
@@ -133,7 +133,7 @@ public function getComponent($key, $autoload = false, $config = null);
      *
      * @return self Provides fluent interface
      */
-    public function setComponent($key, $component);
+    public function setComponent(string $key, AbstractComponent $component): self;
 
     /**
      * Remove a component instance.
@@ -144,5 +144,5 @@ public function setComponent($key, $component);
      *
      * @return self Provides fluent interface
      */
-    public function removeComponent($component);
+    public function removeComponent($component): self;
 }
diff --git a/src/Component/ComponentAwareQueryTrait.php b/src/Component/ComponentAwareQueryTrait.php
@@ -41,7 +41,7 @@ public function getComponentTypes()
      *
      * @return self Provides fluent interface
      */
-    public function registerComponentType($key, $component)
+    public function registerComponentType(string $key, string $component): ComponentAwareQueryInterface
     {
         $this->componentTypes[$key] = $component;
 
@@ -53,7 +53,7 @@ public function registerComponentType($key, $component)
      *
      * @return AbstractComponent[]
      */
-    public function getComponents()
+    public function getComponents(): array
     {
         return $this->components;
     }
@@ -73,11 +73,13 @@ public function getComponents()
      *
      * @return object|null
      */
-    public function getComponent($key, $autoload = false, $config = null)
+    public function getComponent(string $key, $autoload = false, array $config = null)
     {
         if (isset($this->components[$key])) {
             return $this->components[$key];
-        } elseif (true === $autoload) {
+        }
+
+        if (true === $autoload) {
             if (!isset($this->componentTypes[$key])) {
                 throw new OutOfBoundsException('Cannot autoload unknown component: '.$key);
             }
@@ -103,7 +105,7 @@ public function getComponent($key, $autoload = false, $config = null)
      *
      * @return self Provides fluent interface
      */
-    public function setComponent($key, $component)
+    public function setComponent(string $key, AbstractComponent $component): ComponentAwareQueryInterface
     {
         $component->setQueryInstance($this);
         $this->components[$key] = $component;
@@ -120,7 +122,7 @@ public function setComponent($key, $component)
      *
      * @return self Provides fluent interface
      */
-    public function removeComponent($component)
+    public function removeComponent($component): ComponentAwareQueryInterface
     {
         if (is_object($component)) {
             foreach ($this->components as $key => $instance) {
@@ -142,11 +144,15 @@ public function removeComponent($component)
      * Build component instances based on config.
      *
      * @param array $configs
+     *
+     * @return self Provides fluent interface
      */
-    protected function createComponents($configs)
+    protected function createComponents(array $configs): ComponentAwareQueryInterface
     {
         foreach ($configs as $type => $config) {
             $this->getComponent($type, true, $config);
         }
+
+        return $this;
     }
 }