Download the PHP package leizongmin/leiphp without Composer

LeiPHP 轻量级的 PHP MVC 框架

Lightweight MVC framework for simplistic PHP apps.

LeiPHP is contained in one single PHP file. It works based on a config file and is perfect for small to medium PHP-powered projects.

Features:

• Supports database interaction
• Support for file uploads
• Debugging tools
• File dependency management
• Template engine
• REST-based routing
• Easy to initialize

此框架仅有一个文件，其中包含了MySQL数据库、上传文件、调试信息、导入依赖文件、模板和REST路由等一系列常用操作。API接口简单，学习成本低，开箱即用，适合用来快速写一些对性能要求不高的程序。

项目文件结构

安装

• 直接下载lei.php文件：wget https://raw.githubusercontent.com/leizongmin/leiphp/master/lei.php
• 通过composer安装：composer require leizongmin/leiphp

初始化

首先新建一个global.inc.php文件，所有程序通过加载该文件来进行配置及初始化：

如果通过composer安装，则载入路径应改为：

在所有php程序中，均可载入global.inc.php文件唉实现初始化LeiPHP：

REST路由

LeiPHP可以根据不同的请求方法来调用相应的处理函数完成请求，比如：

模板渲染

LeiPHP中提供了一个静态类 TPL 来渲染HTML模板：

模板文件存放在template目录内，比如要渲染template/index.html：

模板文件中通过$locals变量来获取模板数据：

以下为模板渲染相关的方法：

• TPL::get($name, $locals) 载入模板文件，若不指定后缀名，会自动加上.html，以常量APP_TPL_ROOT定义的模板目录作为根目录，模板文件实际上为php程序文件，第二个参数为模板中可用的变量，在模板中通过$locals来读取（若无命名冲突也可以直接使用键名），返回渲染后的内容；
• TPL::set_val($name, $value) 设置模板变量；
• TPL::get_val($name) 取模板变量值；
• TPL::render($name, $locals, $layout = '') 自动为$locals加上用APP::set_val()设置的变量，并渲染模板。如果指定了视图模板$layout，则需要在视图模板中通过$body变量来获取模板内容；

操作MySQL数据库

LeiPHP中提供了一个静态类 SQL 来操作MySQL数据库（基于 mysqli 实现）：

• SQL::connect($server = 'localhost:3306', $username = 'root', $password = '',$database = '');连接到数据库，当配置了数据库连接时，leiapp会自动执行此方法来连接到数据库，若你的程序中已经通过mysqli_connect来创建了一个数据库连接，可以不用再执行此方法连接数据库（如果要使用永久连接来提高性能，可以在$server前加字符串p:，如：p:localhost:3306）；
• SQL::find_all($sql) 查询SQL，并返回数组格式的结果，失败返回FALSE；
• SQL::find_one($sql) 查询SQL，仅返回第一条结果，失败返回FALSE；
• SQL::update($sql) 查询SQL，返回受影响的记录数，一般用于执行插入或更新操作；
• SQL::id() 或 SQL::lastId() 返回最后插入的一条记录的ID；
• SQL::errno() 返回最后执行的一条SQL语句的出错号；
• SQL::errmsg() 返回最后执行的一条SQL语句的出错信息；
• SQL::escape($str) 返回安全的SQL字符串；

更简便的数据库操作：

• SQL::find_all($table, $where) 查询所有记录，其中$table是表名，$where是一个条件数组，如：array('id' => 1)；
• SQL::find_one($table, $where) 查询一条记录；
• SQL::update($table, $where, $update) 更新记录并返回受影响的记录数，其中$update是要更新的数据数组，如：array('name' => 'haha')；
• SQL::insert($table, $data) 插入一条记录并返回其ID，其中$data是一个数组，如：array('name' => 'haha', 'age' => 20)；
• SQL::delete($table, $where) 删除记录；

条件格式：

• 普通：array('a' => 1, 'b' => 2) 相当于 a=1 AND b=2；
• 指定连接操作符：array('link' => 'OR', 'a' => 1, 'b' => 2) 相当于 a=1 OR b=2；
• 指定比较操作符：array('a' => array('>' => 2)) 相当于 a>2；
• 同一个字段多个条件：array('a' => array('>' => 2, '<' => 5)) 相当于(a>2 AND a < 5)；
• 指定多个条件的连接操作符：array('a' => array('link' => 'OR', '>' => 2, '<' => 5))相当于 (a>2 OR a < 5)；

上传文件操作

LeiPHP中提供了一个静态类 UPLOAD 来操作上传文件：

• UPLOAD::get($filename) 返回指定名称的上传文件信息，该名称为<form>表单中的<input type="file">中的name值，该返回值为一个数组，包含以下项： name（名称）， type （MIME类型）， size （大小），__tmp_name__ （临时文件名）；
• UPLOAD::move($file, $target) 移动上传的文件到指定位置，第一个参数为UPLOAD::get($filename)的返回值，第二个参数为目标文件名；

调试信息操作

LeiPHP中提供了一个静态类 DEBUG 来操作调试信息，当定义了常量APP_DEBUG时， 会在页面底部输出调试信息：

• DEBUG::put($msg = '', $title = '') 输出调试信息；
• DEBUG::get() 取调试信息；
• DEBUG::clear() 清除所有调试信息；

应用相关操作

LeiPHP中提供了一个静态类 APP 来进行应用相关的操作，及一些公共函数：

• APP::set($name, $value) 设置
• APP::get($name) 获取设置值
• APP::is_set($name) 检查是否有指定设置项
• APP::encrypt_password ($password) 加密密码，返回一个加盐处理后的MD5字符串，如：FF:15855D447208A6AB4BD2CC88D4B91732:83；
• APP::validate_password ($password, $encrypted) 验证密码，第一个参数为待验证的密码，第二个参数为APP::encrypt_password ($password)返回的字符串，返回TRUE或FALSE；
• APP::dump($var) 打印变量结构，一般用于调试；
• APP::show_error($msg) 显示出错信息；
• APP::load($filename) 载入依赖的php文件，若不指定后缀名，会自动加上.php，默认以当前php文件为根目录，若文件名以/开头，则以常量APP_ROOT定义的应用目录作为根目录；几种用途：
  • 载入依赖文件：APP::load('xxx.php')；
  • 使用php文件存储数据，将其读取出来：$data = APP::load('data.php')，php文件内容：``；
  • 使用json文件存储数据，将其读取出来：$data = APP::load('data.json')，json文件内容：[1,2]；
• APP::send_json($data) 返回JSON格式数据；
• APP::send_json_error($msg, $data = array()) 返回JSON格式的出错信息：{"error":"msg"}；
• APP::auth_encode($string, $key, $expirey) 加密账户验证信息，可指定过期时间；
• APP::auth_decode($string, $key) 加密账户验证信息；
• APP::init() 初始化LeiPHP；
• APP::end() 提前退出；

自动路由

LeiPHP中提供了一个静态类 ROUTER 来进行路由相关的操作：

• ROUTER::register($path, $function, $is_preg = false) 注册中间件，其中$path为路径前缀，$function为要执行的函数，如果$is_preg为true表示$path是一个正则表达式;
• ROUTER::run($dir, $path) 执行自动路由。其中$dir是要自动加载的PHP文件所在的目录，以应用目录APP_ROOT中定义的目录为根目录，默认为action目录，$path是当前请求的路径，默认为$_GET['__path__'];

示例

新建应用统一入口文件：index.php：

新建首页处理程序：action/index.php：

需要配置服务器的URL Rewrite，比如将 /app/(.*) 的所有请求转到/app/index.php?__path__=$1

使用PATH_INFO

通过/index.php/xxxx访问。

Apache的配置示例

Nginx的配置示例

SAE的配置示例

当请求 /app/my/action 时，会自动执行文件 /action/my/action.php

如请求 /app/my/action/ ，则自动执行文件 /action/my/action/index.php

License

基于MIT协议发布。