[mixerapi/collection-view] Feature Request : Ability to display Current Page Number

[angelxmoreno]

Description

I am using a custom CollectionView configuration to modify the structure of the paginated JSON response. Below is the configuration file I am using:

<?php
return [
    'CollectionView' => [
        'collection' => '{{collection}}', // array that holds pagination data
        'collection.url' => '{{url}}', // URL of the current page
        'collection.count' => '{{count}}', // items on this page
        'collection.page' => '{{page}}', // current page number
        'collection.pages' => '{{pages}}', // total pages
        'collection.total' => '{{total}}', // total records in the database
        'collection.next' => '{{next}}', // next page URL
        'collection.prev' => '{{prev}}', // previous page URL
        'collection.first' => '{{first}}', // first page URL
        'collection.last' => '{{last}}', // last page URL
        'data' => '{{data}}', // the collection of data
    ]
];

However, when I try to use this configuration, I get a response that still displays the placeholder {{page}} instead of the current page number:

{
    "collection": {
        "url": "/account-transactions?account_id=2&transactionDuration=all&page=1",
        "count": 20,
        "page": "{{page}}",
        "pages": 26,
        "total": 501,
        "next": "/account-transactions?account_id=2&transactionDuration=all&page=2",
        "prev": "",
        "first": "/account-transactions?account_id=2&transactionDuration=all&page=1",
        "last": "/account-transactions?account_id=2&transactionDuration=all&page=26"
    }
}

Steps to Reproduce

1. Create a config/collection_view.php file and use the custom configuration mentioned above.
2. Access a paginated endpoint in your application.
3. Observe that the response includes the literal placeholder {{page}} instead of the actual page number.

Expected Behavior

The collection.page key should be replaced by the current page number in the JSON response, such as:

json
{
    "page": 1
}

Actual Behavior

The response displays the placeholder value {{page}} instead of the actual page number.

Potential Cause

It appears that the Serializer class does not correctly handle the custom collection.page key. Looking at the Serializer class, it seems that the collection() method does not properly replace the placeholder {{page}} with the correct value.

Additional Context

Here's the relevant snippet from the Serializer class:

php
if ($this->paginator instanceof PaginatorHelper) {
    $return[$collection][$next] = $this->paginator->next();
    $return[$collection][$prev] = $this->paginator->prev();
    $return[$collection][$first] = $this->paginator->first();
    $return[$collection][$last] = $this->paginator->last();
    $return[$collection][$pages] = $this->paginator->total();
    $return[$collection][$total] = intval($this->paginator->param('totalCount'));
    $return[$collection]['page'] = $this->paginator->param('page'); // This line should replace {{page}}
}

[cnizzardini]

Can you provide version information for php, mixerapi and cakephp?

[angelxmoreno]

PHP v7.4.33
CakePHP v4.5.7
Mixerapi v0.3.0

I am aware that I am on an older version of MixerApi but it is using the latest version of MixerApi/CollectionView. Look at CollectionView's Serializer class, I do not see where it passes "page" as a value:

https://github.com/mixerapi/collection-view/blob/master/src/Serializer.php#L112

Would you happen to know if the latest version of MixerApi use something other than MixerApi/CollectionView to render the pagination?

[cnizzardini]

Well, mixing and matching versions like that...IDK mate. Pretty certain the newer version is using CollectionView as well.

In anycase, where are you getting the idea that {{page}} is supported? I don't see that I listed that in the documentation https://github.com/mixerapi/collection-view

# config/collection_view.php
return [
    'CollectionView' => [
        'pagination' => '{{collection}}', // array that holds pagination data
        'pagination.url' => '{{url}}', // url of current page
        'pagination.count' => '{{count}}', // items on the page
        'pagination.total' => '{{total}}', // total database records
        'pagination.pages' => '{{pages}}', // total pages
        'pagination.next' => '{{next}}', // next page url
        'pagination.prev' => '{{prev}}', // previous page url
        'pagination.first' => '{{first}}', // first page url
        'pagination.last' => '{{last}}', // last page url
        'items' => '{{data}}', // the collection of data
    ]
];

And I don't see it in the source... https://github.com/mixerapi/collection-view/blob/master/src/Configuration.php#L18

Should this be a bug report that this is not throwing an exception for a unexpected setting instead? Followed by you creating a feature request?

[angelxmoreno]

@cnizzardini i do not see where it is supported but is it not a pagination view ? Cake's pagination view has page. Come to think of it, this issue should be a feature request and not a bug :-P