DBQuery Class Reference

Inheritance diagram for DBQuery:

DBQueryMySQL DBQueryPostgre

List of all members.

Public Member Functions

 __construct ($str="")
 __toString ()
 copy ()
 parse ($str)
 sql ()
 fill ($config, $event=false)
 set_select ()
 set_table ($data)
 set_order ($data, $direction='ASC', $event=false)
 save_rules ()
 restore_rules ()
 set_rules ($rule, $event=false)
 set_count ($count, $from=0)

Public Attributes

 $select
 select statement
 $table
 table statement
 $order
 order statement
 $rules
 where statement
 $from
 start position
 $count
 count of records requested
 $group_by
 group statement

Protected Member Functions

 init ()

Private Attributes

 $old_rules
 used for storing initil set of rules


Detailed Description

generator of custom select sql queries

While base class provide enough functionality to work with any SQL compilant database, connectors never use it directly, but creates child classes, specific for each DB type.


Constructor & Destructor Documentation

__construct ( str = ""  ) 

constructor

object can be created empty, or on base of existing sql query

Parameters:
str sql query from which initial data will be taken


Member Function Documentation

__toString (  ) 

convert self to the string, used for logging

copy (  ) 

make a copy of itself

Returns:
DBQuery object with same properties

fill ( config,
event = false 
)

fill internal state based on config

Parameters:
config config object
event EventMaster object

Reimplemented in DBQueryPostgre.

init (  )  [protected]

prepare internal state for sql generation

Reimplemented in DBQueryPostgre.

parse ( str  ) 

parse sql string and fill internal state based on it

Parameters:
str string which need to be parsed

restore_rules (  ) 

restore previously saved set of rules for later usage

save_rules (  ) 

save current set of rules for later usage

set_count ( count,
from = 0 
)

set limit part of query

Parameters:
count count of requested records
from set start position of query, optional starts from 0 by default

set_order ( data,
direction = 'ASC',
event = false 
)

set order by part of query

Parameters:
data array with (name,aliase) of sorting field
direction sorting directtion, string, can be ASC or DESC
event EventMaster object, optional

set_rules ( rule,
event = false 
)

set filtering rules for query ( where section )

Parameters:
rule array of rules, structure is
  • array(name,value,operation)
  • array(nave,value) - LIKE x% will be used as operation
event EventMaster object, optional

set_select (  ) 

construct select part of query

method can accept any number of params, which will be threated as array(name,aliase) objects

set_table ( data  ) 

set from part of query

Parameters:
data array with (name,aliase) of table

sql (  ) 

generates sql query based on current state

Returns:
sql string

Reimplemented in DBQueryPostgre.


Member Data Documentation

$count

count of records requested

$from

start position

$group_by

group statement

$old_rules [private]

used for storing initil set of rules

$order

order statement

$rules

where statement

$select

select statement

$table

table statement


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

Generated on Tue Mar 3 20:06:24 2009 for dhxmlXConnector by  doxygen 1.5.8