README

一个用于渲染包徽章的PHP包

安装

此包需要PHP 5.6+

通过composer安装，请将包包含在你的composer.json文件中。

"midnite81/badges": "^1.0.0"

运行composer install或composer update下载依赖，或者你可以运行composer require midnite81/badges。

支持的徽章

随着时间的推移，将对其他徽章提供支持。您可以创建自己的模板，这些模板扩展了Midnite81\Badges\Type\BadgeType，并且可以通过$badges->get(MyClass::class)方法传递。稍后将添加有关添加您自己的模板的更多文档。

示例用法

首先，您需要创建徽章的一个实例。

use Midnite81\Badges\Badges;
$badges = new Badges($attributes);
// or 
$badges = Badges::create($attributes);

您会注意到在构造函数中传递了一个$attributes变量。这些属性是包将用于转换模板的属性。默认情况下，我们只传递以下属性，因为它们对于支持的徽章是必需的。显然，根据您的需求更新上述属性。

$attributes = [
    '$PACKAGE_NAME$' => 'midnite81/badges', // Your GitHub package repo name
    '$STYLE_CI$' => 'repoNumber', // Your StyleCi repo number
    '$GITTER_ROOM$' => 'room-name' // Your gitter room name
];

一旦类被实例化，您就需要选择您想要的徽章类型。

$myBadge = $this->latestStableVersion();

这将返回一个Writer对象，您可以通过调用->toHtml()或->toMarkdown进行最终的渲染。默认的_toString方法将返回html版本。

所以总的来说；

use Midnite81\Badges\Badges;
$badges = Badges::create(['$PACKAGE_NAME$' => 'midnite81/badges']); 

echo $badges->latestStableVersion()->toMarkdown();

将输出

[![最新稳定版本](https://poser.pugx.org/midnite81/badges/version)](https://packagist.org.cn/packages/midnite81/badges)

midnite81 / badges

维护者

详情

README

安装

支持的徽章

示例用法