首页 > 教程 > 文章 > PHP > 正文

在 PHP 中格式化并高亮 SQL 语句

转载2021-06-14 19:04:12 0 21

jdorn/sql-formatter 是一个轻量级的 PHP 类用于格式化 SQL 语句。

它支持自动进行缩进、添加换行,甚至还支持语法高亮。

在命令行内使用

该扩展包包含一个 bin/sql-formatter 可执行文件,可直接用于命令行格式化 SQL。

使用 Composer 全局安装后便可使用该命令了:

composer global require jdorn/sql-formatter
sql-formatter "SELECT SOME QUERY;" // 直接格式化
// 或
echo "SELECT SOME QUERY;" | sql-formatter // 使用管道,更适合较大量的 SQL 语句

作为扩展包使用

SqlFormatter 类包含一个名为 format 的静态方法,它可以接收一个 SQL 语句字符串作为参数,并返回格式化后使用 pre 标签包裹的 HTML 代码。

例如:

<?php
require_once('SqlFormatter.php');
$query = "SELECT count(*),`Column1`,`Testing`, `Testing Three` FROM `Table1`
    WHERE Column1 = 'testing' AND ( (`Column2` = `Column3` OR Column4 >= NOW()) )
    GROUP BY Column1 ORDER BY Column3 DESC LIMIT 5,10";
echo SqlFormatter::format($query);

输出:

只格式化不高亮

若是不需要高亮,只需要添加缩进和换行,请将第二个参数设置为 false 即可。

适用于输出错误日志或者其它非 HTML 数据时。

<?php
echo SqlFormatter::format($query, false);

输出:

只高亮不格式化

有个单独的方法名为 highlight 能够保证原有的格式不被改动,只添加语法高亮。

适用于 SQL 已经被良好格式化,需让它更加易读时。

压缩查询语句

compress 方法可删除所有的 SQL 注释,并压缩不必要的空格。

适用于输出多条查询语句,并使其易于复制粘贴到命令行时。

-- This is a comment
    SELECT
    /* This is another comment
    On more than one line */
    Id #This is one final comment
    as temp, DateCreated as Created FROM MyTable;
echo SqlFormatter::compress($query);

输出:

SELECT Id as temp, DateCreated as Created FROM MyTable;

删除注释

如果你需要保留原有格式,但仍需删除 SQL 注释,你可以使用 removeComments 方法来代替 compress。

-- This is a comment
    SELECT
    /* This is another comment
    On more than one line */
    Id #This is one final comment
    as temp, DateCreated as Created FROM MyTable;
echo SqlFormatter::removeComments($query);

输出:

    SELECT
    Id 
    as temp, DateCreated as Created FROM MyTable;

将多条 SQL 语句分割为数组

还有一个与格式化无关的特性,能够将多条 SQL 语句分离为数组。

例如:

DROP TABLE IF EXISTS MyTable;
CREATE TABLE MyTable ( id int );
INSERT INTO MyTable (id)
    VALUES
    (1),(2),(3),(4);
SELECT * FROM MyTable;
$queries = SqlFormatter::splitQuery($sql);

结果:

DROP TABLE IF EXISTS MyTable;
CREATE TABLE MyTable ( id int );
INSERT INTO MyTable (id) VALUES (1),(2),(3),(4);
SELECT * FROM MyTable;

为何不使用正则表达式?

去看看 README 吧~https://github.com/jdorn/sql-formatter#why...

以上就是《在 PHP 中格式化并高亮 SQL 语句》的详细内容,更多请关注 “设计者在线”其它相关文章!

申明:本站文章多来自互联网,如果侵犯了你的权益,请联系站长及时处理!谢谢!!

  • 相关标签:
  • 本文由 设计者在线 原创发布,转载请注明出处,感谢您的尊重!
  • 相关文章

    相关视频


    网友评论

    文明上网理性发言,请遵守 新闻评论服务协议

    我要评论 条评论
  • 专题推荐

    • 帝国系统

      简介:抗击新型冠状病毒感染肺炎

    • JQUERY

      简介:春节好春节好春节好春节好春节好春节好春节好春节好

    • 不忘初心牢记使命教育活动

      简介:不忘初心牢记使命教育活动

    • 我们的生活

      简介:我们的生活我们的生活我们的生活我们的生活我们的生活我们的生活我们的生活我们的生活我们的生活我们的生活我们的生活我们的生活我们的生活

    • 明天会更好

      简介:明天会更好明天会更好明天会更好明天会更好明天会更好明天会更好明天会更好

    推荐视频教程
    视频分类
    [!--date--]Y-m-d[!--date--]