Bouncy Melons 0.2
declarative style orm
Public Member Functions | Data Fields | Protected Attributes
Filter Class Reference
Inheritance diagram for Filter:
IFilter FilterAll FilterComplex FilterRaw FilterPermissive FilterStrict

Public Member Functions

 __constcruct ()
 
 setBm ($bm)
 
 getBm ()
 
 setPage ($page=null)
 
 getPage ()
 
 setItemsPerPage ($itemsPerPage=null)
 
 getItemsPerPage ()
 
 setOrderBy ($orderBy)
 
 setGroupBy ($groupBy)
 
 getDefaultItemsPerPage ()
 
 createLimit ()
 
 createOrderBy ($fields)
 
 createGroupBy ()
 
- Public Member Functions inherited from IFilter
 createWhere ($fields)
 

Data Fields

const DEFAULT_PAGE = 0
 
const DEFAULT_ITEMS_PER_PAGE = 50
 
const INFINITY = -1
 

Protected Attributes

 $page
 
 $itemsPerPage
 
 $orderBy
 
 $groupBy
 

Detailed Description

Definition at line 5 of file Filter.php.

Member Function Documentation

__constcruct ( )

Definition at line 24 of file Filter.php.

createGroupBy ( )

Definition at line 87 of file Filter.php.

createLimit ( )

Implements IFilter.

Definition at line 74 of file Filter.php.

createOrderBy (   $fields)

Implements IFilter.

Definition at line 83 of file Filter.php.

getBm ( )

Definition at line 30 of file Filter.php.

getDefaultItemsPerPage ( )
Returns
int

Definition at line 70 of file Filter.php.

getItemsPerPage ( )

Implements IFilter.

Definition at line 49 of file Filter.php.

getPage ( )

Definition at line 38 of file Filter.php.

setBm (   $bm)

Definition at line 26 of file Filter.php.

setGroupBy (   $groupBy)

Definition at line 63 of file Filter.php.

setItemsPerPage (   $itemsPerPage = null)

Definition at line 45 of file Filter.php.

setOrderBy (   $orderBy)
Parameters
arrayof IOrderByClause $orderBy

Definition at line 59 of file Filter.php.

setPage (   $page = null)

Definition at line 34 of file Filter.php.

Field Documentation

$groupBy
protected

Definition at line 20 of file Filter.php.

$itemsPerPage
protected

Definition at line 18 of file Filter.php.

$orderBy
protected

Definition at line 19 of file Filter.php.

$page
protected

Definition at line 17 of file Filter.php.

const DEFAULT_ITEMS_PER_PAGE = 50

Definition at line 8 of file Filter.php.

const DEFAULT_PAGE = 0

Definition at line 7 of file Filter.php.

const INFINITY = -1

this is to indicate, that no LIMIT should be in sql query example: $list->find((null, ::INFINITY));

Definition at line 15 of file Filter.php.


The documentation for this class was generated from the following file: