Class CriteriaElement

A criteria (grammar?) for a database query.

This abstract base class should never be instantiated directly.

Direct known subclasses

CriteriaElement, Xoops\Core\Kernel\Criteria, Xoops\Core\Kernel\CriteriaCompo

Indirect known subclasses

Abstract
Namespace: Xoops\Core\Kernel
Package: Xoops\Core\Kernel
Category: Xoops\Core\Kernel\CriteriaElement
Copyright: 2000-2013 XOOPS Project (http://xoops.org)
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Kazumi Ono onokazu@xoops.org
Author: Nathan Dial ndial@trillion21.com
Author: Taiwen Jiang phppp@users.sourceforge.net
Since: 2.0.0
Link: http://xoops.org
Located at oops_lib/Xoops/Core/Kernel/CriteriaElement.php

Methods summary
`abstract public string`	# `render( )` Render the criteria element Render the criteria element Returns string
`abstract public string`	# `renderWhere( )` Make the criteria into a SQL "WHERE" clause Make the criteria into a SQL "WHERE" clause Returns string
`abstract public string`	# `renderLdap( )` Generate an LDAP filter from criteria Generate an LDAP filter from criteria Returns string
`abstract public Doctrine\DBAL\Query\QueryBuilder`	# `renderQb( Doctrine\DBAL\Query\QueryBuilder $qb = null, string $whereMode = '' )` Render as Doctrine QueryBuilder instructions Render as Doctrine QueryBuilder instructions Parameters `$qb` query builder instance `$whereMode` how does this fit in the passed in QueryBuilder? '' = as where,'and'= as andWhere, 'or' = as orWhere Returns Doctrine\DBAL\Query\QueryBuilder query builder instance
`abstract public string`	# `buildExpressionQb( Doctrine\DBAL\Query\QueryBuilder $qb )` Build an expression to be included in a Doctrine QueryBuilder instance. Build an expression to be included in a Doctrine QueryBuilder instance. This method will build an expression, adding any parameters to the query, but the caller is responsible for adding the expression to the query, for example as where() parameter. This allows the caller to handle all context, such as parenthetical groupings. Parameters `$qb` query builder instance Returns string expression
`public`	# `setSort( string $sort )` set sort column set sort column Parameters `$sort` sort column
`public string`	# `getSort( )` get sort column get sort column Returns string sort column
`public`	# `setOrder( string $order )` set sort order set sort order Parameters `$order` sort order ASC or DESC
`public string`	# `getOrder( )` get sort order get sort order Returns string sort order
`public`	# `setLimit( integer $limit = 0 )` set row limit set row limit Parameters `$limit` row limit
`public integer`	# `getLimit( )` get row limit get row limit Returns integer row limit
`public`	# `setStart( integer $start = 0 )` set first row offset set first row offset Parameters `$start` offset of first row
`public integer`	# `getStart( )` get first row offset get first row offset Returns integer start row offset
`public`	# `setGroupBy( string $group )` set group by set group by Parameters `$group` group by
`public string`	# `getGroupBy( )` get group by get group by Returns string group by

Properties summary
`protected string`	`$order` Sort order Sort order	# `'ASC'`
`protected string`	`$sort`	# `''`
`protected integer`	`$limit` Number of records to retrieve Number of records to retrieve	# `0`
`protected integer`	`$start` Offset of first record Offset of first record	# `0`
`protected string`	`$groupBy`	# `''`

Namespaces

Classes

Class CriteriaElement

Direct known subclasses

Indirect known subclasses

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns