FizeWeb 参考手册¶

欢迎使用
安装说明
更新日志
许可协议
捐赠我们
参数配置
类库参考

欢迎使用 ¶

欢迎使用¶

FizeWeb 是一个 Web环境参数变量的获取和设置类库。

FizeWeb 提供诸如：Cookie 、Request 、Response 、Session 等 WEB 相关的变量参数的设置、获取、处理等操作。

FizeWeb 暴露的接口简单明了，易于使用。

FizeWeb 有非常完善的参考文档。

安装说明 ¶

安装说明¶

FizeWeb 的环境要求如下：

“php”: “>=7.0.0”

使用Composer安装¶

FizeWeb 支持使用 Composer 安装，也是唯一官方推荐的安装方法。

注解

如果您尚未安装 composer ，请参考安装 composer 。

使用阿里云镜像以提高下载速度及稳定性。

在命令行下面，切换到您的项目根目录下面并执行下面的命令：

composer require fize/web

好了！您现在可以开始使用 FizeWeb 了，就是这么简单！~

注解

Fize 项目(包括所有子项目)严格遵守语义化版本，您可以放心大胆的使用。

更新日志 ¶

更新日志¶

v1.3.1 (2019-12-05) : 增强 Cookie 的 set 方法。
v1.3.0 (2019-12-04) : Request 添加 url 方法。
v1.2.0 (2019-12-02) : Session类改进。
v1.1.0 (2019-11-18) : 添加session操作方法，FizeSession只进行session底层管理。
v1.0.1 (2019-11-03) : 修正URL重定向时http code仍为200的错误。
v1.0.0 (2019-11-03) : 发布首个版本。

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

注解

以下为中文译文

MIT 开源许可协议¶

特此向任何得到本软件副本或相关文档的人授权：被授权人有权使用、复制、修改、合并、出版、发布、散布、再授权和/或贩售软件及软件的副本，及授予被供应人同等权利，只需服从以下义务：

该软件是”按原样”提供的，没有任何形式的明示或暗示，包括但不限于为特定目的和不侵权的适销性和适用性的保证担保。在任何情况下，作者或版权持有人，都无权要求任何索赔，或有关损害赔偿的其他责任。无论在本软件的使用上或其他买卖交易中，是否涉及合同，侵权或其他行为。

捐赠我们 ¶

捐赠我们¶

Fize 项目及其下所有子项目目前都为个人维护，坚持开源和免费提供使用。如果您对我们的成果表示认同并且觉得对你有所帮助我们愿意接受来自各方面的捐赠。

使用手机支付宝扫描进行捐赠

https://i.loli.net/2019/11/19/MY9pe7vIb1rUGf4.jpg

使用手机微信扫描进行捐赠

https://i.loli.net/2019/11/19/wGWiC6mEr1MTD9K.jpg

以下是捐赠明细(截止2019-11-19)：

梁*萍 50.00元

董*辉 100.00元

曾*庆 20.00元

许*钦 10.00元

陈* 88.88元

参数配置 ¶

参数配置¶

Cookie¶

Cookie 配置¶

参数名	说明	是否可选	默认值
expire	有效时间，以秒为单位	是	3600
path	Cookie 有效路径	是	/
domain	Cookie 有效域名	是	“”
secure	是否只允许在 HTTPS 安全链接下生效	是	false
httponly	是否使用httponly，为安全性，全局默认开启	是	true
prefix	Cookie 键名前缀,如果发生冲突可以修改该值	是	“”
encode_key	是否加密cookie键名	是	false
encode_value	是否加密cookie键值	是	false
secret_key	加密密钥	是	“”

注解

启动加密功能必须安装 FizeSecurity。

加密键名则需要对所有 cookie 进行遍历获取，不合适 cookie 数量过多的情况。

Request¶

Request 配置¶

参数名	说明	是否可选	默认值
var_method	请求方式伪装字段	是	‘_method’
var_ajax	AJAX 伪装字段	是	‘_ajax’
var_pjax	PJAX 伪装字段	是	‘_pjax’
https_agent_name	HTTPS 代理标识	是	‘’
accept_type	指定接受类型	是	‘’

Response¶

Response 配置¶

注解

Response 无需配置参数即可使用。

Session¶

Session 配置¶

注解

Session 配置请参考 FizeSession 参考手册

类库参考 ¶

类库参考¶

Cookie 管理类¶

属性	值
命名空间	fize\web
类名	Cookie

方法:

方法名	说明
__construct()	初始化
onTamper()	绑定 cookie 被篡改事件
set()	设置一个 cookie
get()	获取指定 cookie 值，未设置则返回 false
has()	判断 Cookie 是否存在
remove()	删除某个 Cookie 值
clear()	清空 Cookie 值

方法¶

__construct()¶

初始化

public function __construct (
    array $config = []
)

参数:

名称	说明
config	要更改的配置项

使用 Cookie 静态方法前请先执行初始化
注意开启 httponly 后，前端 JS 是无法获取到 cookie 的。
如果需要前端 js 获取 cookie ，可在设置 cookie 时禁用 httponly。

onTamper()¶

绑定 cookie 被篡改事件

public static function onTamper (
    callable $func
)

参数:

名称	说明
func	cookie 被篡改事件回调函数

参数 `$func` :
该回调参数定义为 ($key, $value)

set()¶

设置一个 cookie

public static function set (
    string $key,
    string $value,
    array|int $config = []
)

参数:

名称	说明
key	键名
value	键值
config	有效时长或临时指定的配置

参数 `$config` :
类型为 int 表示有效时长，array 表示临时指定的配置

get()¶

获取指定 cookie 值，未设置则返回 false

public static function get (
    string $key,
    array $config = []
) : string

参数:

名称	说明
key	cookie 名(加密前)
config	附加设置

参数 `$config` :
附加和设置 cookie 时相同的配置才能获取到

has()¶

判断 Cookie 是否存在

public static function has (
    string $key,
    array $config = []
) : bool

参数:

名称	说明
key	cookie 名(加密前)
config	附加设置

参数 `$config` :
附加和设置 cookie 时相同的配置才能获取到

remove()¶

删除某个 Cookie 值

public static function remove (
    string $key,
    array $config = []
)

参数:

名称	说明
key	cookie 键名
config	附加设置

参数 `$config` :
附加和设置 cookie 时相同的配置才能正确操作

clear()¶

清空 Cookie 值

public static function clear ()

Request 请求类¶

属性	值
命名空间	fize\web
类名	Request

方法:

方法名	说明
__construct()	初始化静态属性
server()	获取原生 SERVER
get()	获取 GET 参数
post()	获取 POST 参数
files()	获取上传文件
request()	获取 REQUEST 参数
session()	获取 SESSION 参数
env()	获取 ENV 参数
cookie()	获取 COOKIE 参数
input()	返回原始输入数据
header()	获取请求头
contentType()	当前请求 HTTP_CONTENT_TYPE
method()	当前的请求类型
isGet()	是否为 GET 请求
isPost()	是否为 POST 请求
isPut()	是否为 PUT 请求
isDelete()	是否为 DELTE 请求
isHead()	是否为 HEAD 请求
isPatch()	是否为 PATCH 请求
isOptions()	是否为 OPTIONS 请求
isCli()	是否为 cli
isCgi()	是否为 cgi
isSsl()	当前是否 ssl
isJson()	当前是否 JSON 请求
isAjax()	当前是否 Ajax 请求
isPjax()	当前是否 Pjax 请求
isMobile()	检测是否使用手机访问
url()	返回当前请求 URL

方法¶

__construct()¶

初始化静态属性

public function __construct (
    array $config = []
)

参数:

名称	说明
config	配置

server()¶

获取原生 SERVER

public static function server (
    string $key = null,
    string $default = null
) : mixed

参数:

名称	说明
key	键名
default	默认值

get()¶

获取 GET 参数

public static function get (
    string $key = null,
    string $default = null
) : mixed

参数:

名称	说明
key	键名
default	默认值

post()¶

获取 POST 参数

public static function post (
    string $key = null,
    string $default = null
) : mixed

参数:

名称	说明
key	键名
default	默认值

files()¶

获取上传文件

public static function files (
    string $key = null
) : mixed

参数:

名称	说明
key	键名

request()¶

获取 REQUEST 参数

public static function request (
    string $key = null
) : mixed

参数:

名称	说明
key	键名

session()¶

获取 SESSION 参数

public static function session (
    string $key = null,
    string $default = null
) : mixed

参数:

名称	说明
key	键名
default	默认值

env()¶

获取 ENV 参数

public static function env (
    string $key = null,
    string $default = null
) : mixed

参数:

名称	说明
key	键名
default	默认值

input()¶

返回原始输入数据

public static function input () : string

返回值:	失败时返回 false

header()¶

获取请求头

public static function header (
    string $key = null,
    mixed $default = null
) : mixed

参数:

名称	说明
key	键名，不设置则返回请求头数组
default	默认值

contentType()¶

当前请求 HTTP_CONTENT_TYPE

public static function contentType () : string

method()¶

当前的请求类型

public static function method () : string

isGet()¶

是否为 GET 请求

public static function isGet () : bool

isPost()¶

是否为 POST 请求

public static function isPost () : bool

isPut()¶

是否为 PUT 请求

public static function isPut () : bool

isDelete()¶

是否为 DELTE 请求

public static function isDelete () : bool

isHead()¶

是否为 HEAD 请求

public static function isHead () : bool

isPatch()¶

是否为 PATCH 请求

public static function isPatch () : bool

isOptions()¶

是否为 OPTIONS 请求

public static function isOptions () : bool

isCli()¶

是否为 cli

public static function isCli () : bool

isCgi()¶

是否为 cgi

public static function isCgi () : bool

isSsl()¶

当前是否 ssl

public static function isSsl () : bool

isJson()¶

当前是否 JSON 请求

public static function isJson () : bool

isAjax()¶

当前是否 Ajax 请求

public static function isAjax () : bool

isPjax()¶

当前是否 Pjax 请求

public static function isPjax () : bool

isMobile()¶

检测是否使用手机访问

public static function isMobile () : bool

url()¶

返回当前请求 URL

public static function url (
    bool $host = true,
    bool $protocol = true
) : string

参数:

名称	说明
host	是否携带主机名
protocol	是否携带协议

Response 响应类¶

属性	值
命名空间	fize\web
类名	Response

方法:

方法名	说明
content()	设置或获取响应主体内容
code()	HTTP 状态
header()	添加响应头获取返回响应头
contentType()	页面输出类型
send()	发送响应
noCache()	强制浏览器不进行缓存
json()	JSON 响应
html()	HTML 响应
xml()	XML 响应
redirect()	跳转
download()	下载

方法¶

content()¶

设置或获取响应主体内容

public function content (
    string $content = null
) : string

参数:

名称	说明
content	主体内容

code()¶

HTTP 状态

public function code (
    int $code = null
) : int

参数:

名称	说明
code	状态码

header()¶

添加响应头获取返回响应头

public function header (
    mixed $header = null,
    null $value = null
) : array

参数:

名称	说明
header	要附加的响应头，数组则附加数组，字符串则附加单个，如果不指定该参数则返回当前响应头
value	如果指定该值则为 key 的值

返回值:

返回响应头

contentType()¶

页面输出类型

public function contentType (
    string $content_type,
    string $charset = "utf-8"
)

参数:

名称	说明
content_type	输出类型
charset	输出编码

send()¶

发送响应

public function send ()

noCache()¶

强制浏览器不进行缓存

public static function noCache ()

json()¶

JSON 响应

public static function json (
    array|string $json,
    string $charset = "utf-8"
) : \fize\web\Response

参数:

名称	说明
json	数组或者 JSON 字符串
charset	输出编码

html()¶

HTML 响应

public static function html (
    string $html,
    string $charset = "utf-8"
) : \fize\web\Response

参数:

名称	说明
html	HTML 内容
charset	输出编码

xml()¶

XML 响应

public static function xml (
    string $xml,
    string $charset = "utf-8"
) : \fize\web\Response

参数:

名称	说明
xml	XML 内容
charset	输出编码

redirect()¶

跳转

public static function redirect (
    string $url,
    int $delay = null
) : \fize\web\Response

参数:

名称	说明
url	跳转 URL
delay	延迟时间，以秒为单位

download()¶

下载

public static function download (
    string $file,
    string $filename = null
) : \fize\web\Response

参数:

名称	说明
file	要下载的文件路径
filename	下载文件名

Session 管理类¶

属性	值
命名空间	fize\web
类名	Session

方法:

方法名	说明
__construct()	构造
get()	获取一个 Session 值
has()	查看指定 Session 值是否存在
set()	设置一个 Session 值
remove()	删除一个 Session
clear()	清空 SESSION

方法¶

__construct()¶

构造

public function __construct (
    array $config = []
)

参数:

名称	说明
config	配置

在构造方法中初始化 Session 底层管理
使用 Session 静态方法前请先执行初始化

get()¶

获取一个 Session 值

public static function get (
    string $name,
    mixed $default = null
) : mixed

参数:

名称	说明
name	名称
default	默认值

has()¶

查看指定 Session 值是否存在

public static function has (
    string $name
) : bool

参数:

名称	说明
name	名称

set()¶

设置一个 Session 值

public static function set (
    string $name,
    mixed $value
)

参数:

名称	说明
name	名称
value	值

remove()¶

删除一个 Session

public static function remove (
    string $name
)

参数:

名称	说明
name	名称

clear()¶

清空 SESSION

public static function clear ()

FizeWeb 参考手册¶

欢迎使用¶

欢迎使用¶

安装说明¶

安装说明¶

使用Composer安装¶

更新日志¶

更新日志¶

许可协议¶

许可协议¶

The MIT License (MIT)¶

MIT 开源许可协议¶

捐赠我们¶

捐赠我们¶

参数配置¶

参数配置¶

Cookie¶

Cookie 配置¶

Request¶

Request 配置¶

Response¶

Response 配置¶

Session¶

Session 配置¶

类库参考¶

类库参考¶

Cookie 管理类¶

方法¶

__construct()¶

onTamper()¶

set()¶

get()¶

has()¶

remove()¶

clear()¶

Request 请求类¶

方法¶

__construct()¶

server()¶

get()¶

post()¶

files()¶

request()¶

session()¶

env()¶

cookie()¶

input()¶

header()¶

contentType()¶

method()¶

isGet()¶

isPost()¶

isPut()¶

isDelete()¶

isHead()¶

isPatch()¶

isOptions()¶

isCli()¶

isCgi()¶

isSsl()¶

isJson()¶

isAjax()¶

isPjax()¶

isMobile()¶

url()¶

Response 响应类¶

方法¶

content()¶

code()¶

header()¶

contentType()¶

send()¶

noCache()¶

json()¶

html()¶

xml()¶

redirect()¶

download()¶

Session 管理类¶

方法¶

欢迎使用 ¶

安装说明 ¶

更新日志 ¶

许可协议 ¶

捐赠我们 ¶

参数配置 ¶

类库参考 ¶