30.2. Usage
发布于 2015-10-07 09:48:04 | 199 次阅读 | 评论: 0 | 来源: 网络整理
In order to paginate items into pages, Zend_Paginator
must have a generic way of accessing that data. For that reason,
all data access takes place through data source adapters. Several
adapters ship with Zend Framework by default:
表 30.1. Adapters for Zend_Paginator
| Adapter | Description |
|---|---|
| Array | Use a PHP array |
| DbSelect |
Use a Zend_Db_Select
instance, which will return an array
|
| DbTableSelect |
Use a Zend_Db_Table_Select
instance, which will return an instance of
Zend_Db_Table_Rowset_Abstract.
This provides additional information about the
result set, such as column names.
|
| Iterator |
Use an Iterator
instance
|
| Null |
Do not use Zend_Paginator to manage
data pagination. You can still take advantage of
the pagination control feature.
|
![[注意]](http://www.php100.com/manual/ZendFramework/images/note.png) |
注意 |
|---|---|
|
Instead of selecting every matching row of a given query, the DbSelect and DbTableSelect adapters retrieve only the smallest amount of data necessary for displaying the current page.
Because of this, a second query is dynamically generated to
determine the total number of matching rows. However, it is
possible to directly supply a count or count query yourself.
See the |
To create an instance of Zend_Paginator, you must
supply an adapter to the constructor:
$paginator = new Zend_Paginator(new Zend_Paginator_Adapter_Array($array));
For convenience, you may take advantage of the static
factory() method for the adapters packaged with Zend
Framework:
$paginator = Zend_Paginator::factory($array);
|
注意 |
|---|---|
In the case of the Null adapter, in lieu of a data collection you must supply an item count to its constructor. |
Although the instance is technically usable in this state, in your controller action you'll need to tell the paginator what page number the user requested. This allows him to advance through the paginated data.
$paginator->setCurrentPageNumber($page);
The simplest way to keep track of this value is through a URL.
Although we recommend using a
Zend_Controller_Router_Interface-compatible
router to handle this, it is not a requirement.
The following is an example route you might use in an INI configuration file:
routes.example.route = articles/:articleName/:page
routes.example.defaults.controller = articles
routes.example.defaults.action = view
routes.example.defaults.page = 1
routes.example.reqs.articleName = \w+
routes.example.reqs.page = \d+
With the above route (and using Zend Framework MVC components), you might set the current page number like this:
$paginator->setCurrentPageNumber($this->_getParam('page'));
There are other options available; see Configuration for more on them.
Finally, you'll need to assign the paginator instance to your view.
If you're using Zend_View with the ViewRenderer action
helper, the following will work:
$this->view->paginator = $paginator;
The view script is used to render the page items (if you're using
Zend_Paginator to do so) and display the pagination
control.
Because Zend_Paginator implements the SPL interface
IteratorAggregate,
looping over your items and displaying them is simple.
<html>
<body>
<h1>Example</h1>
<?php if (count($this->paginator)): ?>
<ul>
<?php foreach ($this->paginator as $item): ?>
<li><?= $item; ?></li>
<?php endforeach; ?>
</ul>
<?php endif; ?>
<?= $this->paginationControl($this->paginator, 'Sliding', 'my_pagination_control.phtml'); ?>
</body>
</html>
Notice the view helper call near the end. PaginationControl accepts up to four parameters: the paginator instance, a scrolling style, a view partial, and an array of additional parameters.
The second and third parameters are very important. Whereas the view partial is used to determine how the pagination control should look, the scrolling style is used to control how it should behave. Say the view partial is in the style of a search pagination control, like the one below:
What happens when the user clicks the "next" link a few times? Well, any number of things could happen. The current page number could stay in the middle as you click through (as it does on Yahoo!), or it could advance to the end of the page range and then appear again on the left when the user clicks "next" one more time. The page numbers might even expand and contract as the user advances (or "scrolls") through them (as they do on Google).
There are four scrolling styles packaged with Zend Framework:
表 30.2. Scrolling styles for Zend_Paginator
| Scrolling style | Description |
|---|---|
| All | Returns every page. This is useful for dropdown menu pagination controls with relatively few pages. In these cases, you want all pages available to the user at once. |
| Elastic | A Google-like scrolling style that expands and contracts as a user scrolls through the pages. |
| Jumping | As users scroll through, the page number advances to the end of a given range, then starts again at the beginning of the new range. |
| Sliding | A Yahoo!-like scrolling style that positions the current page number in the center of the page range, or as close as possible. This is the default style. |
The fourth and final parameter is reserved for an optional
associative array of additional variables that you want available
in your view partial (available via $this). For
instance, these values could include extra URL parameters for
pagination links.
By setting the default view partial, default scrolling style, and view instance, you can eliminate the calls to PaginationControl completely:
Zend_Paginator::setDefaultScrollingStyle('Sliding');
Zend_View_Helper_PaginationControl::setDefaultViewPartial('my_pagination_control.phtml');
$paginator->setView($view);
When all of these values are set, you can render the pagination control inside your view script with a simple echo statement:
<?= $this->paginator; ?>
|
注意 |
|---|---|
|
Of course, it's possible to use
$smarty->assign('pages', $paginator->getPages());
You could then access paginator values from a template like so:
{$pages.pageCount}
|
The following example pagination controls will hopefully help you get started:
Search pagination
<!--
See http://developer.yahoo.com/ypatterns/pattern.php?pattern=searchpagination
-->
<?php if ($this->pageCount): ?>
<div class="paginationControl">
<!-- Previous page link -->
<?php if (isset($this->previous)): ?>
<a href="<?= $this->url(array('page' => $this->previous)); ?>">< Previous</a> |
<?php else: ?>
<span class="disabled">< Previous</span> |
<?php endif; ?>
<!-- Numbered page links -->
<?php foreach ($this->pagesInRange as $page): ?>
<?php if ($page != $this->current): ?>
<a href="<?= $this->url(array('page' => $page)); ?>"><?= $page; ?></a> |
<?php else: ?>
<?= $page; ?> |
<?php endif; ?>
<?php endforeach; ?>
<!-- Next page link -->
<?php if (isset($this->next)): ?>
<a href="<?= $this->url(array('page' => $this->next)); ?>">Next ></a>
<?php else: ?>
<span class="disabled">Next ></span>
<?php endif; ?>
</div>
<?php endif; ?>
Item pagination
<!--
See http://developer.yahoo.com/ypatterns/pattern.php?pattern=itempagination
-->
<?php if ($this->pageCount): ?>
<div class="paginationControl">
<?= $this->firstItemNumber; ?> - <?= $this->lastItemNumber; ?>
of <?= $this->totalItemCount; ?>
<!-- First page link -->
<?php if (isset($this->previous)): ?>
<a href="<?= $this->url(array('page' => $this->first)); ?>">First</a> |
<?php else: ?>
<span class="disabled">First</span> |
<?php endif; ?>
<!-- Previous page link -->
<?php if (isset($this->previous)): ?>
<a href="<?= $this->url(array('page' => $this->previous)); ?>">< Previous</a> |
<?php else: ?>
<span class="disabled">< Previous</span> |
<?php endif; ?>
<!-- Next page link -->
<?php if (isset($this->next)): ?>
<a href="<?= $this->url(array('page' => $this->next)); ?>">Next ></a> |
<?php else: ?>
<span class="disabled">Next ></span> |
<?php endif; ?>
<!-- Last page link -->
<?php if (isset($this->next)): ?>
<a href="<?= $this->url(array('page' => $this->last)); ?>">Last</a>
<?php else: ?>
<span class="disabled">Last</span>
<?php endif; ?>
</div>
<?php endif; ?>
Dropdown pagination
<?php if ($this->pageCount): ?>
<select id="paginationControl" size="1">
<?php foreach ($this->pagesInRange as $page): ?>
<?php $selected = ($page == $this->current) ? ' selected="selected"' : ''; ?>
<option value="<?= $this->url(array('page' => $page)); ?>"<?= $selected ?>><?= $page; ?></option>
<?php endforeach; ?>
</select>
<?php endif; ?>
<script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/prototype/1.6.0.2/prototype.js"></script>
<script type="text/javascript">
$('paginationControl').observe('change', function() {
window.location = this.options[this.selectedIndex].value;
})
</script>
The following options are available to pagination control view partials:
表 30.3. Properties available to view partials
| Property | Type | Description |
|---|---|---|
| first | integer | First page number (i.e., 1) |
| firstItemNumber | integer | Absolute number of the first item on this page |
| firstPageInRange | integer | First page in the range returned by the scrolling style |
| current | integer | Current page number |
| currentItemCount | integer | Number of items on this page |
| last | integer | Last page number |
| lastItemNumber | integer | Absolute number of the last item on this page |
| lastPageInRange | integer | Last page in the range returned by the scrolling style |
| next | integer | Next page number |
| pageCount | integer | Number of pages |
| pagesInRange | array | Array of pages returned by the scrolling style |
| previous | integer | Previous page number |
| totalItemCount | integer | Total number of items |