Skip to content

Commit 1d6ebb5

Browse files
guanguansguanguans
committed
Update README.md
1 parent f233159 commit 1d6ebb5

File tree

2 files changed

+88
-70
lines changed

2 files changed

+88
-70
lines changed

‎README-EN.md

Lines changed: 44 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -495,28 +495,37 @@ app('soar'); // 获取 Soar 实例
495495

496496
/**
497497
* Soar 门面.
498+
*
499+
* @method static \self create(array $options = [], null|string $soarPath = null)
500+
* @method static string help()
501+
* @method static string version()
502+
* @method static \self clone()
503+
* @method static array arrayScores(array|string $sqls, int $depth = 512, int $options = 0)
504+
* @method static string jsonScores(array|string $sqls)
505+
* @method static string htmlScores(array|string $sqls)
506+
* @method static string markdownScores(array|string $sqls)
507+
* @method static string scores(array|string $sqls)
508+
* @method static \self addOptions(array $options)
509+
* @method static \self addOption(string $key, void $value)
510+
* @method static \self removeOptions(array $keys)
511+
* @method static \self removeOption(string $key)
512+
* @method static \self onlyOptions(array $keys = ['-test-dsn','-online-dsn'])
513+
* @method static \self onlyOption(string $key)
514+
* @method static \self setOptions(array $options)
515+
* @method static \self setOption(string $key, void $value)
516+
* @method static \self mergeOptions(array $options)
517+
* @method static \self mergeOption(string $key, void $value)
518+
* @method static array getOptions()
519+
* @method static void getOption(string $key, void $default = null)
520+
* @method static string getSerializedNormalizedOptions()
521+
* @method static array getNormalizedOptions()
522+
* @method static string getSoarPath()
523+
* @method static \self setSoarPath(string $soarPath)
524+
* @method static void dd(void ...$args)
525+
* @method static \self dump(void ...$args)
526+
* @method static string run(array|string $withOptions = [], null|callable $processTapper = null, null|callable $callback = null)
527+
* @method static \Guanguans\LaravelSoar\Soar|\Illuminate\Support\HigherOrderTapProxy tap(null|callable $callback = null)
498528
*
499-
* @method static string score(string $sql) // SQL 评分
500-
* @method static array arrayScore(string $sql) // SQL 数组格式评分
501-
* @method static string jsonScore(string $sql) // SQL json 格式评分
502-
* @method static string htmlScore(string $sql) // SQL html 格式评分
503-
* @method static string mdScore(string $sql) // SQL markdown 格式评分
504-
* @method static string explain(string $sql) // explain 解读信息
505-
* @method static string mdExplain(string $sql) // markdown 格式 explain 解读信息
506-
* @method static string htmlExplain(string $sql) // html 格式 explain 解读信息
507-
* @method static null|string syntaxCheck(string $sql) // 语法检查
508-
* @method static string fingerPrint(string $sql) // SQL 指纹
509-
* @method static string pretty(string $sql) // 格式化 SQL
510-
* @method static string md2html(string $sql) // markdown 转 html
511-
* @method static string help() // Soar 帮助
512-
* @method static null|string exec(string $command) // 执行任意 Soar 命令
513-
* @method static string getSoarPath() // 获取 Soar 路径
514-
* @method static array getOptions() // 获取 Soar 配置选项
515-
* @method static Soar setSoarPath(string $soarPath) // 设置 Soar 路径
516-
* @method static Soar setOption(string $key, $value) // 设置 Soar 配置选项
517-
* @method static Soar setOptions(array $options) // 批量设置 Soar 配置选项
518-
*
519-
* @see \Guanguans\SoarPHP\Soar
520529
* @see \Guanguans\LaravelSoar\Soar
521530
*/
522531
class Soar{}
@@ -532,22 +541,22 @@ class Soar{}
532541
namespace Illuminate\Database\Eloquent {
533542
/**
534543
* @method string toRawSql()
535-
* @method void dumpRawSql()
536-
* @method void ddRawSql()
537-
* @method array toSoarArrayScore()
538-
* @method void dumpSoarArrayScore()
539-
* @method void ddSoarArrayScore()
540-
* @method string toSoarJsonScore()
541-
* @method void dumpSoarJsonScore()
542-
* @method void ddSoarJsonScore()
543-
* @method string toSoarHtmlScore()
544-
* @method void echoSoarHtmlScore()
545-
* @method void exitSoarHtmlScore()
546-
* @method string toSoarHtmlExplain()
547-
* @method void echoSoarHtmlExplain()
548-
* @method void exitSoarHtmlExplain()
544+
* @method void dumpRawSql()
545+
* @method void ddRawSql()
546+
* @method array toSoarArrayScores()
547+
* @method void dumpSoarArrayScores()
548+
* @method void ddSoarArrayScores()
549+
* @method string toSoarJsonScores()
550+
* @method void dumpSoarJsonScores()
551+
* @method void ddSoarJsonScores()
552+
* @method string toSoarHtmlScores()
553+
* @method void echoSoarHtmlScores()
554+
* @method void exitSoarHtmlScores()
555+
*
556+
* @mixin \Illuminate\Database\Query\Builder
549557
*
550558
* @see \Guanguans\LaravelSoar\Macros\QueryBuilderMacro
559+
* @see \Illuminate\Database\Eloquent\Builder
551560
*/
552561
class Builder
553562
{

‎README.md

Lines changed: 44 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -495,28 +495,37 @@ app('soar'); // 获取 Soar 实例
495495

496496
/**
497497
* Soar 门面.
498+
*
499+
* @method static \self create(array $options = [], null|string $soarPath = null)
500+
* @method static string help()
501+
* @method static string version()
502+
* @method static \self clone()
503+
* @method static array arrayScores(array|string $sqls, int $depth = 512, int $options = 0)
504+
* @method static string jsonScores(array|string $sqls)
505+
* @method static string htmlScores(array|string $sqls)
506+
* @method static string markdownScores(array|string $sqls)
507+
* @method static string scores(array|string $sqls)
508+
* @method static \self addOptions(array $options)
509+
* @method static \self addOption(string $key, void $value)
510+
* @method static \self removeOptions(array $keys)
511+
* @method static \self removeOption(string $key)
512+
* @method static \self onlyOptions(array $keys = ['-test-dsn','-online-dsn'])
513+
* @method static \self onlyOption(string $key)
514+
* @method static \self setOptions(array $options)
515+
* @method static \self setOption(string $key, void $value)
516+
* @method static \self mergeOptions(array $options)
517+
* @method static \self mergeOption(string $key, void $value)
518+
* @method static array getOptions()
519+
* @method static void getOption(string $key, void $default = null)
520+
* @method static string getSerializedNormalizedOptions()
521+
* @method static array getNormalizedOptions()
522+
* @method static string getSoarPath()
523+
* @method static \self setSoarPath(string $soarPath)
524+
* @method static void dd(void ...$args)
525+
* @method static \self dump(void ...$args)
526+
* @method static string run(array|string $withOptions = [], null|callable $processTapper = null, null|callable $callback = null)
527+
* @method static \Guanguans\LaravelSoar\Soar|\Illuminate\Support\HigherOrderTapProxy tap(null|callable $callback = null)
498528
*
499-
* @method static string score(string $sql) // SQL 评分
500-
* @method static array arrayScore(string $sql) // SQL 数组格式评分
501-
* @method static string jsonScore(string $sql) // SQL json 格式评分
502-
* @method static string htmlScore(string $sql) // SQL html 格式评分
503-
* @method static string mdScore(string $sql) // SQL markdown 格式评分
504-
* @method static string explain(string $sql) // explain 解读信息
505-
* @method static string mdExplain(string $sql) // markdown 格式 explain 解读信息
506-
* @method static string htmlExplain(string $sql) // html 格式 explain 解读信息
507-
* @method static null|string syntaxCheck(string $sql) // 语法检查
508-
* @method static string fingerPrint(string $sql) // SQL 指纹
509-
* @method static string pretty(string $sql) // 格式化 SQL
510-
* @method static string md2html(string $sql) // markdown 转 html
511-
* @method static string help() // Soar 帮助
512-
* @method static null|string exec(string $command) // 执行任意 Soar 命令
513-
* @method static string getSoarPath() // 获取 Soar 路径
514-
* @method static array getOptions() // 获取 Soar 配置选项
515-
* @method static Soar setSoarPath(string $soarPath) // 设置 Soar 路径
516-
* @method static Soar setOption(string $key, $value) // 设置 Soar 配置选项
517-
* @method static Soar setOptions(array $options) // 批量设置 Soar 配置选项
518-
*
519-
* @see \Guanguans\SoarPHP\Soar
520529
* @see \Guanguans\LaravelSoar\Soar
521530
*/
522531
class Soar{}
@@ -532,22 +541,22 @@ class Soar{}
532541
namespace Illuminate\Database\Eloquent {
533542
/**
534543
* @method string toRawSql()
535-
* @method void dumpRawSql()
536-
* @method void ddRawSql()
537-
* @method array toSoarArrayScore()
538-
* @method void dumpSoarArrayScore()
539-
* @method void ddSoarArrayScore()
540-
* @method string toSoarJsonScore()
541-
* @method void dumpSoarJsonScore()
542-
* @method void ddSoarJsonScore()
543-
* @method string toSoarHtmlScore()
544-
* @method void echoSoarHtmlScore()
545-
* @method void exitSoarHtmlScore()
546-
* @method string toSoarHtmlExplain()
547-
* @method void echoSoarHtmlExplain()
548-
* @method void exitSoarHtmlExplain()
544+
* @method void dumpRawSql()
545+
* @method void ddRawSql()
546+
* @method array toSoarArrayScores()
547+
* @method void dumpSoarArrayScores()
548+
* @method void ddSoarArrayScores()
549+
* @method string toSoarJsonScores()
550+
* @method void dumpSoarJsonScores()
551+
* @method void ddSoarJsonScores()
552+
* @method string toSoarHtmlScores()
553+
* @method void echoSoarHtmlScores()
554+
* @method void exitSoarHtmlScores()
555+
*
556+
* @mixin \Illuminate\Database\Query\Builder
549557
*
550558
* @see \Guanguans\LaravelSoar\Macros\QueryBuilderMacro
559+
* @see \Illuminate\Database\Eloquent\Builder
551560
*/
552561
class Builder
553562
{

0 commit comments

Comments
 (0)