Docs For Class QueryAbstract

Class QueryAbstract

Description

Implements interfaces:

Query

A generic Query interface to be implemented by all Query objects.

author: Adam Franco <AT adamfranco DOT com adam AT adamfranco DOT com> <afranco AT middlebury DOT edu>
abstract:
version: $Id: Query.abstract.php,v 1.6 2007/09/05 21:38:59 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/DBHandler/Query.abstract.php (line 24)

SObject
   |
   --QueryAbstract

Direct descendents

Class	Description
DeleteQuery	A DeleteQuery class provides the tools to build a DELETE query.
GenericSQLQuery	A GenericSQLQuery provides a way to specify the SQL string manually. Use this query type to execute queries not available through the other Query objects (for example, data-definition queries).
InsertQuery	An InsertQuery object provides the tools to build an INSERT query.
SelectQuery	A SelectQuery class provides the tools to build a SELECT query.
UpdateQuery	An UpdateQuery class provides the tools to build an UPDATE query.

Variable Summary

mixed $_type

Method Summary

void addWhereComparison (string $column, string $value, string $comparison, [mixed $logicalOperation = _AND])

void addWhereEqual (string $column, string $value, [mixed $logicalOperation = _AND])

void addWhereGreaterThan (string $column, string $value, [mixed $logicalOperation = _AND])

void addWhereGreaterThanOrEqual (string $column, string $value, [mixed $logicalOperation = _AND])

void addWhereIn (string $column, array $values, [mixed $logicalOperation = _AND])

void addWhereLessThan (string $column, string $value, [mixed $logicalOperation = _AND])

void addWhereLessThanOrEqual (string $column, string $value, [mixed $logicalOperation = _AND])

void addWhereNotEqual (string $column, string $value, [mixed $logicalOperation = _AND])

void addWhereNotIn (string $column, array $values, [mixed $logicalOperation = _AND])

void addWhereNotNull (string $column, [mixed $logicalOperation = _AND], string $value)

void addWhereNull (string $column, [mixed $logicalOperation = _AND], string $value)

void addWhereRawComparison (string $column, string $value, string $comparison, [mixed $logicalOperation = _AND])

void addWhereRawEqual (string $column, string $value, [mixed $logicalOperation = _AND])

void addWhereRawGreaterThan (string $column, string $value, [mixed $logicalOperation = _AND])

void addWhereRawGreaterThanOrEqual (string $column, string $value, [mixed $logicalOperation = _AND])

void addWhereRawIn (string $column, array $values, [mixed $logicalOperation = _AND])

void addWhereRawLessThan (string $column, string $value, [mixed $logicalOperation = _AND])

void addWhereRawLessThanOrEqual (string $column, string $value, [mixed $logicalOperation = _AND])

void addWhereRawNotEqual (string $column, string $value, [mixed $logicalOperation = _AND])

void addWhereRawNotIn (string $column, array $values, [mixed $logicalOperation = _AND])

string asString (int $dbIndex)

string cleanColumn (string $column)

integer getType ()

void reset ()

Variables

mixed $_type (line 35)

The type of the query.

The type of the query. Allowed values: SELECT, INSERT, DELETE, or UPDATE. var integer $_type The type of the query.

Methods

addWhereComparison (line 101)

Add a comparison where the value is quoted and escaped.

since: 3/9/07
access: public

void addWhereComparison (string $column, string $value, string $comparison, [mixed $logicalOperation = _AND])

string $column
string $value
string $comparison

addWhereEqual (line 118)

Add a where clause of the form column='value'.

since: 3/9/07
access: public

void addWhereEqual (string $column, string $value, [mixed $logicalOperation = _AND])

string $column
string $value

addWhereGreaterThan (line 157)

Add a where clause of the form column>'value'.

since: 3/9/07
access: public

void addWhereGreaterThan (string $column, string $value, [mixed $logicalOperation = _AND])

string $column
string $value

addWhereGreaterThanOrEqual (line 183)

Add a where clause of the form column>='value'.

since: 3/9/07
access: public

void addWhereGreaterThanOrEqual (string $column, string $value, [mixed $logicalOperation = _AND])

string $column
string $value

addWhereIn (line 304)

Add a where clause of the form column IN ('xxx', 'yyy').

since: 3/9/07
access: public

void addWhereIn (string $column, array $values, [mixed $logicalOperation = _AND])

string $column
array $values

addWhereLessThan (line 144)

Add a where clause of the form column<'value'.

since: 3/9/07
access: public

void addWhereLessThan (string $column, string $value, [mixed $logicalOperation = _AND])

string $column
string $value

addWhereLessThanOrEqual (line 170)

Add a where clause of the form column<='value'.

since: 3/9/07
access: public

void addWhereLessThanOrEqual (string $column, string $value, [mixed $logicalOperation = _AND])

string $column
string $value

addWhereNotEqual (line 131)

Add a where clause of the form column!='value'.

since: 3/9/07
access: public

void addWhereNotEqual (string $column, string $value, [mixed $logicalOperation = _AND])

string $column
string $value

addWhereNotIn (line 324)

Add a where clause of the form column NOT IN ('xxx', 'yyy').

since: 3/9/07
access: public

void addWhereNotIn (string $column, array $values, [mixed $logicalOperation = _AND])

string $column
array $values

addWhereNotNull (line 289)

Add a where clause of the form column IS NOT NULL.

since: 3/9/07
access: public

void addWhereNotNull (string $column, [mixed $logicalOperation = _AND], string $value)

string $column
string $value

addWhereNull (line 274)

Add a where clause of the form column IS NULL.

since: 3/9/07
access: public

void addWhereNull (string $column, [mixed $logicalOperation = _AND], string $value)

string $column
string $value

addWhereRawComparison (line 80)

Add a comparison where the value is NOT quoted or escaped

since: 3/9/07
access: public

void addWhereRawComparison (string $column, string $value, string $comparison, [mixed $logicalOperation = _AND])

string $column
string $value
string $comparison

addWhereRawEqual (line 196)

Add a where clause of the form column='value'.

since: 3/9/07
access: public

void addWhereRawEqual (string $column, string $value, [mixed $logicalOperation = _AND])

string $column
string $value

addWhereRawGreaterThan (line 235)

Add a where clause of the form column>'value'.

since: 3/9/07
access: public

void addWhereRawGreaterThan (string $column, string $value, [mixed $logicalOperation = _AND])

string $column
string $value

addWhereRawGreaterThanOrEqual (line 261)

Add a where clause of the form column>='value'.

since: 3/9/07
access: public

void addWhereRawGreaterThanOrEqual (string $column, string $value, [mixed $logicalOperation = _AND])

string $column
string $value

addWhereRawIn (line 344)

Add a where clause of the form column IN ('xxx', 'yyy').

since: 3/9/07
access: public

void addWhereRawIn (string $column, array $values, [mixed $logicalOperation = _AND])

string $column
array $values

addWhereRawLessThan (line 222)

Add a where clause of the form column<'value'.

since: 3/9/07
access: public

void addWhereRawLessThan (string $column, string $value, [mixed $logicalOperation = _AND])

string $column
string $value

addWhereRawLessThanOrEqual (line 248)

Add a where clause of the form column<='value'.

since: 3/9/07
access: public

void addWhereRawLessThanOrEqual (string $column, string $value, [mixed $logicalOperation = _AND])

string $column
string $value

addWhereRawNotEqual (line 209)

Add a where clause of the form column!='value'.

since: 3/9/07
access: public

void addWhereRawNotEqual (string $column, string $value, [mixed $logicalOperation = _AND])

string $column
string $value

addWhereRawNotIn (line 360)

Add a where clause of the form column NOT IN ('xxx', 'yyy').

since: 3/9/07
access: public

void addWhereRawNotIn (string $column, array $values, [mixed $logicalOperation = _AND])

string $column
array $values

asString (line 375)

Answer a string representation of the query.

since: 7/10/07
access: public

string asString (int $dbIndex)

int $dbIndex

Redefinition of:

SObject::asString(): Answer a String whose characters are a description of the receiver.

cleanColumn (line 64)

Answer a safe SQL column string

since: 3/9/07
access: public

string cleanColumn (string $column)

string $column

getType (line 52)

Returns the type of this query.

Returns the type of this query: SELECT, INSERT, DELETE, or UPDATE.

return: The type of this query: SELECT, INSERT, DELETE, or UPDATE.
access: public

integer getType ()

reset (line 41)

Resets the query.

access: public

void reset ()

Redefined in descendants as:

DeleteQuery::reset() : Resets the query.
GenericSQLQuery::reset() : Resets the query.
InsertQuery::reset() : Resets the query.
SelectQuery::reset() : Resets the query.
UpdateQuery::reset() : Resets the query.

Inherited Methods

Inherited From SObject

SObject::asA()
SObject::asString()
SObject::copy()
SObject::copySameFrom()
SObject::copyTwoLevel()
SObject::deepCopy()
SObject::isEqual()
SObject::isEqualTo()
SObject::isNotEqualTo()
SObject::isNotReferenceTo()
SObject::isReferenceTo()
SObject::newFrom()
SObject::postCopy()
SObject::printableString()
SObject::shallowCopy()
SObject::_deepCopyArray()

Documentation generated on Wed, 19 Sep 2007 10:25:44 -0400 by phpDocumentor 1.3.0RC3