类 ServerRequest

缺少方法处理程序，处理包装旧样式的 isAjax() 类型方法

参数

返回值

抛出

创建一个新的请求对象。

您可以将数据提供为数组或字符串。如果您使用字符串，您只能提供请求的 URL。使用数组可以提供以下键

• post POST 数据或非查询字符串数据
• query 查询字符串中的附加数据。
• files 以规范化结构上传的文件，每个叶子都是 UploadedFileInterface 的实例。
• cookies 此请求的 Cookie。
• environment $_SERVER 和 $_ENV 数据。
• url 请求的 URL，不包括基本路径。
• uri PSR7 UriInterface 对象。如果为 null，则将从 url 或 environment 创建一个。
• base 请求的基本 URL。
• webroot 请求的 webroot 目录。
• input 来自 php://input 的数据，这对模拟带有 put、patch 或 delete 数据的请求很有用。
• session Session 对象的实例

参数

检测是否存在特定接受头。

参数

返回值

检测是否存在特定的环境变量。

参数

返回值

检测是否存在特定头。

参数

返回值

公共 is() 函数的工作器

参数

返回值

检测是否存在特定的请求参数。

参数

返回值

将 config/settings 数据处理到属性中。

参数

返回值

获取客户端接受的语言，或检查是否接受特定语言。

获取接受的语言列表

$request->acceptLanguage();

检查是否接受特定语言

$request->acceptLanguage('es-es');

参数

返回值

找出客户端接受的哪种内容类型，或检查它们是否接受特定类型的内容。

获取所有类型

$this->request->accepts();

检查单个类型

$this->request->accepts('application/json');

此方法将根据客户端指示的偏好值对返回的媒体类型进行排序。

参数

返回值

在请求可以使用检测器列表中添加新的检测器。可以设置多种类型的检测器。

回调比较

回调检测器允许您提供一个闭包来处理检查。闭包将以请求对象作为其唯一参数。

addDetector('custom', function ($request) { //Return a boolean });

环境值比较

环境值比较，将从 env() 获取的值与已知值进行比较，环境值将与提供的值进行相等性检查。

addDetector('post', ['env' => 'REQUEST_METHOD', 'value' => 'POST']);

请求参数比较

允许对请求参数进行自定义检测。

addDetector('admin', ['param' => 'prefix', 'value' => 'admin']);

Accept 比较

允许检测器与 Accept 标头值进行比较。

addDetector('csv', ['accept' => 'text/csv']);

标头比较

允许比较一个或多个标头。

addDetector('fancy', ['header' => ['X-Fancy' => 1]);

param、env 和比较类型允许以下值比较选项

模式值比较

模式值比较允许您将从 env() 获取的值与正则表达式进行比较。

addDetector('iphone', ['env' => 'HTTP_USER_AGENT', 'pattern' => '/iPhone/i']);

基于选项的比较

基于选项的比较使用选项列表来创建正则表达式。对已定义的选项检测器进行后续添加调用将合并选项。

addDetector('mobile', ['env' => 'HTTP_USER_AGENT', 'options' => ['Fennec']]);

您还可以使用 options 键与多个值进行比较。当您要检查请求值是否在一个选项列表中时，这很有用。

addDetector('extension', ['param' => '_ext', 'options' => ['pdf', 'csv']]

参数

返回值

仅允许某些 HTTP 请求方法，如果请求方法不匹配，将显示 405 错误，并将设置所需的 "Allow" 响应头。

示例

$this->request->allowMethod('post'); 或者 $this->request->allowMethod(['post', 'delete']);

如果请求为 GET，则会设置响应头 "Allow: POST, DELETE" 并返回 405 错误。

参数

返回值

抛出

清除实例检测器缓存，由 is() 函数使用

返回值

获取客户端使用的 IP，或声称使用的 IP。

返回值

获取此请求中使用的内容类型。

返回值

获取域名，并包含 $tldLength 个 tld 段。

参数

返回值

从请求中读取属性，或获取默认值

检索单个派生的请求属性，如 getAttributes() 中所述。如果属性以前未设置，则返回提供的默认值。

此方法无需使用 hasAttribute() 方法，因为它允许指定一个默认值，如果属性未找到，则返回该值。

参数

返回值

获取请求中的所有属性。

这将包含 CakePHP 提供的 params、webroot、base 和 here 属性。

返回值

获取消息的正文。

返回值

从请求的 cookie 数据中读取 cookie 数据。

参数

返回值

根据请求的 cookie 获取 cookie 集合

CookieCollection 允许您使用 \Cake\Http\Cookie\Cookie 对象与请求 Cookie 进行交互，并且可以更轻松地将请求 Cookie 转换为响应 Cookie。

此方法每次调用时都会创建一个新的 CookieCollection。这是一种优化，可以减少分配的对象数量，直到需要更复杂的 CookieCollection。通常，您应该优先使用 getCookie() 和 getCookieParams() 而不是此方法。如果您的 Cookie 包含复杂的 JSON 编码数据，则使用 CookieCollection 是理想的选择。

返回值

获取请求中的所有 cookie 数据。

检索客户端发送到服务器的 Cookie。

数据必须与 $_COOKIE 超级全局变量的结构兼容。

返回值

提供对请求数据的安全访问器。允许使用 Hash::get() 兼容的路径。

读取值。

// get all data
$request->getData();

// Read a specific field.
$request->getData('Post.title');

// With a default value.
$request->getData('Post.not there', 'default value');

读取值时，对于不存在的键/值，您将获得 null。

鼓励开发人员使用 getParsedBody()，如果他们需要整个数据数组，因为它符合 PSR-7 标准，而此方法则不符合。使用 Hash::get() 您也可以获取单个参数。

PSR-7 替代方法

$value = Hash::get($request->getParsedBody(), 'Post.id');

参数

返回值

从请求的环境数据中获取值。如果 $environment 属性中没有设置键，则回退使用 env()。

参数

返回值

返回此请求的 FlashMessage 对象的实例

返回值

从请求中获取单个头。

将头值作为数组返回。如果头不存在，则返回空数组。

参数

返回值

链接

从请求中以字符串形式获取单个头。

此方法将给定不区分大小写的头名称的所有头值作为用逗号连接在一起的字符串返回。

注意：并非所有头值都适合使用逗号连接来表示。对于此类头，请改用 getHeader() 并提供您自己的分隔符以进行连接。

如果头未出现在消息中，此方法必须返回空字符串。

参数

返回值

链接

获取请求中的所有头。

返回一个关联数组，其中头名称为键，值为头值的列表。

虽然头名称不区分大小写，但 getHeaders() 将规范化头。

返回值

链接

获取此请求使用的 HTTP 方法。有几种方法可以指定方法。

• 如果您的客户端支持，您可以使用本机 HTTP 方法。
• 您可以设置 X-Http-Method-Override 头。
• 您可以提交一个名为 _method 的输入。

这三种方法中的任何一种都可以用来设置 CakePHP 在内部使用的 HTTP 方法，并将影响此方法的结果。

返回值

链接

安全访问 $this->params 中的值。

参数

返回值

获取解析的请求正文数据。

如果请求 Content-Type 为 application/x-www-form-urlencoded 或 multipart/form-data，并且请求方法为 POST，则这将是发布数据。对于其他内容类型，它可能是反序列化的请求正文。

返回值

获取当前请求的路径。

返回值

检索 HTTP 协议版本，作为字符串。

该字符串必须仅包含 HTTP 版本号（例如，“1.1”、“1.0”）。

返回值

读取特定查询值或点路径。

鼓励开发人员使用 getQueryParams()，如果他们需要整个查询数组，因为它符合 PSR-7 标准，而此方法则不符合。使用 Hash::get() 您也可以获取单个参数。

PSR-7 替代方法

$value = Hash::get($request->getQueryParams(), 'Post.id');

参数

返回值

另请参阅

根据 PSR-7 规范获取所有查询参数。要读取特定的查询值，请使用替代的 getQuery() 方法。

检索反序列化的查询字符串参数（如果有）。

注意：查询参数可能与 URI 或服务器参数不同步。如果您需要确保仅获取原始值，则可能需要从getUri()->getQuery()或QUERY_STRING服务器参数解析查询字符串。

返回值

链接

检索请求的目标。

检索消息的请求目标，无论是按请求方式还是按withRequestTarget()设置的方式。默认情况下，这将返回应用程序相对路径（不含基本目录）以及 SERVER 环境中定义的查询字符串。

返回值

获取所有服务器环境参数。

读取用于创建此请求的所有“环境”或“服务器”数据。

返回值

链接

返回此请求的 Session 对象的实例

返回值

获取受信任代理

返回值

从点路径获取上传的文件。

参数

返回值

从请求中获取上传文件数组。

此方法以规范化的树形式返回上传元数据，其中每个叶子都是 Psr\Http\Message\UploadedFileInterface 的实例。

这些值可能在实例化期间从 $_FILES 或消息主体准备，或者可能通过 withUploadedFiles() 注入。

返回值

检索 URI 实例。

此方法必须返回 UriInterface 实例。

返回值

检查请求中是否设置了标头。

参数

返回值

链接

获取处理请求的宿主。

返回值

检查请求是否为特定类型。

使用内置检测规则以及使用 {@link \Cake\Http\ServerRequest::addDetector()} 定义的附加规则。任何检测器都可以称为 is($type) 或 is$Type()。

参数

返回值

抛出

检查请求是否匹配所有给定类型。

允许您测试多种类型并联合结果。有关如何添加其他类型和内置类型的详细信息，请参阅 Request::is()。

参数

返回值

另请参阅

将标头名称规范化为 SERVER 版本。

参数

返回值

获取处理请求的端口。

返回值

根据 url 选项设置环境变量以方便 UriInterface 实例生成。

query 选项也会根据 URL 的查询字符串进行更新。

参数

返回值

返回引用此请求的来源。

参数

返回值

获取用于请求的当前 URL 方案。

例如“http”或“https”。

返回值

注册受信任代理。

参数

返回值

获取主机的子域。

参数

返回值

递归验证上传的文件数据。

参数

返回值

抛出

获取修改后的请求，其中包含提供的标头。

将保留现有的标头值。提供的将追加到现有的值中。

参数

返回值

链接

返回具有指定请求属性的实例。

此方法允许设置单个派生请求属性，如 getAttributes() 中所述。

此方法必须以保留消息不变性的方式实现，并且必须返回具有更新属性的实例。

参数

返回值

返回具有指定消息正文的实例。

主体必须是 StreamInterface 对象。

此方法必须以保留消息不变性的方式实现，并且必须返回具有新主体流的新实例。

参数

返回值

将请求中的 Cookie 替换为提供的 CookieCollection 中的 Cookie。

参数

返回值

替换 Cookie 并获取新的请求实例。

数据不需要来自 $_COOKIE 超级全局变量，但必须与 $_COOKIE 的结构兼容。通常，此数据将在实例化时注入。

此方法绝不能更新请求实例的相关 Cookie 标头，也不更新服务器参数中的相关值。

此方法必须以保留消息不变性的方式实现，并且必须返回具有更新 cookie 值的实例。

参数

返回值

使用新的请求数据元素更新请求。

返回更新的请求对象。此方法返回一个新的请求对象，不会就地修改请求。

如果您需要替换所有请求数据，请使用withParsedBody()。

参数

返回值

使用新的环境数据元素更新请求。

返回更新的请求对象。此方法返回一个新的请求对象，不会就地修改请求。

参数

返回值

获取修改后的请求，其中包含提供的标头。

虽然标题名称不区分大小写，但此函数将保留标题的大小写，并从 getHeaders() 中返回。

此方法必须以保留消息不变性的方式实现，并且必须返回具有新的和/或更新的标题和值的实例。

参数

返回值

链接

更新请求方法并获取新的实例。

虽然 HTTP 方法名称通常都是大写字符，但 HTTP 方法名称区分大小写，因此实现不应该修改给定的字符串。

此方法必须以保留消息不变性的方式实现，并且必须返回具有更改的请求方法的实例。

参数

返回值

链接

使用新的路由参数更新请求。

返回更新的请求对象。此方法返回一个新的请求对象，不会就地修改请求。

参数

返回值

更新解析后的正文并获取新的实例。

这些 MAY 在实例化期间注入。

如果请求 Content-Type 为 application/x-www-form-urlencoded 或 multipart/form-data，并且请求方法为 POST，则仅使用此方法注入 $_POST 的内容。

数据 IS NOT REQUIRED 来自 $_POST，但 MUST 是对请求主体内容进行反序列化后的结果。反序列化/解析返回结构化数据，因此，此方法 ONLY 接受数组或对象，或者如果没有任何可解析的内容，则接受 null 值。

例如，如果内容协商确定请求数据是 JSON 负载，则可以使用此方法创建包含反序列化参数的请求实例。

此方法 MUST 以保持消息不变的方式实现，并且 MUST 返回一个具有更新的正文参数的实例。

参数

返回值

返回具有指定 HTTP 协议版本的实例。

版本字符串 MUST 仅包含 HTTP 版本号（例如，“1.1”、“1.0”）。

参数

返回值

更新查询字符串数据并获取新的实例。

这些值 SHOULD 在传入请求的过程中保持不变。它们 MAY 在实例化期间注入，例如来自 PHP 的 $_GET 超级全局变量，或者 MAY 从其他值（如 URI）中推断出来。在从 URI 解析参数的情况下，数据 MUST 与 PHP 的 parse_str() 返回的数据兼容，以便处理重复的查询参数以及嵌套集的处理方式。

设置查询字符串参数 MUST NOT 更改请求存储的 URI，也不更改服务器参数中的值。

此方法 MUST 以保持消息不变的方式实现，并且 MUST 返回一个具有更新的查询字符串参数的实例。

参数

返回值

链接

使用特定请求目标创建新实例。

可以使用此方法覆盖从请求的 Uri 推断出的请求目标。这还可以更改请求目标的形式为绝对形式、授权形式或星号形式

参数

返回值

链接

更新请求，替换文件并创建新实例。

此方法 MUST 以保持消息不变的方式实现，并且 MUST 返回一个具有更新的正文参数的实例。

参数

返回值

抛出

返回具有指定 URI 的实例。

警告替换 Uri 不会更新 base、webroot 和 url 属性。

参数

返回值

返回没有指定请求属性的实例。

此方法允许删除在 getAttributes() 中描述的单个派生请求属性。

此方法 MUST 以保持消息不变的方式实现，并且 MUST 返回删除属性的实例。

参数

返回值

抛出

更新请求以删除数据元素。

返回更新的请求对象。此方法返回一个新的请求对象，不会就地修改请求。

参数

返回值

获取修改后的请求，不包含提供的标头。

标头解析 MUST 在不区分大小写的情况下完成。

此方法 MUST 以保持消息不变的方式实现，并且 MUST 返回删除命名标头的实例。

参数

返回值

链接