Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/midnite81/badges
A php package to display repository badges
https://github.com/midnite81/badges
badges package-badges packages php
Last synced: 15 days ago
JSON representation
A php package to display repository badges
- Host: GitHub
- URL: https://github.com/midnite81/badges
- Owner: midnite81
- Created: 2018-07-14T03:29:36.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-02-05T14:11:18.000Z (almost 3 years ago)
- Last Synced: 2024-04-27T09:34:33.395Z (7 months ago)
- Topics: badges, package-badges, packages, php
- Language: PHP
- Size: 20.5 KB
- Stars: 0
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Badges
[](https://packagist.org/packages/midnite81/badges) [](https://packagist.org/packages/midnite81/badges) [](https://packagist.org/packages/midnite81/badges) [](https://packagist.org/packages/midnite81/badges) [](https://travis-ci.org/midnite81/badges) [](https://coveralls.io/github/midnite81/badges?branch=master)
_A PHP package to render out package badges_
## Installation
This package requires PHP 5.6+
To install through composer include the package in your `composer.json`.
"midnite81/badges": "^1.0.0"
Run `composer install` or `composer update` to download the dependencies or you can
run `composer require midnite81/badges`.
## Badges Supported
| Type | Example |
|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
|Latest Stable |[](https://packagist.org/packages/midnite81/badges) |
|Total Downloads |[](https://packagist.org/packages/midnite81/badges) |
|Latest Unstable |[](https://packagist.org/packages/midnite81/badges) |
|Licence |[](https://packagist.org/packages/midnite81/badges) |
|Build |[](https://travis-ci.org/midnite81/badges) |
|Coverage |[](https://coveralls.io/github/midnite81/badges?branch=master)|
|Gitter |[](https://gitter.im/midnite81-badges/?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
|StyleCI |(Image Coming soon) |
|Scrutinizer |(Image Coming soon) |
Over time support for other badges will be added. You can create your own templates which extend
`Midnite81\Badges\Type\BadgeType` and can be passed through the `$badges->get(MyClass::class)` method. More
documentation on adding your own templates will be added later.
## Example Usage
Firstly, you need to create an instance of badges.
```php
use Midnite81\Badges\Badges;
$badges = new Badges($attributes);
// or
$badges = Badges::create($attributes);
```
You'll notice that a variable of $attributes is passed on construction. The attributes are what the package will use
to translate the template. By default we're only going to pass the following attributes as they are needed for the
supported badges. Obviously update the above attributes to suit your own needs.
```
$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
];
```
Once the class is instantiated, you then need to select the type of badge you want.
```php
$myBadge = $this->latestStableVersion();
```
This will return you a `Writer` object, which you can call `->toHtml()` or `->toMarkdown` on for the final rendering
of the badge. The default `_toString` method will return the html version.
So all in all;
```
use Midnite81\Badges\Badges;
$badges = Badges::create(['$PACKAGE_NAME$' => 'midnite81/badges']);
echo $badges->latestStableVersion()->toMarkdown();
```
will output
[](https://packagist.org/packages/midnite81/badges)
`[](https://packagist.org/packages/midnite81/badges)`