PHP 封装一个 api 接口类
使用:
$this->apiSuccess('返回成功', ['message'=>'yes']);
返回结果:
{ "info": "发布话题成功", "data": { "message": "yes" }, "code": 200 }
调用:
$this->apiError('返回失败');
返回结果:
{ "info":"返回失败", "code":400 }
代码如下:
<?php class MY_Controller extends CI_Controller { // 当前请求类型 protected $_method = ''; // 当前请求的资源类型 protected $_type = ''; // REST允许的请求类型列表 protected $allowMethod = array('get', 'post', 'put', 'delete'); // REST默认请求类型 protected $defaultMethod = 'get'; // REST允许请求的资源类型列表 protected $allowType = array('html', 'xml', 'json', 'rss'); // 默认的资源类型 protected $defaultType__EXT__ = 'html'; // REST允许输出的资源类型列表 protected $allowOutputType = array( 'xml' => 'application/xml', 'json' => 'application/json', 'html' => 'text/html', ); /** * 架构函数 * @access public */ public function __construct() { parent::__construct(); $this->_type = $this->getAcceptType(); // 请求方式检测 $method = strtolower($_SERVER['REQUEST_METHOD']); if (!in_array($method, $this->allowMethod)) { // 请求方式非法 则用默认请求方法 $method = $this->defaultMethod; } $this->_method = $method; } /** * 获取当前请求的Accept头信息 * @return string */ protected function getAcceptType() { $type = array( 'html' => 'text/html,application/xhtml+xml,*/*', 'xml' => 'application/xml,text/xml,application/x-xml', 'json' => 'application/json,text/x-json,application/jsonrequest,text/json', 'js' => 'text/javascript,application/javascript,application/x-javascript', 'css' => 'text/css', 'rss' => 'application/rss+xml', 'yaml' => 'application/x-yaml,text/yaml', 'atom' => 'application/atom+xml', 'pdf' => 'application/pdf', 'text' => 'text/plain', 'png' => 'image/png', 'jpg' => 'image/jpg,image/jpeg,image/pjpeg', 'gif' => 'image/gif', 'csv' => 'text/csv' ); foreach ($type as $key => $val) { $array = explode(',', $val); foreach ($array as $k => $v) { if (isset($_SERVER['HTTP_ACCEPT']) && stristr($_SERVER['HTTP_ACCEPT'], $v)) { return $key; }else{ return false; } } } return false; } // 发送Http状态信息 protected function sendHttpStatus($code) { static $_status = array( // Informational 1xx 100 => 'Continue', 101 => 'Switching Protocols', // Success 2xx 200 => 'OK', 201 => 'Created', 202 => 'Accepted', 203 => 'Non-Authoritative Information', 204 => 'No Content', 205 => 'Reset Content', 206 => 'Partial Content', // Redirection 3xx 300 => 'Multiple Choices', 301 => 'Moved Permanently', 302 => 'Moved Temporarily ', // 1.1 303 => 'See Other', 304 => 'Not Modified', 305 => 'Use Proxy', // 306 is deprecated but reserved 307 => 'Temporary Redirect', // Client Error 4xx 400 => 'Bad Request', 401 => 'Unauthorized', 402 => 'Payment Required', 403 => 'Forbidden', 404 => 'Not Found', 405 => 'Method Not Allowed', 406 => 'Not Acceptable', 407 => 'Proxy Authentication Required', 408 => 'Request Timeout', 409 => 'Conflict', 410 => 'Gone', 411 => 'Length Required', 412 => 'Precondition Failed', 413 => 'Request Entity Too Large', 414 => 'Request-URI Too Long', 415 => 'Unsupported Media Type', 416 => 'Requested Range Not Satisfiable', 417 => 'Expectation Failed', // Server Error 5xx 500 => 'Internal Server Error', 501 => 'Not Implemented', 502 => 'Bad Gateway', 503 => 'Service Unavailable', 504 => 'Gateway Timeout', 505 => 'HTTP Version Not Supported', 509 => 'Bandwidth Limit Exceeded' ); if (isset($_status[$code])) { header('HTTP/1.1 ' . $code . ' ' . $_status[$code]); // 确保FastCGI模式下正常 header('Status:' . $code . ' ' . $_status[$code]); }else{ // 找不到code码时为400 $code = 400; header('HTTP/1.1 ' . $code . ' ' . $_status[$code]); // 确保FastCGI模式下正常 header('Status:' . $code . ' ' . $_status[$code]); } } /** * 编码数据 * @access protected * @param mixed $data 要返回的数据 * @param String $type 返回类型 JSON XML * @return void */ protected function encodeData($data, $type = '') { if (empty($data)) return ''; if ('json' == $type) { // 返回JSON数据格式到客户端 包含状态信息 $data = json_encode($data,JSON_UNESCAPED_UNICODE); } elseif ('xml' == $type) { // 返回xml格式数据 $data = xml_encode($data); } elseif ('php' == $type) { $data = serialize($data); } // 默认直接输出 $this->setContentType($type); header('Content-Length: ' . strlen($data)); return $data; } /** * 设置页面输出的CONTENT_TYPE和编码 * @access public * @param string $type content_type 类型对应的扩展名 * @param string $charset 页面输出编码 * @return void */ public function setContentType($type, $charset = '') { if (headers_sent()) return; if (empty($charset)) $charset = 'utf-8'; $type = strtolower($type); if (isset($this->allowOutputType[$type])) //过滤content_type header('Content-Type: ' . $this->allowOutputType[$type] . '; charset=' . $charset); } /** * 输出返回数据 * @access protected * @param mixed $data 要返回的数据 * @param String $type 返回类型 JSON XML * @param integer $code HTTP状态 * @return void */ protected function response($data, $type = '', $code = 200) { $this->sendHttpStatus($code); exit($this->encodeData($data, strtolower($type))); } protected function aresponse($data, $type = '', $code = 200) { $this->asendHttpStatus($code); exit($this->encodeData($data, strtolower($type))); } /** * apiReturn api返回方法,约定 。int 是 code。string 是 Info,array 是 data * 其中array型可以传多个,第一个返回参数名为data,其余的按照data_ + 调用时的位置 命名 */ protected function apiReturn() { $code = 200; $args = func_get_args(); $this->apiResponse($args,$code); } protected function apiSuccess(){ $args = func_get_args(); $code = 200; $this->apiResponse($args,$code); } protected function apiError(){ $args = func_get_args(); $code = 400; $this->apiResponse($args,$code); } protected function apiResponse($args,$code=200){ $rs = array(); foreach ($args as $key => $v) { if (is_array($v)) { if (isset($rs['data'])) { $rs['data_'.$key] = $v; }else{ $rs['data'] = $v; } } elseif (is_int($v)) { $code = $v; } else { $rs['info'] = $v; } } $rs['code'] = $code; $this->response($rs, 'json', $code); } }