liquidweb / htaccess-validator
检查并验证 Apache2 Htaccess 文件
v0.2.0
2021-03-08 22:45 UTC
Requires
- php: ^5.6||^7.0||^8.0
- liquidweb/htaccess-validator-shell: ^0.1
Requires (Dev)
This package is auto-updated.
Last update: 2024-09-09 07:15:14 UTC
README
这是一个用于 Liquid Web Htaccess Validator 脚本的 Composer 包包装器,它使 PHP 应用程序能够轻松地验证 Htaccess 文件。
安装
安装此包最简单的方式是通过 Composer
$ composer require liquidweb/htaccess-validator
由于该包使用 Apache2 本身进行验证,因此必须在您的环境中可用。Liquid Web 知识库提供了在大多数流行平台上安装 Apache 的说明。
使用方法
使用验证器主要有两种方式
- 作为独立的命令行工具
- 作为 PHP 库(需要
proc_open
可用)
通过命令行界面(CLI)验证 Apache2 配置
bin/validate-htaccess
脚本接受要验证的配置文件
$ bin/validate-htaccess /path/to/some/file.conf
如果检测到验证错误,脚本将返回非零退出码。单个代码在脚本头部有文档说明。
在 PHP 脚本中验证 Apache2 配置
LiquidWeb\HtaccessValidator\Validator
类作为 bin/validate-htaccess
脚本的包装器,允许应用程序以编程方式验证 Apache2 配置。
创建类的实例有两种方式
-
将正在验证的文件的完整系统路径传递给类构造函数
use LiquidWeb\HtaccessValidator\Validator; $validator = new Validator($file);
-
将配置直接传递给
::createFromString()
工厂方法use LiquidWeb\HtaccessValidator\Validator; $validator = Validator::createFromString('Options +FollowSymLinks');
一旦您有了验证器实例,您可以通过两种方式来验证它
# Throws a LiquidWeb\HtaccessValidator\Exceptions\ValidationException upon failure. $validator->validate(); # Return a boolean. $validator->isValid();
修改验证器 shell 脚本的路径
默认情况下,库假设 validate-htaccess
shell 脚本位于 vendor/bin/
。
如果您使用的是非标准的 Composer 配置,您可以通过设置 HTACCESS_VALIDATOR_SCRIPT
环境变量来显式指定路径,无论是在环境配置中还是在行内设置
# Absolute system path to the shell script. putenv('HTACCESS_VALIDATOR_SCRIPT=/some/path/to/vendor/bin/htaccess-validator'); # Will now use the Htaccess Validator script specified above. $validator = (new Validator($file))->validate();