diff --git a/src/Interface/BadgeableInterface.php b/src/Interface/BadgeableInterface.php index 4b1f907..29a23e8 100644 --- a/src/Interface/BadgeableInterface.php +++ b/src/Interface/BadgeableInterface.php @@ -7,10 +7,15 @@ namespace Pcm\BadgeBundle\Interface; use Pcm\BadgeBundle\Enum\Badge; /** - * Enables this class to be rendered as a badge using the Badge and BadgeOutline Twig components. + * Allows rendering the implementing class as a badge using the PCM Badge twig component. */ interface BadgeableInterface { + /** + * Get the badge colour that should be used when rendering this object as a badge. + * + * @return Badge Colour of badge to render + */ public function getBadgeColour(): Badge; }