generated from inherelab/php-pkg-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
up: update the gh release action and add zh-CN readme
- Loading branch information
Showing
4 changed files
with
225 additions
and
64 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,27 +1,36 @@ | ||
| options: | ||
| title: '## Change Log' | ||
| style: gh-release | ||
| title: '## Change Log' | ||
| # style allow: simple, markdown(mkdown), ghr(gh-release) | ||
| style: gh-release | ||
| # group names | ||
| names: [Refactor, Fixed, Feature, Update, Other] | ||
| #repo_url: https://github.com/gookit/gcli | ||
|
|
||
| filters: | ||
| # message length >= 12 | ||
| - name: msgLen | ||
| minLen: 12 | ||
| # message words >= 3 | ||
| - name: wordsLen | ||
| minLen: 3 | ||
| # message length should >= 12 | ||
| - name: msg_len | ||
| min_len: 12 | ||
| # message words should >= 3 | ||
| - name: words_len | ||
| min_len: 3 | ||
| - name: keyword | ||
| keyword: format code | ||
| exclude: true | ||
| - name: keywords | ||
| keywords: ['format code'] | ||
| keywords: format code, action test | ||
| exclude: true | ||
|
|
||
| # group match rules | ||
| # not matched will use 'Other' group. | ||
| groups: | ||
| - name: New | ||
| keywords: [add, new] | ||
| rules: | ||
| - name: Refactor | ||
| start_withs: [refactor, break] | ||
| contains: ['refactor:', 'break:'] | ||
| - name: Fixed | ||
| startWiths: [add, new] | ||
| keywords: [add, new] | ||
| - name: Feat | ||
| startWiths: [feat] | ||
| keywords: [feature] | ||
| start_withs: [fix] | ||
| contains: ['fix:'] | ||
| - name: Feature | ||
| start_withs: [feat, new] | ||
| contains: ['feat:', 'new:'] | ||
| - name: Update | ||
| startWiths: [update, 'up:'] | ||
| keywords: [update] | ||
| start_withs: [up] | ||
| contains: ['update:', 'up:'] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,157 @@ | ||
| # INI | ||
|
|
||
| [](LICENSE) | ||
| [](https://packagist.org/packages/phppkg/ini) | ||
| [](https://github.com/phppkg/ini) | ||
| [](https://github.com/phppkg/ini/actions) | ||
|
|
||
| 💪 PHP编写的一个增强的 `INI` 格式解析器。 | ||
|
|
||
| - 自动转换数据类型，例如：`int, bool, float` | ||
| - 支持将数据编码为 `INI` 字符串。 | ||
| - 忽略以 `;` 或者 `＃` 开头的注释行 | ||
| - 支持数组值和数组值键 | ||
| - 增强：支持内联数组值 | ||
| - 增强：支持多行字符串。 使用 `'''` 或 `"""` | ||
| - 增强：支持在收集值之前添加拦截器 | ||
| - TODO: support parse ENV var. `${SHELL | bash}` | ||
|
|
||
| > **[EN README](README.md)** | ||
| ## 安装 | ||
|
|
||
| - Required PHP 8.0+ | ||
|
|
||
| **composer** | ||
|
|
||
| ```bash | ||
| composer require phppkg/ini | ||
| ``` | ||
|
|
||
| ## 使用 | ||
|
|
||
| example ini: | ||
|
|
||
| ```ini | ||
| ; comments line | ||
| // comments line | ||
| # comments line | ||
|
|
||
| int = 23 | ||
| float = 34.5 | ||
| str=ab cd | ||
| bool=true | ||
| empty-str = | ||
|
|
||
| # support multi-line | ||
| multi-line = ''' | ||
| this is | ||
| a multi | ||
| line string | ||
| ''' | ||
|
|
||
| # simple inline list array | ||
| inlineList = [ab, 23, 34.5] | ||
|
|
||
| # simple multi-line list array, equals the 'simpleList1' | ||
| simpleList[] = 567 | ||
| simpleList[] = "some value" | ||
|
|
||
| # simple multi-line list array | ||
| [simpleList1] | ||
| - = 567 | ||
| - = "some value" | ||
|
|
||
| # simple k-v map | ||
| [simpleMap] | ||
| val_one = 567 | ||
| val_two = 'some value' | ||
|
|
||
| # multi level list array | ||
| [array] | ||
| arr_sub_key[] = "arr_elem_one" | ||
| arr_sub_key[] = "arr_elem_two" | ||
| arr_sub_key[] = "arr_elem_three" | ||
|
|
||
| # multi level k-v map sub array | ||
| [array_keys] | ||
| val_arr_two[6] = "key_6" | ||
| val_arr_two[some_key] = "some_key_value" | ||
| ``` | ||
|
|
||
| ### 解析为数据 | ||
|
|
||
| usage: | ||
|
|
||
| ```php | ||
| use PhpPkg\Ini\Ini; | ||
|
|
||
| $data = Ini::decode($ini); | ||
| vdump($data); | ||
|
|
||
| $cfg = Collection::new($data); | ||
| $int = $cfg->get('int'); // 23 | ||
| ``` | ||
|
|
||
| **Output**: | ||
|
|
||
| ```text | ||
| array(13) { | ||
| ["int"]=> int(23) | ||
| ["float"]=> float(34.5) | ||
| ["str"]=> string(5) "ab cd" | ||
| ["bool"]=> bool(true) | ||
| ["empty-str"]=> string(0) "" | ||
| ["multi-line"]=> string(30) "this is | ||
| a multi | ||
| line string" | ||
| ["inlineList"]=> array(3) { | ||
| [0]=> string(2) "ab" | ||
| [1]=> int(23) | ||
| [2]=> float(34.5) | ||
| } | ||
| ["simpleList"]=> array(2) { | ||
| [0]=> int(567) | ||
| [1]=> string(10) "some value" | ||
| } | ||
| ["simpleList1"]=> array(2) { | ||
| [0]=> int(567) | ||
| [1]=> string(10) "some value" | ||
| } | ||
| ["simpleMap"]=> array(2) { | ||
| ["val_one"]=> int(567) | ||
| ["val_two"]=> string(10) "some value" | ||
| } | ||
| ["array"]=> array(1) { | ||
| ["arr_sub_key"]=> array(3) { | ||
| [0]=> string(12) "arr_elem_one" | ||
| [1]=> string(12) "arr_elem_two" | ||
| [2]=> string(14) "arr_elem_three" | ||
| } | ||
| } | ||
| ["array_keys"]=> array(1) { | ||
| ["val_arr_two"]=> array(2) { | ||
| [6]=> string(5) "key_6" | ||
| ["some_key"]=> string(14) "some_key_value" | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### 从文件解析 | ||
|
|
||
| ```php | ||
| $data = Ini::decodeFile($iniFile); | ||
| ``` | ||
|
|
||
| ## 编码数据为INI | ||
|
|
||
| Encode data to INI string. | ||
|
|
||
| ```php | ||
| $iniString = Ini::encode($data); | ||
| ``` | ||
|
|
||
| ## License | ||
|
|
||
| [MIT](LICENSE) |