pcm-libraries/pcm-badge-bundle
Public Access
3
0
Fork 0
Code Issues 4 Packages Releases Activity

Update readme

Browse Source
This commit is contained in:
brabli
2025-02-26 11:41:21 +00:00
parent 62e279e0c9
commit f0c19dad5e
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -20,21 +20,21 @@ Create badges from objects or as standalone elements.
Any object that you would like to be able to be turned into a badge must implement `BadgeableInterface`.
This interface specifies a single method `getBadgeColour()` and is used to determine what colour the badge should be rendered as.
This interface specifies a single method `getBadgeColour()` which expects an instance of the enum `BadgeColour` to be returned and is used to determine the colour of the rendered badge.
This method can contain as much logic in it as you'd like to return different colours of badge under different circumstances. EG:
```php
// Job.php
public function getBadgeColour(): Badge
public function getBadgeColour(): BadgeColour
{
return match ($this->getKind()) {
JobKind::Investigation => Badge::BLUE,
JobKind::Interrogation => Badge::RED,
JobKind::Shootout => Badge::BLACK,
JobKind::SipWhiskey => Badge::FOREST,
default => Badge::GREY
JobKind::Investigation => BadgeColour::BLUE,
JobKind::Interrogation => BadgeColour::RED,
JobKind::Shootout => BadgeColour::BLACK,
JobKind::SipWhiskey => BadgeColour::FOREST,
default => BadgeColour::GREY
};
}
```