PersistentCollection::removeElement() returns object or NULL instead of boolean

[holtkamp]

When using strict typing in PHP 7.0.4: declare (strict_types = 1); , I noticed that an error is returned for userland code like

public function removeUser(User $user) : bool
{
    return $this->users->removeElement($user);
}

This results in an error message like:

Return value of Project\Entity::removeUser() must be of the type boolean, object returned

I had a look at all removeElement() functions used in the project and I suspect this section

Will try to come up with a test but already wanted to register this issue so I will not forget it.

UPDATE
It appears that this can be tested in ExtraLazyCollectionTest::testRemoveElementManyToMany():

        $result = $user->groups->removeElement($group);
        $this->assertTrue($result);

However, this made me wonder, why does this part returns NULL while the Collection interface indicates it should return a boolean? Is returning the element/null on purpose?

[holtkamp]

Anything else I can do to resolve this issue?

[Ocramius]

@holtkamp see #6550