Document what count() is supposed to return

[greg0ire]

Q	A
Bug fix?	no
New feature?	no
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	none
License	MIT
Doc PR	none

count() could return the number of pages, or the total number of items, or the number of items on the current page. Looking at the doctrine ORM implementation, it looks like it should be the number of items on the current page, so let's document that, maybe it is relied on somewhere?

I'm contributing this on 2.1, but on master the implementation was moved in an abstract class. Here is how it looks:

core/src/Bridge/Doctrine/Orm/AbstractPaginator.php

Lines 71 to 74 in c7e2cda

	public function count(): int
	{
	return iterator_count($this->getIterator());
	}

[dunglas]

We can even remove Paginator Interface.. This comments brings nothing.

[greg0ire]

@dunglas done

[greg0ire]

Does anyone know when this method is supposed to be called by the way? If it is unused, I think it should be removed. I tried throwing an exception in it, and I have yet to see any page break.

[dunglas]

https://github.com/api-platform/core/blob/master/src/Hydra/Serializer/CollectionNormalizer.php#L98 I guess?

[greg0ire]

@dunglas I think you found a bug, because the result is assigned to $data['hydra:totalItems'], but really is the number of items on the current page (at least that what it seems to be based on my tests).

EDIT: Oh sorry I didn't read the whole condition, this is not a bug, it makes some sense.

core/src/Hydra/Serializer/CollectionNormalizer.php

Line 98 in c7e2cda

$data['hydra:totalItems'] = $paginated ? $object->getTotalItems() : count($object);

[greg0ire]

@dunglas but if the object is not $paginated, it does not implement the interface... so... try again :P ?

[dunglas]

Thanks @greg0ire