This helps to avoid the following deprecation message being generated by Symfony's DebugClassLoader:

Method "JsonSerializable::jsonSerialize()" might add "mixed" as a native return type declaration in the future. Do the same in implementation "Solarium\Core\Query\AbstractDocument" now to avoid errors or add an explicit @return annotation to suppress this message.

Co-authored-by: Markus Kalkbrenner git@kalki.de

What's Changed

• Remove deprecated curl_close() for PHP 8.5 compatibility (6.4.x backport) by @mably in #1178

New Contributors

• @mably made their first contribution in #1178

Full Changelog: 6.4.1...6.4.2

##Added

• CBOR formatted update requests
• Solarium\Core\Query\Helper::knn()
• Solarium\Core\Query\Helper::knnTextToVector()
• Solarium\Core\Query\Helper::vectorSimilarity()

prepared corrected 6.4.x minor releases

Added

• Additional test coverage

Changed

• PHPUnit 9 → 10

Removed

• PHP 8.0 support

Added

• PHP 8.4 support
• Solarium\QueryType\Select\Query\Quey::setCanCancel()
• Solarium\QueryType\Select\Query\Quey::setQueryUuid()
• Solarium\QueryType\Select\Query\Quey::setPartialResults()
• Solarium\QueryType\Select\Query\Quey::setCpuAllowed()
• Solarium\QueryType\Select\Query\Quey::setMemAllowed()
• Solarium\QueryType\Select\Query\Quey::setSegmentTerminateEarly()
• Solarium\QueryType\Select\Query\Quey::setMultiThreaded()

Fixed

• JSON update requests correctly handle Stringable object set as field value

Changed

• JSON update requests give precedence to Stringable over JsonSerializable for object set as field value to keep behaviour consistent across request formats

Removed

• Support for config objects, you have to convert them to an array before passing to a constructor or setOptions()

Deprecated

• Solarium\Core\Query\AbstractQuery::setTimeAllowed(), moved to Solarium\QueryType\Select\Query\Query

Added

• Option buildAll for Suggesters
• NoWaitForResponseRequest Plugin

Fixed

• PHP 8.2 deprecations for Solarium\QueryType\Server\Collections results

Added

• PHP 8.3 support
• Solarium\QueryType\Server\Api\Result::getWarning()
• Term Vector Component

Fixed

• ParallelExecution adds a HttpException instead of an empty Result in case of an endpoint failure
• Facet pivot stats contain all fields (previously only the last field was present in the result)
• Facet pivot stats return NAN for a mean value that's NaN
• Facet pivot stats return an associative array for percentiles
• PHP 8.2 deprecation for V1 Config/V2 Introspect API results

Changed

• Facet pivot stats results use the field name instead of 'stats_fields' as array key

Changed

• Spatial component distance type changed from int to float
• Revert return type for Solarium\Component\QueryTrait::setQuery() from self to QueryInterface for backward compatibility with custom query classes that override this method

Added

• Solarium\Component\ReRankQuery::setOperator()
• Solarium\Component\ReRankQuery::setScale() and setMainScale()

Fixed

• MinimumScoreFilter can have a null value in a ValueGroupResult
• Warning when building an Extract request from a stream resource without an associated URI/filename

Changed

• LoadBalancer plugin blocks Extract queries from load balancing by default

Removed

• PHP 7 support

Added

• Loadbalancer plugin can failover on an optional list of HTTP status codes
• Solarium\QueryType\Extract\Query::setFile() now supports stream resources
• Solarium\QueryType\Extract\Result::getFile() and getFileMetadata() to access the retrieved data for extractOnly=true

Fixed

• Solarium\Core\Query\Helper::escapeTerm() has to quote reserved terms AND, OR, TO

Changed

• Solarium\Core\Client\Endpoint::setAuthentication() marks $password as #[\SensitiveParameter] (PHP 8 >= 8.2.0)
• Solarium\Core\Client\Endpoint::setAuthorizationToken() marks $token as #[\SensitiveParameter] (PHP 8 >= 8.2.0)
• Solarium\Core\Client\Request::setAuthentication() marks $password as #[\SensitiveParameter] (PHP 8 >= 8.2.0)

Added

• Support for Luke queries
• Solarium\Component\QueryElevation::setExcludeTags()
• Solarium\Core\Query\Result\QueryType::getStatus() and getQueryTime(), inherited by all Solarium\QueryType Results
• Solarium\QueryType\CoreAdmin\Result\Result::getInitFailureResults()
• Solarium\QueryType\Ping\Result::getPingStatus() and getZkConnected()
• Fluent interface methods for adding/removing excludes in Solarium\Component\Facet\AbstractFacet
• Fluent interface methods for adding/removing terms in Solarium\Component\Facet\Field

Fixed

• JSON serialization of arrays with non-consecutive indices in multivalue fields
• PHP 8.2 deprecations
• Handling of escaped literal commas in local parameters for faceting

Changed

• Update queries use the JSON request format by default
• Ping queries set omitHeader=false by default

Removed

• Removed deprecated class constant Client::Version. Use Client::getVersion() instead
• Removed Core/Query/AbstractResponseParser::addHeaderInfo()

Deprecated

• Solarium\QueryType\Server\Collections\Result\CreateResult::getStatus(), use getCreateStatus() instead
• Solarium\QueryType\Server\Collections\Result\DeleteResult::getStatus(), use getDeleteStatus() instead
• Solarium\QueryType\Server\Collections\Result\ReloadResult::getStatus(), use getReloadStatus() instead
• LocalParameters::removeTerms(), use removeTerm() instead

Added

• PHP 8.2 support
• JSON formatted update requests
• Solarium\Component\Highlighting\Highlighting::setQueryFieldPattern()

Added

• Core\Client\Adapter\Curl::setProxy() to set proxy (instead of through options)
• Proxy support for Http adapter with Core\Client\Adapter\Http::setProxy()
• Authorization token support

Fixed

• Plugins unregister event listeners when removed with Client::removePlugin()
• Workaround for opcache.preload issue in deprecated code unless 6.3.0 will be released

Changed

• RequestBuilders must set a Content-Type on the Request for POST and PUT requests. Adapters no longer set a default.

Deprecated

• Setting proxy on the Curl adapter through options, use setProxy() instead

Fixed

• An empty array for a multiValued field was wrongly interpreted as an empty child document by the Update request builder in 6.2.5

Added

• Results and Documents implement JsonSerializable
• ParallelExecution dispatches PreExecute, PreExecuteRequest, PostExecuteRequest, PostExecute events. It can be combined with plugins that hook into these events (e.g. PostBigRequest).
• ParallelExecution support for Server queries
• Solarium\Client::getVersion()

Fixed

• Adding nested child documents through Document::setField() and Document::addField()

Changed

• ParallelExecution doesn't replace an existing cURL adapter on the Client. Timeout and proxy settings are honoured on parallel requests.
• ParallelExecution sets the 'timeout' and 'connectiontimeout' options from (Connection)TimeoutAware adapters when switching to a cURL adapter

Removed

• Solarium\QueryType\Update\Query\Document::setFilterControlCharacters(), extend Update\Query\Query to use a custom request builder & helper if you don't want control characters filtered

Deprecated

• Solarium\Client::VERSION

Added

• Symfony 6 support
• Solr 9 support
• Unified Highlighter support + improved support for other highlighters

Fixed

• Solarium\QueryType\Server\Collections\Query\Action\ClusterStatus::getRoute() always returned NULL even if a route was set
• Solarium\Component\Highlighting\Highlighting::setMethod() didn't set the correct request parameter

Changed

• Solarium\QueryType\Select\Query\Query::setCursormark() and getCursormark() are now setCursorMark() and getCursorMark() with uppercase M
• Managed resources execute GET requests for the Exists command by default to avoid SOLR-15116 and SOLR-16274. Set the 'useHeadRequest' option to true to execute HEAD requests instead.

Removed

• Solarium\QueryType\Stream\Expression, use Solarium\QueryType\Stream\ExpressionBuilder instead

Added

• Plugin\BufferedAddLite (BufferedAdd without event dispatching)
• Plugin\BufferedDelete and Plugin\BufferedDeleteLite

Fixed

• Local parameter values are now escaped automatically when necessary

Added

• PHP 8.1 support

Added

• Possibility to set the context on an endpoint for SolrCloud instances with a non-default hostContext or Solr instances behind a reverse proxy, defaults to solr if omitted

Added

• Component\FacetSet::setOffset()
• Component\FacetSet::setMethod() and Component\FacetSet::{METHOD_ENUM,METHOD_FC,METHOD_FCS,METHOD_UIF}
• Component\FacetSet::setEnumCacheMinimumDocumentFrequency()
• Component\FacetSet::setExists()
• Component\FacetSet::setOverrequestCount()
• Component\FacetSet::setOverrequestRatio()
• Component\FacetSet::setThreads()
• Component\FacetSet::setPivotMinCount() to set the global facet.pivot.mincount parameter
• Component\Facet\Pivot::setPivotMinCount() to set the facet.pivot.mincount parameter for a specific pivot's fields
• Component\Facet\Pivot::setOffset()
• Component\Facet\Pivot::setSort()
• Component\Facet\Pivot::setOverrequestCount()
• Component\Facet\Pivot::setOverrequestRatio()
• Component\Facet\Field::METHOD_FCS for per-segment field faceting for single-valued string fields
• Component\Facet\Field::METHOD_UIF for UnInvertedField faceting
• Component\Facet\Field::setEnumCacheMinimumDocumentFrequency()
• Component\Facet\Field::setExists()
• Component\Facet\Field::setOverrequestCount()
• Component\Facet\Field::setOverrequestRatio()
• Component\Facet\Field::setThreads()
• Component\Facet\JsonTerms::{SORT_COUNT_ASC,SORT_COUNT_DESC,SORT_INDEX_ASC,SORT_INDEX_DESC}
• Component\Facet\JsonTerms::setOverRefine()
• Component\Facet\JsonTerms::setPrelimSort()

Fixed

• Component\Facet\Pivot::setLimit() now sets the correct query parameter
• Component\Facet\JsonTerms::setSort() PHPDoc

Deprecated

• Component\Facet\Pivot::setMinCount(), use Component\FacetSet::setPivotMinCount() or Component\Facet\Pivot::setPivotMinCount() instead
• Component\Facet\JsonTerms::SORT_COUNT, use SORT_COUNT_ASC or SORT_COUNT_DESC instead
• Component\Facet\JsonTerms::SORT_INDEX, use SORT_INDEX_ASC or SORT_INDEX_DESC instead

Added

• PHP 8.1 support
• QueryType\Update\Query\Document::setFields() to set all fields on a Document

Fixed

• Always respect automatic filtering of control characters in field values in QueryType\Update\Query\Document
• Remove the field modifier along with the value(s) and boost in QueryType\Update\Query\Document::removeField()
• Allow string to be returned for min, max and mean statistics in Component\Result\Stats\ResultTrait

Added

• Component\Result\Stats\Result::getDistinctValues()
• Component\Result\Stats\Result::getCountDistinct()
• Component\Result\Stats\Result::getCardinality()
• Component\Result\Stats\FacetValue::getPercentiles()
• Component\Result\Stats\FacetValue::getDistinctValues()
• Component\Result\Stats\FacetValue::getCountDistinct()
• Component\Result\Stats\FacetValue::getCardinality()
• Component\Result\Stats\FacetValue::getStatValue()
• Plugin PostBigExtractRequest
• Support for Configset API
• Set connection timeout on cURL adapter

Fixed

• Component\Result\Stats\Result::getPercentiles() returns percentiles as an associative array

Changed

• Component\Result\Stats\Result::getMean() returns NAN instead of 'NaN' if mean is NaN
• Component\Result\Stats\FacetValue::getMean() returns NAN instead of 'NaN' if mean is NaN
• Component\Result\Stats\Result::getValue() is renamed to getStatValue()

Deprecated

• Component\Result\Stats\FacetValue::getFacets()
• Component\Result\Stats\Result::getValue()

Added

• Solarium\QueryType\ManagedResources\Result\Command::getWasSuccessful()
• Solarium\QueryType\ManagedResources\Result\Command::getStatusMessage()
• Query a single term in a Managed Resource

Fixed

• Syntax error in request with facet queries that contain local parameters
• HEAD requests could lead to timeouts with cURL adapter
• Fix for reserved characters in managed resources (SOLR-6853)
• Parsing nested details in debug response

Changed

• Solarium\Component\Result\Stats\Result::getValue() is now public

Fixed

• possible exception in Debug\Detail::__toString() when sub details are missing

Added

• MoreLikeThis::setMaximumDocumentFrequency()
• MoreLikeThis::setMaximumDocumentFrequencyPercentage()
• getInterestingTerms() of MoreLikeThis Component results

Fixed

• Debug\Detail return value types
• Debug\Document return value types

Deprecated

• Support for mlt.match.include and mlt.match.offset in MoreLikeThis Component (they only work in MLT queries)

Fixed

• Set Client::VERSION to '6.1.1'. Release 6.1.0 accidentally declared itself as 6.0.4.

Added

• Indexing labelled nested child documents through pseudo-fields
• Extract query now supports extractFormat
• Helper::rangeQuery() now supports left-inclusive only and right-inclusive only queries

Fixed

• PrefetchIterator::key() should return 0 instead of NULL on a fresh PrefetchIterator
• PrefetchIterator::next() shouldn't skip fetched results after PrefetchIterator::count() on a fresh PrefetchIterator
• PrefetchIterator::rewind() no longer results in duplicate documents when invoked mid-set
• Fixed incorrect median function
• Fix for maxScore being returned as "NaN" when group.query doesn't match any docs (SOLR-13839)

Changed

• Exception message for invalid/unavailable file in Extract query now contains filename
• Helper::rangeQuery() detects point values without parameter to turn off escaping

Removed

• PHP 7.2 support

Added

• PHP 8 support

Fixed

• Avoid Notice: Undefined variable: http_response_header

Fixed

• Tika based file extraction with Solr 8.6
• Avoid TypeError if ClusterState contains no collections

Changed

• Require specific symfony/event-dispatcher-contracts package instead of the generic symfony/contracts

Added

• Support for the analytics component
• Function builder
• Solarium\Component\FacetSet::setMatches()
• Solarium\Component\FacetSet::setExcludeTerms()
• Solarium\Component\Facet\Field::setMatches()
• Solarium\Component\Facet\Field::setExcludeTerms()
• Solarium\Component\Highlighting\Highlighting::setMethod()

Changed

• Refactored Managed Resources code: use createCommand() and createInitArgs() to issue commands

Added

• Solarium\Component\Result\Facet\JsonRange::getBefore()
• Solarium\Component\Result\Facet\JsonRange::getAfter()
• Solarium\Component\Result\Facet\JsonRange::getBetween()

Changed

• Json range facet result now returns Solarium\Component\Result\Facet\JsonRange

Added

• \Solarium\Component\Result\Facet\Buckets::getNumBuckets()

Changed

• Thrown exceptions always implement Solarium\Exception\ExceptionInterface

Added

• \Solarium\Support\Utility::getXmlEncoding()

Fixed

• MoreLikeThis result parsing fails on SolrCloud
• MinimumScoreFilter plugin might fail on Solr 7 in cloud mode

Changed

• PostBigRequest plugin now acts on PRE_EXECUTE_REQUEST event instead of POST_CREATE_REQUEST
• CustomizeRequest plugin now acts on POST_CREATE_REQUEST event instead of PRE_EXECUTE_REQUEST

Removed

• PHP 7.1 support

Added

• Raw XML commands to update query
• Raw XML from file in update query
• Set input encoding for select and update queries
• Create and configure Managed Resources

Changed

• More strict types and type hinting
• AdapterInterface does not extend ConfigurableInterface anymore
• Http Adapter does not implement ConfigurableInterface anymore
• Psr18Adapter does not implement ConfigurableInterface anymore
• Solarium Client now accepts any PSR-14 compatible event dispatcher (previously it had to be the Symfony EventDispatcher)

Removed

• Zend2HttpAdapter
• GuzzleAdapter
• Guzzle3Adapter
• Endpoint::setTimeout and Endpoint::getTimeout
• Passing local parameter options (e.g. key, tag, exclude) without the local_ prefix
• Support for Solr versions before 7.7

Added

• PSR-18 http adapter

Fixed

• PUT requests against Solr 8.5.0 using the Zend2Http and Http adapters

Deprecated

• Zend2HttpAdapter, use PSR-18 http adapter instead
• GuzzleAdapter, use PSR-18 http adapter instead
• Guzzle3Adapter, use PSR-18 http adapter instead
• Endpoint::setTimeout and Endpoint::getTimeout, configure the timeout on the http adapter instead

Added

• Range facet pivot support
• Support for useConfiguredElevatedOrder
• FilterQuery::setCache and FilterQuery::setCost()

Fixed

• Setting limit for pivot facets

Changed

• Internal handling of Solr local parameters

Deprecated

• Helper::cacheControl(). Use FilterQuery::setCache() and FilterQuery::setCost() instead

Security

• Remove explicit requirements for symfony/cache because of CVE-2019-18889

Added

• Symfony 5 support

Fixed

• PHP 7.4 compatibility issue: deprecated parameter order of implode()
• PHP 7.4 test coverage
• Solarium\Component\Result\Stats\Result getters might return null

Added

• Solarium\Component\Facet\Pivot::setLimit()
• Solarium\Component\Facet\Pivot::getLimit()

Fixed

• Client::checkExact() checks against wrong version number

Fixed

• Solarium\Component\ResponseParser\Debug fails on SolrCloud 6.x during extracting timing phases

Fixed

• BufferedAdd does not support Symfony event dispatcher
• An empty array as value in combination with the set modifier should remove a field when performing Atomic Updates

Fixed

• PHP 7.1 compatibility issue: date constants are not available as part of DateTimeInterface before PHP 7.2.0
• Use Symfony\Contracts\EventDispatcher\Event instead of deprecated Symfony\Component\EventDispatcher\Event

Fixed

• BufferedAdd::commit() type hints
• Symfony >=4.3 event dispatcher deprecation warnings

Added

• Solarium\Core\Query\Helper::formatDate() now handles DateTimeImmutable

Changed

• Try to capture complete response body as error message when using guzzle instead of using guzzle's truncated message
• Adapted to Symfony >=4.3 event dispatching, backward compatible to >=3.4, <=4.2

Fixed

• Complex ReRank queries should not cause Solr parse errors
• Update request builders format \DateTimeImmutable correctly
• Symfony >=4.3 event dispatcher deprecation warnings

Removed

• Symfony <3.4 support

Fixed

• Solarium\QueryType\MoreLikeThis\Query::setBoost()

Changed

• Solarium\Core\Query\AbstractQuery::setTimeZone() now accepts \DateTimeZone objects as parameter

Fixed

• Spellchecker result isn't NULL in case of no suggestions and correctly spelled
• RangeFacet Result
• Solarium\QueryType\Select\Result and Component return types
• Solarium\Component\Highlighting::setFields() should accept comma separated string, too
• Solarium\Component\Result\Grouping\ValueGroup various return types
• Solarium\Component\RequestBuilder\RequestParamsTrait::addParam should not add empty arrays
• MinimumScoreFilterPlugin
• Running the examples

Added

• Solarium\Component\MoreLikeThis::setInterestingTerms()
• Solarium\Component\MoreLikeThis::setMatchInclude()
• Solarium\Component\MoreLikeThis::setMatchOffset()

Fixed

• Getting started documentation

Added

• Component\Result\Facet\Bucket::getFacetSet()

Added

• Spellcheck\Suggestion::getOriginalTerm()
• QueryType\Stream\ExpressionBuilder

Changed

• Usage of composer and autoloader in examples.

Fixed

• Query::setFields() should accept comma separated string, too.
• Readthedocs theme

Deprecated

• QueryType\Stream\Expression is deprecated. Use QueryType\Stream\ExpressionBuilder instead.

Added

• Support multiple spellcheck dictionaries

Fixed

• Helper::rangeQuery() must not escape point values. Added a new parameter to turn off escaping.

Added

• Introduced FacetResultInterface

Fixed

• TypeError: Return value of Solarium\Component\Result\FacetSet::getFacet()

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
• Refactored the two variants of DocumentInterface to become one to reduce confusion

Removed

• PHP 7.0 support

Fixed

• Status codes of the HTTPAdapter

Added

• Basic V2 API support
• Endpoint::getV2BaseUri

Changed

• AdapterHelper functions are static

Fixed

• In the past, the V1 API endpoint solr was not added automatically, so most users set it as path on the endpoint. This bug was discovered with the addition of V2 API support. In almost every setup, the path has to be set to / instead of /solr with this release!

Fixed

• If a term contains a space, the space needs to be quoted by Helper::escapeTerm()
• Typos

Added

• Support for managed resources
• Support for add-distinct and removeregex modifiers
• Basic support for Collections API (create, delete, reload, clusterstatus)

Added

• Basic support for PUT requests in the HttpAdapter layer
• Support for managed resources
• Core Admin Queries
• Endpoint::getServerUri
• Endpoint::getCoreBaseUri
• Expression::indent
• BufferedAdd::setCommitWithin
• BufferedAdd::setOverwrite
• Set erroneous expression on StreamException
• Managed resources, stopwords and synonyms query types

Deprecated

• Endpoint::getBaseUri is deprecated. Please use getServerUri or getCoreBaseUri now

Fixed

• Allow multiple Field Facets for the same field by dynamically using local facet params if required