DBMysql Class Reference

Inheritance diagram for DBMysql:

Public Member Functions
	__construct ($auto_connect=TRUE)
	create ()
	__connect ($connection)
	_afterConnect ($connection)
	_close ($connection)
	addQuotes ($string)
	_begin ($transactionLevel=0)
	_rollback ($transactionLevel=0)
	_commit ()
	__query ($query, $connection)
	_fetch ($result, $arrayIndexEndValue=NULL)
	getNextSequence ()
	isValidOldPassword ($password, $saved_password)
	isTableExists ($target_name)
	addColumn ($table_name, $column_name, $type= 'number', $size= '', $default=null, $notnull=false)
	dropColumn ($table_name, $column_name)
	isColumnExists ($table_name, $column_name)
	addIndex ($table_name, $index_name, $target_columns, $is_unique=false)
	dropIndex ($table_name, $index_name, $is_unique=false)
	isIndexExists ($table_name, $index_name)
	createTableByXml ($xml_doc)
	createTableByXmlFile ($file_name)
	_createTable ($xml_doc)
	_executeInsertAct ($queryObject, $with_values=true)
	_executeUpdateAct ($queryObject, $with_values=true)
	_executeDeleteAct ($queryObject, $with_values=true)
	_executeSelectAct ($queryObject, $connection=null, $with_values=true)
	db_insert_id ()
	db_fetch_object (&$result)
	db_free_result (&$result)
&	getParser ($force=FALSE)
	queryError ($queryObject)
	queryPageLimit ($queryObject, $result, $connection, $with_values=true)
	getSelectPageSql ($query, $with_values=true, $start_count=0, $list_count=0)
Public Member Functions inherited from DB
	getInstance ($db_type=NULL)
	create ()
	__construct ()
	getSupportedList ()
	_getSupportedList ()
	_sortDBMS ($a, $b)
	isSupported ()
	isConnected ($type= 'master', $indx=0)
	actStart ($query)
	actFinish ()
	setQueryLog ($log)
	setError ($errno=0, $errstr= 'success')
	isError ()
	getError ()
	executeQuery ($query_id, $args=NULL, $arg_columns=NULL, $type=NULL)
	checkQueryCacheFile ($query_id, $xml_file)
	_executeQuery ($cache_file, $source_args, $query_id, $arg_columns, $type)
	getCountCache ($tables, $condition)
	putCountCache ($tables, $condition, $count=0)
	resetCountCache ($tables)
	dropTable ($table_name)
	getSelectSql ($query, $with_values=TRUE)
	getClickCountQuery ($queryObject)
	getDeleteSql ($query, $with_values=TRUE, $with_priority=FALSE)
	getUpdateSql ($query, $with_values=TRUE, $with_priority=FALSE)
	getInsertSql ($query, $with_values=TRUE, $with_priority=FALSE)
	_getSlaveConnectionStringIndex ()
	_getConnection ($type= 'master', $indx=NULL)
	_dbInfoExists ()
	_close ($connection)
	close ($type= 'master', $indx=0)
	_begin ($transactionLevel=0)
	begin ()
	_rollback ($transactionLevel=0)
	rollback ()
	_commit ()
	commit ($force=FALSE)
	__query ($query, $connection)
	_query ($query, $connection=NULL)
	_setDBInfo ()
	__connect ($connection)
	_afterConnect ($connection)
	_connect ($type= 'master', $indx=0)
	actDBClassStart ()
	actDBClassFinish ()
	getParser ($force=FALSE)

Public Attributes
	$prefix = 'xe_'
	$comment_syntax = '/* %s */'
	$column_type
Public Attributes inherited from DB
	$priority_dbms
	$count_cache_path = 'files/cache/db'
	$cond_operation
	$master_db = NULL
	$slave_db = NULL
	$result = NULL
	$errno = 0
	$errstr = ''
	$query = ''
	$connection = ''
	$elapsed_time = 0
	$elapsed_dbclass_time = 0
	$transaction_started = FALSE
	$is_connected = FALSE
	$cache_file = 'files/cache/queries/'
	$db_type
	$use_prepared_statements

Additional Inherited Members
Static Public Member Functions inherited from DB
static	getEnableList ()
static	getDisableList ()
Static Public Attributes inherited from DB
static	$isSupported = FALSE
static	$supported_list = array()

Detailed Description

Definition at line 14 of file DBMysql.class.php.

Constructor & Destructor Documentation

DBMysql::__construct

(

$auto_connect = TRUE

)

Constructor

Returns

void

Definition at line 46 of file DBMysql.class.php.

Member Function Documentation

DBMysql::__connect

(

$connection

)

DB Connect this method is private

Parameters

array

$connection

connection's value is db_hostname, db_port, db_database, db_userid, db_password

Returns

resource

Definition at line 67 of file DBMysql.class.php.

DBMysql::__query	(		$query,
			$connection
	)

Execute the query this method is private

Parameters

string	$query
resource	$connection

Returns

resource

Definition at line 182 of file DBMysql.class.php.

DBMysql::_afterConnect

(

$connection

)

If have a task after connection, add a taks in this method this method is private

Parameters

resource

$connection

Returns

void

Definition at line 110 of file DBMysql.class.php.

DBMysql::_begin

(

$transactionLevel = 0

)

DB transaction start this method is private

Returns

boolean

Definition at line 150 of file DBMysql.class.php.

DBMysql::_close

(

$connection

)

DB disconnection this method is private

Parameters

resource

$connection

Returns

void

Definition at line 122 of file DBMysql.class.php.

DBMysql::_commit

(

)

DB transaction commit this method is private

Returns

boolean

Definition at line 170 of file DBMysql.class.php.

DBMysql::_createTable

(

$xml_doc

)

Create table by using the schema xml

type : number, varchar, tinytext, text, bigtext, char, date,
opt : notnull, default, size
index : primary key, index, unique

Parameters

string

$xml_doc

xml schema contents

Returns

void|object

Definition at line 477 of file DBMysql.class.php.

DBMysql::_executeDeleteAct	(		$queryObject,
			$with_values = true
	)

Handles deleteAct

Parameters

BaseObject	$queryObject
boolean	$with_values

Returns

resource

Definition at line 603 of file DBMysql.class.php.

DBMysql::_executeInsertAct	(		$queryObject,
			$with_values = true
	)

Handles insertAct

Parameters

BaseObject	$queryObject
boolean	$with_values

Returns

resource

Definition at line 565 of file DBMysql.class.php.

DBMysql::_executeSelectAct	(		$queryObject,
			$connection = null,
			$with_values = true
	)

Handle selectAct In order to get a list of pages easily when selecting
it supports a method as navigation

Parameters

BaseObject	$queryObject
resource	$connection
boolean	$with_values

Returns

BaseObject

Definition at line 623 of file DBMysql.class.php.

DBMysql::_executeUpdateAct	(		$queryObject,
			$with_values = true
	)

Handles updateAct

Parameters

BaseObject	$queryObject
boolean	$with_values

Returns

resource

Definition at line 582 of file DBMysql.class.php.

DBMysql::_fetch	(		$result,
			$arrayIndexEndValue = NULL
	)

Fetch the result

Parameters

resource	$result
int | NULL	$arrayIndexEndValue

Returns

array

Definition at line 205 of file DBMysql.class.php.

DBMysql::_rollback

(

$transactionLevel = 0

)

DB transaction rollback this method is private

Returns

boolean

Definition at line 160 of file DBMysql.class.php.

DBMysql::addColumn	(		$table_name,
			$column_name,
			$type = 'number',
			$size = '',
			$default = null,
			$notnull = false
	)

Add a column to the table

Parameters

string	$table_name	table name
string	$column_name	column name
string	$type	column type, default value is 'number'
int	$size	column size
string | int	$default	default value
boolean	$notnull	not null status, default value is false

Returns

void

Definition at line 302 of file DBMysql.class.php.

DBMysql::addIndex	(		$table_name,
			$index_name,
			$target_columns,
			$is_unique = false
	)

Add an index to the table $target_columns = array(col1, col2) $is_unique? unique : none

Parameters

string	$table_name	table name
string	$index_name	index name
string | array	$target_columns	target column or columns
boolean	$is_unique

Returns

void

Definition at line 383 of file DBMysql.class.php.

DBMysql::addQuotes

(

$string

)

Handles quatation of the string variables from the query

Parameters

string

$string

Returns

string

Definition at line 132 of file DBMysql.class.php.

DBMysql::create

(

)

Create an instance of this class

Returns

DBMysql return DBMysql object instance

Definition at line 56 of file DBMysql.class.php.

DBMysql::createTableByXml

(

$xml_doc

)

Creates a table by using xml contents

Parameters

string

$xml_doc

xml schema contents

Returns

void|object

Definition at line 447 of file DBMysql.class.php.

DBMysql::createTableByXmlFile

(

$file_name

)

Creates a table by using xml file path

Parameters

string

$file_name

xml schema file path

Returns

void|object

Definition at line 457 of file DBMysql.class.php.

DBMysql::db_fetch_object

(

&

$result

)

Fetch a result row as an object

Parameters

resource

$result

Returns

object

Definition at line 677 of file DBMysql.class.php.

DBMysql::db_free_result

(

&

$result

)

Free result memory

Parameters

resource

$result

Returns

boolean Returns TRUE on success or FALSE on failure.

Definition at line 687 of file DBMysql.class.php.

DBMysql::db_insert_id

(

)

Get the ID generated in the last query Return next sequence from sequence table This method use only mysql

Returns

int

Definition at line 666 of file DBMysql.class.php.

DBMysql::dropColumn	(		$table_name,
			$column_name
	)

Drop a column from the table

Parameters

string	$table_name	table name
string	$column_name	column name

Returns

void

Definition at line 337 of file DBMysql.class.php.

DBMysql::dropIndex	(		$table_name,
			$index_name,
			$is_unique = false
	)

Drop an index from the table

Parameters

string	$table_name	table name
string	$index_name	index name
boolean	$is_unique

Returns

void

Definition at line 401 of file DBMysql.class.php.

DBMysql::getNextSequence

(

)

Return the sequence value incremented by 1 Auto_increment column only used in the sequence table

Returns

int

Definition at line 243 of file DBMysql.class.php.

& DBMysql::getParser

(

$force = FALSE

)

Return the DBParser

Parameters

boolean

$force

Returns

DBParser

Definition at line 697 of file DBMysql.class.php.

DBMysql::getSelectPageSql	(		$query,
			$with_values = true,
			$start_count = 0,
			$list_count = 0
	)

If select query execute, return paging sql

Parameters

object	$query
boolean	$with_values
int	$start_count
int	$list_count

Returns

string select paging sql

Definition at line 833 of file DBMysql.class.php.

DBMysql::isColumnExists	(		$table_name,
			$column_name
	)

Check column exist status of the table

Parameters

string	$table_name	table name
string	$column_name	column name

Returns

boolean

Definition at line 349 of file DBMysql.class.php.

DBMysql::isIndexExists	(		$table_name,
			$index_name
	)

Check index status of the table

Parameters

string	$table_name	table name
string	$index_name	index name

Returns

boolean

Definition at line 413 of file DBMysql.class.php.

DBMysql::isTableExists

(

$target_name

)

Check a table exists status

Parameters

string

$target_name

Returns

boolean

Definition at line 280 of file DBMysql.class.php.

DBMysql::isValidOldPassword	(		$password,
			$saved_password
	)

Function to obtain mysql old password(mysql only)

Parameters

string	$password	input password
string	$saved_password	saved password in DBMS

Returns

boolean

Definition at line 263 of file DBMysql.class.php.

DBMysql::queryError

(

$queryObject

)

If have a error, return error object

Parameters

BaseObject

$queryObject

Returns

BaseObject

Definition at line 708 of file DBMysql.class.php.

DBMysql::queryPageLimit	(		$queryObject,
			$result,
			$connection,
			$with_values = true
	)

If select query execute, return page info

Parameters

BaseObject	$queryObject
resource	$result
resource	$connection
boolean	$with_values

Returns

BaseObject BaseObject with page info containing

Definition at line 735 of file DBMysql.class.php.

Member Data Documentation

DBMysql::$column_type

Initial value:

= array(
        'bignumber' => 'bigint',
        'number' => 'bigint',
        'varchar' => 'varchar',
        'char' => 'char',
        'text' => 'text',
        'bigtext' => 'longtext',
        'date' => 'varchar(14)',
        'float' => 'float',
    )

Definition at line 31 of file DBMysql.class.php.

DBMysql::$comment_syntax = '/* %s */'

Definition at line 22 of file DBMysql.class.php.

DBMysql::$prefix = 'xe_'

Definition at line 21 of file DBMysql.class.php.

---

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

• classes/db/DBMysql.class.php