raymond/baselib

BaseLib 基础库有常用的函数和类库。参数验证的规则和基类。

Maintainers

Details

gitee.com/vteipjuq/base-lib.git

Installs: 4

Dependents: 1

Suggesters: 0

Security: 0

Type:project

v1.3.3 2020-10-21 06:54 UTC

Requires

mit 589ee0b23be1c46c3bda7cae43dc5aed47e0e8a2

  • 尹学蛟 <2548146224.woop@qq.com>

This package is not auto-updated.

Last update: 2025-05-13 06:23:33 UTC

README

介绍

BaseLib 基础库常用的函数和类库,40个常用的函数。参数验证和异常抛出基础函数。

本插件只支持laravel

安装教程


安装

[//]: # (我是注释)


添加指定包 composer require raymond/baselib 

更新指定包 composer update raymond/baselib

移除指定的包 composer remove raymond/baselib

或删除vendor目录中的raymond

添加测式包：composer require "raymond/baselib:dev-master" -vvv


发布配置文件到config目录下面(可选):

php artisan vendor:publish


config/app.php中加入如下代码：

'providers' => [
	Raymond\BaseLib\BaseLibServiceProvider::class,
]

'aliases' => [
	'BaseLib' => Raymond\BaseLib\BaseLib::class,
]


控制器中引用:

use BaseLib;

<br/>

使用说明

常用函数

调用方法：类名::函数名 ，也可以BaseLib::common()->getlasttime()这种方法调用也可以


例：BaseLib::common()->getlasttime('2020-10-09 09:14');

<br/>

计算时间: BaseLib::get_last_time(2020-10-09 09:14);

名称是否必须备注
stringtrue日期字符串（例：2020-10-09 09:14）

<br/>

手机号码验证: BaseLib::is_phone(15610032203);

名称是否必须备注
stringtrue手机号（例：15610032203）

<br/>

手机号隐藏中间4位: BaseLib::substr_mobile(15610032203)

名称是否必须备注
stringtrue手机号（例：15610032203）

<br/>

curl get 请求: BaseLib::http_get(url);

名称是否必须备注
urltrueurl（例：http://www.baidu.com）

<br/>

curl post 请求: BaseLib::http_post(url,data);

名称是否必须备注
urltrueurl（例：http://www.baidu.com）
datatrue数组参数['id'=>1,'name'=>'张飞']

<br/>

对emoji表情转义: BaseLib::emoji_encode();

名称是否必须备注
stringtrue表情字符串

<br/>

对emoji表情转反义: BaseLib::emoji_decode();

名称是否必须备注
stringtrue表情字符串

<br/>

判断字符串是否全是英文: BaseLib::is_english();

名称是否必须备注
stringtrue字符串

<br/>

字符串截取并且超出显示省略号: BaseLib::subtext();

名称是否必须备注
texttrue字符串
lengthfalse字符串长度

<br/>

字符串截取: BaseLib::get_str_truncate();

名称是否必须备注
texttrue字符串
lengthfalse字符串长度
etcfalse要替换的字符串

<br/>

获取随机字符串: BaseLib::random();

名称是否必须备注
lengthfalse字符串长度
typefalse类型
convertfalse转换大小写 1大写 0小写

<br/>

判断数组类型参数是否含有空元素值: BaseLib::is_arraynull();

名称是否必须备注
arrtrue数组

<br/>

utf-8转gbk: BaseLib::gbk();

名称是否必须备注
strtrue字符串

<br/>

gbk转utf8: BaseLib::utf8();

名称是否必须备注
strtrue字符串

<br/>

正则验证邮箱地址: BaseLib::match_email()

名称是否必须备注
emailtrue邮箱

<br/>

查询字符是否存在于某字符串: BaseLib::str_exists()

名称是否必须备注
haystacktrue字符串
needletrue要查找的字符

<br/>

检测输入中是否含有特殊字符: BaseLib::is_badword()

名称是否必须备注
stringtrue字符串

<br/>

处理json字符中的特殊字符: BaseLib::get_json_to_arr()

名称是否必须备注
stringtruejson字符串

<br/>

非法字符过滤函数: BaseLib::has_unsafeword()

名称是否必须备注
stringtrue字符串

<br/>

判断是否是微信浏览器还是企业微信浏览器: BaseLib::is_wxbrowser()

名称是否必须备注
无无无

<br/>

判断是否是企业微信浏览器: BaseLib::is_wx_company()

名称是否必须备注
无无无

<br/>

判断两个字符串是否相等: BaseLib::string_equal()

名称是否必须备注
str1true字符串
str2true字符串

<br/>

随机验证码: BaseLib::get_random()

名称是否必须备注
lengthfalse生成随机数长度，默认为6

<br/>

压缩文件: BaseLib::zip()

名称是否必须备注
filestrue待压缩文件
filePathtrue输出文件路径 【绝对文件地址】

<br/>

zip解压方法: BaseLib::unzip()

名称是否必须备注
filePathtrue压缩包所在地址 【绝对文件地址】
pathtrue解压路径 【绝对文件目录路径】

<br/>

二维数组去重: BaseLib::array_unset_repeat()

名称是否必须备注
arrtrue数组
keytrue判断的键值

<br/>

二维数组合并重复项: BaseLib::array_restruct()

名称是否必须备注
arrtrue数组
keytrue判断的键值

<br/>

判断字符串是否在数组中: BaseLib::for_in_array()

名称是否必须备注
strtrue判定的字符串
arrtrue数组

<br/>

获取客户端IP: BaseLib::get_ip()

名称是否必须备注
无无无

<br/>

自动生成密码: BaseLib::generate_password()

名称是否必须备注
lengthtrue密码长度
strengthtrue1:加入大写字母BDGHJLMNPQRSTVWXZ，2：加入AEUY，4：加入数字，8：加入特殊字符'@#$%'

<br/>

检查密码长度是否符合规定: BaseLib::is_password()

名称是否必须备注
passwordtrue密码

<br/>

人民币数字小写转大写: BaseLib::rmb_format()

名称是否必须备注
moneytrue人民币数值
int_unitfalse币种单位，默认"元"，有的需求可能为"圆"
is_roundfalse是否对小数进行四舍五入
is_extra_zerofalse是否对整数部分以0结尾，小数存在的数字附加0,比如1960.30

<br/>

返回格式化数字: BaseLib::number_format_plus()

名称是否必须备注
numbertrue待格式化数字
decimalsfalse保留小数位数，默认2位
dec_pointfalse整数和小数分隔符号
thousands_sepfalse整数部分每三位数读分隔符号

<br/>

转换时间戳为常用的日期格式: BaseLib::trans_time()

名称是否必须备注
timestamptrue时间戳

<br/>

银行卡号格式检测: BaseLib::chk_card()

名称是否必须备注
cardtrue卡号

<br/>

根据身份证号计算性别: BaseLib::get_gender()

名称是否必须备注
idtrue身份证号

<br/>

检测姓名中文格式: BaseLib::chk_chinese()

名称是否必须备注
nametrue字符串

<br/>

将数组转换成xml: BaseLib::arr_xml()

名称是否必须备注
arrtrue数组

<br/>

将xml转为array: BaseLib::xml_arr()

名称是否必须备注
xmltruexml字符串

<br/>

根据过期时间判断剩余的天数: BaseLib::check_remaining_days()

名称是否必须备注
expire_timetrue时间戳

<br/>

数组编码转换: BaseLib::arr_iconv()

名称是否必须备注
arrtrue待处理的数组
in_charsettrue输入编码
out_charsettrue输出编码

<br/>

获取文件扩展名（后缀）: BaseLib::get_extension()

名称是否必须备注
filenametrue文件名

<br/>

列出目录下的文件名: BaseLib::listDirFiles()

名称是否必须备注
DirPathtrue目录

<br/>

检查目标文件夹是否存在，如果不存在则自动创建该目录: BaseLib::make_dir()

名称是否必须备注
foldertrue目录路径。不能使用相对于网站根目录的URL

<br/>

滤器laravel request中请求参数的数组中的多余参数: BaseLib::params_filter()

名称是否必须备注
requesttrue数组
keyfalse要删除的数组下标（可以不传）例：['id','name']

<br/>

生成海报: BaseLib::create_poster()
名称是否必须备注
configtrue海报配置信息，类型为数组
filenametrue海报保存路径

config

名称是否必须备注
textfalse文字，类型为数组
imagefalse图片，类型为数组
backgroundtrue背景图，类型为数组

text

名称是否必须备注
texttrue文字
leftfalse左边距
topfalse上边距
fontSizefalse字号
fontColorfalse字体颜色
fontPathfalse字体路径

image

名称是否必须备注
urltrue图地址
widthfalse宽度
heightfalse高度
leftfalse左边距
rightfalse右边距
topfalse上边距
bottomfalse下边距
opacityfalse透明度
radiusfalse圆角

background

名称是否必须备注
urltrue背景图地址
radiusfalse圆角
 
	$config = [
		//文字
		'text'=>[
			['text'=>'昵称','left'=>182,'top'=>105,'fontSize'=>18,'fontColor'=>'255,0,0', 'angle'=>0,],
			['text'=>'张冰冰','left'=>182,'top'=>205,'fontSize'=>18,'fontColor'=>'255,0,0','angle'=>0,]
		],
		//图片
		'image'=> [
			['url'     => 'http://local.l56.cn/img/qrcode.png','stream'  => 0,'left'    => 380,'top'     => -380,'right'   => 0,'bottom'  => 0,'width'   => 260,'height'  => 260,'opacity' => 100,'radius' => 100,],
			['url'=>'http://local.l56.cn/img/mendian.jpg','left'=>320,'top'=>70,'right'=>0,'stream'=>0,'bottom'=>0,'width'=>155,'height'=>155,'opacity'=>100,],
		],
		//背景图
		'background' => ['bg'=>'http://local.l56.cn/img/bg.png']
	];

	$filename =dirname(dirname(dirname(dirname(__FILE__)))).'/public/img/'. time() . '.png';

	BaseLib::create_poster($config,$filename);

<br/>

api返回信息
默认的返回结构

正确返回 BaseLib::success();

名称是否必须备注
datatrue数组，例：['info'=>'','msg'=>'','data'=>'']，info和msg可以不传，默认：使用的config/errorInfo.php中的public_succ。修改的话用msg传public_add_fail。info中传提示信息
 
$data=['id'=>1,'name'=>'张飞'];
例1：BaseLib::success([data'=>$data]);
例2：BaseLib::success(['msg'=>'public_add_fail','info'=>'成功',data'=>$data]);

<br/>

错误返回 BaseLib::error();

名称是否必须备注
datatrue数组，例：['info'=>'','msg'=>'','data'=>'']，info和msg可以不传，默认：使用的config/errorInfo.php中的public_succ。修改的话用msg传public_add_fail。info中传提示信息
 
$data=['id'=>1,'name'=>'张飞'];
例1：BaseLib::error([data'=>$data]);
例2：BaseLib::error(['msg'=>'public_add_fail','info'=>'错误',data'=>$data]);

<br/>

自定义的的返回结构
成功 BaseLib::return_msg();

失败 BaseLib::return_err();

1.可以在配置文件中修改返回结构体return_succ,return_err
2.参数根据配置中的结构体传值，必须是数组

<br/>

调用方法：类名::函数名 ，也可以BaseLib::result()->success()这种方法调用也可以


例：BaseLib::result()->error();BaseLib::result()->return_msg();

<br/>

参数验证

BaseLib::goCheck();

名称是否必须备注
ruletrue验证规则
messagetrue错误信息
 

成功：['state'=>'ok','info'=>'']
失败：['state'=>'err','info'=>'错误信息']

<br/>

BaseLib::params->goCheck()参数同上

<br/>

异常抛出

BaseLib::handler();

名称是否必须备注
requesttruerender函数中的参数
exceptiontruerender函数中的参数
 

app/Exceptions/Handler.php中的render函数

<br/>

BaseLib::exceptions->handler()参数同上

<br/>

jwt-token

BaseLib::handler();

名称是否必须备注
requesttruerender函数中的参数
exceptiontruerender函数中的参数
 

app/Exceptions/Handler.php中的render函数

<br/>

BaseLib::exceptions->handler()参数同上