kpr/parking-system-sdk

Parking System SDK.

Maintainers

Details

gitee.com/kupurui_php/ParkingSystemSdk.git

Homepage

Installs: 0

Dependents: 0

Suggesters: 0

Security: 0

dev-master 2020-09-25 08:42 UTC

Requires

  • php: >=5.6.0

MIT a176a2e5456edc595d33eb15c0ea4cdc45757c3d

  • Kpr <service.woop@kupurui.com>

parking

This package is not auto-updated.

Last update: 2025-08-10 08:00:23 UTC

README

介绍

聚合一个能支持目前流行的各个车场硬件厂商SDK。该SDK可以根据不同的厂家、版本号进行相对应的SDK调用

开发规范

1、所有的硬件厂家对应SDK库文件均放在lib目录下，并都必须继承 interfaces\BaseInterface 接口
2、BaseInterface接口文件中的属性中以 //* 开头的都必须要在继承类中进行重写
3、一个方法中只允许出现一次对外路由请求（嵌套调用除外）
4、继承类中的所有请求路由必须放在当前类的allRouteList属性中，其中key为使用此路由的方法名,value为路由地址
5、允许外部设置allRouteList中的key对应的值
6、所有路由地址获取都应该通过this->getAllRouteList()方法获取，不应该直接读取allRouteList中的值
7、如果调用方法中有对外请求，且调用者传入了uri则应该优先使用外部传入的uri进行访问
8、所有的方法返回格式统一为数组 ['code'=>'int 状态值:0正常 大于0则据不同的错误类型返回对应的code值', 'msg'=>'string 接口调用描述，如果产生错误则是错误描述','data'=>'array 此值应该根据接口文件中规定的对应方法注释@return 后面的描述来返回，如果注释中没有描述返回值则此处应为一个空数组']
9、所有的公用的工具方法都应该写在KprTool类中，并以静态方法呈现
10、所有的返回码CODE都应该在CodeList类中进行获取并返回，如果需要新添CODE码，则应该在CodeList文件中先在$codeList属性中添加code及对应的描述，然后在CodeList类中添加一个静态属性，属性值为code例如我添加 0为正常  则在$codeList[0]='正常'; 然后在添加 	public static $SUCCESS = 0;
11、编写硬件SDK文件时文件名的规则是 厂家标识_版本号（版本号中的小数点替换为_） 例如海康 v1.0的SDK则文件名应该为  hikvision_v1_0.php
12、当文件编写好后还需要在config.php文件中注册，注册规则是 最外层key是厂家代码，对应值是一个数组，数组中的值也是数组，每个字数组都代表一个版本以及对应的SDK文件名称，注意所有的SDK文件都必须在以Kpr\lib的目录下
13、当每次对此SDK进行了修改都应该更新本文档的使用说明文档
14、使用说明文档中编写规则：每个SDK文件一个模块，模块下面详细介绍每个字段属性、方法、方法参数、方法返回值等

使用说明文档