FuelPHP, a PHP 5.3 Framework Documentation

How To

A simple example on how to use the Pagination class. You can put this inside your action methods in your controller.

$config = array(
	'pagination_url' => 'http://localhost/fuel/welcome/index/',
	'total_items' => 10,
	'per_page' => 5,
	'uri_segment' => 3,
	),
);

// Create a pagination instance named 'mypagination'
$pagination = Pagination::forge('mypagination', $config);

$data['example_data'] = DB::select('id', 'value')->from('pagination')
												->limit($pagination->per_page)
												->offset($pagination->offset)
												->execute()
												->as_array();

$data['pagination'] = $pagination->render();
$this->render('welcome/index', $data);

設定

You can configure the pagination instance in several ways. You can pass an array with the configuration when you forge the instance, or you can update the properties directly on the instance.

The following configuration settings can be defined:

3

5

0

10

null

Templating

Every pagination instance uses a template to generate the HTML needed to create the pagination markup. You can store your standard templates in the config/pagination.php file. Copy the file from the core config folder to your app config folder before you make any modifications. The default configuration file comes with two templates, the FuelPHP default, and a Twitter Bootstrap v2 compatible template.

The following template entries must be defined:

<div class="pagination">\n\t{pagination}\n</div>\n

<span class=\"previous\">\n\t{link}\n</span>\n

\t\t<a href=\"{uri}\">{page}</a>\n

<span class=\"previous-inactive\">\n\t{link}\n</span>\n

\t\t<a href=\"{uri}\">{page}</a>\n

<span>\n\t{link}\n</span>\n

\t\t<a href=\"{uri}\">{page}</a>\n

<span class=\"active\">\n\t{link}\n</span>\n

\t\t<a href=\"{uri}\">{page}</a>\n

<span class=\"next\">\n\t{link}\n</span>\n

\t\t<a href=\"{uri}\">{page}</a>\n

<span class=\"next-inactive\">\n\t{link}\n</span>\n

\t\t<a href=\"{uri}\">{page}</a>\n

In the template, {uri} will be replaced by the generated pagination link, and {page} by the page number or the previous / next marker. If you want to use an image for these markers, just modify the corresponding link definitions in the template, replacing {page} by the markup for the image.

The configuration you pass when you forge the pagination instance will be merged with the default template defined in your configuration file. This will allow you to only pass the values you want to override. If your template in the configuration file is not complete, the default values as mentioned above will be used.

Static interface

For your convinience, the Pagination class also has a static interface that operates on the default instance only.

// fetch the current page number
$page_number = Pagination::get('current_page');

// this is an alias of
$page_number = Pagination::instance()->current_page;

// set the total number of rows
$page_number = Pagination::set('total_items', 610);

// this is an alias of
Pagination::instance()->total_items = 610;

For backward compatibility, the static methods set_config(), create_links(), next_link() and prev_link() will be emulated on the default instance, minimizing the migration effort needed when upgrading an existing application to FuelPHP v1.4+.

Note that there is no possible way to emulate direct access to static class properties at the moment, so if your application uses that, you'll have to change them:

// pre v1.4 usage:
Pagination::$per_page = 10;

// new usage:
Pagination::set('per_page', 10);

// pre v1.4 usage:
Model_Article::find()
	->order_by('date', 'ASC')
	->rows_offset(\Pagination::$offset)
	->rows_limit(\Pagination::$per_page)
	->get());

// new usage:
Model_Article::find()
	->order_by('date', 'ASC')
	->rows_offset(\Pagination::get('offset'))
	->rows_limit(\Pagination::get('per_page'))
	->get());