webbuilders-group / silverstripe-packagistshortcode
为 HTMLText 字段添加 Packagist 安装按钮的短代码,并显示安装数量。
2.0.3
2023-10-19 19:00 UTC
Requires
- silverstripe/framework: ^4|^5
README
为 HTMLText 字段添加 Packagist 安装按钮的短代码,并显示安装数量。
维护者联系方式
- Ed Chipman (UndefinedOffset)
需求
- SilverStripe CMS 4.x | 5.x
安装
Composer (推荐)
composer require webbuilders-group/silverstripe-packagistshortcode
如果您愿意,也可以手动安装
- 从这里下载模块 https://github.com/webbuilders-group/silverstripe-packagistshortcode/archive/master.zip
- 将下载的压缩包解压到网站根目录,以便目标文件夹命名为 githubshortcode,解压后的文件夹应包含根目录中的 _config.php 文件以及其他文件/文件夹
- 运行 dev/build?flush=all 以重新生成清单
用法
用法非常直接,要添加 Packagist 下载按钮,只需添加以下内容
[packagist package="package owner/package name"]
可选地,您也可以添加 mode="monthly" 或 button="daily" (默认为 total) 以显示指定期间的下载次数。
[packagist package="package owner/package name" mode="monthly"]
在 3.1 版本中,上述短代码将按包含的方式工作,但短代码的更新语法将是(当然,布局和按钮不是必需的)
[packagist,package="package owner/package name",mode="monthly"]
配置选项
您有一些可用的配置选项
SilverStripe\Core\Injector\Injector: Psr\SimpleCache\CacheInterface.PackagistShortCode: factory: SilverStripe\Core\Cache\CacheFactory constructor: namespace: "NewRelic" defaultLifetime: 86400 #Cache time in seconds WebbuildersGroup\PackagistShortCode\PackagistShortCode: UseShortHandNumbers: true #Use short hand numbers i.e 5.6K or not