tebe / php-package-skeleton
使用最佳实践的PHP包骨架
Requires
- php: >=7.1
Requires (Dev)
- apigen/apigen: ^4.1
- pds/skeleton: ~1.0
- phpunit/phpunit: ^6.4
- squizlabs/php_codesniffer: ^3.1
This package is auto-updated.
Last update: 2024-08-29 04:43:04 UTC
README
PHP包骨架
这个骨架是基于PDS骨架的实例包。它使用了PDS建议的标准文件系统结构，并添加了一些额外的文件夹和文件。主要思路是使用这个包创建一个项目，然后删除项目中未使用或不必要的部分。
安装
要创建一个基于此骨架包的新项目，只需运行以下命令
$ composer create-project -s dev tebe/php-package-skeleton myproject
现在，删除项目中未使用或不必要的部分。
摘要
包包含以下根目录
包包含以下根目录文件
包包含以下脚本
根目录
bin/
这是命令行可执行文件的根目录。您可以根据需要定义目录的结构和内容。
config/
这是配置文件的根目录。您可以根据需要定义目录的结构和内容。
docs/
这是Markdown文档的根目录。
该目录包含三个子目录
您可以根据需要扩展目录的结构和内容。
examples/
这是示例文件的根目录。您可以根据需要定义目录的结构和内容。
public/
这是web服务器文件的根目录。您可以根据需要定义目录的结构和内容。
resources/
这是其他资源文件的根目录。您可以根据需要定义目录的结构和内容。
src/
这是PHP源代码文件的根目录。您可以根据需要定义目录的结构和内容。
tests/
这是由PHPunit运行测试文件的根目录。
该目录至少包含
- bootstrap.php: PHPUnit使用的引导文件
您可以根据需要定义目录的结构和内容。
vendor/
这是由Composer管理的根目录。
此目录是自动生成的，不得修改。
其他目录
您可以根据需要添加用于此骨架未使用目的的根目录。
根目录文件
.apigen.yml
(待定)
.gitignore
(待定)
.travis.yml
(待定)
CHANGELOG.md
这是自上次发布或版本以来变更的列表的根目录文件。您可以根据需要定义文件的结构和内容。
.composer.json
(待定)
.composer.lock
(待定)
CONTRIBUTING.md
这是描述如何为包做出贡献的根目录文件。您可以根据需要定义文件的结构和内容。
LICENSE
这是指示包内容许可和版权条款的根目录文件。
这对于可能侵犯版权法的包使用者来说是必要的，当复制未经许可的知识产权时可能会违反版权法。
您可以根据需要定义文件的结构和内容。
mkdocs.yml
(待定)
phpcs.xml
(待定)
phpunit.xml
(待定)
README.md
这是包含关于包自身信息的根级文件。您可以根据需要定义文件的结构和内容。
其他文件
您可以为在此骨架中未使用的目的添加其他根级文件。
脚本
在Composer的术语中，脚本可以是PHP回调或任何命令行可执行命令。它们定义在根目录下的composer.json包中，在Composer执行过程中执行包的定制代码或特定于包的命令时很有用。