serhii/goodbye-html
Composer 安装命令：
composer require serhii/goodbye-html
包简介
Simple html parser for parsing html files into a string
README 文档
README
A very simple package for separating PHP logic from HTML or any other text. It allows you to insert variables, if/elseif/else statements, loops and ternary operators into any text file and dynamically get parsed content of this file.
Supported PHP versions
- ✅ 8.2
- ✅ 8.3
- ✅ 8.4
- ✅ 8.5
What is it for?
This package is useful when you need to separate PHP logic from HTML or any other text. For example if you need to send an email with some dynamic content, you can create a template file with HTML and insert variables, if/elseif/else statements, loops and ternary operators into it. Then you can pass this file to the parser and get parsed content of this file as a string. Then you can use this string as a content of your email.
What is it not for?
This package is not for creating a full-featured template engine. It's just a simple parser that allows you to insert some PHP logic into any text file. It's not for creating a full-featured template engine like Twig, Blade or Latte. If you need a full-featured template engine, you should use one of the mentioned above.
What Goodbye HTML has?
- Variables
- Assigning variables
- Using variables
- Printing variables
- Comparison operators
- Equal (==)
- Not equal (!=)
- Strong equal (===)
- Strong not equal (!==)
- Greater than (>)
- Less than (<)
- Greater than or equal (>=)
- Less than or equal (<=)
- If/Else-If/Else statements
- Expressions
- Ternary Expressions (true ? 'yes' : 'no')
- Grouped Expressions ((3 + 4) * 5)
- Loops
- Prefix operators
- Negation operator (!)
- Minus operator (-)
- String concatenation
- Math operations
- Addition
- Subtraction
- Multiplication
- Division
- Modulus
Usage
use Serhii\GoodbyeHtml\Parser; $variables = [ 'title' => 'Title of the document', 'uses_php_3_years' => true, 'show_container' => false, ]; // Absolute file path to a text file $file_path = __DIR__ . '/hello.html'; $parser = new Parser($file_path, $variables); // this will parsed content of hello.html file echo $parser->parseHtml();
HTML file content with 2 php variables before parsing it
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>{{ $title }}</title> </head> <body class="{{ $show_container ? 'container' : '' }}"> <nav> <ul> {{ loop 1, 3 }} <li><a href="#">Link - {{ $index }}</a></li> {{ end }} </ul> </nav> {{ if $uses_php_3_years }} <h1>I'm not a pro, but it's only a matter of time</h1> {{ end }} </body> </html>
Parsed HTML to a PHP string
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>Title of the document</title> </head> <body class=""> <nav> <ul> <li><a href="#">Link - 1</a></li> <li><a href="#">Link - 2</a></li> <li><a href="#">Link - 3</a></li> </ul> </nav> <h1>I'm not a pro, but it's only a matter of time</h1> </body> </html>
Same example but for WordPress shortcode
use Serhii\GoodbyeHtml\Parser; add_shortcode('my_shortcode', 'shortcode_callback'); function shortcode_callback() { $parser = new Parser(__DIR__ . '/shortcodes/main.html', [ 'title' => 'Title of the document', 'uses_php_3_years' => true, 'show_container' => false, ]); return $parser->parseHtml(); }
Options
The instance of Parser class takes the third argument as a ParserOption enum. You can pass it to the constructor of the Parser class as a third argument. For now, it has only a single options:
ParserOption::PARSE_TEXT
If you pass this option, the parser, instead of getting the content of the provided file path, will parse the provided string. This option is useful when you want to parse a string instead of a file.
$parser = new Parser('<div>{{ $title }}</div>', [ 'title' => 'Hello world' ], ParserOption::PARSE_TEXT); // output: <div>Hello world</div>
Supported types
Types that you can pass to the parser to include them in the html/text file. Note that not all PHP types are supported for know. More types will be added in next releases.
| PHP Type | Value example |
|---|---|
| bool | true |
| string | 'Is title' |
| int | 24 |
| float | 3.1415 |
| null | null |
Supported prefix operators
Prefix operators are used to change the value of the variable. For example if you have a variable $is_smoking and you want to check if it's false, you can use ! prefix operator to change the value of the variable to false. Or if you have a variable $age and you want to make it negative, you can use - prefix operator to change the value of the variable to negative.
| Prefix name | Prefix value | Example | Supported types for prefix |
|---|---|---|---|
| Not | ! | !true | all the types |
| Minus | - | -24 | int, float |
Supported infix operators
Infix operators are used to perform math operations or string concatenation. For example if you have a variable $age and you want to add 1 to it, you can use + infix operator to add 1 to the variable. Or if you have a variable $first_name and you want to concatenate it with $last_name, you can use . infix operator to concatenate these 2 variables.
| Operator name | Operator literal | Example | Supported types for prefix |
|---|---|---|---|
| Plus | + | 3 + 4 | int, float |
| Minus | - | 5 - 4 | int, float |
| Multiply | * | 3 * 4 | int, float |
| Divide | / | 6 / 3 | int, float |
| Modulo | % | 5 % 2 | int, float |
| Concatenate | . | 'Hello' . ' world' | string |
| Assigning | = | {{ $a = 5 }} | all the types |
| Equal | == | 5 == 5 | all the types |
| Not equal | != | 5 != 4 | all the types |
| Strong equal | === | 5 === 5 | all the types |
| Strong not equal | !== | 5 !== 4 | all the types |
| Greater than | > | 5 > 4 | int, float |
| Less than | < | 5 < 4 | int, float |
| Greater or equal | >= | 5 >= 4 | int, float |
| Less or equal | <= | 5 <= 4 | int, float |
All the available syntax in html/text file
Variable
<!-- Inside html tags --> <div>{{ $guest_name }}</div>
<!-- Inside attributes --> <h2 class="{{ $styles }}">The title of the page</h2>
If statements
<!-- Block syntax --> <section> {{ if true }} <h1>PHP is awesome programming language</h1> {{ end }} </section>
<!-- Inline syntax --> <h1 class="{{if $show_container}}container{{end}}"> This package is cool </h1>
If/Else statements
<!-- Block syntax --> <section> {{ if $likes_bread }} <h1>I like bread</h1> {{ else }} <h1>I don't really like bread</h1> {{ end }} </section>
<!-- Inline syntax --> <section> <h1>{{ if $late }}It's late{{ else }}It's not late{{ end }}</h1> </section>
If/Else-If/Else statements
Similar to PHP, you can write
elseiforelse ifin the same way.
<!-- Block syntax --> <section> {{ if $likes_bread }} <h1>I like bread</h1> {{ else if $likes_cake }} <h1>I like cake</h1> {{ elseif $likes_pizza }} <h1>I like pizza</h1> {{ else }} <h1>I don't really like anything</h1> {{ end }} </section>
<!-- Inline syntax --> <section> <h1>I like {{ if $likes_bread }}bread{{ else if $likes_cake }}cake{{ else }}just water{{ end }}</h1> </section>
Ternary operator
Ternary operator is commonly referred to as the conditional operator, inline if/else. An expression a ? b : c evaluates to b if the value of a is true, and otherwise to c. One can read it aloud as "if a then b otherwise c".
<!-- Inside html attributes --> <section class="{{ $wrap ? 'container' : '' }}"> <h1>Title</h1> </section>
<!-- With strings --> <section class="container"> {{ 23 === 23 ? '<h1>Main title</h1>' : '<h2>Secondary</h2>' }} </section>
<!-- With variables --> <section class="container"> {{ $has_apple ? $with_apple : $without_apple }} </section>
Loops
Loop takes 2 integer arguments. The first argument is from what number start looping, and the second argument is where to stop. For example if you start from 1 to 4, it's going to result 4 repeated blocks. Inside each loop you can use $index variable that is going to have a value of current iteration number.
<!-- Block syntax --> <div> {{ loop 0, 5 }} <h1>Hello world {{ $index }}</h1> {{ end }} </div>
<!-- Inline syntax --> <div> <h1 class="{{ loop 1, 4 }}class-{{$index}} {{ end }}"></h1> </div>
<!-- With integer variables --> <div> {{ loop $from, $to }} <h1>Hello world {{ $index }}</h1> {{ end }} </div>
Assigning statements
You can assign values to variables inside your text files using curly braces. For example if you want to assign value 5 to variable $a, you can do it like this {{ $a = 5 }}. You can also use prefix operators to change the value of the variable. For example if you want to assign value false to variable $is_smoking, you can do it like this {{ $is_smoking = !true }}.
<div>{{ $age = 33 }}</div>
Getting started
composer require serhii/goodbye-html
Contribute
With a Container Engine
Build an Image
To build an image, navigate to the root of project and run this command.
With Podman:
podman-compose build
With Docker:
docker compose build
Run the Container
To run the container, navigate to the root of project and run this command.
With Podman:
podman-compose run --rm app
With Docker:
docker compose run --rm app
Destroy the Container
You can cleanup after working on a project by destroying things like networks with this command.
With Podman:
podman-compose down
With Docker:
docker compose down
serhii/goodbye-html 适用场景与选型建议
serhii/goodbye-html 是一款 基于 PHP 开发的 Composer 扩展包，目前已累计 387 次下载、GitHub Stars 达 7， 最近一次更新时间为 2019 年 09 月 24 日， 在 PHP 生态内属于活跃度较高的组件。
它主要适用于以下技术方向： 「library」 「parser」 「html」 等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。
我们在过去多个企业项目中使用过 serhii/goodbye-html 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。
基于 serhii/goodbye-html 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。
线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。
承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。
与 serhii/goodbye-html 相关的其它包
同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：
Texy converts plain text in easy to read Texy syntax into structurally valid (X)HTML. It supports adding of images, links, nested lists, tables and has full support for CSS. Texy supports hyphenation of long words (which reflects language rules), clickable emails and URL (emails are obfuscated again
Easy to use SDK with grabber for multiple platforms at once like YouTube, Dailymotion, Facebook and more.
An MT940 bank statement parser for PHP
HTML and form generation
Inbox pattern process implementation for your Laravel Applications
Laravel integration for the jsonapi.org parser
统计信息
- 总下载量： 387
- 月度下载量： 0
- 日度下载量： 0
- 收藏数： 8
- 点击次数： 9
- 依赖项目数： 0
- 推荐数： 0
其他信息
- 授权协议： MIT
- 更新时间： 2019-09-24