Finish adding return type declarations to phpdoc

[franmomu]

Q	A
Type	improvement
BC Break	no
Fixed issues

Summary

This is the last PR adding return type declarations (I'll create a couple for parameter type declarations), there is one change in GraphLookup:: convertTargetFieldName, this method is called in:

mongodb-odm/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/GraphLookup.php

Lines 92 to 106 in 38fc494

	public function connectFromField(string $connectFromField): self
	{
	// No targetClass mapping - simply use field name as is
	if (! $this->targetClass) {
	$this->connectFromField = $connectFromField;
	return $this;
	}
	// connectFromField doesn't have to be a reference - in this case, just convert the field name
	if (! $this->targetClass->hasReference($connectFromField)) {
	$this->connectFromField = $this->convertTargetFieldName($connectFromField);
	return $this;
	}

and

mongodb-odm/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/GraphLookup.php

Lines 123 to 128 in 38fc494

	public function connectToField(string $connectToField): self
	{
	$this->connectToField = $this->convertTargetFieldName($connectToField);
	return $this;
	}

In both calls the argument is a string, so it will never be an array.

[malarzm]

why do we need these?

[franmomu]

For the inheritDoc cases, I was getting these errors:

FILE: lib/Doctrine/ODM/MongoDB/Iterator/PrimingIterator.php
-----------------------------------------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
-----------------------------------------------------------------------------------------------------------------------------------------------------------
 47 | ERROR | Method \Doctrine\ODM\MongoDB\Iterator\PrimingIterator::current() does not have return type hint nor @return annotation for its return value.
-----------------------------------------------------------------------------------------------------------------------------------------------------------

I remember reading about phpcs that performs analysis by file, so it doesn't get that information from the parent, I'll see if there is a way to avoid this.

[franmomu]

slevomat/coding-standard#1149 🤔 the only thing I can think of is that we can try to reach level 5 of phpstan that checks missing type declarations and remove this sniff.

[malarzm]

The good thing is that we're already on level 5 :) https://github.com/doctrine/mongodb-odm/blob/2.2.x/phpstan.neon.dist#L5

[franmomu]

Level 6 sorry 😞

[malarzm]

Dang, so close. Personally I'd rather not clutter the code with useless inheritdoc just to satisfy CS Fixer. How about merging all the other changes, still keep the rule as excluded, and work towards level 6? I'd also much appreciate @alcaeus input on this

[franmomu]

I don't like inheritdoc either, I'm fine keeping the rule excluded. Should I remove all the inheritdoc? (apart from the ones added in this PR) 🤔

[malarzm]

👍 for removing all @inheritDocs

[franmomu]

friendly ping @malarzm if you could take a look, the @inheritDoc blocks have been removed

PS: if you have more time (and feel like reviewing) you can also take a look at #2369 😬

[malarzm]

Thanks @franmomu and sorry for keeping you waiting 🎉