Xoops\Core\Kernel\CriteriaElement Class Reference

Inheritance diagram for Xoops\Core\Kernel\CriteriaElement:

Public Member Functions
	buildExpressionQb (QueryBuilder $qb)
	getGroupby ()
	getLimit ()
	getOrder ()
	getSort ()
	getStart ()
	render ()
	renderLdap ()
	renderQb (QueryBuilder $qb=null, $whereMode= '')
	renderWhere ()
	setGroupby ($group)
	setLimit ($limit=0)
	setOrder ($order)
	setSort ($sort)
	setStart ($start=0)

Protected Attributes
	$groupby = ''
	$limit = 0
	$order = 'ASC'
	$sort = ''
	$start = 0

Detailed Description

Definition at line 31 of file CriteriaElement.php.

Member Function Documentation

Xoops\Core\Kernel\CriteriaElement::buildExpressionQb ( QueryBuilder  $qb )

abstract

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

QueryBuilder

$qb

query builder instance

Returns

string expression

Xoops\Core\Kernel\CriteriaElement::getGroupby

(

)

get group by

Returns

string group by

Definition at line 221 of file CriteriaElement.php.

Xoops\Core\Kernel\CriteriaElement::getLimit

(

)

get row limit

Returns

int row limit

Definition at line 177 of file CriteriaElement.php.

References Xoops\Core\Kernel\CriteriaElement\$limit.

Xoops\Core\Kernel\CriteriaElement::getOrder

(

)

get sort order

Returns

string sort order

Definition at line 155 of file CriteriaElement.php.

References Xoops\Core\Kernel\CriteriaElement\$order.

Xoops\Core\Kernel\CriteriaElement::getSort

(

)

get sort column

Returns

string sort column

Definition at line 128 of file CriteriaElement.php.

References Xoops\Core\Kernel\CriteriaElement\$sort.

Xoops\Core\Kernel\CriteriaElement::getStart

(

)

get first row offset

Returns

int start row offset

Definition at line 199 of file CriteriaElement.php.

References Xoops\Core\Kernel\CriteriaElement\$start.

Xoops\Core\Kernel\CriteriaElement::render ( )

abstract

Render the criteria element

Returns

string

Xoops\Core\Kernel\CriteriaElement::renderLdap ( )

abstract

Generate an LDAP filter from criteria

Returns

string

Xoops\Core\Kernel\CriteriaElement::renderQb ( QueryBuilder  $qb = null,   $whereMode = ''  )

abstract

Render as Doctrine QueryBuilder instructions

Parameters

QueryBuilder	$qb	query builder instance
string	$whereMode	how does this fit in the passed in QueryBuilder? '' = as where,'and'= as andWhere, 'or' = as orWhere

Returns

QueryBuilder query builder instance

Xoops\Core\Kernel\CriteriaElement::renderWhere ( )

abstract

Make the criteria into a SQL "WHERE" clause

Returns

string

Xoops\Core\Kernel\CriteriaElement::setGroupby

(

$group

)

set group by

Parameters

string

$group

group by

Returns

void

Definition at line 211 of file CriteriaElement.php.

Xoops\Core\Kernel\CriteriaElement::setLimit

(

$limit = 0

)

set row limit

Parameters

int

$limit

row limit

Returns

void

Definition at line 167 of file CriteriaElement.php.

References Xoops\Core\Kernel\CriteriaElement\$limit.

Xoops\Core\Kernel\CriteriaElement::setOrder

(

$order

)

set sort order

Parameters

string

$order

sort order ASC or DESC

Returns

void

Definition at line 140 of file CriteriaElement.php.

References Xoops\Core\Kernel\CriteriaElement\$order.

Xoops\Core\Kernel\CriteriaElement::setSort

(

$sort

)

set sort column

Parameters

string

$sort

sort column

Returns

void

Definition at line 118 of file CriteriaElement.php.

References Xoops\Core\Kernel\CriteriaElement\$sort.

Xoops\Core\Kernel\CriteriaElement::setStart

(

$start = 0

)

set first row offset

Parameters

int

$start

offset of first row

Returns

void

Definition at line 189 of file CriteriaElement.php.

References Xoops\Core\Kernel\CriteriaElement\$start.

Member Data Documentation

Xoops\Core\Kernel\CriteriaElement::$groupby = ''

protected

Definition at line 62 of file CriteriaElement.php.

Xoops\Core\Kernel\CriteriaElement::$limit = 0

protected

Definition at line 50 of file CriteriaElement.php.

Referenced by Xoops\Core\Kernel\CriteriaElement\getLimit(), and Xoops\Core\Kernel\CriteriaElement\setLimit().

Xoops\Core\Kernel\CriteriaElement::$order = 'ASC'

protected

Definition at line 38 of file CriteriaElement.php.

Referenced by Xoops\Core\Kernel\CriteriaElement\getOrder(), and Xoops\Core\Kernel\CriteriaElement\setOrder().

Xoops\Core\Kernel\CriteriaElement::$sort = ''

protected

Definition at line 43 of file CriteriaElement.php.

Referenced by Xoops\Core\Kernel\CriteriaElement\getSort(), and Xoops\Core\Kernel\CriteriaElement\setSort().

Xoops\Core\Kernel\CriteriaElement::$start = 0

protected

Definition at line 57 of file CriteriaElement.php.

Referenced by Xoops\Core\Kernel\CriteriaElement\getStart(), and Xoops\Core\Kernel\CriteriaElement\setStart().

---

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

• C:/usr64/htdocs/xoops_lib/Xoops/Core/Kernel/CriteriaElement.php