Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs about configuration request parameter name #38

Merged
merged 1 commit into from Mar 2, 2020

Conversation

peter-gribanov
Copy link
Member

@peter-gribanov peter-gribanov commented Mar 2, 2020

Request parameter name

As default used page as request parameter name. So for first page will be generated / link, for second /?page=2, for third /?page=3 and etc. You can change this parameter name.

Configuration

gpslab_pagination:
    parameter_name: 'p'

Controller

$pagination = new Configuration();
$pagination->setFirstPageLink('/');
$pagination->setPageLink('/?p=%d');
// or you can use callback function
//$pagination->setPageLink(static function (int $number): string {
//    return sprintf('/?p=%d', $number);
//});

Annotations

use Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter;

/**
 * @ParamConverter("pagination", options={"parameter_name": "p"})
 */
public function index(Configuration $pagination): Response
{
    // ...
}

@peter-gribanov peter-gribanov self-assigned this Mar 2, 2020
@peter-gribanov peter-gribanov added this to the Release 1.4.0 milestone Mar 2, 2020
@coveralls
Copy link

Coverage Status

Coverage remained the same at 100.0% when pulling 2adfa56 on peter-gribanov:parameter_name into e54f159 on gpslab:master.

3 similar comments
@coveralls
Copy link

Coverage Status

Coverage remained the same at 100.0% when pulling 2adfa56 on peter-gribanov:parameter_name into e54f159 on gpslab:master.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 100.0% when pulling 2adfa56 on peter-gribanov:parameter_name into e54f159 on gpslab:master.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 100.0% when pulling 2adfa56 on peter-gribanov:parameter_name into e54f159 on gpslab:master.

@peter-gribanov peter-gribanov merged commit a74976d into gpslab:master Mar 2, 2020
@peter-gribanov peter-gribanov deleted the parameter_name branch March 2, 2020 11:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants