
本文详解 Cloudflare PHP SDK 中 AccessRules::createRule() 方法的参数传递规范,重点解决因误传数组导致的类型错误,并演示如何通过 AccessRules 配置对象正确构造防火墙访问规则。
本文详解 cloudflare php sdk 中 `accessrules::createrule()` 方法的参数传递规范,重点解决因误传数组导致的类型错误,并演示如何通过 `accessrules` 配置对象正确构造防火墙访问规则。
Cloudflare 官方 PHP SDK 对类型安全有严格要求:createRule() 的第三个参数必须是 Cloudflare\API\Configurations\AccessRules 类的实例,不能直接传入关联数组或普通对象。你当前代码中 $configData = ['target' => 'ip', 'value' => '1.2.3.4'] 是一个数组,与方法签名中声明的 Configurations 类型不兼容,因此触发了 TypeError。
✅ 正确做法是使用 SDK 提供的专用配置类:
use Cloudflare\API\Configurations\AccessRules;
// 实例化配置对象
$configData = new AccessRules();
$configData->setIP('1.2.3.4'); // 自动设置 target='ip' 且 value='1.2.3.4'
// 或者更显式地指定目标类型(如需 block IP range 或 country)
// $configData->setIPRange('192.168.0.0/16');
// $configData->setCountry('CN');
完整可运行示例:
<?php require_once 'vendor/autoload.php';
use Cloudflare\API\Auth\APIKey;
use Cloudflare\API\Adapter\Guzzle;
use Cloudflare\API\Endpoints\AccessRules;
use Cloudflare\API\Configurations\AccessRules as Config;
$userEmail = 'your@email.com';
$api_key = 'your_api_key';
$zoneID = 'your_zone_id';
$key = new APIKey($userEmail, $api_key);
$adapter = new Guzzle($key);
$fw = new AccessRules($adapter);
// ✅ 正确:使用 Configurations\AccessRules 实例
$config = new Config();
$config->setIP('1.2.3.4');
$result = $fw->createRule($zoneID, 'block', $config, 'Auto block');
if ($result) {
echo "✅ Access rule created successfully.\n";
} else {
echo "❌ Failed to create rule. Check Cloudflare response body for details.\n";
var_dump($fw->getBody()); // 获取原始响应用于调试
}
⚠️ 注意事项:
-
setIP()、setIPRange()、setCountry()等方法会自动填充target和value字段,无需手动调用setTarget(); - 若需自定义其他字段(如
field),请确认 SDK 版本是否支持——较新版本可能提供setField()方法,旧版本需查阅对应类源码; - 始终检查
$fw->getBody()在失败时的结构,$this->body->errors通常包含明确的 API 错误信息(如权限不足、无效 IP 格式等); - 推荐使用 Composer 管理依赖,并保持
cloudflare/sdk更新至 最新稳定版,以获得完整方法支持和安全修复。
通过遵循配置类契约而非“猜测”数组结构,你不仅能避免类型错误,还能获得 IDE 自动补全、静态分析支持及未来 SDK 升级的兼容性保障。
大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!











