From 8dbab98dfea5dd54be7c5005c4a0c9b8d9907444 Mon Sep 17 00:00:00 2001 From: Deeka Wong <8337659+huangdijia@users.noreply.github.com> Date: Sun, 31 Aug 2025 15:41:45 +0800 Subject: [PATCH 1/3] =?UTF-8?q?chore:=20fix=20naming/spelling;=20rename=20?= =?UTF-8?q?DatabaseMessages=E2=86=92DatabaseMessage=20(BC=20alias)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Replace 'Not Support job type.' with 'Unsupported job type.' - Correct 'will removed' → 'will be removed' in deprecations - Improve ReCaptcha not published message - Deprecate EntryType::SCHEDULED_TASK as alias of SCHEDULE - Rename DatabaseMessages to DatabaseMessage; update tests; add class_alias for BC - Tweak cache ConfigProvider comments --- src/cache/src/CacheInterface.php | 2 +- src/cache/src/ConfigProvider.php | 4 ++-- src/cache/src/Contract/CacheInterface.php | 2 +- src/helpers/src/Functions.php | 4 ++-- .../{DatabaseMessages.php => DatabaseMessage.php} | 13 ++++++++++++- src/recaptcha/src/ReCaptchaManager.php | 2 +- src/support/src/Environment.php | 2 +- src/support/src/Once/Backtrace.php | 2 +- src/support/src/Once/Cache.php | 2 +- src/telescope/src/EntryType.php | 4 ++++ ...DatabaseChannelCustomizeTypeTestNotification.php | 6 +++--- .../NotificationDatabaseChannelTestNotification.php | 6 +++--- 12 files changed, 32 insertions(+), 17 deletions(-) rename src/notification/src/Message/{DatabaseMessages.php => DatabaseMessage.php} (65%) diff --git a/src/cache/src/CacheInterface.php b/src/cache/src/CacheInterface.php index d3dab20ca..3ec39080d 100644 --- a/src/cache/src/CacheInterface.php +++ b/src/cache/src/CacheInterface.php @@ -15,7 +15,7 @@ class_alias(Contract\Repository::class, CacheInterface::class); if (false) { // @phpstan-ignore-line /** - * @deprecated since v3.1, use `\FriendsOfHyperf\Cache\Contract\Repository` instead, will removed in v3.2 + * @deprecated since v3.1, use `\FriendsOfHyperf\Cache\Contract\Repository` instead, will be removed in v3.2 */ interface CacheInterface extends Contract\Repository { diff --git a/src/cache/src/ConfigProvider.php b/src/cache/src/ConfigProvider.php index 5ca93a45e..478385df4 100644 --- a/src/cache/src/ConfigProvider.php +++ b/src/cache/src/ConfigProvider.php @@ -19,8 +19,8 @@ public function __invoke(): array 'dependencies' => [ Contract\Factory::class => fn ($container) => $container->get(CacheManager::class), Contract\Repository::class => RepositoryFactory::class, - Contract\CacheInterface::class => fn ($container) => $container->get(Contract\Repository::class), // Will removed in v3.2 - CacheInterface::class => fn ($container) => $container->get(Contract\Repository::class), // Will removed in v3.2 + Contract\CacheInterface::class => fn ($container) => $container->get(Contract\Repository::class), // Will be removed in v3.2 + CacheInterface::class => fn ($container) => $container->get(Contract\Repository::class), // Will be removed in v3.2 ], ]; } diff --git a/src/cache/src/Contract/CacheInterface.php b/src/cache/src/Contract/CacheInterface.php index 975f53659..7ec519f78 100644 --- a/src/cache/src/Contract/CacheInterface.php +++ b/src/cache/src/Contract/CacheInterface.php @@ -15,7 +15,7 @@ class_alias(Repository::class, CacheInterface::class); if (false) { // @phpstan-ignore-line /** - * @deprecated since v3.1, use `\FriendsOfHyperf\Cache\Contract\Repository` instead, will removed in v3.2 + * @deprecated since v3.1, use `\FriendsOfHyperf\Cache\Contract\Repository` instead, will be removed in v3.2 */ interface CacheInterface extends Repository { diff --git a/src/helpers/src/Functions.php b/src/helpers/src/Functions.php index 28f3c1e52..9f9703f93 100644 --- a/src/helpers/src/Functions.php +++ b/src/helpers/src/Functions.php @@ -215,14 +215,14 @@ function dispatch($job, ...$arguments) ->getProducer((string) ($arguments[0] ?? 'default')) ->sendBatch([$job]), class_exists(AsyncTask::class) && interface_exists(AsyncTaskInterface::class) && $job instanceof AsyncTaskInterface => AsyncTask::deliver($job, ...$arguments), // @deprecated since v3.1, will be removed in v3.2 - default => throw new InvalidArgumentException('Not Support job type.') + default => throw new InvalidArgumentException('Unsupported job type.') }; } /** * @param mixed $environments * @return bool|Environment - * @deprecated since 3.1, use `Str::is($patterns, env('APP_ENV'))` instead, will removed in 3.2. + * @deprecated since 3.1, use `Str::is($patterns, env('APP_ENV'))` instead, will be removed in 3.2. */ function environment(...$environments) { diff --git a/src/notification/src/Message/DatabaseMessages.php b/src/notification/src/Message/DatabaseMessage.php similarity index 65% rename from src/notification/src/Message/DatabaseMessages.php rename to src/notification/src/Message/DatabaseMessage.php index e6b83478c..464eb9ec8 100644 --- a/src/notification/src/Message/DatabaseMessages.php +++ b/src/notification/src/Message/DatabaseMessage.php @@ -11,7 +11,7 @@ namespace FriendsOfHyperf\Notification\Message; -class DatabaseMessages +class DatabaseMessage { /** * Create a new message instance. @@ -22,3 +22,14 @@ public function __construct( ) { } } + +class_alias(DatabaseMessage::class, DatabaseMessages::class); + +if (false) { // @phpstan-ignore-line + /** + * @deprecated Use DatabaseMessage instead. Will be removed in v3.2. + */ + class DatabaseMessages extends DatabaseMessage + { + } +} diff --git a/src/recaptcha/src/ReCaptchaManager.php b/src/recaptcha/src/ReCaptchaManager.php index 28b517abd..d9a409da5 100644 --- a/src/recaptcha/src/ReCaptchaManager.php +++ b/src/recaptcha/src/ReCaptchaManager.php @@ -40,7 +40,7 @@ public function get(?string $version = null): ReCaptcha } if (! $this->config->has('recaptcha')) { - throw new RuntimeException('Not publish yet, please run \'php bin/hyperf.php vendor:publish friendsofhyperf/recaptcha\''); + throw new RuntimeException('Configuration not published yet, please run \'php bin/hyperf.php vendor:publish friendsofhyperf/recaptcha\'.'); } $version ??= (string) $this->config->get('recaptcha.default', 'v3'); diff --git a/src/support/src/Environment.php b/src/support/src/Environment.php index 1fc955f6d..c2cf62ecd 100644 --- a/src/support/src/Environment.php +++ b/src/support/src/Environment.php @@ -23,7 +23,7 @@ * @method bool isDevelop() * @method bool isProduction() * @method bool isOnline() - * @deprecated since 3.1, use `Str::is($patterns, env('APP_ENV'))` instead, will removed in 3.2. + * @deprecated since 3.1, use `Str::is($patterns, env('APP_ENV'))` instead, will be removed in 3.2. */ class Environment { diff --git a/src/support/src/Once/Backtrace.php b/src/support/src/Once/Backtrace.php index 7d53c34ed..ae58a92f5 100644 --- a/src/support/src/Once/Backtrace.php +++ b/src/support/src/Once/Backtrace.php @@ -12,7 +12,7 @@ namespace FriendsOfHyperf\Support\Once; /** - * @deprecated since v3.1, use FriendsOfHyperf\Support\Onceable instead, will removed in v3.2 + * @deprecated since v3.1, use FriendsOfHyperf\Support\Onceable instead, will be removed in v3.2 */ class Backtrace { diff --git a/src/support/src/Once/Cache.php b/src/support/src/Once/Cache.php index 132829830..e3b17f4a1 100644 --- a/src/support/src/Once/Cache.php +++ b/src/support/src/Once/Cache.php @@ -15,7 +15,7 @@ use WeakMap; /** - * @deprecated since v3.1, use FriendsOfHyperf\Support\Once instead, will removed in v3.2 + * @deprecated since v3.1, use FriendsOfHyperf\Support\Once instead, will be removed in v3.2 */ class Cache implements Countable { diff --git a/src/telescope/src/EntryType.php b/src/telescope/src/EntryType.php index b3eea41d3..c77c2fc97 100644 --- a/src/telescope/src/EntryType.php +++ b/src/telescope/src/EntryType.php @@ -41,6 +41,10 @@ class EntryType public const REQUEST = 'request'; + /** + * Alias for SCHEDULE; kept for backward compatibility. + * @deprecated Use EntryType::SCHEDULE instead. Will be removed in v3.2. + */ public const SCHEDULED_TASK = 'schedule'; public const GATE = 'gate'; diff --git a/tests/Notification/Stubs/NotificationDatabaseChannelCustomizeTypeTestNotification.php b/tests/Notification/Stubs/NotificationDatabaseChannelCustomizeTypeTestNotification.php index afb6d1567..030ad0799 100644 --- a/tests/Notification/Stubs/NotificationDatabaseChannelCustomizeTypeTestNotification.php +++ b/tests/Notification/Stubs/NotificationDatabaseChannelCustomizeTypeTestNotification.php @@ -11,14 +11,14 @@ namespace FriendsOfHyperf\Tests\Notification\Stubs; -use FriendsOfHyperf\Notification\Message\DatabaseMessages; +use FriendsOfHyperf\Notification\Message\DatabaseMessage; use FriendsOfHyperf\Notification\Notification; class NotificationDatabaseChannelCustomizeTypeTestNotification extends Notification { - public function toDatabase($notifiable): DatabaseMessages + public function toDatabase($notifiable): DatabaseMessage { - return new DatabaseMessages([ + return new DatabaseMessage([ 'invoice_id' => 1, ]); } diff --git a/tests/Notification/Stubs/NotificationDatabaseChannelTestNotification.php b/tests/Notification/Stubs/NotificationDatabaseChannelTestNotification.php index 67770d50a..0efe5b5b5 100644 --- a/tests/Notification/Stubs/NotificationDatabaseChannelTestNotification.php +++ b/tests/Notification/Stubs/NotificationDatabaseChannelTestNotification.php @@ -11,14 +11,14 @@ namespace FriendsOfHyperf\Tests\Notification\Stubs; -use FriendsOfHyperf\Notification\Message\DatabaseMessages; +use FriendsOfHyperf\Notification\Message\DatabaseMessage; use FriendsOfHyperf\Notification\Notification; class NotificationDatabaseChannelTestNotification extends Notification { - public function toDatabase($notifiable): DatabaseMessages + public function toDatabase($notifiable): DatabaseMessage { - return new DatabaseMessages([ + return new DatabaseMessage([ 'message' => 'Hello World', ]); } From 5f013a434462424e24153e3becd71d8ccda7f2cb Mon Sep 17 00:00:00 2001 From: Deeka Wong <8337659+huangdijia@users.noreply.github.com> Date: Sun, 31 Aug 2025 15:43:16 +0800 Subject: [PATCH 2/3] fix: update deprecation notice for DatabaseMessages class --- src/notification/src/Message/DatabaseMessage.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/notification/src/Message/DatabaseMessage.php b/src/notification/src/Message/DatabaseMessage.php index 464eb9ec8..19101796a 100644 --- a/src/notification/src/Message/DatabaseMessage.php +++ b/src/notification/src/Message/DatabaseMessage.php @@ -27,7 +27,7 @@ class_alias(DatabaseMessage::class, DatabaseMessages::class); if (false) { // @phpstan-ignore-line /** - * @deprecated Use DatabaseMessage instead. Will be removed in v3.2. + * @deprecated since v3.1, use `DatabaseMessage` instead. Will be removed in v3.2. */ class DatabaseMessages extends DatabaseMessage { From 40410bc463ff18fc5d3e376ced9cd86f0af30831 Mon Sep 17 00:00:00 2001 From: Deeka Wong <8337659+huangdijia@users.noreply.github.com> Date: Sun, 31 Aug 2025 15:44:48 +0800 Subject: [PATCH 3/3] refactor: remove DatabaseMessages class and update deprecation notice for DatabaseMessage --- .../src/Message/DatabaseMessage.php | 11 ----------- .../src/Message/DatabaseMessages.php | 19 +++++++++++++++++++ 2 files changed, 19 insertions(+), 11 deletions(-) create mode 100644 src/notification/src/Message/DatabaseMessages.php diff --git a/src/notification/src/Message/DatabaseMessage.php b/src/notification/src/Message/DatabaseMessage.php index 19101796a..aa17b6ab6 100644 --- a/src/notification/src/Message/DatabaseMessage.php +++ b/src/notification/src/Message/DatabaseMessage.php @@ -22,14 +22,3 @@ public function __construct( ) { } } - -class_alias(DatabaseMessage::class, DatabaseMessages::class); - -if (false) { // @phpstan-ignore-line - /** - * @deprecated since v3.1, use `DatabaseMessage` instead. Will be removed in v3.2. - */ - class DatabaseMessages extends DatabaseMessage - { - } -} diff --git a/src/notification/src/Message/DatabaseMessages.php b/src/notification/src/Message/DatabaseMessages.php new file mode 100644 index 000000000..e2b9f30c5 --- /dev/null +++ b/src/notification/src/Message/DatabaseMessages.php @@ -0,0 +1,19 @@ +