Controller.php 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  1. <?php
  2. namespace App\Http\Controllers;
  3. use App\Constants\HttpStatus;
  4. use Illuminate\Foundation\Auth\Access\AuthorizesRequests;
  5. use Illuminate\Foundation\Bus\DispatchesJobs;
  6. use Illuminate\Foundation\Validation\ValidatesRequests;
  7. use Illuminate\Routing\Controller as BaseController;
  8. use Illuminate\Support\Facades\App;
  9. class Controller extends BaseController
  10. {
  11. use AuthorizesRequests, DispatchesJobs, ValidatesRequests;
  12. /**
  13. * @apiDefine header
  14. * @apiHeader {String} Authorization "Bearer "+ token
  15. *
  16. */
  17. /**
  18. * @apiDefine lang
  19. * @apiParam (公共参数) {String} [lang=en] 语言
  20. * - 允许值:`zh-CN`,`en`
  21. */
  22. /**
  23. *
  24. */
  25. /**
  26. * @apiDefine result
  27. * @apiSuccess (成功) {Number} code=0 错误代码 0-请求成功 详见 <a href="javascript:;" onclick="toMenu('Error','GetGeterrorcode')">错误代码</a>
  28. * @apiSuccess (成功) {Number} timestamp 服务器时间戳
  29. * @apiSuccess (成功) {String} msg 错误信息 OK为成功
  30. * @apiSuccess (成功) {Array} [data] 数据 若code!=0 则为错误数据,code=101009 该值为验证失败的详情
  31. *
  32. *
  33. */
  34. /**
  35. * @api {get} /getErrorCode 错误代码
  36. * @apiGroup Error
  37. * @apiSampleRequest off
  38. * @apiDescription 下面列出一些常见的错误代码:
  39. * | code | 说明 |
  40. * |---------|-----------------------------------------------------------------------------------|
  41. * |-1 | 未知错误,联系开发人员 |
  42. * |0 | OK 请求成功 |
  43. * |101001 | 用户不存在 |
  44. * |101002 | 密码错误 |
  45. * |101003 | 验证码错误 |
  46. * |101004 | 验证码已过期 |
  47. * |101005 | 密码不一致 |
  48. * |101006 | 用户名已存在,请直接登录 |
  49. * |101007 | 邮箱已存在,请直接登录 |
  50. * |101008 | 用户名错误 |
  51. * |101009 | 参数验证失败,具体错误信息见 data |
  52. * |101010 | 系统错误 |
  53. * |101011 | 没有登录,请检查登录状态 |
  54. * |101012 | 禁止收藏自己 |
  55. * |101013 | 先填写基本信息 |
  56. * |101014 | 请求地址不存在,请检查请求地址是否正确 |
  57. * |101015 | 上传的头像必须是正方形的,如果用户所选的图片不是方形的,请裁剪后上传 |
  58. * |101016 | 没有匹配到合适的对象 |
  59. * |101017 | 可收藏数达到最大值,完善资料可获取更多数量 |
  60. * |101018 | 发送失败 |
  61. * |101019 | 手机号码不正确 |
  62. * |101020 | 帖子不存在 |
  63. * |101021 | 文件上传错误 |
  64. * |101022 | 邀请码错误 |
  65. * |101023 | 用户已在其他设备登录 |
  66. * |101024 | 剩余抽奖次数不足 |
  67. * |101025 | 地址数量最多10条 |
  68. * |101026 | post请求错误 |
  69. * |101027 | IM 错误 |
  70. * |101028 | 手机号已存在或已绑定其他账号,请直接登录或绑定其它手机号 |
  71. * |101029 | 谷歌登录错误 |
  72. * |101030 | 聊天余额不足 |
  73. * |101031 | 钱包余额不足 |
  74. * |101032 | Facebook 错误 |
  75. * |101033 | 资料验证失败,请检查当前是否是待验证状态 |
  76. *
  77. * @apiVersion 1.0.0
  78. */
  79. protected function success($data = [], $msg = '')
  80. {
  81. return response()->json([
  82. 'code' => HttpStatus::OK,
  83. 'timestamp' => time(),
  84. 'msg' => __('messages.' . HttpStatus::OK),
  85. 'data' => $data
  86. ]);
  87. }
  88. protected function error($code, string $msg = '', $data = [])
  89. {
  90. App::setLocale(isset($_REQUEST['lang']) && $_REQUEST['lang'] == 'en' ? 'en' : 'zh-CN');
  91. $code = intval($code);
  92. if ($code === 0) $code = -1;
  93. $m = __('messages.' . $code);
  94. if ($msg) $m .= ":{$msg}";
  95. if ($code === -3) $m = $msg;
  96. return response()->json([
  97. 'code' => $code,
  98. 'timestamp' => time(),
  99. 'msg' => $m,
  100. 'data' => $data
  101. ]);
  102. }
  103. }