Dutch PHP Conference 2027

Yar_Client::setOpt

(PECL yar >= 1.0.0)

Yar_Client::setOpt设置客户端选项

说明

public function Yar_Client::setOpt(int $name, mixed $value): Yar_Client|bool

设置客户端选项。选项在每次调用发起时才会被求值, 因此可以在两次调用之间随时修改。

参数

name

YAR_OPT_* 常量之一:

value

选项的值。无效的值会产生一条警告,并使调用返回 false

返回值

返回客户端对象自身,从而支持流畅接口(fluent interface); 当选项名称未知、值无效,或者该选项不适用于客户端创建时所用的协议时,返回 false

错误/异常

以下情况会使调用返回 false,同时产生一条警告:

  • YAR_OPT_HEADERYAR_OPT_RESOLVEYAR_OPT_PROXY 仅对 HTTP 协议有效; 在 tcp://unix:// 客户端上使用它们会产生警告。

  • YAR_OPT_RESOLVE 还要求 libcurl >= 7.21.3。

  • 每个选项都要求特定类型的值(字符串、布尔、整型或数组), 具体说明见常量页面。

示例

示例 #1 Yar_Client::setOpt() 示例

<?php

$client = new Yar_Client("http://api.example.com/operator.php");

/* 设置超时时间为 1 秒 */
$client->setOpt(YAR_OPT_TIMEOUT, 1000);

/* 设置打包器为 JSON */
$client->setOpt(YAR_OPT_PACKAGER, "json");

/* 设置自定义 HTTP 头 */
$client->setOpt(YAR_OPT_HEADER, ["X-Api-Key: value"]);

/* 通过 HTTP 代理转发请求 */
$client->setOpt(YAR_OPT_PROXY, "127.0.0.1:8888");

/* 调用远程服务 */
$result = $client->some_method("parameter");
?>

参见

添加备注

用户贡献的备注

此页面尚无用户贡献的备注。
To Top