You are here

Home » API reference » Examples for Developers 7 » pager_example.module

function pager_example_page in Examples for Developers 7

Build the pager query.

Uses the date_formats table since it is installed with ~35 rows in it and we don't have to create fake data in order to show this example.

Return value

array A render array completely set up with a pager.

Related topics

Example: Pager
Example of a results pager.
1 string reference to 'pager_example_page'
pager_example_menu in pager_example/pager_example.module
Implements hook_menu().

File

pager_example/pager_example.module, line 54
This is an example describing how a module can implement a pager in order to reduce the number of output rows to the screen and allow a user to scroll through multiple screens of output.

Code

function pager_example_page() {

  // We are going to output the results in a table with a nice header.
  $header = array(
    array(
      'data' => t('DFID'),
    ),
    array(
      'data' => t('Format'),
    ),
    array(
      'data' => t('Type'),
    ),
  );

  // We are extending the PagerDefault class here.
  // It has a default of 10 rows per page.
  // The extend('PagerDefault') part here does all the magic.
  $query = db_select('date_formats', 'd')
    ->extend('PagerDefault');
  $query
    ->fields('d', array(
    'dfid',
    'format',
    'type',
  ));

  // Change the number of rows with the limit() call.
  $result = $query
    ->limit(10)
    ->orderBy('d.dfid')
    ->execute();
  $rows = array();
  foreach ($result as $row) {

    // Normally we would add some nice formatting to our rows
    // but for our purpose we are simply going to add our row
    // to the array.
    $rows[] = array(
      'data' => (array) $row,
    );
  }

  // Create a render array ($build) which will be themed as a table with a
  // pager.
  $build['pager_table'] = array(
    '#theme' => 'table',
    '#header' => $header,
    '#rows' => $rows,
    '#empty' => t('There are no date formats found in the db'),
  );

  // Attach the pager theme.
  $build['pager_pager'] = array(
    '#theme' => 'pager',
  );
  return $build;
}