Issues (121)

src/Model/Changelog/DefaultChangelogStatus.php (1 issue)

1
<?php
2
3
declare(strict_types=1);
4
5
namespace Inspirum\Balikobot\Model\Changelog;
6
7
use Inspirum\Arrayable\BaseModel;
8
9
/**
10
 * @extends \Inspirum\Arrayable\BaseModel<string,string>
11
 */
12
final class DefaultChangelogStatus extends BaseModel implements ChangelogStatus
13
{
14 7
    public function __construct(
15
        private readonly string $name,
16
        private readonly string $description,
17
    ) {
18 7
    }
19
20 1
    public function getName(): string
21
    {
22 1
        return $this->name;
23
    }
24
25 1
    public function getDescription(): string
26
    {
27 1
        return $this->description;
28
    }
29
30
    /** @inheritDoc */
31 4
    public function __toArray(): array
32
    {
33 4
        return [
0 ignored issues
show
Bug Best Practice introduced by
The expression return array('name' => $... => $this->description) returns the type array<string,string> which is incompatible with the return type mandated by Inspirum\Arrayable\BaseModel::__toArray() of Inspirum\Arrayable\TValue[].

In the issue above, the returned value is violating the contract defined by the mentioned interface.

Let's take a look at an example:

interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
Loading history...
34 4
            'name' => $this->name,
35 4
            'description' => $this->description,
36 4
        ];
37
    }
38
}
39