Docs For Class TActiveRecordCriteria

Description

Search criteria for Active Record.

Criteria object for active record finder methods. Usage:

 $criteria = new TActiveRecordCriteria;
 $criteria->Condition = 'username = :name AND password = :pass';
 $criteria->Parameters[':name'] = 'admin';
 $criteria->Parameters[':pass'] = 'prado';
 $criteria->OrdersBy['level'] = 'desc';
 $criteria->OrdersBy['name'] = 'asc';
 $criteria->Limit = 10;
 $criteria->Offset = 20;

since: 3.1
version: $Id: TActiveRecordCriteria.php 1545 2006-12-03 22:26:04Z wei $
author: Wei Zhuo <weizho[at]gmail[dot]com>

Located in /Data/ActiveRecord/TActiveRecordCriteria.php (line 33)

TComponent
   |
   --TActiveRecordCriteria

Method Summary

TActiveRecordCriteria __construct ([mixed $condition = null], [mixed $parameters = array()])

string getCondition ()

boolean getIsNamedParameters ()

int getLimit ()

int getOffset ()

TAttributeCollection getOrdersBy ()

TAttributeCollection getParameters ()

void setCondition (string $value)

void setLimit (int $value)

void setOffset (int $value)

void setOrdersBy (ArrayAccess $value)

void setParameters (ArrayAccess $value)

Methods

Constructor __construct (line 44)

Creates a new criteria with given condition;

access: public

TActiveRecordCriteria __construct ([mixed $condition = null], [mixed $parameters = array()])

getCondition (line 99)

return: search conditions.
access: public

string getCondition ()

getIsNamedParameters (line 72)

return: true if the parameter index are string base, false otherwise.
access: public

boolean getIsNamedParameters ()

getLimit (line 116)

return: maximum number of records to return.
access: public

int getLimit ()

getOffset (line 132)

return: record offset.
access: public

int getOffset ()

getOrdersBy (line 81)

return: ordering clause.
access: public

TAttributeCollection getOrdersBy ()

getParameters (line 54)

return: list of named parameters and values.
access: public

TAttributeCollection getParameters ()

setCondition (line 108)

Sets the search conditions to be placed after the WHERE clause in the SQL.

access: public

void setCondition (string $value)

string $value: search conditions.

setLimit (line 124)

access: public

void setLimit (int $value)

int $value: maximum number of records to return.

setOffset (line 140)

access: public

void setOffset (int $value)

int $value: record offset.

setOrdersBy (line 89)

access: public

void setOrdersBy (ArrayAccess $value)

ArrayAccess $value: ordering clause.

setParameters (line 62)

access: public

void setParameters (ArrayAccess $value)

ArrayAccess $value: named parameters.

Inherited Methods

Inherited From TComponent

TComponent::addParsedObject()
TComponent::attachEventHandler()
TComponent::canGetProperty()
TComponent::canSetProperty()
TComponent::createdOnTemplate()
TComponent::detachEventHandler()
TComponent::evaluateExpression()
TComponent::evaluateStatements()
TComponent::getEventHandlers()
TComponent::getSubProperty()
TComponent::hasEvent()
TComponent::hasEventHandler()
TComponent::hasProperty()
TComponent::raiseEvent()
TComponent::setSubProperty()
TComponent::__get()
TComponent::__set()