Skip to content

[11.x] Improve docblocks for morph maps in Relation #54560

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 11, 2025
Merged

[11.x] Improve docblocks for morph maps in Relation #54560

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9d470b8
add docblocks
cosmastech Feb 11, 2025
927220e
more generics
cosmastech Feb 11, 2025
1c8112e
Update Relation.php
cosmastech Feb 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions src/Illuminate/Database/Eloquent/Relations/Relation.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,9 @@ abstract class Relation implements BuilderContract
protected static $constraints = true;

/**
* An array to map class names to their morph names in the database.
* An array to map morph names to their class names in the database.
*
* @var array
* @var array<string, class-string<\Illuminate\Database\Eloquent\Model>>
*/
public static $morphMap = [];

Expand Down Expand Up @@ -451,7 +451,7 @@ public static function requiresMorphMap()
/**
* Define the morph map for polymorphic relations and require all morphed models to be explicitly mapped.
*
* @param array $map
* @param array<string, class-string<\Illuminate\Database\Eloquent\Model>> $map
* @param bool $merge
* @return array
*/
Expand All @@ -465,9 +465,9 @@ public static function enforceMorphMap(array $map, $merge = true)
/**
* Set or get the morph map for polymorphic relations.
*
* @param array|null $map
* @param array<string, class-string<\Illuminate\Database\Eloquent\Model>>|null $map
* @param bool $merge
* @return array
* @return array<string, class-string<\Illuminate\Database\Eloquent\Model>>
*/
public static function morphMap(?array $map = null, $merge = true)
{
Expand All @@ -484,8 +484,8 @@ public static function morphMap(?array $map = null, $merge = true)
/**
* Builds a table-keyed array from model class names.
*
* @param string[]|null $models
* @return array|null
* @param list<class-string<\Illuminate\Database\Eloquent\Model>>|null $models
* @return array<string, class-string<\Illuminate\Database\Eloquent\Model>>|null
*/
protected static function buildMorphMapFromModels(?array $models = null)
{
Expand All @@ -502,7 +502,7 @@ protected static function buildMorphMapFromModels(?array $models = null)
* Get the model associated with a custom polymorphic type.
*
* @param string $alias
* @return string|null
* @return class-string<\Illuminate\Database\Eloquent\Model>|null
*/
public static function getMorphedModel($alias)
{
Expand All @@ -512,7 +512,7 @@ public static function getMorphedModel($alias)
/**
* Get the alias associated with a custom polymorphic class.
*
* @param string $className
* @param class-string<\Illuminate\Database\Eloquent\Model> $className
* @return int|string
*/
public static function getMorphAlias(string $className)
Expand Down