Back to Hyperf

v3.2.1 - TBD

docs/en/changelog/3.2.md

3.2.08.1 KB
Original Source

v3.2.1 - TBD

v3.2.0 - 2026-06-07

Break Changes

  1. The BC of Carbon component

    • Carbon::createFromTimestamp() don't read the default timezone by date_default_timezone_get() for v3.0.
    • Carbon::diffInDays() no longer returns an absolute value by default. Use the $absolute parameter to control whether the result is absolute.
  2. #7625 Renamed JobInterface::getQueueName() to getPoolName() in async-queue component for terminology consistency.

php
<?php
// Before
class CustomJob extends \Hyperf\AsyncQueue\Job
{
    public function getQueueName(): string
    {
        return 'custom';
    }
}

// After
class CustomJob extends \Hyperf\AsyncQueue\Job
{
    public function getPoolName(): string
    {
        return 'custom';
    }
}
php
<?php

use Carbon\Carbon;

$t = time();

# The break usage
Carbon::createFromTimestamp($t, date_default_timezone_get());

# The correct usage
Carbon::createFromTimestamp($t, date_default_timezone_get());
  1. The logger configuration structure has been changed. Please refer to #7563.
php
<?php

// Before
return [
    'default' => [
        'driver' => 'daily',
        'path' => BASE_PATH . '/runtime/logs/hyperf.log',
        'level' => env('LOG_LEVEL', 'debug'),
        'days' => 7,
    ],
];

// After
return [
    'default' => 'default',
    'channels' => [
        'default' => [
            'driver' => 'daily',
            'path' => BASE_PATH . '/runtime/logs/hyperf.log',
            'level' => env('LOG_LEVEL', 'debug'),
            'days' => 7,
        ],
        // Add your custom channels here
    ],
];
  1. The cache configuration structure has been changed. Please refer to #7594.
php
<?php
// Before
return [
    'default' => [
        'driver' => RedisDriver::class,
        'packer' => PhpSerializerPacker::class,
        'prefix' => 'c:',
    ],
];

// After
return [
    'default' => env('CACHE_DRIVER', 'default'),
    'stores' => [
        'default' => [
            'driver' => RedisDriver::class,
            'packer' => PhpSerializerPacker::class,
            'prefix' => 'c:',
        ],
    ],
];
  1. Added dependencies when using swow.

config/autoload/dependencies.php

php
<?php
use Hyperf\Contract\ResponseEmitterInterface;
use Hyperf\Engine\ResponseEmitter;

return [
    ResponseEmitterInterface::class => ResponseEmitter::class,
];

Warn

  1. If you have upgraded to PHP 8.4, please note that both the fgetcsv and fputcsv methods now require providing a default value for the escape parameter.
fputcsv($fp, $fields) must be changed to fputcsv($fp, $fields, escape: '')
fgetcsv($fp) must be changed to fgetcsv($fp, escape: '')

Dependencies Upgrade

  • Upgrade the php version to >=8.2
  • Upgrade the elasticsearch/elasticsearch version to ^8.0 || ^9.0
  • Upgrade the nikic/php-parser version to 5.6
  • Upgrade the symfony/* components to ^6.0 || ^7.0
  • Upgrade the phpunit/phpunit version to ^11.0
  • Upgrade the version of google/protobuf to ^3.6.1 || ^4.2.
  • Upgrade the version of guzzlehttp/guzzle to ^7.0.

Removed

  • #7278 Removed abandoned laminas/laminas-mime package.
  • #7573 Removed deprecated Hyperf\Serializer\Contract\CacheableSupportsMethodInterface interface.
  • #7609 Removed backward compatibility code from Hyperf\AsyncQueue\JobMessage serialization.
  • #7610 Removed deprecated code scheduled for v3.2 removal, including Collection backward compatibility, ProxyTrait parameter mapping, ResumeExitCoordinatorListener, SocketIO Future flag parameter, and WebSocket HandeShakeException typo alias.

Optimized

  • #6804 Optimized the code for reading contents from file when using Hyperf\Di\ReflectionManager::getAllClassesByFinder().
  • #7142 Enhance array shuffle method to support custom random engines.
  • #7431 Optimized the toCssClasses and toCssStyles methods by directly using the input array to simplify the code logic.
  • #7523 Modernize array utilities and JSON validation using PHP 8.4+ functions with polyfills.
  • #7620 Added Symfony 7.4 compatibility with batch command registration.
  • #7653 Improved Parser::parseResponse return value format by replacing Grpc\StringifyAble with Google\Rpc\Status objects for better standardization and code readability.
  • #7658 Optimized event listener provider by adding cache for non-anonymous event classes to avoid repeated listener resolution.

Added

  • #6538 Support to specify the queue name based on the job.
  • #6591 Support v3.0 for nesbot/carbon.
  • #6761 Added toJson method to Hyperf\Contract\Jsonable.
  • #6794 feat: Add Htmlable contract interface for HTTP responses.
  • #7019 Added PDO subclass support for PHP 8.4.
  • #7198 Added connection name to QueryException.
  • #7202 Added support for elasticsearch 8.x.
  • #7629 Added support for elasticsearch 9.x.
  • #7214 Improve Hyperf\Support\Fluent.
  • #7247 Added Hyperf\Pipeline\Pipeline::finally().
  • #7274 Support to take multiple items for shift() and pop() in Hyperf\Collection\Collection.
  • #7302 Added partition() and reject() to Hyperf\Collection\Arr.
  • #7312 Added Macroable support to Hyperf\Context\Context.
  • #7605 Added NonCoroutine attribute for flexible test execution control.
  • #7618 Added a new registration mode for async queue consumer processes that supports automatic registration based on configuration, eliminating the need for manual process registration in config/autoload/processes.php.
  • #7621 Added timestamp prefix to StdoutLogger output format.
  • #7717 Added package database-sqlserver.

Changed

  • #6760 Changed the default type of deleted_at to datetime for hyperf/database.
  • #7208 Throw exceptions when the value is smaller than zero for Hyperf\Database\Query\Builder::limit().
  • #7372 Use empty string as escape for function str_getcsv.
  • #7462 Replaced influxdb/influxdb-php into influxdata/influxdb-client-php.
  • #7563 Changed the logger configuration structure.
  • #7594 Changed the cache configuration structure.
  • #7615 Renamed $queue property to $pool in ConsumerProcess for async-queue component.
  • #7625 Renamed getQueueName() to getPoolName() in async-queue component for terminology consistency.
  • #7714 Don't support Monolog 2.x, only 3.x is supported.

Fixed

  • #6934 Fixed bug that sortByMany() don't return the same result like sortBy().