Helpers

此元件為 Hyperf 提供常用輔助函式。

安裝

composer require friendsofhyperf/helpers

配置與自動載入

此包透過 Composer 自動載入函式檔案。其配置提供器不會註冊或釋出任何配置，因此無需額外設定。

除 call 定義在 FriendsOfHyperf\Helpers\Command 名稱空間外，其他函式均定義在 FriendsOfHyperf\Helpers 名稱空間。

函式參考

函式	簽名與行為
app	app(null|string|callable $abstract = null, array $parameters = [])：從容器解析服務；將可呼叫值轉換為 Closure。
base_path	base_path(string $path = ''): string：返回 BASE_PATH，可追加路徑。
blank / filled	判斷值是否為空或非空。模型、數字和布林值不視為空。
cache	cache(...$arguments)：無引數時返回快取服務；字串引數用於讀取；陣列引數用於設定其中第一組鍵值。
cookie	建立 Cookie；未傳名稱時返回 CookieJarInterface 服務。非零有效期以分鐘為單位。
class_namespace	class_namespace(object|string $class): string：返回類的名稱空間。
di	di(?string $abstract = null, array $parameters = [])：解析或建立服務。無容器時直接例項化類；此時不傳抽象名稱會丟擲異常。
enum_value	返回有值列舉的值、純列舉的名稱或原值。空的非字串值使用可選預設值。
event	event(object $event)：分發事件並返回分發器的結果。
fluent	fluent(object|array $value): Fluent：建立 Fluent 物件。
get_client_ip	返回 x-real-ip 請求頭；不存在時返回請求的 remote_addr。
info	info(string|Stringable $message, array $context = [], bool $backtrace = false)：寫入 info 日誌；可附加 backtrace 上下文值。
literal	僅有一個位置引數時原樣返回；使用命名引數時建立物件。
logger	未傳訊息時返回預設日誌記錄器；否則寫入 debug 日誌，並可附加呼叫棧。
logs	logs(string $name = 'hyperf', ?string $channel = null): LoggerInterface：從 LoggerFactory 獲取日誌記錄器。
microseconds / milliseconds / months / weeks	建立指定單位的 CarbonInterval。
object_get	使用點號讀取巢狀物件屬性；鍵為空時返回物件，屬性不存在時求值並返回預設值。
preg_replace_array	使用替換陣列中的值依次替換每個正則匹配項。
request	未傳鍵時返回請求；支援字串鍵、鍵陣列和可選預設值。
resolve	resolve(string|callable $abstract, array $parameters = [])：透過 di 解析服務，或將可呼叫值轉換為 Closure。
response	無引數時返回響應服務；否則使用字串或 JSON 陣列內容和狀態碼建立響應，並接受響應頭陣列。
rescue	執行回撥；捕獲任意 Throwable 後返回備用值，可選異常處理器會接收該異常。
session	未傳鍵時返回會話；陣列用於儲存值，字串鍵用於讀取值。
throw_if / throw_unless	根據條件丟擲異常例項、異常類或以訊息建立的 RuntimeException；不丟擲時返回條件值。
transform	僅在值非空時執行回撥；否則返回或求值預設值。
validator	無引數時返回驗證器工廠；否則使用資料、規則、訊息和自定義屬性建立驗證器。
when	根據求值後的表示式返回選中的值或預設值；選中值為 Closure 時執行它。
Command\call	call(string $command, array $arguments = []): int：使用 NullOutput 執行控制檯命令並返回退出碼。

可選依賴

僅為應用實際使用的輔助函式或整合安裝可選 Hyperf 包。此包建議使用以下相容的 ~3.2.0 版本：

包	相關用途
hyperf/cache	cache
hyperf/di	基於容器的服務解析
hyperf/framework	執行時服務繫結和 Command\call
hyperf/logger	info、logger 和 logs
hyperf/session	session
hyperf/validation	validator
hyperf/amqp、hyperf/async-queue、hyperf/kafka	包元資料為相應整合建議的依賴；此元件中的函式未直接引用它們。

示例

使用名稱空間函式前先匯入：

use function FriendsOfHyperf\Helpers\blank;
use function FriendsOfHyperf\Helpers\literal;
use function FriendsOfHyperf\Helpers\object_get;
use function FriendsOfHyperf\Helpers\transform;

$profile = literal(name: 'Taylor', contact: (object) ['email' => 'taylor@example.com']);

object_get($profile, 'contact.email'); // taylor@example.com
blank('  '); // true
transform(5, fn (int $value) => $value * 2); // 10

cache 會根據引數選擇行為：

use function FriendsOfHyperf\Helpers\cache;

$cache = cache();
$value = cache('key', 'default');
cache(['key' => 'value'], 60);

控制檯命令使用單獨的名稱空間：

use function FriendsOfHyperf\Helpers\Command\call;

$exitCode = call('foo:bar', ['argument' => 'value']);