Paginator/Adapter/DbSelect.php

Show:

inherited

Classes
- \Zend_Paginator_Adapter_DbSelect

Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Paginator
Version: $Id: DbSelect.php 24754 2012-05-05 02:30:56Z adamlundrigan $

\Zend_Paginator_Adapter_DbSelect
jump to top

Package: Zend\Paginator

Implements: \Zend_Paginator_Adapter_Interface
Children: \Zend_Paginator_Adapter_DbTableSelect
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

string 
                ROW_COUNT_COLUMN
                = 'zend_paginator_row_count'

Name of the row count column

: string

Properties

string $_cacheIdentifier = null

Identifies this adapter for caching purposes.

This value will remain constant for the entire life of this adapter regardless of how many different pages are queried.

Default valuenullDetails

Type: string

\Zend_Db_Select $_countSelect = null

The COUNT query

Default valuenullDetails

Type: \Zend_Db_Select

integer $_rowCount = null

Total item count

Default valuenullDetails

Type: integer

\Zend_Db_Select $_select = null

Database query

Default valuenullDetails

Type: \Zend_Db_Select

Methods

__construct(\Zend_Db_Select $select) : void

Constructor.

Parameters

Name	Type	Description
$select	\Zend_Db_Select	The select query

count() : integer

Returns the total number of rows in the result set.

Returns

Type	Description
integer

getCacheIdentifier() : string

Returns the cache identifier.

Returns

Type	Description
string

getCountSelect() : \Zend_Db_Select

Get the COUNT select object for the provided query

TODO: Have a look at queries that have both GROUP BY and DISTINCT specified. In that use-case I'm expecting problems when either GROUP BY or DISTINCT has one column.

Returns

Type	Description
\Zend_Db_Select

getItems(integer $offset, integer $itemCountPerPage) : array

Returns an array of items for a page.

Parameters

Name	Type	Description
$offset	integer	Page offset
$itemCountPerPage	integer	Number of items per page

Returns

Type	Description
array

setRowCount( $rowCount) : \Zend_Paginator_Adapter_DbSelect

Sets the total row count, either directly or through a supplied query.

Without setting this, getPages() selects the count as a subquery (SELECT COUNT ... FROM (SELECT ...)). While this yields an accurate count even with queries containing clauses like LIMIT, it can be slow in some circumstances. For example, in MySQL, subqueries are generally slow when using the InnoDB storage engine. Users are therefore encouraged to profile their queries to find the solution that best meets their needs.

Parameters

Name	Type	Description
$rowCount

Returns

Type	Description
\Zend_Paginator_Adapter_DbSelect	$this

Throws

Exception	Description
\Zend_Paginator_Exception

Paginator/Adapter/DbSelect.php

\Zend_Paginator_Adapter_DbSelectjump to top

Constants

Properties

Methods

\Zend_Paginator_Adapter_DbSelect
jump to top