<ac:macro ac:name="note"><ac:parameter ac:name="title">Under Construction</ac:parameter><ac:rich-text-body>
<p>This proposal is being merged with <a class="external-link" href="http://framework.zend.com/wiki/display/ZFPROP/Zend_Paginate+-+Jurri">http://framework.zend.com/wiki/display/ZFPROP/Zend_Paginate+-+Jurri</a>ën+Stutterheim+and+Matthew+Ratzloff</p></ac:rich-text-body></ac:macro>

<ac:macro ac:name="unmigrated-inline-wiki-markup"><ac:plain-text-body><![CDATA[

<ac:macro ac:name="unmigrated-inline-wiki-markup"><ac:plain-text-body><![CDATA[

Zend Framework: Zend_Paginator - Matthew Ratzloff Component Proposal

Table of Contents

1. Overview

Zend_Paginator is a pagination class for both database- and view-level pagination. Users supply a page number and an optional configuration object and the rest is handled more or less seamlessly. The database strategy is the default, but view-level pagination can be selected in the options. For database pagination, users should have their models implement Zend_Paginator_Pageable_Interface.

Disclaimer: This is something I threw together over a couple of hours on Christmas Eve. I haven't coded anything yet, so I'm not sure if everything would work exactly as currently described. I really should probably finish all my other proposals and not-yet-proposals before I create another proposal, but this is something that a lot of people probably need right away.

2. References

I really wasn't impressed with any other pagination implementations I came across. In general, they were just too limiting.

3. Component Requirements, Constraints, and Acceptance Criteria

• This component will paginate database and arbitrary result sets.
• This component will be flexible enough to allow users to implement any page-to-page navigation they like.
• This component will not be a one-size-fits-all solution. That means that there may be a little more work involved on the part of the user when initially incorporating this class into their project.

4. Dependencies on Other Framework Components

• Zend_Exception
• Zend_Db
• Probably not Zend_View (but we'll see)

5. Theory of Operation

6. Milestones / Tasks

• Milestone 1: Proposal is finished.
• Milestone 2: Working prototype checked into the incubator supporting use cases #1, #2, ...
• Milestone 3: Working prototype checked into the incubator supporting use cases #3 and #4.
• Milestone 4: Unit tests exist, work, and are checked into SVN.
• Milestone 5: Initial documentation exists.

7. Class Index

• Zend_Paginator
• Zend_Paginator_Exception
• Zend_Paginator_Page
• Zend_Paginator_Pageable_Interface
• Zend_Paginator_Strategy_Db
• Zend_Paginator_Strategy_View

8. Use Cases

Database-level pagination example

Controller:

Model (which implements Zend_Paginator_Pageable_Interface):

View (page_selector.php partial):

View-level pagination example

Controller:

View (page_selector.php partial):

9. Class Skeletons

Here's a partial list. This includes the public methods.