Renderable::__toString()   A
last analyzed

Complexity

Conditions 2
Paths 1

Size

Total Lines 16

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 6

Importance

Changes 0
Metric Value
dl 0
loc 16
ccs 0
cts 9
cp 0
rs 9.7333
c 0
b 0
f 0
cc 2
nc 1
nop 0
crap 6
1
<?php
2
/**
3
 * This file is part of Railt package.
4
 *
5
 * For the full copyright and license information, please view the LICENSE
6
 * file that was distributed with this source code.
7
 */
8
declare(strict_types=1);
9
10
namespace Railt\Lexer\Result\Common;
11
12
/**
13
 * Trait Renderable
14
 */
15
trait Renderable
16
{
17
    /**
18
     * @return string
19
     */
20
    public function __toString(): string
21
    {
22
        $format = function (string $value) {
23
            $value = (string)(\preg_replace('/\s+/iu', ' ', $value) ?? $value);
24
            $value = \addcslashes($value, '"');
25
26
            if (\mb_strlen($value) > 35) {
27
                $value = \mb_substr($value, 0, 30) .
28
                    \sprintf('… (%s+)', \mb_strlen($value) - 30);
29
            }
30
31
            return $value;
32
        };
33
34
        return \sprintf('"%s" (%s)', $format($this->getValue()), $this->getName());
0 ignored issues
show
Bug introduced by
It seems like getValue() must be provided by classes using this trait. How about adding it as abstract method to this trait?

This check looks for methods that are used by a trait but not required by it.

To illustrate, let’s look at the following code example

trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

The trait Idable provides a method equalsId that in turn relies on the method getId(). If this method does not exist on a class mixing in this trait, the method will fail.

Adding the getId() as an abstract method to the trait will make sure it is available.

Loading history...
Bug introduced by
It seems like getName() must be provided by classes using this trait. How about adding it as abstract method to this trait?

This check looks for methods that are used by a trait but not required by it.

To illustrate, let’s look at the following code example

trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

The trait Idable provides a method equalsId that in turn relies on the method getId(). If this method does not exist on a class mixing in this trait, the method will fail.

Adding the getId() as an abstract method to the trait will make sure it is available.

Loading history...
35
    }
36
}
37