Zend Framework: Zend_Paginator_Adapter_Doctrine - Jason Eisenmenger Component Proposal

Proposed Component Name	Zend_Paginator_Adapter_Doctrine - Jason Eisenmenger
Developer Notes	http://framework.zend.com/wiki/display/ZFDEV/Zend_Paginator_Adapter_Doctrine - Jason Eisenmenger
Proposers	Jason Eisenmenger
Zend Liaison	Ralph Schindler
Revision	1.0 - 5 September 2008: Initial Draft. (wiki revision: 9)

Milestone 1: [DONE] Write proposal
Milestone 2: [DONE] Post working prototype
Milestone 3: [DONE] Review by community
Milestone 4: Working prototype checked into the incubator supporting use cases #1, #2, ...
Milestone 5: Working prototype checked into the incubator supporting use cases #3 and #4.
Milestone 6: Unit tests exist, work, and are checked into SVN.
Milestone 7: Initial documentation exists.

7. Class Index

Zend_Paginator_Adapter_Doctrine

8. Use Cases

UC-01: Standard Usage

$query = Doctrine_Query::create()
    ->select('a.title, a.date, au.firstname, au.lastname')
    ->from('Article a')
    ->innerJoin('a.Author au')
    ->orderby('a.date DESC');

$paginator  = new Zend_Paginator(
    new Zend_Paginator_Adapter_Doctrine($query)); 

$paginator->setRouteName('article') 
          ->setItemCountPerPage(15) 
          ->setPageRange(5) 
          ->setCurrentPageNumber($this->_getParam('page')); 

$this->view->pages = $paginator;

UC-01: Supplying a count query

$query = Doctrine_Query::create()
    ->select('a.title, a.date, au.firstname, au.lastname')
    ->from('Article a')
    ->innerJoin('a.Author au')
    ->orderby('a.date DESC');

$paginator  = new Zend_Paginator(
    new Zend_Paginator_Adapter_Doctrine($query));

$countQuery = Doctrine_Query::create()
    ->select('COUNT(a.id) AS '. Zend_Paginator_Adapter_Doctrine::ROW_COUNT_COLUMN)
    ->from('Article a)
    ->innerJoin(a.Author au');

$paginator->setRowCount($countQuery)
          ->setRouteName('article') 
          ->setItemCountPerPage(15) 
          ->setPageRange(5) 
          ->setCurrentPageNumber($this->_getParam('page')); 

$this->view->pages = $paginator;

9. Class Skeletons

class Zend_Paginator_Adapter_Doctrine implements Zend_Paginator_Adapter_Interface
{
    /**
     * Name of the row count column
     *
     * @var string
     */
    const ROW_COUNT_COLUMN = 'zend_paginator_row_count';

    /**
     * Database query
     *
     * @var Doctrine_Query
     */
    protected $_query = null;

    /**
     * Total item count
     *
     * @var integer
     */
    protected $_rowCount = null;

    /**
     * Constructor.
     *
     * @param Doctrine_Query $query The select query
     */
    public function __construct(Doctrine_Query $query)
    {
    }

    /**
     * Sets the total row count, either directly or through a supplied query.
     *
     * @param  Doctrine_Query|integer $totalRowCount Total row count integer 
     *                                               or query
     * @return Zend_Paginator_Adapter_Doctrine_Query $this
     * @throws Zend_Paginator_Exception
     */
    public function setRowCount($rowCount)
    {
    }

    /**
     * Returns an array of items for a page.
     *
     * @param  integer $offset Page offset
     * @param  integer $itemCountPerPage Number of items per page
     * @return array
     */
    public function getItems($offset, $itemCountPerPage)
    {
    }

    /**
     * Returns the total number of rows in the result set.
     *
     * @return integer
     */
    public function count()
    {
    }
}

Page Operations

Browse Space

Zend_Paginator_Adapter_Doctrine - Jason Eisenmenger

Labels

Zend Framework: Zend_Paginator_Adapter_Doctrine - Jason Eisenmenger Component Proposal

Table of Contents

1. Overview

2. References

3. Component Requirements, Constraints, and Acceptance Criteria

4. Dependencies on Other Framework Components

5. Theory of Operation

6. Milestones / Tasks

7. Class Index

8. Use Cases

9. Class Skeletons