282 lines
12 KiB
PHP
282 lines
12 KiB
PHP
<?php
|
||
/*
|
||
* Copyright © 2016 - 2023 筱锋xiao_lfeng. All Rights Reserved.
|
||
* 开发开源遵循 MIT 许可，若需商用请联系开发者
|
||
* https://www.x-lf.com/
|
||
*/
|
||
|
||
/**
|
||
* 标准Json输出及HTTP状态码输出类
|
||
* @author 筱锋xiao_lfeng
|
||
* @version 1.0.2-beta
|
||
*/
|
||
class Normal
|
||
{
|
||
|
||
/**
|
||
* Json标准输出部分
|
||
* @param int $gType 输入数字类型输出不同的段落格式
|
||
* @param array|null $OtherArray 其他需要附带，不属于标准Json输出内容部分
|
||
* @param string|null $OtherOutput 其他数据，会拼接在output后面使用 __ 分割
|
||
* @return void
|
||
*/
|
||
public static function Output(int $gType, array $OtherArray = null, string $OtherOutput = null)
|
||
{
|
||
if (self::OutputMessage($gType, 1) != null) {
|
||
if (!empty($OtherOutput))
|
||
$OtherOutput = '__' . $OtherOutput;
|
||
else
|
||
$OtherOutput = null;
|
||
$Json_Data = [
|
||
'output' => self::OutputMessage($gType, 0) . $OtherOutput,
|
||
'code' => self::OutputMessage($gType, 1),
|
||
'data' => [
|
||
'statusCode' => $gType,
|
||
'message' => self::OutputMessage($gType, 2),
|
||
],
|
||
];
|
||
if (!empty($OtherArray)) {
|
||
$Json_Data['data']['data'] = $OtherArray;
|
||
}
|
||
header(self::HttpStatusCode(self::OutputMessage($gType, 1)));
|
||
} else {
|
||
$Json_Data = [
|
||
'output' => 'DevelopError',
|
||
'code' => 0,
|
||
'data' => [
|
||
'statusCode' => 0,
|
||
'message' => "开发错误，请查阅",
|
||
],
|
||
];
|
||
header(self::HttpStatusCode(502));
|
||
}
|
||
// Json 输出
|
||
echo json_encode($Json_Data, JSON_UNESCAPED_UNICODE);
|
||
}
|
||
|
||
/**
|
||
* 自定义生成标标准接口输出 | 样式举例
|
||
*
|
||
* - Json
|
||
* - output( **$Json_Output** )
|
||
* - code( **$Json_Code** )
|
||
* - data
|
||
* - [data] statusCode( **$Json_ReturnCode=999** )
|
||
* - [data] message( **$Json_Message** )
|
||
* - [data] data( **$Json_Other=null** )
|
||
*
|
||
* $Json_ReturnCode 默认为 999 可自定义其他 Code 代码，但不可与现有代码重复
|
||
* @param string $Json_Output 输出代码示例
|
||
* @param int $Json_Code 输出HTTP状态码
|
||
* @param string $Json_Message 中文提示码
|
||
* @param array|null $Json_Other 输出data内容
|
||
* @param int $Json_ReturnCode 输出自定义code值
|
||
* @return void 直接 echo json_encode 无需返回值
|
||
*/
|
||
public static function CustomOutput(string $Json_Output, int $Json_Code, string $Json_Message, array $Json_Other = null, int $Json_ReturnCode = 999)
|
||
{
|
||
// 检查自定义代码是否重复
|
||
if (!empty(self::OutputMessage($Json_ReturnCode, 1))) {
|
||
// 进行操作
|
||
$Json_Data = [
|
||
'output' => self::OutputMessage(800, 0),
|
||
'code' => self::OutputMessage(800, 1),
|
||
'data' => [
|
||
'statusCode' => 800,
|
||
'message' => self::OutputMessage(800, 2),
|
||
],
|
||
];
|
||
} else {
|
||
// 进行操作
|
||
$Json_Data = [
|
||
'output' => $Json_Output,
|
||
'code' => $Json_Code,
|
||
'data' => [
|
||
'statusCode' => $Json_ReturnCode,
|
||
'message' => $Json_Message,
|
||
],
|
||
];
|
||
if (!empty($Json_Other)) {
|
||
$Json_Data['data']['data'] = $Json_Other;
|
||
}
|
||
}
|
||
header(self::HttpStatusCode($Json_Code));
|
||
echo json_encode($Json_Data, JSON_UNESCAPED_UNICODE);
|
||
}
|
||
|
||
/**
|
||
* 输出状态监控
|
||
* @param int $gType
|
||
* @param int $bCode
|
||
* @return int|string|null
|
||
*/
|
||
private static function OutputMessage(int $gType, int $bCode)
|
||
{
|
||
if ($gType == 100)
|
||
if ($bCode == 0) return 'SessionError';
|
||
else if ($bCode == 1) return 502;
|
||
else return "通讯密钥为空或错误";
|
||
else if ($gType == 200)
|
||
if ($bCode == 0) return 'Success';
|
||
else if ($bCode == 1) return 200;
|
||
else return "操作成功";
|
||
else if ($gType == 201)
|
||
if ($bCode == 0) return 'SuccessButEmail';
|
||
else if ($bCode == 1) return 200;
|
||
else return "操作成功但邮件发送失败";
|
||
else if ($gType == 300)
|
||
if ($bCode == 0) return 'SqlInsertFail';
|
||
else if ($bCode == 1) return 400;
|
||
else return "数据表内容插入失败";
|
||
else if ($gType == 301)
|
||
if ($bCode == 0) return 'SqlSelectFail';
|
||
else if ($bCode == 1) return 400;
|
||
else return "数据表内容查询失败";
|
||
else if ($gType == 302)
|
||
if ($bCode == 0) return 'SqlUpdateFail';
|
||
else if ($bCode == 1) return 400;
|
||
else return "数据表内容修改失败";
|
||
else if ($gType == 303)
|
||
if ($bCode == 0) return 'SqlDeleteFail';
|
||
else if ($bCode == 1) return 400;
|
||
else return "数据表内容删除失败";
|
||
else if ($gType == 310)
|
||
if ($bCode == 0) return 'TokenTooShort';
|
||
else if ($bCode == 1) return 502;
|
||
else return "Token长度过短";
|
||
else if ($gType == 311)
|
||
if ($bCode == 0) return 'TokenTooLong';
|
||
else if ($bCode == 1) return 502;
|
||
else return "Token长度过长";
|
||
else if ($gType == 400)
|
||
if ($bCode == 0) return 'usernameFormat';
|
||
else if ($bCode == 1) return 405;
|
||
else return "用户名格式不符合 （格式允许0-9,A-Z,a-z及_）";
|
||
else if ($gType == 401)
|
||
if ($bCode == 0) return 'emailFormat';
|
||
else if ($bCode == 1) return 405;
|
||
else return "邮箱格式不符合";
|
||
else if ($gType == 402)
|
||
if ($bCode == 0) return 'userFormat';
|
||
else if ($bCode == 1) return 405;
|
||
else return "用户格式不符合";
|
||
else if ($gType == 403)
|
||
if ($bCode == 0) return 'passwordIncorrect';
|
||
else if ($bCode == 1) return 403;
|
||
else return "密码不正确";
|
||
else if ($gType == 404)
|
||
if ($bCode == 0) return 'typeFormat';
|
||
else if ($bCode == 1) return 403;
|
||
else return "类型不正确";
|
||
else if ($gType == 405)
|
||
if ($bCode == 0) return 'blog_nameFormat';
|
||
else if ($bCode == 1) return 403;
|
||
else return "博客名字格式不符合";
|
||
else if ($gType == 406)
|
||
if ($bCode == 0) return 'blog_introduceFormat';
|
||
else if ($bCode == 1) return 403;
|
||
else return "博客描述格式不符合";
|
||
else if ($gType == 407)
|
||
if ($bCode == 0) return 'internetFormat';
|
||
else if ($bCode == 1) return 403;
|
||
else return "地址格式错误";
|
||
else if ($gType == 408)
|
||
if ($bCode == 0) return 'booleanFormat';
|
||
else if ($bCode == 1) return 403;
|
||
else return "布尔值格式错误";
|
||
else if ($gType == 409)
|
||
if ($bCode == 0) return 'blog_hostFormat';
|
||
else if ($bCode == 1) return 403;
|
||
else return "主机格式不符合";
|
||
else if ($gType == 410)
|
||
if ($bCode == 0) return 'blog_location';
|
||
else if ($bCode == 1) return 403;
|
||
else return "添加位置错误";
|
||
else if ($gType == 500)
|
||
if ($bCode == 0) return 'CaptchaEffective';
|
||
else if ($bCode == 1) return 200;
|
||
else return "激活码任然有效";
|
||
else if ($gType == 501)
|
||
if ($bCode == 0) return 'ParameterLack';
|
||
else if ($bCode == 1) return 403;
|
||
else return "激活码任然有效";
|
||
else if ($gType == 600)
|
||
if ($bCode == 0) return 'AlReadyUser';
|
||
else if ($bCode == 1) return 403;
|
||
else return "已经有这个用户";
|
||
else if ($gType == 601)
|
||
if ($bCode == 0) return 'ConsolePermissionDenied';
|
||
else if ($bCode == 1) return 403;
|
||
else return "后端权限拒绝";
|
||
else if ($gType == 700)
|
||
if ($bCode == 0) return 'AdminPermissionDenied';
|
||
else if ($bCode == 1) return 403;
|
||
else return "管理员权限拒绝";
|
||
else if ($gType == 701)
|
||
if ($bCode == 0) return 'UserPermissionDenied';
|
||
else if ($bCode == 1) return 403;
|
||
else return "用户权限拒绝";
|
||
else if ($gType == 702)
|
||
if ($bCode == 0) return 'PermissionDenied';
|
||
else if ($bCode == 1) return 403;
|
||
else return "权限拒绝";
|
||
else if ($gType == 703)
|
||
if ($bCode == 0) return 'NoUser';
|
||
else if ($bCode == 1) return 403;
|
||
else return "没有这个用户";
|
||
else if ($gType == 800)
|
||
if ($bCode == 0) return 'CodeRepeat';
|
||
else if ($bCode == 1) return 403;
|
||
else return "序号重复，拒绝定义此序号（开发定义错误，请查阅开发文档）";
|
||
else
|
||
return null;
|
||
}
|
||
|
||
/**
|
||
* HTTP状态码反馈
|
||
* @param int $Input_State 输入HTTP状态码数字
|
||
* @return string 反馈对应 PHP 状态码 header
|
||
*/
|
||
private static function HttpStatusCode(int $Input_State): string
|
||
{
|
||
if ($Input_State == 200) return 'HTTP/1.1 200 OK';
|
||
else if ($Input_State == 100) return 'HTTP/1.1 100 Continue';
|
||
else if ($Input_State == 101) return 'HTTP/1.1 101 Switching Protocols';
|
||
else if ($Input_State == 201) return 'HTTP/1.1 201 Created';
|
||
else if ($Input_State == 202) return 'HTTP/1.1 202 Accepted';
|
||
else if ($Input_State == 203) return 'HTTP/1.1 203 Non-Authoritative Information';
|
||
else if ($Input_State == 204) return 'HTTP/1.1 204 No Content';
|
||
else if ($Input_State == 205) return 'HTTP/1.1 205 Reset Content';
|
||
else if ($Input_State == 206) return 'HTTP/1.1 206 Partial Content';
|
||
else if ($Input_State == 300) return 'HTTP/1.1 300 Multiple Choices';
|
||
else if ($Input_State == 301) return 'HTTP/1.1 301 Moved Permanently';
|
||
else if ($Input_State == 302) return 'HTTP/1.1 302 Found';
|
||
else if ($Input_State == 303) return 'HTTP/1.1 303 See Other';
|
||
else if ($Input_State == 304) return 'HTTP/1.1 304 Not Modified';
|
||
else if ($Input_State == 305) return 'HTTP/1.1 305 Use Proxy';
|
||
else if ($Input_State == 307) return 'HTTP/1.1 307 Temporary Redirect';
|
||
else if ($Input_State == 400) return 'HTTP/1.1 400 Bad Request';
|
||
else if ($Input_State == 401) return 'HTTP/1.1 401 Unauthorized';
|
||
else if ($Input_State == 402) return 'HTTP/1.1 402 Payment Required';
|
||
else if ($Input_State == 403) return 'HTTP/1.1 403 Forbidden';
|
||
else if ($Input_State == 404) return 'HTTP/1.1 404 Not Found';
|
||
else if ($Input_State == 405) return 'HTTP/1.1 405 Method Not Allowed';
|
||
else if ($Input_State == 406) return 'HTTP/1.1 406 Not Acceptable';
|
||
else if ($Input_State == 407) return 'HTTP/1.1 407 Proxy Authentication Required';
|
||
else if ($Input_State == 408) return 'HTTP/1.1 408 Request Time-out';
|
||
else if ($Input_State == 409) return 'HTTP/1.1 409 Conflict';
|
||
else if ($Input_State == 410) return 'HTTP/1.1 410 Gone';
|
||
else if ($Input_State == 411) return 'HTTP/1.1 411 Length Required';
|
||
else if ($Input_State == 412) return 'HTTP/1.1 412 Precondition Failed';
|
||
else if ($Input_State == 413) return 'HTTP/1.1 413 Request Entity Too Large';
|
||
else if ($Input_State == 414) return 'HTTP/1.1 414 Request-URI Too Large';
|
||
else if ($Input_State == 415) return 'HTTP/1.1 415 Unsupported Media Type';
|
||
else if ($Input_State == 416) return 'HTTP/1.1 416 Requested range not satisfiable';
|
||
else if ($Input_State == 417) return 'HTTP/1.1 417 Expectation Failed';
|
||
else if ($Input_State == 500) return 'HTTP/1.1 500 Internal Server Error';
|
||
else if ($Input_State == 501) return 'HTTP/1.1 501 Not Implemented';
|
||
else if ($Input_State == 502) return 'HTTP/1.1 502 Bad Gateway';
|
||
else if ($Input_State == 503) return 'HTTP/1.1 503 Service Unavailable';
|
||
else return 'HTTP/1.1 504 Gateway Time-out';
|
||
}
|
||
} |