More types for PHPStan.

Author: johnbillion

src/Doc.php

@@ -60,6 +60,7 @@ public function getTags(): Tags {
 
 	/**
 	 * @return array<int, Tag>
+	 * @phpstan-return list<Tag>
 	 */
 	public function getParams(): array {
 		return $this->getTags()->getParams();

src/Hook.php

@@ -85,6 +85,7 @@ public function getArgs(): int {
 
 	/**
 	 * @return array<int, Tag>
+	 * @phpstan-return list<Tag>
 	 */
 	public function getParams(): array {
 		return $this->getDoc()->getParams();

src/Hooks.php

@@ -57,13 +57,15 @@ public function getIterator(): \Generator {
 
 	/**
 	 * @return array<int, Hook>
+	 * @phpstan-return list<Hook>
 	 */
 	public function all(): array {
 		return iterator_to_array( $this );
 	}
 
 	/**
 	 * @return array<int, Hook>
+	 * @phpstan-return list<Hook>
 	 */
 	public function filter( string $search ): array {
 		$hooks = [];

src/Tag.php

@@ -7,7 +7,7 @@
  * @phpstan-type TagArray array{
  *   name: string,
  *   content: string,
- *   types?: array<int, string>,
+ *   types?: list<string>,
  *   variable?: string,
  *   link?: string,
  *   refers?: string,
@@ -27,6 +27,7 @@ final class Tag {
 
 	/**
 	 * @var ?array<int, string>
+	 * @phpstan-var ?list<string>
 	 */
 	protected $types;
 

src/Tags.php

@@ -11,6 +11,7 @@
 final class Tags implements \Countable, \IteratorAggregate {
 	/**
 	 * @var array<int, Tag>
+	 * @phpstan-var list<Tag>
 	 */
 	protected $tags;
 
@@ -36,13 +37,15 @@ public function getIterator(): \Traversable {
 
 	/**
 	 * @return array<int, Tag>
+	 * @phpstan-return list<Tag>
 	 */
 	public function all(): array {
 		return iterator_to_array( $this );
 	}
 
 	/**
 	 * @return array<int, Tag>
+	 * @phpstan-return list<Tag>
 	 */
 	public function getParams(): array {
 		$params = [];

tests/phpunit/HooksTest.php

@@ -52,6 +52,10 @@ public function testFindByUnknownNameReturnsNull(): void {
 
 	/**
 	 * @return array<string, array<int, string>>
+	 * @phpstan-return array{
+	 *   actions: list<string>,
+	 *   filters: list<string>,
+	 * }
 	 */
 	public function dataCoreVendorPaths(): array {
 		$dir = dirname( __DIR__, 2 );
@@ -72,6 +76,10 @@ public function dataCoreVendorPaths(): array {
 
 	/**
 	 * @return array<string, array<int, string>>
+	 * @phpstan-return array{
+	 *   actions: list<string>,
+	 *   filters: list<string>,
+	 * }
 	 */
 	public function dataCoreFiles(): array {
 		$dir = dirname( __DIR__, 2 ) . '/vendor/wp-hooks/wordpress-core/hooks';