SQLMaster Class Reference

List of all members.

Public Member Functions

 __construct ($db)
 add_field ($name, $aliase=false)
 remove_field ($name)
 auto_insert ($mode=true)
 config ($config)
 attach ($name, $data)
 get ($name, $rid, $data)
 confirm_sql ($rid)
 update_sql ($rid, $data)
 delete_sql ($rid, $data)
 insert_sql ($rid, $data, $id=false)

Public Attributes

 $config
 configuration of dataset

Private Member Functions

 is_field ($name)

Private Attributes

 $sqls
 has of sql queries
 $db
 database object
 $confirm
 flag of auto-insert mode


Constructor & Destructor Documentation

__construct ( db  ) 

constructor

Parameters:
db database object


Member Function Documentation

add_field ( name,
aliase = false 
)

add field to dataset config

added field will be used in all auto-generated queries

Parameters:
name name of field
aliase aliase of field, optional

attach ( name,
data 
)

assign named sql query

Parameters:
name name of sql query
data sql query text

auto_insert ( mode = true  ) 

enable auto insert mode

in auto insert mode, connector checks result of update operation and if it was not successful ( there are no affected records ), then same operation repeated in insert mode

Parameters:
mode boolean flag, optional, true by default

config ( config  ) 

assign config structure

Parameters:
config config structure

confirm_sql ( rid  ) 

generates confirmation sql

Parameters:
rid id of record
Returns:
sql string, which validates that element with defined ID exist

delete_sql ( rid,
data 
)

generates delete sql

Parameters:
rid id of record
data hash of data
Returns:
sql string, which delete record

get ( name,
rid,
data 
)

retrieve named sql query

query will have replaced all occurenses of named parameters

Parameters:
name name of sql query
rid id of record
data data hash of record
Returns:
sql string

insert_sql ( rid,
data,
id = false 
)

generates insert sql

Parameters:
rid id of record
data has of data
id id which will be used for new record, optional
Returns:
sql string, which inserts new record with provided data

is_field ( name  )  [private]

check if field is a part of dataset

Parameters:
name name of field
Returns:
returns true if field already a part of dataset, otherwise returns true

remove_field ( name  ) 

remove field from dataset config

removed field will be excluded from all auto-generated queries

Parameters:
name name of field, or aliase of field

update_sql ( rid,
data 
)

generates update sql

Parameters:
rid id of record
data hash of object's data
Returns:
sql string, which updates record with provided data


Member Data Documentation

$config

configuration of dataset

$confirm [private]

flag of auto-insert mode

$db [private]

database object

$sqls [private]

has of sql queries


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