📅  最后修改于: 2023-12-03 15:20:00.809000             🧑  作者: Mango
要使用 scirvere,需要在 PHP 文件中通过 require
或者 include
引入 scirvere 的文件:
require_once 'path/to/scirvere.php';
在引入 scirvere 后,需要创建一个 scirvere 实例。scirvere 的构造函数需要传入两个参数,第一个参数是文件路径,第二个参数是 scirvere 的选项配置:
use Scirvere\Scirvere;
$scirvere = new Scirvere($filename, $options);
其中,$filename
是需要检查和修改的文件的路径;$options
是 scirvere 的选项配置,可以不传,使用默认值。
创建 scirvere 实例后,就可以开始对文件进行操作。常用的操作有:
使用 checkFormat()
方法可以检查文件格式是否规范:
$checkResult = $scirvere->checkFormat();
if ($checkResult->isSuccess()) {
echo "文件格式规范";
} else {
echo "检查到以下问题:\n";
echo $checkResult->getErrorsMarkdown();
}
使用 format()
方法可以格式化文件:
$formattedCode = $scirvere->format();
echo $formattedCode;
使用 autoFix()
方法可以自动修改文件中的格式问题:
$fixedCode = $scirvere->autoFix();
file_put_contents($filename, $fixedCode);
以下是一个使用 scirvere 检查和修改 PHP 文件的完整例子:
use Scirvere\Scirvere;
$filename = 'path/to/myfile.php';
// 创建 scirvere 实例
$scirvere = new Scirvere($filename);
// 检查格式
$checkResult = $scirvere->checkFormat();
if (!$checkResult->isSuccess()) {
// 格式不规范,输出错误信息
echo "文件格式不规范:\n";
echo $checkResult->getErrorsMarkdown();
// 自动修复格式问题
$fixedCode = $scirvere->autoFix();
// 写入修复后的代码
file_put_contents($filename, $fixedCode);
echo "文件格式已修复\n";
} else {
echo "文件格式规范\n";
}
返回markdown格式:
# 如何在 PHP 文件中使用 scirvere
## 1. 引入 scirvere
要使用 scirvere,需要在 PHP 文件中通过 `require` 或者 `include` 引入 scirvere 的文件:
```php
require_once 'path/to/scirvere.php';
在引入 scirvere 后,需要创建一个 scirvere 实例。scirvere 的构造函数需要传入两个参数,第一个参数是文件路径,第二个参数是 scirvere 的选项配置:
use Scirvere\Scirvere;
$scirvere = new Scirvere($filename, $options);
其中,$filename
是需要检查和修改的文件的路径;$options
是 scirvere 的选项配置,可以不传,使用默认值。
创建 scirvere 实例后,就可以开始对文件进行操作。常用的操作有:
使用 checkFormat()
方法可以检查文件格式是否规范:
$checkResult = $scirvere->checkFormat();
if ($checkResult->isSuccess()) {
echo "文件格式规范";
} else {
echo "检查到以下问题:\\n";
echo $checkResult->getErrorsMarkdown();
}
使用 format()
方法可以格式化文件:
$formattedCode = $scirvere->format();
echo $formattedCode;
使用 autoFix()
方法可以自动修改文件中的格式问题:
$fixedCode = $scirvere->autoFix();
file_put_contents($filename, $fixedCode);
以下是一个使用 scirvere 检查和修改 PHP 文件的完整例子:
use Scirvere\Scirvere;
$filename = 'path/to/myfile.php';
// 创建 scirvere 实例
$scirvere = new Scirvere($filename);
// 检查格式
$checkResult = $scirvere->checkFormat();
if (!$checkResult->isSuccess()) {
// 格式不规范,输出错误信息
echo "文件格式不规范:\\n";
echo $checkResult->getErrorsMarkdown();
// 自动修复格式问题
$fixedCode = $scirvere->autoFix();
// 写入修复后的代码
file_put_contents($filename, $fixedCode);
echo "文件格式已修复\\n";
} else {
echo "文件格式规范\\n";
}
注意,返回的markdown格式中,\\n
代表换行。