artimman / dbmframework
DbM 框架 PHP MVC 简单 CMS
Requires
- php: ^7.4 || ^8.0
- phpmailer/phpmailer: ^6.6
Requires (Dev)
- phpstan/phpstan: ^1.10
- phpunit/phpunit: ^9.6
README
DbM 框架 PHP MVC 简单 CMS, 版本 2
由 PHP 7.4 创建的应用程序,v2.3.7 版本已在 PHP 8.3 中测试
版权所有 © Design by Malina (DbM)
网站: www.dbm.org.pl
DbM 框架简单 CMS
DbM 框架 PHP MVC 简单 CMS 允许您创建简单且美观的网站,如名片、着陆页等,其中内容存储在文本文件中,从而消除了使用数据库的需求。尽管框架易于使用,但为了编辑网站内容,建议您了解 HTML 和 CSS。
框架还提供了更高级的选项,例如创建需要数据库的应用程序,这允许您构建专业的博客或更复杂的系统,以满足个人需求。示例应用程序展示了基于文本的简单网站和基于数据库的更高级 CMS 系统。因此,DbM 框架可用于各种项目,从简单网站到更复杂的应用程序。
理念
DbM 框架是一个轻量级、快速且功能丰富的基于 MVC 架构模式的框架。MVC 将应用程序逻辑(模型)与表示(视图)和请求处理(控制器)分离,从而极大地简化了代码的开发和维护。框架专注于纯 PHP,这使用户具有灵活性和几乎无限的应用程序定制能力。与更复杂的框架相比,DbM 保持简单直观,这允许快速部署解决方案,而无需复杂的配置。
先决条件
要开始在框架中工作,您必须安装以下组件:PHP、MySQL、Apache,或者使用 XAMPP 软件包,或者使用 Docker 容器。对于 Docker,您可以使用 PHP、MySQL 和 Apache 的预配置镜像来配置环境。
结构
- application (应用程序核心和框架核心)
- classes
- interfaces
- libraries
- data (文件和数据,目录需要写入权限)
- attachment
- content
- mailer
- txt
- public (公共目录和文件)
- src (应用程序逻辑:控制器、模型、服务和其他)
- Config
- Controller
- Model
- Service
- templates (视图:模板)
- tests (测试)
- tools (工具)
- translations (翻译)
- var / log / mailer 和 var / cache (自动创建,需要写入权限)
- vendor (为 Composer 预留)
手动安装和配置
要手动安装 DbM 框架应用程序,请按照以下步骤操作
- 在远程服务器域名中 - 需要将域名指向
/public/
目录地址,并设置正确的 RewriteBase 参数值。在 /public/ 目录中的 .htaccess 文件中设置 RewriteBase /(主目录不使用 .htaccess)。根据服务器配置,运行应用程序可能需要禁用 PHP 配置中的 open_basedir 目录结构中文件列表的限制。 - 如果您在本地服务器(localhost)或域名目录中安装应用程序,创建一个目录,例如
dbmframework
(主目录),然后从 _Documents 目录复制 .htaccess 文件到主目录,并设置正确的 RewriteBase 参数值。在主目录中的 .htaccess 文件设置 RewriteBase /dbmframework/,在 /public/ 目录中的 .htaccess 文件设置 RewriteBase /dbmframework/public/。 - 进入主目录并配置 .env.dist 配置文件。在 APP_URL 中设置正确的目录路径(域名,目录)。将应用程序设置为生产环境(production)并补充其他配置参数。可以省略 'Mailer settings' 配置,只需设置参数 MAIL_SMTP=false。请确保在 APP_EMAIL 中提供正确的电子邮件地址。完成应用程序配置后,将
.env.dist
文件重命名为.env
。 - 在服务器上导入数据库并根据要求进行配置。
应用程序具有发送电子邮件的功能。该机制需要使用 PHPMailer 库,要加载库,请使用 Composer 管理包,或者可以将 _Documents/Composer/ 目录以及 composer.lock 文件复制到主目录(应通过 Composer 加载库,不建议复制 vendor 目录)。/vendor/ 目录是 Composer 依赖管理器的专用目录。
高级配置选项位于 ConstantConfig.php 文件中。如果不需要更改,请保持默认设置。
手动安装使我们的框架独立于其他工具,并配备自带的自动加载功能。执行 composer install
命令将创建 Compose 的自动加载并安装选定的包,例如用于发送电子邮件的包以及开发包。执行该命令后,框架将与 Composer 一起工作。
使用 Composer 安装
如果您希望使用 Composer 进行安装或项目需要安装包,请按照以下步骤操作
- 克隆仓库
git clone https://github.com/artimman/dbmframework.git
- 进入项目目录(您可以更改目录名称)
cd dbmframework
- 运行依赖关系安装
composer install
这些步骤将创建 Compose 的自动加载,并下载并安装所有所需的最新版本包。
FlatFile .txt 数据(文本文件中的数据)
data/content/
文本文件中的数据,为文件设置写入权限data/mailer/
发送电子邮件的模板
数据库(应用程序运行不需要数据库)
- _Documents/Database/dbm_cms.sql
如果您想使用数据库,请将其导入服务器并在配置文件中配置连接。
路由机制
位于 /application/classes/Router.php 文件中的类被框架用于创建路由器对象,对象允许定义路由并使用方法启动动作。对于基本路由模式,用户不直接使用 Router 类,而是使用类中的 addRoute() 方法添加更多项目页面。
要添加路由地址,请进入 /aplicattion/routes.php
文件并使用路由器方法。
$router->addRoute('address', [Controller, 'method']);
此方法允许以简化的方式添加路由地址,使用以下参数:页面名称(地址)、控制器和方法。在地址中,名称可以包含参数:{#} - 固定,{id} - 可变,例如对于链接 page-title.key.5.html,地址为 /{#}.key.{id}.html
。如果需要扩展路由模式,可以在 Router 类的 buildRouteUri() -> create pattern 方法中添加这些模式。
模板引擎
DbM Framework 默认使用简单的模板引擎,也可以替换为更复杂的引擎,例如 Twig。Twig 使用示例位于 /Documents/Script/BaseController_for_Twig.php。查看 templates
目录中的文件,您将了解如何使用推荐默认模板系统。
库
使用了以下包
注册模块的邮件发送器(可选)
- PHPMailer - 用于发送电子邮件的库。
注意!免费许可证要求在可见位置(例如页脚)放置作者网站的链接。删除链接违反许可证。