HttpFoundation组件
编辑该页面警告:你浏览的文档欧宝体育电话欧宝娱乐app下载地址Symfony 3.4,不再维护。
读这个页面的更新版本Symf欧宝娱乐app下载地址ony 6.2(当前的稳定版本)。
HttpFoundation组件
HttpFoundation组件为HTTP规范定义了一种面向对象的层。
在PHP中,请求是由一些全局变量($ _GET
,$ _POST
,带有_file美元
,_COOKIE美元
,_SESSION美元
,…)和一些函数生成的响应(回声
,头()
,setcookie ()
,……)。
Symf欧宝娱乐app下载地址ony HttpFoundation组件替换这些默认PHP全局变量和函数的一种面向对象的层。
安装
1
美元作曲家需要symfony / ht欧宝娱乐app下载地址tp-foundation: ^ 3.4
请注意
如果你安装这个组件之外的Symfony应用程序,你必须要求欧宝娱乐app下载地址供应商/ autoload.php
文件在你的代码,使作曲家提供的类加载机制。读这篇文章为更多的细节。
另请参阅
这篇文章解释了如何使用HttpFoundation功能作为一个独立的组件在任何PHP应用程序。在Sy欧宝娱乐app下载地址mfony应用程序都已经配置好了,可以使用了。读了控制器篇文章来了解如何使用这些特性在创建控制器。
请求
最常见的方式来创建一个请求是它基于当前的PHP全局变量createFromGlobals ():
1 2 3
使用欧宝娱乐app下载地址\组件\HttpFoundation\请求;美元请求=请求::createFromGlobals ();
这几乎等同于更详细的,但也更灵活,__construct ()电话:
1 2 3 4 5 6 7 8
美元请求=新请求(美元_GET,美元_POST[],美元_COOKIE,美元带有_file,美元_SERVER);
访问请求数据
一个请求对象持有客户端请求的信息。这些信息可以通过访问几个公共属性:
请求
:相当于$ _POST
;查询
:相当于$ _GET
(请求- >查询- >获取美元(“名字”)
);饼干
:相当于_COOKIE美元
;属性
:不等效,所使用的应用程序来存储其他数据(见下面);文件
:相当于带有_file美元
;服务器
:相当于$ _SERVER
;头
:主要是等价的一个子集$ _SERVER
(请求- >标题- >获取美元(“用户代理”)
)。
每个属性都是一个ParameterBag(或者一个子类的实例),这是一个数据夹类:
请求
:ParameterBag;查询
:ParameterBag;饼干
:ParameterBag;属性
:ParameterBag;文件
:FileBag;服务器
:ServerBag;头
:HeaderBag。
所有ParameterBag实例方法来检索和更新他们的数据:
- 所有()
- 返回的参数。
- 键()
- 返回参数的键。
- 替换()
- 替换当前由一组新的参数。
- add ()
- 添加参数。
- get ()
- 返回一个参数的名字。
- 设置()
- 设置一个参数的名字。
- 有()
-
返回
真正的
如果参数是定义。 - remove ()
- 删除一个参数。
的ParameterBag实例也有一些方法来过滤输入值:
- getAlpha ()
- 返回参数的字母字符值;
- getAlnum ()
- 返回参数的字母字符和数字值;
- getBoolean ()
- 返回参数值转换为布尔值;
- getDigits ()
- 返回参数值的位数;
- getInt ()
- 返回参数值转换为整数;
- filter ()
- 通过使用PHP过滤器的参数使用filter_var函数。
所有getter需要两个参数:第一个是参数名和第二个是默认值返回,如果参数不存在:
1 2 3 4 5 6 7 8 9 10
/ /查询字符串是“? foo = bar”美元请求- >查询- >get (“foo”);/ /返回“酒吧”美元请求- >查询- >get (“酒吧”);/ /返回null美元请求- >查询- >get (“酒吧”,“记者”);/ /返回“记者”
当PHP进口请求查询,它处理请求参数foo(酒吧)=巴兹
在一种特殊的方式创建一个数组。所以你可以得到喷火
参数,你将返回一个数组酒吧
元素:
1 2 3 4 5 6 7 8 9 10
/ /查询字符串foo”?(酒吧)=巴兹'美元请求- >查询- >get (“foo”);/ /返回['酒吧' = > '巴兹']美元请求- >查询- >get (“foo(酒吧)”);/ /返回null美元请求- >查询- >get (“foo”)[“酒吧”];/ /返回“记者”
由于公共属性
财产,你可以额外的数据存储在请求,也是的一个实例ParameterBag。这主要是用于附加信息,属于请求,需要在应用程序中从许多不同的访问点。
最后,原始数据发送请求主体可以访问使用getContent ():
1
美元内容=美元请求- >getContent ();
举例来说,这可能是有用的过程一个JSON字符串发送到应用程序的远程服务使用HTTP POST方法。
识别一个请求
在您的应用程序,您需要一种方法来确定一个请求;大多数时候,这是通过请求的路径信息”,可以通过访问getPathInfo ()方法:
1 2 3
/ /请求到http://example.com/blog/index.php/post/hello-world/ /路径信息是“/ post / hello world”美元请求- >getPathInfo ();
模拟一个请求
而不是创建一个请求基于PHP的全局变量,你也可以模拟一个请求:
1 2 3 4 5
美元请求=请求::创建(' / hello world ',“得到”,(“名字”= >“法”]);
的create ()方法基于一个URI创建一个请求,一个方法和一些参数(查询参数或根据HTTP请求的方法);当然,你也可以覆盖所有其他变量(默认情况下,Symfony创建合理的默认值为所有PHP全局变量)。欧宝娱乐app下载地址
基于这样的要求,你可以通过覆盖全球的PHP变量overrideGlobals ():
1
美元请求- >overrideGlobals ();
访问会话
如果你有一个会话请求,您可以通过访问它getSession ()方法;的hasPreviousSession ()方法告诉你如果请求包含一个会话开始在前面的请求。
访问接受- *
头数据
您可以访问基本数据提取接受- *
头用以下方法:
- getAcceptableContentTypes ()
- 返回接受内容类型的列表命令下行质量。
- getLanguages ()
- 返回接受语言命令的列表质量下降。
- getCharsets ()
- 返回接受数据集的列表命令下行质量。
- getEncodings ()
- 返回的列表接受编码下令下行质量。
如果你需要完全访问解析数据接受
,接收语言
,Accept-Charset
或接受编码
,你可以使用AcceptHeader工具类:
1 2 3 4 5 6 7 8 9 10 11 12
使用欧宝娱乐app下载地址\组件\HttpFoundation\AcceptHeader;美元acceptHeader= AcceptHeader::fromString (美元请求- >头- >get (“接受”));如果(美元acceptHeader- >有(“text / html”)){美元项=美元acceptHeader- >get (“text / html”);美元字符集=美元项- >getAttribute (“字符集”,“utf - 8”);美元质量=美元项- >getQuality ();}/ / Accept标头项质量按降序排序美元acceptHeaders= AcceptHeader::fromString (美元请求- >头- >get (“接受”))- >所有();
压倒一切的请求
的请求
类不应该覆盖,因为它是一个数据对象,它是一个HTTP消息。但从遗留系统时,添加方法或修改一些默认的行为可能会有帮助。在这种情况下,注册一个PHP调用创建的实例请求
类:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21日22日23日24
使用AppBundle\Http\SpecialRequest;使用欧宝娱乐app下载地址\组件\HttpFoundation\请求;请求::setFactory (函数(数组美元查询=[]数组美元请求=[]数组美元属性=[]数组美元饼干=[]数组美元文件=[]数组美元服务器= [],美元内容= null){返回新SpecialRequest (美元查询,美元请求,美元属性,美元饼干,美元文件,美元服务器,美元内容);});美元请求=请求::createFromGlobals ();
响应
一个响应对象持有的所有信息需要从给定请求发送回客户机。构造函数接受三个参数:响应内容,状态代码,和HTTP头的数组:
1 2 3 4 5 6 7
使用欧宝娱乐app下载地址\组件\HttpFoundation\响应;美元响应=新响应(“内容”、响应::并,“内容类型”= >“text / html”]);
这些信息也可以操纵响应对象创建后:
1 2 3 4 5 6
美元响应- >setContent (“Hello World”);/ / ResponseHeaderBag头公共属性美元响应- >头- >集(“内容类型”,“文本/普通”);美元响应- >setStatusCode(响应::HTTP_NOT_FOUND);
当设置内容类型
的反应,你可以设置字符集,但最好是通过setCharset ()方法:
1
美元响应- >setCharset (“iso - 8859 - 1”);
注意,默认情况下,Symfony假定你的反应欧宝娱乐app下载地址是用utf - 8编码。
发送响应
在发送响应之前,您可以调用准备()方法来解决任何与HTTP规范(例如,一个错误的不相容内容类型
头):
1
美元响应- >准备(美元请求);
然后发送响应给客户端调用一样简单send ():
1
美元响应- >send ();
设置cookie
响应可以通过操纵饼干头
公共属性:
1 2 3
使用欧宝娱乐app下载地址\组件\HttpFoundation\饼干;美元响应- >头- >setCookie (新饼干(“foo”,“酒吧”));
的setCookie ()方法取的一个实例饼干作为参数。
你可以明确一个cookie通过clearCookie ()方法。
注意您可以创建一个饼干对象从原始头值使用fromString ()。
3.3
的饼干:fromString ()
方法是在Symfony 3.3中引入的。欧宝娱乐app下载地址
管理HTTP缓存
的响应类具有一组功能丰富的方法来操作相关的HTTP头信息缓存:
- setPublic ()
- setPrivate ()
- (到期)
- setExpires ()
- setMaxAge ()
- setSharedMaxAge ()
- setTtl ()
- setClientTtl ()
- setLastModified ()
- setEtag ()
- setVary ()
的setCache ()方法可用于设置最常用的一个方法调用的缓存信息:
1 2 3 4 5 6 7 8 9
美元响应- >setCache ([“etag”= >“六边形abcdef”,“last_modified”= >新\ DateTime (),“max_age”= >600年,“s_maxage”= >600年,“私人”= >假,“公共”= >真正的,“不变”= >真正的]);
检查如果响应验证器(ETag
,last - modified
)匹配客户机请求中指定一个条件值,使用isNotModified ()方法:
1 2 3
如果(美元响应- >isNotModified (美元请求)){美元响应- >send ();}
如果响应不修改,设置状态代码304,删除实际的响应内容。
重定向用户
重定向客户端到另一个URL,您可以使用RedirectResponse类:
1 2 3
使用欧宝娱乐app下载地址\组件\HttpFoundation\RedirectResponse;美元响应=新RedirectResponse (“http://example.com/”);
流媒体的回应
的StreamedResponse类允许您流回客户机的响应。响应内容由PHP调用而不是一个字符串:
1 2 3 4 5 6 7 8 9 10 11
使用欧宝娱乐app下载地址\组件\HttpFoundation\StreamedResponse;美元响应=新StreamedResponse ();美元响应- >setCallback (函数(){var_dump (“Hello World”);冲洗();睡眠(2);var_dump (“Hello World”);冲洗();});美元响应- >send ();
请注意
的冲洗()
函数不冲洗缓冲。如果ob_start ()
或者是之前被称为output_buffering
php . ini
选择启用,您必须调用ob_flush ()
之前冲洗()
。
另外,PHP并不是唯一的层,可以缓冲输出。您的web服务器也可能根据其配置缓冲。一些服务器,比如nginx,让你禁用缓冲配置级别或通过添加一个特殊的HTTP头的反应:
1 2
/ /禁用FastCGI缓冲nginx只响应美元响应- >头- >集(“X-Accel-Buffering”,“不”)
服务文件
发送一个文件时,您必须添加一个附加项
头给你回应。在创建这个头基本文件下载很简单,使用非ascii文件名是更多的参与。的makeDisposition ()摘要背后的辛勤工作一个简单的API:
1 2 3 4 5 6 7 8 9 10 11 12
使用欧宝娱乐app下载地址\组件\HttpFoundation\响应;使用欧宝娱乐app下载地址\组件\HttpFoundation\ResponseHeaderBag;美元fileContent=……;/ /生成的文件内容美元响应=新响应(美元fileContent);美元性格=美元响应- >头- >makeDisposition (ResponseHeaderBag::DISPOSITION_ATTACHMENT,“foo.pdf”);美元响应- >头- >集(“附加”,美元性格);
或者,如果你是为一个静态文件,您可以使用一个BinaryFileResponse:
1 2 3 4
使用欧宝娱乐app下载地址\组件\HttpFoundation\BinaryFileResponse;美元文件=“路径/ / file.txt”;美元响应=新BinaryFileResponse (美元文件);
的BinaryFileResponse
会自动处理范围
和If-Range
头从请求。它还支持X-Sendfile
(见nginx和Apache)。使用它,您需要确定是否X-Sendfile-Type
头应该信任和电话trustXSendfileTypeHeader ()如果它应该:
1
BinaryFileResponse::trustXSendfileTypeHeader ();
请注意
的BinaryFileResponse
只会处理X-Sendfile
如果存在特定的头。对于Apache,这不是默认情况。
添加标题使用mod_headers
Apache模块和Apache配置添加以下:
1 2 3 4 5 6 7 8 9 10
< IfModule mod_xsendfile.c >#这是已经存在某个地方……XSendFile在XSendFilePath…一些道路…#这需要补充道:< IfModule mod_headers.c >RequestHeader设置X-Sendfile-Type X-Sendfile< / IfModule >< / IfModule >
与BinaryFileResponse
,你还可以设置内容类型
发送的文件,或改变它附加项
:
1 2 3 4 5 6
/ /……美元响应- >头- >集(“内容类型”,“文本/普通”);美元响应- >setContentDisposition (ResponseHeaderBag::DISPOSITION_ATTACHMENT,“filename.txt”);
可以删除文件的响应发送后deleteFileAfterSend ()方法。请注意,这将不是工作时X-Sendfile
头被设置。
3.3
的流
类是在Symfony 3.3中引入的。欧宝娱乐app下载地址
如果服务文件的大小是未知的(例如,因为它是动态生成的,或者因为一个PHP流过滤注册,等等),你可以通过流
实例BinaryFileResponse
。这将禁用范围
和内容长度
处理,切换到分块编码:
1 2 3 4 5
使用欧宝娱乐app下载地址\组件\HttpFoundation\BinaryFileResponse;使用欧宝娱乐app下载地址\组件\HttpFoundation\文件\流;美元流=新流(的路径/ /流);美元响应=新BinaryFileResponse (美元流);
请注意
如果你只是文件在同一请求,创建文件可能发送没有任何内容。这可能是由于缓存文件数据文件的大小,返回0。为了解决这个问题,电话函数(真的,$文件)
二进制文件的路径。
创建一个JSON响应
可以通过创建任何类型的反应响应类通过设置正确的内容和标题。一个JSON响应可能会看起来像这样:
1 2 3 4 5 6 7
使用欧宝娱乐app下载地址\组件\HttpFoundation\响应;美元响应=新反应();美元响应- >setContent (json_encode ([“数据”= >123年)));美元响应- >头- >集(“内容类型”,“application / json”);
也有帮助JsonResponse类,它可以使这更容易:
1 2 3 4 5 6 7 8 9 10 11 12
使用欧宝娱乐app下载地址\组件\HttpFoundation\JsonResponse;/ /如果你知道发送的数据在创建响应美元响应=新JsonResponse ([“数据”= >123年]);/ /如果你不知道发送的数据在创建响应美元响应=新JsonResponse ();/ /……美元响应- >setData ([“数据”= >123年]);/ /如果数据发送已经用JSON编码美元响应= JsonResponse::fromJsonString (“{“数据”:123}”);
3.2
的fromJsonString ()方法是在Symfony 3.2中引入的。欧宝娱乐app下载地址
的JsonResponse
类集内容类型
头来application / json
并将数据编码为JSON。
JSONP回调
如果你使用JSONP,你可以设置回调函数,数据应该传递给:
1
美元响应- >setCallback (“handleResponse”);
在这种情况下,内容类型
头会text / javascript
和响应内容是这样的:
1
handleResponse ({“数据”:123年});