Extending Collection causes infinite loop

[LordSimal]

Description

Original Thread: https://discourse.cakephp.org/t/extended-collection-class-not-behaving-the-same-as-base-collection-class/11734

As can be seen in the mentioned forum link (thanks @Zuluru) if one extends a collection it behaves differently (in this specific case it causes an infinite loop)

I'll just copy/paste the example in here:

<?php
namespace App\Test\TestCase;

use Cake\Collection\Collection;
use PHPUnit\Framework\TestCase;

class MyCollection extends Collection { }

class CollectionTest extends TestCase
{
    public function testIterators(): void {
        $records = [
            ['field' => true],
            ['field' => false],
            ['field' => true],
        ];

        $collection = new MyCollection($records);
        $count = 0;
        foreach ($collection as $investment) {
            $count ++;
            if ($count > 20) {
                break;
            }
            if ($collection->every(fn ($record) => $record['field'] === true)) {
                // Nothing, really, just need to execute the every() call
            }
        }

        $this->assertEquals(3, $count);
    }
}

if you change new MyCollection to new Collection it works just fine.

My guess is related to this line: https://github.com/cakephp/cakephp/blob/5.x/src/Collection/CollectionTrait.php#L937

But I don't use collections and have not yet doven into this black magic.

CakePHP Version

5.0.3

PHP Version

8.2

[othercorey]

Looks like that assumes Collection. I'm not a big fan of these traits, but think we can fix this.

[othercorey]

Extending Collection outside of cake is not possible because we have logic that work sonly for Collection and only for the custom iterators that extend Collection like ExtractIterator.

Because ExtractIterator overrides, unwrap(), we cannot call getInnerIterator() on it.

[Zuluru]

Well, that's unfortunate. :-( I'll have to try to think of a way to encapsulate it instead of extending, I guess. The class should probably be marked as final?

[othercorey]

We have to change the iterators to not extend Collection to mark it final.

Will keep this open while we look into if the interfaces or inheritance can change in 5.1.

[github-actions]

This issue is stale because it has been open for 120 days with no activity. Remove the stale label or comment or this will be closed in 15 days