Files
kiri-core/HttpServer/Http/HttpParams.php
T

478 lines
9.5 KiB
PHP
Raw Normal View History

2020-08-31 01:27:08 +08:00
<?php
/**
* Created by PhpStorm.
* User: admin
* Date: 2019-03-18
* Time: 14:54
*/
2020-10-29 18:17:25 +08:00
declare(strict_types=1);
2020-10-30 01:26:42 +08:00
2020-08-31 01:27:08 +08:00
namespace HttpServer\Http;
use Exception;
use HttpServer\Exception\RequestException;
2021-02-02 19:18:06 +08:00
use JetBrains\PhpStorm\Pure;
2020-12-25 15:57:52 +08:00
use ReflectionException;
2020-12-24 11:12:23 +08:00
use Snowflake\Core\Json;
2020-12-25 15:57:52 +08:00
use Snowflake\Exception\NotFindClassException;
2020-08-31 12:38:32 +08:00
use Snowflake\Snowflake;
2020-08-31 01:27:08 +08:00
/**
* Class HttpParams
2020-08-31 12:38:32 +08:00
* @package Snowflake\Snowflake\Http
2020-08-31 01:27:08 +08:00
*/
class HttpParams
{
2021-05-08 11:08:43 +08:00
private string|array|null $body = [];
2021-03-23 16:14:05 +08:00
/** @var array */
private array $gets = [];
/** @var array */
private array $files = [];
private array $socket = [];
/**
* HttpParams constructor.
2021-07-09 15:02:08 +08:00
* @param mixed $body
* @param array|null $get
* @param array|null $files
2021-03-23 16:14:05 +08:00
* @param array $socket
*/
2021-07-09 15:02:08 +08:00
public function __construct(mixed $body, ?array $get, ?array $files, array $socket = [])
2021-03-23 16:14:05 +08:00
{
$this->gets = $get ?? [];
$this->files = $files ?? [];
$this->socket = $socket ?? [];
2021-04-30 15:19:34 +08:00
$this->body = $body ?? '';
2021-03-23 16:14:05 +08:00
}
/**
* @return int
*/
public function offset(): int
{
return ($this->page() - 1) * $this->size();
}
/**
* @param array $data
* 批量添加数据
*/
public function setPosts(array $data)
{
if (!is_array($data)) {
return;
}
foreach ($data as $key => $vla) {
$this->body[$key] = $vla;
}
}
/**
* 删除参数
*/
public function clearBody()
{
$this->body = [];
}
/**
* 删除参数
*/
public function clearGet()
{
$this->gets = [];
}
/**
* 清空文件上传信息
*/
public function clearFile()
{
$this->files = [];
}
/**
* @return mixed
*/
public function getBody(): mixed
{
return $this->body;
}
/**
* @return mixed
*/
public function getBodyAndClear(): mixed
{
2021-03-23 18:30:44 +08:00
$data = $this->body['body'];
2021-03-23 16:14:05 +08:00
$this->clearBody();
return $data;
}
/**
* @param string $key
* @param string $value
*/
public function addGetParam(string $key, string $value)
{
$this->gets[$key] = $value;
}
/**
* @return int
*/
private function page(): int
{
return (int)$this->get('page', 1);
}
/**
* @return int
*/
public function size(): int
{
return (int)$this->get('size', 20);
}
/**
* @param $name
* @param null $defaultValue
* @param null $call
* @return mixed
*/
public function get($name, $defaultValue = null, $call = null): mixed
{
return $this->gets[$name] ?? $defaultValue;
}
/**
* @param $name
* @param null $defaultValue
* @param null $call
* @return mixed
*/
public function post($name, $defaultValue = null, $call = null): mixed
{
$data = $this->body[$name] ?? $defaultValue;
if ($call !== null) {
$data = call_user_func($call, $data);
}
return $data;
}
/**
* @param $name
* @return bool|string
* @throws Exception
*/
public function json($name): bool|string
{
$data = $this->array($name);
if (empty($data)) {
return Json::encode([]);
} else if (!is_array($data)) {
return Json::encode([]);
}
return Json::encode($data);
}
/**
* @return array
*/
public function gets(): array
{
return $this->gets;
}
/**
* @return array
*/
#[Pure] public function params(): array
{
return array_merge($this->body ?? [], $this->files ?? []);
}
/**
* @return array
*/
#[Pure] public function load(): array
{
return array_merge($this->files ?? [], $this->body ?? [], $this->gets ?? [], $this->socket ?? []);
}
/**
* @param $name
* @param array $defaultValue
* @return mixed
*/
2021-07-09 15:02:08 +08:00
public function array($name, array $defaultValue = []): mixed
2021-03-23 16:14:05 +08:00
{
return $this->body[$name] ?? $defaultValue;
}
/**
* @param $name
* @return File|null
* @throws ReflectionException
* @throws NotFindClassException
*/
public function file($name): File|null
{
if (!isset($this->files[$name])) {
return null;
}
$param = $this->files[$name];
$param['class'] = File::class;
return Snowflake::createObject($param);
}
/**
2021-07-09 15:02:08 +08:00
* @param string $name
2021-03-23 16:14:05 +08:00
* @param bool $isNeed
* @return mixed
* @throws RequestException
*/
private function required(string $name, bool $isNeed = false): mixed
{
$body = array_merge($this->body ?? [], $this->socket ?? []);
$int = $body[$name] ?? NULL;
if (is_null($int) && $isNeed === true) {
throw new RequestException("You need to add request parameter $name");
}
return $int;
}
/**
* @param string $name
* @param bool $isNeed
* @param array|int|null $min
* @param int|null $max
* @return int|null
* @throws RequestException
*/
public function int(string $name, bool $isNeed = FALSE, array|int|null $min = NULL, int|null $max = NULL): ?int
{
$int = $this->required($name, $isNeed);
if (is_null($int)) return null;
if (is_array($min)) {
list($min, $max) = $min;
}
$length = strlen((string)$int);
if (!is_numeric($int) || intval($int) != $int) {
throw new RequestException("The request parameter $name must integer.");
}
$this->between($length, $min, $max);
return (int)$int;
}
/**
2021-07-09 15:02:08 +08:00
* @param string $name
2021-03-23 16:14:05 +08:00
* @param bool $isNeed
* @param int $round
* @return float|null
* @throws RequestException
*/
2021-07-09 15:02:08 +08:00
public function float(string $name, bool $isNeed = FALSE, int $round = 0): ?float
2021-03-23 16:14:05 +08:00
{
$int = $this->required($name, $isNeed);
if ($int === null) {
return null;
}
if ($round > 0) {
return round(floatval($int), $round);
} else {
return floatval($int);
}
}
/**
* @param string $name
* @param bool $isNeed
* @param int|array|null $length
*
* @return string|null
* @throws RequestException
*/
public function string(string $name, bool $isNeed = FALSE, int|array|null $length = NULL): ?string
{
$string = $this->required($name, $isNeed);
if ($string === null || $length === null) {
return $string;
}
if (is_numeric($length)) {
2021-07-09 15:02:08 +08:00
if ($length !== mb_strlen((string)$string)) {
throw new RequestException("The minimum value cannot be lower than $length, has length $length");
}
return $string;
} else {
return $this->between($string, $length[0], $length[1] ?? $length[0]);
2021-03-23 16:14:05 +08:00
}
}
/**
* @param $string
* @param $min
* @param $max
* @return mixed
* @throws RequestException
*/
private function between($string, $min, $max): mixed
{
2021-03-29 18:07:48 +08:00
$_length = mb_strlen((string)$string);
2021-03-23 16:14:05 +08:00
if ($min !== NULL && $_length < $min) {
throw new RequestException("The minimum value cannot be lower than $min, has length $_length");
}
if ($max !== NULL && $_length > $max) {
throw new RequestException("Maximum cannot exceed $max, has length " . $_length);
}
return $string;
}
/**
2021-07-09 15:02:08 +08:00
* @param string $name
2021-03-23 16:14:05 +08:00
* @param bool $isNeed
*
* @return string|null
* @throws RequestException
*/
public function email(string $name, bool $isNeed = FALSE): ?string
{
$email = $this->required($name, $isNeed);
if ($email === null) {
return null;
}
if (!preg_match('/^\w+([.-_]\w+)+@\w+(\.\w+)+$/', $email)) {
throw new RequestException("Request parameter $name is in the wrong format", 4001);
}
return $email;
}
/**
* @param string $name
* @param bool $isNeed
*
* @return bool
* @throws RequestException
*/
public function bool(string $name, bool $isNeed = FALSE): bool
{
$email = $this->required($name, $isNeed);
if ($email === null) {
return false;
}
return (bool)$email;
}
/**
* @param string $name
* @param int|null $default
*
* @return int|string|null
* @throws RequestException
*/
public function timestamp(string $name, int|null $default = NULL): null|int|string
{
$value = $this->required($name, false);
if ($value === null) {
return $default;
}
if (!is_numeric($value)) {
throw new RequestException('The request param :attribute not is a timestamp value');
}
if (strlen((string)$value) != 10) {
throw new RequestException('The request param :attribute not is a timestamp value');
}
if (!date('YmdHis', $value)) {
throw new RequestException('The request param :attribute format error', 4001);
}
return $value;
}
/**
* @param string $name
* @param string|null $default
*
* @return string|null
* @throws RequestException
*/
public function datetime(string $name, string $default = NULL): string|null
{
$value = $this->required($name, false);
if ($value === null) {
return $default;
}
$match = '/^\d{4}.*?([1-12]).*([1-31]).*?[0-23].*?[0-59].*?[0-59].*?$/';
$match = preg_match($match, $value, $result);
if (!$match || $result[0] != $value) {
throw new RequestException('The request param :attribute format error', 4001);
}
return $value;
}
2021-04-06 18:54:28 +08:00
/**
* @param string $name
* @param string|null $default
*
* @return string|null
* @throws RequestException
*/
public function date(string $name, string $default = NULL): string|null
{
$value = $this->required($name, false);
if ($value === null) {
return $default;
}
$match = '/^\d{4}.*?([1-12]).*([1-31])$/';
$match = preg_match($match, $value, $result);
if (!$match || $result[0] != $value) {
throw new RequestException('The request param :attribute format error', 4001);
}
return $value;
}
2021-03-23 16:14:05 +08:00
/**
* @param string $name
* @param string|null $default
* @return string|null
* @throws RequestException
*/
public function ip(string $name, string $default = NULL): string|null
{
$value = $this->required($name, false);
if ($value == NULL) {
return $default;
}
$match = preg_match('/^\d{1,3}(\.\d{1,3}){3}$/', $value, $result);
if (!$match || $result[0] != $value) {
throw new RequestException('The request param :attribute format error', 4001);
}
return $value;
}
/**
* @param $name
* @return mixed
*/
#[Pure] public function __get($name): mixed
{
$load = $this->load();
return $load[$name] ?? null;
}
2020-08-31 01:27:08 +08:00
}