src-run / augustus-reflection-library
一个提供部分反射高级API的简单库。
Requires
- php: ~8.1
- src-run/augustus-exception-library: ~0.20
- src-run/augustus-utility-library: ~0.20
Requires (Dev)
- codacy/coverage: ~1.4
- dms/phpunit-arraysubset-asserts: ^0.4.0
- friendsofphp/php-cs-fixer: ~3.2
- php-coveralls/php-coveralls: ~2.1
- symfony/phpunit-bridge: ~4.1 | ~5.0 | ~6.0
README
概览
欢迎!src-run/augustus-reflection-library
包提供
一个提供部分反射高级API的简单库。
分组
我们使用灵感来自Willy Wonka的命名规范为我们的包分组命名。此包是augustus组的一部分,该组是一系列以“核心反射基类”和相关功能为重点的包。
如果您手头有太多时间,欢迎您研究一些关于此特定组无用的细节。
JTT
此包代表在“SR”命名空间下发布的一系列开源代码集合中的一个项目,其中包括许多框架无关的库、一系列Symfony扩展包以及一些单独发布的版本。该项目由Rob Frawley 2nd编写和维护。
快速开始
安装
通过使用Composer CLI显式要求代码,或通过编辑您的composer.json来反映依赖关系并更新您的项目需求来获取代码。例如,要使用CLI显式要求此项目,请使用以下命令。
$ composer require src-run/augustus-reflection-library
或者,要将此项目添加到您的"composer.json"文件中,请在"require"部分添加以下内容。
require: { "src-run/augustus-reflection-library": "dev-master" }
注意:不建议使用"dev-master"约束。请意识到这样做可能会允许向后不兼容的、破坏性的更改被拉入。相反,使用语义版本化和显式要求是良好的实践。例如,要要求版本1.0,请使用^1.0
。
参考
API文档
此包的API参考可在我们的文档网站上找到(请参阅以下“附加链接”部分中找到的表的“参考”行)。所有API文档都在git push事件发生时自动针对master分支编译。
计划为特定版本提供静态API参考,一旦此包成熟并达到版本1里程碑,将发布。.
上述API参考网站是使用名为Sami的可靠且开发良好的CLI工具自动生成的。它经过严格且定期的测试,并被用于一些大型项目,如Symfony全栈框架<见:https://src.run/go/symfony-api>,以及一些较小的项目,如Twig<见:https://src.run/go/twig-api>。请参考Sami的存储库页面以研究在您自己的项目中的使用。
示例/教程
目前,除了这份README(它本身也是从模板生成的)外,没有“人工编写”的文档。待软件包稳定、可用人力和外部用户实际需求确定后,我们可能会发布一个Read the Docs页面,包含官方文档、教程和附加资源。
贡献
讨论
如果您想进行一般性咨询或讨论一个广泛的话题或想法,请在Freenode上找到“robfrawley”。他总是愿意讨论语言层面的想法、项目可能的新的发展方向、新兴技术以及天气。
问题
要报告问题或请求新功能,请使用项目问题跟踪器。在任何错误报告中包含尽可能多的信息。如果您几天内没有收到回复,请随时“ping”该话题(有时Github的通知电子邮件会丢失)。
代码
在利用此包的同时,您创建了额外的功能?太好了:将其反馈给上游!不要犹豫提交拉取请求!您的想象力和我们CONTRIBUTING.md文件中概述的要求是唯一的限制。
许可
该项目受MIT许可证许可,这是一个FSF和OSI批准的、与GPL兼容的、宽松的自由软件许可证。请参阅随源代码一起分发的LICENSE文件以获取更多信息。