← All results

Generic Generator value type in PHPDoc

Group: Advanced PHPDoc types · Category: ecosystem · File: phpdoc_advanced_generator_generic.php

A four-parameter Generator<TKey, TValue, TSend, TReturn> is widely documented; this file only asks whether the yielded value (TValue) is enforced when one generator is passed where another is required. Key, send, and return channels are a different measurement. References: - PHPStan generic classes and Generator - Psalm generic objects and Generator

Analyzer results

AnalyzerVersionResultDiagnostics
phan 6.0.7Phan 6.0.7 php-ast version 1.1.3 PHP version used to run Phan: 8.5.9 Enforced 
phpdoc_advanced_generator_generic.php:48: Argument 1 ($generator) is integers() of type \Generator|\Generator<int,int,void,bool>|\Iterator|\Traversable|iterable but \Conformance\Tests\PhpdocAdvancedGeneratorGeneric\takesStringGenerator() takes \Generator<int,string,void,bool> defined at /Users/megurine/repo/php/php-typing-conformance/conformance/tests/phpdoc_advanced_generator_generic.php:43 [PhanTypeMismatchArgument]
  • Recognition: spelling resolved
  • Enforcement: 1/1 of the expected violations reported
phpstan 2.2.11PHPStan - PHP Static Analysis Tool 2.2.11 Enforced reported Lv.5+ 
phpdoc_advanced_generator_generic.php:48: Parameter #1 $generator of function Conformance\Tests\PhpdocAdvancedGeneratorGeneric\takesStringGenerator expects Generator<int, string, void, bool>, Generator<int, int, void, bool> given. [reported-from-level=5]
With strict-rules
phpdoc_advanced_generator_generic.php:48: Parameter #1 $generator of function Conformance\Tests\PhpdocAdvancedGeneratorGeneric\takesStringGenerator expects Generator<int, string, void, bool>, Generator<int, int, void, bool> given.
  • Recognition: spelling resolved
  • Enforcement: 1/1 of the expected violations reported
psalm 6.16.1Psalm 6.16.1@f1f5de594dc76faf8784e02d3dc4716c91c6f6ac
next: 7.0.0-beta19		 Enforced 
phpdoc_advanced_generator_generic.php:48: Argument 1 of Conformance\Tests\PhpdocAdvancedGeneratorGeneric\takesStringGenerator expects Generator<int, string, void, bool>, but Generator<int, int, void, bool> provided [InvalidArgument]
  • Recognition: spelling resolved
  • Enforcement: 1/1 of the expected violations reported
mago 1.47.4mago 1.47.4 Enforced 
phpdoc_advanced_generator_generic.php:48: Invalid argument type for argument #1 of `Conformance\Tests\PhpdocAdvancedGeneratorGeneric\takesStringGenerator`: expected `Generator<int, string, void, bool>`, but found `Generator<int, int, void, bool>`. [invalid-argument]
  • Recognition: spelling resolved
  • Enforcement: 1/1 of the expected violations reported
mir 0.72.1mir 0.72.1 Enforced 
phpdoc_advanced_generator_generic.php:48: InvalidArgument: Argument $generator of takesStringGenerator() expects 'Generator<int, string, void, bool>', got 'Generator<int, int, void, bool>' [MIR0201]
  • Recognition: spelling resolved
  • Enforcement: 1/1 of the expected violations reported
phpantom 0.10.0phpantom_lsp 0.10.0 Not enforced

No diagnostics reported.

  • Recognition: spelling resolved
  • Enforcement: 0/1 of the expected violations reported
intelephense 1.18.5intelephense 1.18.5 Not enforced

No diagnostics reported.

  • Recognition: spelling resolved
  • Enforcement: 0/1 of the expected violations reported
phpactor 2026.07.22.0Phpactor 2026.07.22.0 Not enforced

No diagnostics reported.

  • Recognition: spelling resolved
  • Enforcement: 0/1 of the expected violations reported
phpy 0.2.0phpy 0.2.0 Not enforced

No diagnostics reported.

  • Recognition: spelling resolved
  • Enforcement: 0/1 of the expected violations reported
qodana 262.9437.196Qodana 262.9437.196 Not enforced

No diagnostics reported.

  • Recognition: spelling resolved
  • Enforcement: 0/1 of the expected violations reported
noverify 0.5.5NoVerify, version 0.5.5: built on: 2025.04.22 14:36:46 OS: r-kuchinskas arm64 Commit: 4774b82f8adc53fbef38f95e97af4b953b4d1529 Unrecognized 
phpdoc_advanced_generator_generic.php:43: param $generator miss matched with phpdoc type <<\Generator<int, string, void, bool>>> [funcParamTypeMissMatch]
  • Recognition: spelling not resolved — reported on declaration line(s) 43
  • Enforcement: 0/1 of the expected violations reported — incidental, since the spelling was not resolved
steins 0.1.6steins 0.1.6 (2026-08-25 revision c13b4c7) Not enforced

No diagnostics reported.

  • Recognition: spelling resolved
  • Enforcement: 0/1 of the expected violations reported
phpstan-strict 2.2.11PHPStan - PHP Static Analysis Tool 2.2.11 Enforced 
phpdoc_advanced_generator_generic.php:48: Parameter #1 $generator of function Conformance\Tests\PhpdocAdvancedGeneratorGeneric\takesStringGenerator expects Generator<int, string, void, bool>, Generator<int, int, void, bool> given.
  • Recognition: spelling resolved
  • Enforcement: 1/1 of the expected violations reported
psalm-next 7.0.0-beta19Psalm 7.0.0-beta19@7e751c06a756fa64dc4c759c09fe4a173afcb433 Enforced 
phpdoc_advanced_generator_generic.php:48: Argument 1 of Conformance\Tests\PhpdocAdvancedGeneratorGeneric\takesStringGenerator expects Generator<int, string, void, bool>, but Generator<int, int, void, bool> provided [InvalidArgument]
  • Recognition: spelling resolved
  • Enforcement: 1/1 of the expected violations reported

Source

<?php

declare(strict_types=1);

namespace Conformance\Tests\PhpdocAdvancedGeneratorGeneric;

/**
 * Generic `Generator` value type in PHPDoc.
 *
 * A four-parameter `Generator<TKey, TValue, TSend, TReturn>` is widely
 * documented; this file only asks whether the yielded value (`TValue`) is
 * enforced when one generator is passed where another is required. Key, send,
 * and return channels are a different measurement.
 *
 * References:
 * - PHPStan generic classes and Generator
 * - Psalm generic objects and Generator
 */

/**
 * @return \Generator<int, string, void, bool>
 */
function strings(): \Generator // T: \Generator<int, string, void, bool>
{
    yield 'value';

    return true;
}

/**
 * @return \Generator<int, int, void, bool>
 */
function integers(): \Generator // T: \Generator<int, int, void, bool>
{
    yield 1;

    return true;
}

/**
 * @param \Generator<int, string, void, bool> $generator
 */
function takesStringGenerator(\Generator $generator): void // T: \Generator<int, string, void, bool>
{
}

takesStringGenerator(strings()); // V
takesStringGenerator(integers()); // E?: a Generator yielding integers is not a Generator yielding strings