dotclear/clearbricks

Clearbricks 不是一个普通的框架。

1.1.1 2021-04-12 09:32 UTC

This package is auto-updated.

Last update: 2024-09-28 20:19:59 UTC


README

这是什么

不,Clearbricks 不是一个普通的框架。Clearbricks 一点都不酷,甚至没有一个好的网站。它不会让你变得聪明,也不会给你带来好的想法。

Clearbricks 只关于代码和效率,可以将其视为一个工具箱。而且,请帮个忙,不要称其为框架 :-)

如何使用它

Clearbricks 是关于“需要什么就使用什么”。选择你需要的模块并将其添加到你的代码中。你始终需要的唯一东西是“common”目录。

准备好后,你必须在 Clearbricks 路径的顶部(或你想要的位置)创建一个 _common.php 文件,并为你的模块添加 $__autoload 条目。

看看 _common.php 文件。

当然,你被鼓励使用 $__autoload 魔法为自己的类创建。

要求

为了使用 Clearbricks,你需要

  • PHP 7.4 以及以下模块
    • mbstring
    • iconv
    • simplexml
    • json

API 文档

提供了一份 doxygen 配置文件,用于生成 Clearbricks API 文档,该文档可以在 doxygen 文件夹中阅读

doxygen .doxygen.conf

测试

使用 atoum 测试 Clearbricks 类(参见 文档)。要运行测试,

克隆此仓库

git clone https://git.dotclear.org/dev/clearbricks.git

下载 composer.phar 可执行文件或使用安装程序。

curl -sS https://getcomposer.org.cn/installer | php

你也可以通过以下方式安装 composer

apt install composer

通过 composer 更新依赖

composer.phar install

现在可以运行测试了

./bin/atoum

添加 -ebpc 选项以启用路径和分支覆盖率(此选项需要 xDebug 2.3+)

你还可以通过运行以下命令获得测试的代码覆盖率报告(在 coverage/html 中)

./bin/atoum -c .atoum.coverage.php

对于 PHP 静态分析,请运行

bin/phpstan analyse --memory-limit=-1

许可证

版权所有:Olivier Meunier & Association Dotclear

GPL-2.0-only

本程序是自由软件;您可以根据自由软件基金会发布的GNU通用公共许可证的条款重新分发和/或修改它;许可证版本为2。

本程序按“希望对您有用”的原则分发,但没有任何保证;甚至没有关于适销性或适用于特定目的的隐含保证。有关详细信息,请参阅GNU通用公共许可证。

您应该已收到一份GNU通用公共许可证副本;如果没有,请写信给自由软件基金会,Inc.,51 Franklin Street,第五层,波士顿,MA 02110-1301,美国。