Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sampart/whiteoctoberpagerfantabundle
Bundle to use Pagerfanta with Symfony
https://github.com/sampart/whiteoctoberpagerfantabundle
pagerfanta php symfony-bundle
Last synced: 13 days ago
JSON representation
Bundle to use Pagerfanta with Symfony
- Host: GitHub
- URL: https://github.com/sampart/whiteoctoberpagerfantabundle
- Owner: sampart
- License: other
- Archived: true
- Created: 2011-04-26T18:57:47.000Z (almost 14 years ago)
- Default Branch: master
- Last Pushed: 2020-11-15T19:32:54.000Z (about 4 years ago)
- Last Synced: 2024-05-19T10:10:05.427Z (9 months ago)
- Topics: pagerfanta, php, symfony-bundle
- Language: PHP
- Homepage:
- Size: 202 KB
- Stars: 469
- Watchers: 31
- Forks: 110
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: code_of_conduct.md
Awesome Lists containing this project
README
This project is no longer maintained. If you are using it with Symfony 3.4, 4.4 or 5, you may want to use [this fork](https://github.com/BabDev/BabDevPagerfantaBundle) instead.
# WhiteOctoberPagerfantaBundle
[](https://travis-ci.org/whiteoctober/WhiteOctoberPagerfantaBundle) [](https://scrutinizer-ci.com/g/whiteoctober/WhiteOctoberPagerfantaBundle/) [](https://insight.sensiolabs.com/projects/e0838383-1c8d-406f-9874-a76c08b7d217)
Bundle to use [Pagerfanta](https://github.com/whiteoctober/Pagerfanta) with [Symfony](https://github.com/symfony/symfony).
**Note:** If you are using a 2.0.x release of Symfony2, please use the `symfony2.0` branch of this bundle. The master branch of this bundle tracks the Symfony master branch.
The bundle includes:
* Twig function to render pagerfantas with views and options.
* Way to use easily views.
* Way to reuse options in views.
* Basic CSS for the DefaultView.
Installation
------------
1) Use [Composer](https://getcomposer.org/) to download the library
```
php composer.phar require white-october/pagerfanta-bundle
```
2) Then add the WhiteOctoberPagerfantaBundle to your application:
In Symfony < 4:
```php
// app/AppKernel.php
public function registerBundles()
{
return array(
// ...
new WhiteOctober\PagerfantaBundle\WhiteOctoberPagerfantaBundle(),
// ...
);
}
```
In Symfony 4 with Symfony Flex this will be done automatically for you.
3) Configure and use things!
A) **Creating a Pager** is shown on the [Pagerfanta](https://github.com/whiteoctober/Pagerfanta) documentation. If you're using the Doctrine ORM, you'll want to use the [DoctrineORMAdapter](https://github.com/whiteoctober/Pagerfanta#doctrineormadapter)
B) **Rendering in Twig** is shown below in the [Rendering Pagerfantas](#rendering-pagerfantas) section.
C) **Configuration** is shown through this document
Rendering Pagerfantas
---------------------
First, you'll need to pass an instance of Pagerfanta as a parameter into your template.
For example:
```php
$adapter = new DoctrineORMAdapter($queryBuilder);
$pagerfanta = new Pagerfanta($adapter);
return $this->render('@YourApp/Main/example.html.twig', [
'my_pager' => $pagerfanta,
]);
```
You then call the the Pagerfanta Twig extension, passing in the Pagerfanta instance.
The routes are generated automatically for the current route using the variable "page" to propagate the page number.
By default, the bundle uses the *DefaultView* with the *default* name. The default syntax is:
```twig
{{ pagerfanta(my_pager) }}
```
By default, the "page" variable is also added for the link to the first page. To
disable the generation of `?page=1` in the url, simply set the `omitFirstPage` option
to `true` when calling the `pagerfanta` twig function:
```
{{ pagerfanta(my_pager, 'default', { 'omitFirstPage': true}) }}
```
You can omit template parameter to make function call shorter, default template will be used:
```
{{ pagerfanta(my_pager, { 'omitFirstPage': true }) }}
```
If you have multiple pagers on one page, you'll need to change the name of the `page` parameter.
Here's an example:
```twig
{{ pagerfanta(my_other_pager, 'default', {'pageParameter': '[page_other]'}) }}
```
Note the square brackets around `page_other`; this won't work without them.
### Twitter Bootstrap
The bundle also has a Twitter Bootstrap view.
For Bootstrap 2:
```twig
{{ pagerfanta(my_pager, 'twitter_bootstrap') }}
```
For Bootstrap 3:
```twig
{{ pagerfanta(my_pager, 'twitter_bootstrap3') }}
```
For Bootstrap 4:
```twig
{{ pagerfanta(my_pager, 'twitter_bootstrap4') }}
```
### Custom template
If you want to use a custom template, add another argument:
```twig
{{ pagerfanta(my_pager, 'my_template') }}
```
With options:
```twig
{{ pagerfanta(my_pager, 'default', { 'proximity': 2}) }}
```
See the [Pagerfanta documentation](https://github.com/whiteoctober/Pagerfanta) for the list of possible parameters.
Rendering the page of items itself
----------------------------------
The items can be retrieved using `currentPageResults`. For example:
```twig
{% for item in my_pager.currentPageResults %}
- {{ item.id }}
{% endfor %}
```
Translate in your language
--------------------------
The bundle also offers two views to translate the *default* and the
*twitter bootstrap* views.
```twig
{{ pagerfanta(my_pager, 'default_translated') }}
{{ pagerfanta(my_pager, 'twitter_bootstrap_translated') }}
```
Adding Views
------------
The views are added to the container with the *pagerfanta.view* tag:
XML
```xml
```
YAML
```yml
services:
pagerfanta.view.default:
class: Pagerfanta\View\DefaultView
public: false
tags: [{ name: pagerfanta.view, alias: default }]
```
Reusing Options
---------------
Sometimes you want to reuse options of a view in your project, and you don't
want to write them all the times you render a view, or you can have different
configurations for a view and you want to save them in a place to be able to
change them easily.
For this you have to define views with the special view *OptionableView*:
```yml
services:
pagerfanta.view.my_view_1:
class: Pagerfanta\View\OptionableView
arguments:
- @pagerfanta.view.default
- { proximity: 2, prev_message: Anterior, next_message: Siguiente }
public: false
tags: [{ name: pagerfanta.view, alias: my_view_1 }]
pagerfanta.view.my_view_2:
class: Pagerfanta\View\OptionableView
arguments:
- @pagerfanta.view.default
- { proximity: 5 }
public: false
tags: [{ name: pagerfanta.view, alias: my_view_2 }]
```
And using then:
```twig
{{ pagerfanta(my_pager, 'my_view_1') }}
{{ pagerfanta(my_pager, 'my_view_2') }}
```
The easiest way to render pagerfantas (or paginators!) ;)
Basic CSS for the default view
------------------------------
The bundles comes with basic CSS for the default view so you can get started with a good paginator faster.
Of course you can change it, use another one or create your own view.
```html
```
Configuration
-------------
It's possible to configure the default view for all rendering in your
configuration file:
```yml
white_october_pagerfanta:
default_view: my_view_1
```
Making bad page numbers return a HTTP 500
-----------------------------------------
Right now when the page is out of range or not a number,
the server returns a 404 response by default.
You can set the following parameters to different than default value
`to_http_not_found` (ie. null) to show a 500 exception when the
requested page is not valid instead.
```yml
// app/config/config.yml
white_october_pagerfanta:
exceptions_strategy:
out_of_range_page: ~
not_valid_current_page: ~
```
More information
----------------
For more advanced documentation, check the [Pagerfanta documentation](https://github.com/whiteoctober/Pagerfanta/blob/master/README.md).
Contributing
-------------
We welcome contributions to this project, including pull requests and issues (and discussions on existing issues).
If you'd like to contribute code but aren't sure what, the [issues list](https://github.com/whiteoctober/WhiteOctoberPagerfantaBundle/issues) is a good place to start.
If you're a first-time code contributor, you may find Github's guide to [forking projects](https://guides.github.com/activities/forking/) helpful.
All contributors (whether contributing code, involved in issue discussions, or involved in any other way) must abide by our [code of conduct](code_of_conduct.md).
Acknowledgements
-----------------
Pablo Díez ([email protected]) for most of the work on the first versions of this bundle.
This project was originally located at https://github.com/whiteoctober/WhiteOctoberPagerfantaBundle.
License
-------
Pagerfanta is licensed under the MIT License. See the LICENSE file for full
details.