Docs For Class atkOci9Query

Home

Documentation home

Atk index

Docs For Class atkOci9Query [ package: atk ]

Class: atkOci9Query

Source Location: /db/class.atkoci9query.inc

Class atkOci9Query

Class Overview

Query builder for Oracle 9i and later databases.

Located in /db/class.atkoci9query.inc [line 30]

Wiki documentation

atkQuery
   |
   --atkOci8Query
      |
      --atkOci9Query

Author(s):

Sandy Pleyte <sandy@ibuildings.nl>

Information Tags:

Properties

$m_bind_vars

Methods

[ Top ]

Inherited from parent

Inherited Properties	Inherited Methods
Inherited From atkQuery atkQuery::$m_aliases atkQuery::$m_conditions atkQuery::$m_db atkQuery::$m_distinct atkQuery::$m_expressions atkQuery::$m_fieldaliases atkQuery::$m_fieldquote atkQuery::$m_fields atkQuery::$m_generatedAlias atkQuery::$m_groupbys atkQuery::$m_joinaliases atkQuery::$m_joins atkQuery::$m_limit atkQuery::$m_offset atkQuery::$m_orderbys atkQuery::$m_quotedfields atkQuery::$m_reservedNames atkQuery::$m_searchconditions atkQuery::$m_searchmethod atkQuery::$m_tables	Inherited From atkOci8Query atkOci8Query::addJoin() Makes a Join SQL query for Oracle atkOci8Query::substringCondition() Generate a searchcondition that checks whether $field contains $value . atkOci8Query::_addLimiter() Add limiting clauses to the query. Inherited From atkQuery atkQuery::addCondition() Add a query condition (conditions are where-expressions that are AND-ed) atkQuery::addExpression() Add's an expression to the select query atkQuery::addField() Add's a field to the query atkQuery::addFields() Add multiple fields at once atkQuery::addGroupBy() Add a group-by statement atkQuery::addJoin() Add join to Join Array atkQuery::addOrderBy() Add order-by statement atkQuery::addSearchCondition() Add search condition to the query. Basically similar to addCondition, but searchconditions make use of the searchmode setting to determine whether the different searchconditions should be and'ed or or'ed. atkQuery::addSequenceField() Add's a sequence field to the query. atkQuery::addTable() Add table to Tables array atkQuery::atkquery() Initialize all variables atkQuery::betweenCondition() Get the between condition atkQuery::buildCount() Builds the SQL Select COUNT() query. This is different from select, because we do joins, like in a select, but we don't really select the fields. atkQuery::buildDelete() Builds the SQL Delete query atkQuery::buildInsert() Builds the SQL Insert query atkQuery::buildSelect() Builds the SQL Select query atkQuery::buildUpdate() Builds the SQL Update query atkQuery::create() Static factory method. This method returns a new instance of a query object for the current database. atkQuery::deAlias() Search Alias in alias array atkQuery::exactCondition() Generate a searchcondition that checks whether $value matches $field exactly. atkQuery::exactNumberCondition() Generate a searchcondition that check number/decimal literal values atkQuery::executeDelete() Wrapper function to execute a delete query atkQuery::executeInsert() Wrapper function to execute an insert query atkQuery::executeSelect() Wrapper function to execute a select query. atkQuery::executeUpdate() Wrapper function to execute an update query atkQuery::getDb() Returns the database instance. atkQuery::greaterthanCondition() Generate searchcondition with greater than atkQuery::greaterthanequalCondition() Generate searchcondition with greater than atkQuery::lessthanCondition() Generate searchcondition with less than atkQuery::lessthanequalCondition() Generate searchcondition with less than atkQuery::notNullCondition() Generate a searchcondition that checks if the field is not null. atkQuery::nullCondition() Generate a searchcondition that checks if the field is null. atkQuery::quoteField() If we set a m_fieldquote you can pass a field to this function and it will quote all the identifiers (db, table, column, etc...) in the field. atkQuery::quoteFields() Quote an array of fields if m_fieldquote is set. atkQuery::setDb() Sets the database instance. atkQuery::setDistinct() Set the 'distinct' mode for the query. atkQuery::setLimit() Set a limit to the number of results. atkQuery::substringCondition() Generate a searchcondition that checks whether $field contains $value . atkQuery::wildcardCondition() Generate a searchcondition that accepts '' as wildcard character. atkQuery::_addFrom() Add FROM clause to query. atkQuery::_addLimiter() Add limiting clauses to the query. atkQuery::_addOrderBy() Add the ORDER BY clause

Inherited Properties

Inherited Methods

Inherited From atkQuery

atkQuery::$m_aliases

atkQuery::$m_conditions

atkQuery::$m_db

atkQuery::$m_distinct

atkQuery::$m_expressions

atkQuery::$m_fieldaliases

atkQuery::$m_fieldquote

atkQuery::$m_fields

atkQuery::$m_generatedAlias

atkQuery::$m_groupbys

atkQuery::$m_joinaliases

atkQuery::$m_joins

atkQuery::$m_limit

atkQuery::$m_offset

atkQuery::$m_orderbys

atkQuery::$m_quotedfields

atkQuery::$m_reservedNames

atkQuery::$m_searchconditions

atkQuery::$m_searchmethod

atkQuery::$m_tables

Inherited From atkOci8Query

atkOci8Query::addJoin()

Makes a Join SQL query for Oracle

atkOci8Query::substringCondition()

Generate a searchcondition that checks whether $field contains $value .

atkOci8Query::_addLimiter()

Add limiting clauses to the query.

Inherited From atkQuery

atkQuery::addCondition()

Add a query condition (conditions are where-expressions that are AND-ed)

atkQuery::addExpression()

Add's an expression to the select query

atkQuery::addField()

Add's a field to the query

atkQuery::addFields()

Add multiple fields at once

atkQuery::addGroupBy()

Add a group-by statement

atkQuery::addJoin()

Add join to Join Array

atkQuery::addOrderBy()

Add order-by statement

atkQuery::addSearchCondition()

Add search condition to the query. Basically similar to addCondition, but searchconditions make use of the searchmode setting to determine whether the different searchconditions should be and'ed or or'ed.

atkQuery::addSequenceField()

Add's a sequence field to the query.

atkQuery::addTable()

Add table to Tables array

atkQuery::atkquery()

Initialize all variables

atkQuery::betweenCondition()

Get the between condition

atkQuery::buildCount()

Builds the SQL Select COUNT(*) query. This is different from select, because we do joins, like in a select, but we don't really select the fields.

atkQuery::buildDelete()

Builds the SQL Delete query

atkQuery::buildInsert()

Builds the SQL Insert query

atkQuery::buildSelect()

Builds the SQL Select query

atkQuery::buildUpdate()

Builds the SQL Update query

atkQuery::create()

Static factory method. This method returns a new instance of a query object for the current database.

atkQuery::deAlias()

Search Alias in alias array

atkQuery::exactCondition()

Generate a searchcondition that checks whether $value matches $field exactly.

atkQuery::exactNumberCondition()

Generate a searchcondition that check number/decimal literal values

atkQuery::executeDelete()

Wrapper function to execute a delete query

atkQuery::executeInsert()

Wrapper function to execute an insert query

atkQuery::executeSelect()

Wrapper function to execute a select query.

atkQuery::executeUpdate()

Wrapper function to execute an update query

atkQuery::getDb()

Returns the database instance.

atkQuery::greaterthanCondition()

Generate searchcondition with greater than

atkQuery::greaterthanequalCondition()

Generate searchcondition with greater than

atkQuery::lessthanCondition()

Generate searchcondition with less than

atkQuery::lessthanequalCondition()

Generate searchcondition with less than

atkQuery::notNullCondition()

Generate a searchcondition that checks if the field is not null.

atkQuery::nullCondition()

Generate a searchcondition that checks if the field is null.

atkQuery::quoteField()

If we set a m_fieldquote you can pass a field to this function and it will quote all the identifiers (db, table, column, etc...) in the field.

atkQuery::quoteFields()

Quote an array of fields if m_fieldquote is set.

atkQuery::setDb()

Sets the database instance.

atkQuery::setDistinct()

Set the 'distinct' mode for the query.

atkQuery::setLimit()

Set a limit to the number of results.

atkQuery::substringCondition()

Generate a searchcondition that checks whether $field contains $value .

atkQuery::wildcardCondition()

Generate a searchcondition that accepts '*' as wildcard character.

atkQuery::_addFrom()

Add FROM clause to query.

atkQuery::_addLimiter()

Add limiting clauses to the query.

atkQuery::_addOrderBy()

Add the ORDER BY clause

[ Top ]

Property Summary

mixed

$m_bind_vars

[ Top ]

Method Summary

atkQuery	&addField()	Add's a field to the query
atkQuery	&addJoin()	Makes a Join SQL query for Oracle
String	buildCount()	Builds the SQL Select COUNT(*) query. This is different from select, because we do joins, like in a select, but we don't really select the fields.
String	buildSelect()	Builds the SQL Select query
String	convertQuery()	Converts the SQL Select query. All aliases which
void	executeInsert()	Wrapper function to execute a query
void	executeUpdate()	Wrapper function to execute a query
string	replaceAliases()	Search patterns which are aliases and replace patterns

[ Top ]

Properties

mixed $m_bind_vars = array() [line 33]

[ Top ]

Methods

addField [line 50]

atkQuery &addField(
string
$name, [string
$value = ""], [string
$table = ""], [string
$fieldaliasprefix = ""], [string
$quote = true], [string
$mode = ""], [string
$fieldType = ""] 
)

Add's a field to the query

Parameters:

string	$name:	Field name
string	$value:	Field value
string	$table:	Table name
string	$fieldaliasprefix:	Field alias prefix
string	$quote:	If this parameter is true, stuff is inserted into the db using quotes, e.g. SET name = 'piet'. If it is false, it's done without quotes, e.d. SET number = 4.
string	$mode:
string	$fieldType:

API Tags:

Return:

The query object, for fluent usage.

Redefinition of:

atkQuery::addField(): Add's a field to the query

[ Top ]

addJoin [line 102]

atkQuery &addJoin(
string
$table, string
$alias, string
$condition, bool
$outer 
)

Makes a Join SQL query for Oracle

Parameters:

string	$table:	Table name
string	$alias:	Alias for the table
string	$condition:	Condition for the join
bool	$outer:	Wether to use an outer (left) join or an inner join

API Tags:

Return:

The query object (for fluent usage)

Redefinition of:

atkOci8Query::addJoin(): Makes a Join SQL query for Oracle

[ Top ]

buildCount [line 162]

String buildCount(
[bool
$distinct = FALSE] 
)

Builds the SQL Select COUNT(*) query. This is different from select, because we do joins, like in a select, but we don't really select the fields.

Parameters:

bool

$distinct:

distinct rows?

API Tags:

Return:

a SQL Select COUNT(*) Query

Redefinition of:

atkQuery::buildCount(): Builds the SQL Select COUNT(*) query. This is different from select, because we do joins, like in a select, but we don't really select the fields.

[ Top ]

buildSelect [line 141]

String buildSelect(
[bool
$distinct = FALSE] 
)

Builds the SQL Select query

Parameters:

bool

$distinct:

distinct records?

API Tags:

Return:

SQL Query

Redefinition of:

atkQuery::buildSelect(): Builds the SQL Select query

[ Top ]

convertQuery [line 176]

String convertQuery(
string
$query 
)

Converts the SQL Select query. All aliases which

have been added with addJoin are replaced with generated aliases bug #137

Parameters:

string

$query:

query string

API Tags:

Return:

SQL query

[ Top ]

executeInsert [line 232]

void executeInsert(
)

Wrapper function to execute a query

Redefinition of:

atkQuery::executeInsert(): Wrapper function to execute an insert query

[ Top ]

executeUpdate [line 222]

void executeUpdate(
)

Wrapper function to execute a query

Redefinition of:

atkQuery::executeUpdate(): Wrapper function to execute an update query

[ Top ]

replaceAliases [line 194]

string replaceAliases(
string
$str 
)

Search patterns which are aliases and replace patterns

Parameters:

string

$str:

to search

[ Top ]