brabli
29 lines
588 B
PHP
29 lines
588 B
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace Pcm\BadgeBundle\Interface;
|
|
|
|
use Pcm\BadgeBundle\Enum\BadgeColour;
|
|
|
|
/**
|
|
* 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 BadgeColour Colour of badge to render
|
|
*/
|
|
public function getBadgeColour(): BadgeColour;
|
|
|
|
/**
|
|
* Get the badge icon name
|
|
*
|
|
* @return ?string Icon name
|
|
*/
|
|
public function getBadgeIcon(): string;
|
|
}
|
|
|