README

这个小型仓库用于维护我经常重用的PHP函数，例如正则表达式函数。

用法

它们可以在任何代码中这样使用

var_dump( format2regex( 'uid=%s,ou=people,dc=example,dc=com' ) );
// string(43) "/uid\=(.*?),ou\=people,dc\=example,dc\=com/"

通过Composer安装

这个仓库旨在包含在其他项目中，因此只需运行此命令即可引入它

composer require macwinnie/phphelpers

由于这个工具也经过了测试，请在生产阶段运行 composer install --no-dev，以确保不安装和自动加载任何不必要的工具到您的生产环境中！

测试

所有功能都是按照BDD（行为驱动开发）原则开发的。因此，使用 Behat 编写Gherkin测试场景并测试它们——所有这些都在 /tests 文件夹中完成。

要运行测试，您需要完整的Composer安装以及所有依赖项，包括生产环境和开发环境。例如，使用 devopsansiblede/apache:latest 运行以下所有内容

docker pull devopsansiblede/apache
docker run -p80:80 -d --name phphelpers -v $(pwd):/var/www/html devopsansiblede/apache
docker exec -it -u www-data phphelpers composer install
docker exec -it -u www-data phphelpers vendor/bin/behat

文档

当前主分支的文档状态

此仓库中的函数使用DocBlock样式进行文档记录。为了可视化文档，项目使用 phpDocumentor 在 /docs 目录中生成可查看的网站。

要创建最新的文档，只需运行以下Docker命令

docker pull phpdoc/phpdoc:3
rm -rf docs
docker run --rm -v $(pwd):/data phpdoc/phpdoc:3 --setting=graphs.enabled=true -d src -t docs --sourcecode --title=PHP-Helpers --no-interaction
cat <<EOF >> docs/css/base.css

code.prettyprint {
    background: var(--primary-color-lighten);
    border: 1px solid var(--code-border-color);
    border-radius: var(--border-radius-base-size);
    padding: 0.1em 0.4em;
    margin: 0.1em 0.2em;
    font-size: 0.9em !important;
}
pre.prettyprint {
    font-size: 0.8em !important;
}
EOF

注意： Docker中的phpDocumentor标签 latest 某种程度上非常旧——希望使用如上面的 :3 这样的版本标签。

最后的依赖项更新和测试

2023-01-29 23:22:39

许可证

CC BY-SA 4.0

macwinnie / phphelpers

维护者

详细信息

README

用法

通过Composer安装

测试

文档

最后的依赖项更新和测试

许可证