kodasnarl / c-pchart
将 "pChart" 库移植到 PHP 5+
Requires
- php: >=5.4
- ext-gd: *
Requires (Dev)
- codeception/codeception: ^2.4
- phpunit/phpunit: ^4.8|^7.1
- squizlabs/php_codesniffer: ^3.4
This package is auto-updated.
Last update: 2024-09-25 10:15:52 UTC
README
支持
该项目以基本方式支持,不会引入新功能。如有需要,将审查和解决问题,所以请随意提交。
构建状态
代码质量
关于
此库是 Jean-Damien Pogolotti 创建的优秀 pChart 统计库的移植版本,旨在允许在现代应用程序中使用它。这是通过将 PSR 标准应用于代码、引入命名空间和类型提示以及一些基本的方法注释来实现的。
这是 3.x
版本,它删除了工厂服务和稍微重新组织了文件结构。它没有引入任何新功能,但更改与 2.x
分支不兼容。与原始库的 BC 兼容性主要保留,但如果您不能承担这些风险,您仍然可以使用 1.x
版本。
所做的工作
-
支持从 PHP 5.4 到 7.3 的版本。
-
完整移植了库的功能。我对实际逻辑的修改很少,因此原始库中的大部分代码应该可以正常工作。
-
为所有类定义并添加了命名空间。
-
将所有
exit()
/die()
命令替换为throw
语句。 -
重构了代码以满足 PSR-2 标准,并添加了注释(尽可能多地添加)到方法中。此外,在可能的情况下,添加了方法类型提示,因此如果进行了某些奇怪的操作,可能会出现一些向后兼容性中断。
-
将所有常量移动到单个 文件 中。它将通过 Composer 自动加载,因此无需手动操作。
许可
之前提到,此软件包使用 MIT 许可证,这不符合原始作者设定的要求。现在它受 GNU GPL v3 许可证的约束,因此如果您希望在商业项目中使用它,则需要支付 适当的费用。
贡献
总的来说,这是一个从 PHP 4 移植的遗留库,因此代码既不美观也不容易理解。我尽我所能对其进行现代化,并添加了一些基本测试,但还有更多工作可以完成。如果您愿意并有时间修复或改进任何内容,请随意提交 PR 或问题。
安装(通过 Composer)
对于 composer 安装,请将以下内容添加到您的 composer.json 文件中并更新您的依赖项。或者,您可以在项目根目录中运行以下命令。
"require": { "szymach/c-pchart": "^3.0" },
to your composer.json file and update your dependencies. Or you can run
$ composer require szymach/c-pchart
in your project's root directory.
使用方法
了解如何使用库的最佳来源仍然是官方维基百科。然而,我已经将每个图表至少一个示例转换为Markdown文件,这样您可以比较每个版本,并找出如何使用当前实现。
通过 Image 类创建的图表
大多数基本图表是通过CpChart\Image
类的方法创建的。下面您可以找到这些图表的完整列表,以及示例代码。
独立图表
更高级的图表有自己的单独类,您需要使用该类来创建它们。与前文一样,下面是这些图表的完整列表,以及示例代码。
条形码
pChart库还提供了渲染39和128条形码的方法。下面可以找到创建它们的文档链接
缓存
如果您发现自己多次使用一组数据创建图表,您可以考虑使用库的缓存组件。前往文档的专门部分获取相关信息。
字体和调色板
如果您想使用任何字体或调色板文件,只需提供实际文件的名称,不要将fonts
或palettes
文件夹添加到传递给函数的字符串中。如果您想从默认目录以外的目录加载它们,您需要添加文件的完整路径(例如:__DIR__.'/folder/to/my/palletes'
)。