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