Merge pull request #7254 from kenjis/fix-phpdoc-model

samsonasik · web-flow · commit 356c0b9630b9 · 2023-02-15T21:15:49.000+07:00
docs: improve PHPDoc for model()
diff --git a/system/Common.php b/system/Common.php
@@ -817,11 +817,12 @@ function log_message(string $level, string $message, array $context = [])
     /**
      * More simple way of getting model instances from Factories
      *
-     * @template T of Model
+     * @template ModelTemplate of Model
      *
-     * @param class-string<T> $name
+     * @param class-string<ModelTemplate>|string $name
      *
-     * @return T
+     * @return ModelTemplate|null
+     * @phpstan-return ($name is class-string<ModelTemplate> ? ModelTemplate : object|null)
      */
     function model(string $name, bool $getShared = true, ?ConnectionInterface &$conn = null)
     {

Original file line number	Diff line number	Diff line change
`@@ -817,11 +817,12 @@ function log_message(string $level, string $message, array $context = [])`
`817`	`817`	`/**`
`818`	`818`	`* More simple way of getting model instances from Factories`
`819`	`819`	`*`
`820`		`- * @template T of Model`
	`820`	`+ * @template ModelTemplate of Model`
`821`	`821`	`*`
`822`		`- * @param class-string<T> $name`
	`822`	`+ * @param class-string<ModelTemplate>\|string $name`
`823`	`823`	`*`
`824`		`- * @return T`
	`824`	`+ * @return ModelTemplate\|null`
	`825`	`+ * @phpstan-return ($name is class-string<ModelTemplate> ? ModelTemplate : object\|null)`
`825`	`826`	`*/`
`826`	`827`	`function model(string $name, bool $getShared = true, ?ConnectionInterface &$conn = null)`
`827`	`828`	`{`