PHPDoc & Psalm - Annotate an "array of classes"

Question

In my code I created an EventFactory like this:

private array $events = [
    'post_created' => PostCreatedEvent::class,
    'exercise_executed' => ExerciseExecutedEvent::class,
];

public function fromTopicAndData(string $topic, array $data) : Event
{
    if (! array_key_exists($topic, $this->events)) {
        throw new Exception('Invalid Topic');
    }

    $event = ($this->events)[$topic];
    return $event::createFromData($data);
}

Both PostCreatedEvent and ExerciseExecutedEvent extends an abstract class Event.

Can you tell me if there is a way to annotate the array in such a way as not to receive error from Psalm?

weirdan · Accepted Answer · 2021-12-21 17:53:45Z

2

Assuming Event class declares createFromData() method the following docblock should do the trick:

/** @var array<string, class-string<Event>> */
private array $events = [
    'post_created' => PostCreatedEvent::class,
    'exercise_executed' => ExerciseExecutedEvent::class,
];

Live demo: https://psalm.dev/r/da11fc8d8c

answered Dec 21, 2021 at 17:53

weirdan

2,67725 silver badges28 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

PHPDoc & Psalm - Annotate an "array of classes"

1 Answer 1

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related