Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
100.00%
2 / 2
100.00%
1 / 1
 CRAP
100.00%
1 / 1
HasDescription
100.00%
2 / 2
100.00%
1 / 1
 1
100.00%
1 / 1
 description
100.00%
2 / 2
100.00%
1 / 1
 1
1<?php
2
3declare(strict_types=1);
4
5/**
6 * Ergonomic utilities for PHP enums, including names, values, lookups, and option maps.
7 *
8 * This file is part of fast-forward/enum project.
9 *
10 * @author   Felipe Sayão Lobato Abreu <github@mentordosnerds.com>
11 * @license  https://opensource.org/licenses/MIT MIT License
12 *
13 * @see      https://github.com/php-fast-forward/enum
14 * @see      https://github.com/php-fast-forward/enum/issues
15 * @see      https://php-fast-forward.github.io/enum/
16 * @see      https://datatracker.ietf.org/doc/html/rfc2119
17 */
18
19namespace FastForward\Enum\Trait;
20
21trait HasDescription
22{
23    /**
24     * @return string
25     */
26    public function description(): string
27    {
28        $description = preg_replace('/(?<!^)[A-Z]/', ' $0', $this->name);
29
30        return $description ?? $this->name;
31    }
32}