Zend Framework 2 : Zend\Paginator : Paginate Your Data

Zend Framework has a component named Zend\Paginator. It can paginate items into pages, paginate arbitrary data, not just relational databases, and fetch only the results that need to be displayed.

For example, i have a array data like this :

$dataItems =  array(
                 0 => array('id'=>1, 'name'=>'samsonasik'),
                 1 => array('id'=>2, 'name'=>'abdul malik ikhsan'),
                 2 => array('id'=>3, 'name'=>'superman'),
         );

And route :

'Test' => array(
    'type'    => 'Segment',
    'options' => array(
        // Change this to something specific to your module
        'route'    => '/[:lang]/test[/:page]',
        'defaults' => array(
            '__NAMESPACE__' => 'Test\Controller',
            'controller'    => 'Test',
            'action'        => 'index',
         ),
      ),
      //........
),

and we will access as http://localhost/zf2app/public/en/test/1 or http://localhost/zf2app/public/en/test/2.
First step, we create a Requesthelper view helper for handling GET parameter if passed by url.

namespace Test\View\Helper;
use Zend\View\Helper\AbstractHelper;

class Requesthelper extends AbstractHelper
{
    protected $request;
    
    //get Request
    public function setRequest($request)
    {
        $this->request = $request;    
    }
    
    public function getRequest()
    {
        return $this->request;    
    }
    
    public function __invoke()
    {
        return $this->getRequest()->getServer()->get('QUERY_STRING');     
    }
}

And then, register it and pass Request object :

'Requesthelper' => function($sm){
   $helper = new View\Helper\Requesthelper;
   $request = $sm->getServiceLocator()->get('Request');
   $helper->setRequest($request);
   return $helper;
}

Next, create a file, for example named pager.phtml:
and write the following of codes into pager.pthml :

<?php
$url = $this->url('Test', array('lang'=>$this->lang));
//handle parameter get 🙂
$parameterGet = $this->Requesthelper();
if ($parameterGet != ""){
  $parameterGet = "?".$parameterGet;
}
?>

<?php if ($this->pageCount): ?>
<div class="paginationControl">
    <p>
	    <!--<div style="float:left">-->
      <!-- Previous page link -->
      <?php if (isset($this->previous)): ?>
     <a class="first" href="<?= $url.'/1'; ?>">&lt;&lt; first&nbsp;&nbsp;</a>
     <a class="Previous" href="<?= $url.'/'.$this->previous.$parameterGet; ?>">&lt; prev&nbsp;&nbsp;</a>      
      <?php else: ?>
      <b><i>&lt;&lt; first&nbsp;&nbsp;</i></b>
      <b><i>&lt; prev&nbsp;&nbsp;</i></b>      
      <?php endif; ?>
      <?php foreach ($this->pagesInRange as $page): ?>
      <?php if ($page != $this->current): ?>
        <a class="nopage" href="<?= $url.'/'.$page.$parameterGet; ?>">
      <?= $page; ?>
      </a>&nbsp;
      <?php else: ?>
            <span class="nopage">
      <?= $page; ?>
    </span>
      </b>&nbsp;
      <?php endif; ?>
      <?php endforeach; ?>
      <?php if (isset($this->next)): ?>
      <a class="next" href="<?= $url.'/'.$this->next.$parameterGet; ?>">&nbsp;next &gt;</a>
      <a class="next" href="<?= $url.'/'.$this->pageCount.$parameterGet; ?>">&nbsp;last &gt;&gt;</a>
      <?php else: ?>      	
	   <b><i>&nbsp;next &gt;&nbsp;</i></b>
	   <b><i>&nbsp;last &gt;&gt;&nbsp;</i></b>
      <?php endif; ?>
    </p>
</div>
<?php endif; ?>

Preparation done, so we can set the fake data to test it in the controller and pass the data to the component :

$matches = $this->getEvent()->getRouteMatch();
$page      = $matches->getParam('page', 1);

$dataItems =    array(
      0 => array('id'=>1, 'name'=>'samsonasik'),
      1 => array('id'=>2, 'name'=>'abdul malik ikhsan'),
      2 => array('id'=>3, 'name'=>'superman'),
  );
$paginator = new \Zend\Paginator\Paginator(new
                    \Zend\Paginator\Adapter\ArrayAdapter($dataItems)
              );

$paginator->setCurrentPageNumber($page);
$paginator->setItemCountPerPage(2);

return new ViewModel(array(
   'test' => $paginator,
   'lang' => $matches->getParam('lang','en')
));

So, in View, we can call :

<?php foreach($test as $key=>$row) : ?>
    <?php echo $row['id']; ?> : <?php echo $row['name']; ?> <br />
<?php endforeach; ?>

<?= ( count($test) > 0 ) ? $this->paginationControl($test, 'Sliding', 'pager.phtml', array('lang'=>$lang)) : ""; ?>

[UPDATE]
How about Paginate data from database ?
First, buffer() the resultSet object :

..................
    public function fetchAll()
    {
        $resultSet = $this->select(function (Select $select){
            $select->columns(array('id', 'name'));
            $select->order(array('id asc'));  
        });
        
        $resultSet->buffer();
        $resultSet->next();
         
        return $resultSet; 
     }
...................

And use Iterator adapter :

        $iteratorAdapter = new \Zend\Paginator\Adapter\Iterator($this->getSampleTable()->fetchAll());
        $paginator = new \Zend\Paginator\Paginator($iteratorAdapter);

DONE !