Docs For Class DeleteQuery

Description

Implements interfaces:

DeleteQueryInterface

A DeleteQuery class provides the tools to build a DELETE query.

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

Located in /harmoni/core/DBHandler/DeleteQuery.class.php (line 26)

SObject
   |
   --QueryAbstract
      |
      --DeleteQuery

Variable Summary

array $_condition

string $_table

Method Summary

DeleteQuery DeleteQuery ()

void addWhere (string $condition, [integer $logicalOperation = _AND])

void reset ()

void setTable (string $table)

void setWhere (string $condition)

Variables

array $_condition (line 46)

This will store the condition in the WHERE clause. Each element of this array stores 2 things: the condition itself, and the logical operator to use to join with the previous condition.

var: The condition in the WHERE clause.
access: private

string $_table (line 36)

var: The name of the table to update.
access: private

Inherited Variables

Inherited from QueryAbstract

QueryAbstract::$_type

Methods

Constructor DeleteQuery (line 54)

This is the constructor for a DELETE query.

access: public

DeleteQuery DeleteQuery ()

addWhere (line 109)

Adds a new condition in the WHERE clause.

The query will execute only on rows that fulfil the condition. If this method is never called, then the WHERE clause will not be included.

access: public

void addWhere (string $condition, [integer $logicalOperation = _AND])

string $condition: condition The WHERE clause condition to add.
integer $logicalOperation
: logicalOperation The logical operation to use to connect this WHERE condition with the previous WHERE conditions. Allowed values:
```
_AND
```
and
```
_OR
```
.

reset (line 130)

Resets the query.

access: public

void reset ()

Redefinition of:

QueryAbstract::reset(): Resets the query.

setTable (line 64)

Sets the table to delete from.

access: public

void setTable (string $table)

string $table: The table to delete from.

setWhere (line 83)

*Deprecated* Specifies the condition in the WHERE clause.

The query will execute only on rows that fulfil the condition. If this method is never called, then the WHERE clause will not be included.

deprecated: July 09, 2003 - Use addWhere() instead.
access: public

void setWhere (string $condition)

string $condition: The WHERE clause condition.

Inherited Methods

Inherited From QueryAbstract

QueryAbstract::addWhereComparison()
QueryAbstract::addWhereEqual()
QueryAbstract::addWhereGreaterThan()
QueryAbstract::addWhereGreaterThanOrEqual()
QueryAbstract::addWhereIn()
QueryAbstract::addWhereLessThan()
QueryAbstract::addWhereLessThanOrEqual()
QueryAbstract::addWhereNotEqual()
QueryAbstract::addWhereNotIn()
QueryAbstract::addWhereNotNull()
QueryAbstract::addWhereNull()
QueryAbstract::addWhereRawComparison()
QueryAbstract::addWhereRawEqual()
QueryAbstract::addWhereRawGreaterThan()
QueryAbstract::addWhereRawGreaterThanOrEqual()
QueryAbstract::addWhereRawIn()
QueryAbstract::addWhereRawLessThan()
QueryAbstract::addWhereRawLessThanOrEqual()
QueryAbstract::addWhereRawNotEqual()
QueryAbstract::addWhereRawNotIn()
QueryAbstract::asString()
QueryAbstract::cleanColumn()
QueryAbstract::getType()
QueryAbstract::reset()

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()